SoClipPlaneElement Class Reference

Stores the current set of clipping planes, specified as SbPlanes. More...

#include <Inventor/elements/SoClipPlaneElement.h>

Inheritance diagram for SoClipPlaneElement:

Public Member Functions
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 SbPlane &	get (int index, SbBool 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 SoElement
virtual SoType	getTypeId () const
	Returns type identifier for element instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
static void	add (SoState *state, SoNode *node, const SbPlane &plane)
	Adds a clip plane to the current set in the state.
static const SoClipPlaneElement *	getInstance (SoState *state)
	Returns the top (current) instance of the element in the state.
static int	getMaxPlanes ()
	Returns the maximum number of concurrent clipping planes supported by current implementation.
Static Public Member Functions inherited from SoAccumulatedElement
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores the current set of clipping planes, specified as SbPlanes.

This element stores the current set of clipping planes, specified as SbPlanes.

When a plane is added, this element gets the current model matrix from the state and stores it in the instance. This allows the get() method to return the clip plane in object space (the plane as originally defined) or world space (after being transformed by the model matrix).

SEE ALSO

SoClipPlane, SoOrthoSlice

Definition at line 75 of file SoClipPlaneElement.h.

Member Function Documentation

add()

static void SoClipPlaneElement::add ( SoState *  state, SoNode *  node, const SbPlane &  plane  )

static

Adds a clip plane to the current set in the state.

get()

const SbPlane & SoClipPlaneElement::get	(	int	index,
		SbBool	inWorldSpace = TRUE
	)		const

Returns the indexed plane an element as an SbPlane.

The plane can be returned in object or world space.

getClassStackIndex()

static int SoClipPlaneElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoClipPlaneElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getInstance()

static const SoClipPlaneElement * SoClipPlaneElement::getInstance ( SoState *  state )

static

Returns the top (current) instance of the element in the state.

getMaxPlanes()

static int SoClipPlaneElement::getMaxPlanes ( )

static

Returns the maximum number of concurrent clipping planes supported by current implementation.

getNum()

int SoClipPlaneElement::getNum

(

)

const

Returns the number of planes in an instance.

pop()

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

virtual

Overrides pop() method to free up planes that were added.

Reimplemented from SoElement.

print()

virtual void SoClipPlaneElement::print ( FILE *  fp ) const

virtual

Prints element (for debugging).

Reimplemented from SoAccumulatedElement.

push()

virtual void SoClipPlaneElement::push ( SoState *  state )

virtual

Overrides push() method to copy values from next instance in the stack.

Reimplemented from SoAccumulatedElement.

---

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

• Inventor/elements/SoClipPlaneElement.h