Open Inventor Reference
SoGLClipPlaneElement Class Reference

Element that adds a clipping plane to the set currently in GL. More...

#include <Inventor/elements/SoGLClipPlaneElement.h>

Inheritance diagram for SoGLClipPlaneElement:
SoClipPlaneElement SoAccumulatedElement SoElement

Public Member Functions

virtual void pop (SoState *state, const SoElement *prevTopElement)
 Override pop() method so side effects can occur in GL.
 
- Public Member Functions inherited from SoClipPlaneElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Overrides push() method to copy values from next instance in the stack.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 Overrides pop() method to free up planes that were added.
 
int getNum () const
 Returns the number of planes in an instance.
 
const SbPlaneget (int index, bool inWorldSpace=TRUE) const
 Returns the indexed plane an element as an SbPlane.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
- Public Member Functions inherited from SoAccumulatedElement
virtual bool matches (const SoElement *elt) const
 Returns TRUE if the element matches another element, based on node-id's.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
- Public Member Functions inherited from SoElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Pushes/pops element.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual bool matches (const SoElement *elt) const =0
 Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
 
virtual SoElementcopyMatchInfo () const =0
 Create a copy that we can put in a cache used list and call matches() on later.
 
SoType getTypeId () const
 Returns type identifier for element instance.
 
int getStackIndex () const
 Returns the stack index for an element instance.
 
void setDepth (int dpth)
 Sets stuff in an element instance.
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance.
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor.
 

Static Public Member Functions

static int getMaxGLPlanes ()
 Returns the maximum number of concurrent clipping planes supported by GL implementation.
 
static void initClass ()
 Initializes the SoGLClipPlaneElement class.
 
- Static Public Member Functions inherited from SoClipPlaneElement
static void add (SoState *state, SoNode *node, const SbPlane &plane)
 Adds a clip plane to the current set in the state.
 
static const SoClipPlaneElementgetInstance (SoState *state)
 Returns the top (current) instance of the element in the state.
 
static void initClass ()
 Initializes the SoClipPlaneElement class.
 
- Static Public Member Functions inherited from SoAccumulatedElement
static void initClass ()
 Initializes the SoAccumulatedElement class.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
static void initElements ()
 Initialize ALL Inventor element classes.
 
static void initClass ()
 Initializes the SoElement class.
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated.
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index.
 

Protected Member Functions

virtual void addToElt (const SbPlane &plane, const SbMatrix &modelMatrix)
 Adds the clipping plane to an instance. Has GL side effects.
 
virtual ~SoGLClipPlaneElement ()
 
- Protected Member Functions inherited from SoClipPlaneElement
virtual void addToElt (const SbPlane &plane, const SbMatrix &modelMatrix)
 Adds the clipping plane to an instance.
 
virtual ~SoClipPlaneElement ()
 
- Protected Member Functions inherited from SoAccumulatedElement
void clearNodeIds ()
 Clears out the list of node id's.
 
void addNodeId (const SoNode *node)
 Adds the id of the given node to the current list.
 
void setNodeId (const SoNode *node)
 Sets the node id list to JUST the id of the given node.
 
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element; this will copy the nodeId list properly.
 
virtual void captureThis (SoState *state) const
 Override normal capture method to capture elements at other depths that we are accumulating with.
 
virtual ~SoAccumulatedElement ()
 Destructor.
 
- Protected Member Functions inherited from SoElement
 SoElement ()
 Constructor; use typeId.createInstance to create elements.
 
void capture (SoState *state) const
 Does whatever is necessary in state to capture this element for caching purposes.
 
virtual void captureThis (SoState *state) const
 Really captures this element, once it has been determined that a cache is open to capture it.
 
void setTypeId (SoType id)
 Sets typeId in instance.
 
void setStackIndex (int index)
 Sets stackIndex in instance.
 
SoElementgetNextInStack () const
 Returns next instance in specific element stack.
 
SoElementgetNextFree () const
 Returns next free element in a specific element stack.
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *state, int stackIndex)
 Returns an instance of an element from the stack with the given index in the given state.
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack.
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index.
 
- Protected Attributes inherited from SoClipPlaneElement
SbPList planes
 List of plane structures.
 
int startIndex
 Index of 1st plane created in this instance.
 
- Protected Attributes inherited from SoAccumulatedElement
SbPList nodeIds
 This stores the list of node id's as pointers, since they should be the same length as int32_ts.
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class.
 

Detailed Description

Overrides the virtual methods on SoClipPlaneElement to send the clipping plane to GL.

Note that this class relies on SoClipPlaneElement to store the plane in the instance.

Definition at line 74 of file SoGLClipPlaneElement.h.

Constructor & Destructor Documentation

◆ ~SoGLClipPlaneElement()

virtual SoGLClipPlaneElement::~SoGLClipPlaneElement ( )
protectedvirtual

Member Function Documentation

◆ addToElt()

virtual void SoGLClipPlaneElement::addToElt ( const SbPlane plane,
const SbMatrix modelMatrix 
)
protectedvirtual

Reimplemented from SoClipPlaneElement.

◆ getMaxGLPlanes()

static int SoGLClipPlaneElement::getMaxGLPlanes ( )
static

◆ initClass()

static void SoGLClipPlaneElement::initClass ( )
static

◆ pop()

virtual void SoGLClipPlaneElement::pop ( SoState state,
const SoElement prevTopElement 
)
virtual

Reimplemented from SoClipPlaneElement.


The documentation for this class was generated from the following file: