SoClipPlaneElement Class Reference

The SoClipPlaneElement class is used to manage the clip plane stack. More...

#include <Inventor/elements/SoClipPlaneElement.h>

Inheritance diagram for SoClipPlaneElement:

Public Member Functions
const SbPlane &	get (const int index, const SbBool inworldspace=TRUE) const
int	getNum (void) const
virtual void	init (SoState *state)
virtual void	push (SoState *state)
Public Member Functions inherited from SoAccumulatedElement
virtual SbBool	matches (const SoElement *element) const
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	print (FILE *file=stdout) const
void	setDepth (const int depth)

Static Public Member Functions
static void	add (SoState *const state, SoNode *const node, const SbPlane &plane)
static void *	createInstance (void)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static const SoClipPlaneElement *	getInstance (SoState *const state)
static void	initClass (void)
Static Public Member Functions inherited from SoAccumulatedElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Member Functions
virtual	~SoClipPlaneElement ()
virtual void	addToElt (const SbPlane &plane, const SbMatrix &modelmatrix)
Protected Member Functions inherited from SoAccumulatedElement
virtual	~SoAccumulatedElement ()
void	addNodeId (const SoNode *const node)
virtual void	captureThis (SoState *state) const
void	clearNodeIds (void)
virtual SoElement *	copyMatchInfo (void) const
void	copyNodeIds (const SoAccumulatedElement *copyfrom)
void	setNodeId (const SoNode *const node)
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
SbList< so_plane_data >	planes
int	startIndex
Protected Attributes inherited from SoAccumulatedElement
SbList< SbUniqueId >	nodeIds
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

Detailed Description

The SoClipPlaneElement class is used to manage the clip plane stack.

Constructor & Destructor Documentation

~SoClipPlaneElement()

SoClipPlaneElement::~SoClipPlaneElement ( )

protectedvirtual

Destructor.

Member Function Documentation

add()

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

static

Adds plane as an active plane. Calls addToElt() to do the job.

addToElt()

void SoClipPlaneElement::addToElt ( const SbPlane & plane, const SbMatrix & modelMatrix )

protectedvirtual

This method adds the clipping plane, plane, to an instance. modelmatrix is the current model matrix.

Reimplemented in SoGLClipPlaneElement.

createInstance()

void * SoClipPlaneElement::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

get()

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

Returns the index'th plane.

getClassStackIndex()

int SoClipPlaneElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoClipPlaneElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getInstance()

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

static

Returns the current (top-of-stack) element.

getNum()

int SoClipPlaneElement::getNum

(

void

)

const

Returns the current number of active clipping planes.

init()

void SoClipPlaneElement::init ( SoState * state )

virtual

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoAccumulatedElement.

Reimplemented in SoGLClipPlaneElement.

initClass()

void SoClipPlaneElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

push()

void SoClipPlaneElement::push ( SoState * state )

virtual

This method is called every time a new element is required in one of the stacks. This happens when a writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoAccumulatedElement.

Member Data Documentation

planes

SoClipPlaneElement::planes

protected

List of currently active planes.

startIndex

SoClipPlaneElement::startIndex

protected

Index of first clip plane in this element. Used to disable clip planes in SoGLClipPlaneElement::pop().

---

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

• SoClipPlaneElement.h
• SoClipPlaneElement.cpp