Package com.openinventor.inventor.elements

Class SoClipPlaneElement

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.elements.SoElement

com.openinventor.inventor.elements.SoAccumulatedElement

com.openinventor.inventor.elements.SoClipPlaneElement

public class SoClipPlaneElement
extends SoAccumulatedElement

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

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method	Description
static void	add(SoState state, SoNode node, SbPlane plane)	Adds a clip plane to the current set in the state.
SbPlane	get(int index)	Calls get(index, true).
SbPlane	get(int index, boolean inWorldSpace)	Returns the indexed plane an element as an SbPlane.
static int	getClassStackIndex()	Deprecated. As of Open Inventor 9.3.0.0.
static 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.
int	getNum()	Returns the number of planes in an instance.
void	pop(SoState state, SoElement prevTopElement)	Overrides pop() method to free up planes that were added.
void	push(SoState state)	Overrides push() method to copy values from next instance in the stack.

Methods inherited from class com.openinventor.inventor.elements.SoElement

getClassStackIndex

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public SbPlane get(int index)

Calls get(index, true).

getMaxPlanes

public static int getMaxPlanes()

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

push

public void push(SoState state)

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

Overrides:

push in class SoAccumulatedElement

getNum

public int getNum()

Returns the number of planes in an instance.

getInstance

public static SoClipPlaneElement getInstance(SoState state)

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

pop

public void pop(SoState state,
                SoElement prevTopElement)

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

Overrides:

pop in class SoElement

getClassStackIndex

@Deprecated(since="9.3.0.0")
public static int getClassStackIndex()

Deprecated.

As of Open Inventor 9.3.0.0. replaced by SoElement.getClassStackIndex(Class)

Returns the stack id for this element. ] *

get

public SbPlane get(int index,
                   boolean inWorldSpace)

Returns the indexed plane an element as an SbPlane. The plane can be returned in object or world space.

add

public static void add(SoState state,
                       SoNode node,
                       SbPlane plane)

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