SoClipPlaneElement Class Reference

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

#include <Inventor/elements/SoClipPlaneElement.h>

Inheritance diagram for SoClipPlaneElement:
SoAccumulatedElement SoElement SoTypedObject

List of all members.

Public Member Functions

virtual void push (SoState *state)
virtual void pop (SoState *state, const SoElement *prevTopElement)
int getNum () const
const SbPlaneget (int index, SbBool inWorldSpace=TRUE) const
virtual void print (FILE *fp) const

Static Public Member Functions

static SoType getClassTypeId ()
static int getClassStackIndex ()
static void add (SoState *state, SoNode *node, const SbPlane &plane)
static const SoClipPlaneElementgetInstance (SoState *state)
static int getMaxPlanes ()

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).


SoClipPlane, SoOrthoSlice

Member Function Documentation

static void SoClipPlaneElement::add ( SoState state,
SoNode node,
const SbPlane plane 
) [static]

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

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.

static int SoClipPlaneElement::getClassStackIndex (  )  [static]

Returns the stack id for this element.

Reimplemented from SoAccumulatedElement.

static SoType SoClipPlaneElement::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoAccumulatedElement.

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

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

static int SoClipPlaneElement::getMaxPlanes (  )  [static]

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

int SoClipPlaneElement::getNum (  )  const

Returns the number of planes in an instance.

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

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

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

Prints element (for debugging).

Reimplemented from SoAccumulatedElement.

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:

Open Inventor Toolkit reference manual, generated on 22 Dec 2020
Copyright © Thermo Fisher Scientific All rights reserved.