com.openinventor.inventor.elements

Class SoElement

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.elements.SoElement

Direct Known Subclasses:

SoAccumulatedElement, SoBBoxCacheElement, SoBlendElement, SoCacheElement, SoDepthBufferElement, SoFloatElement, SoFullSceneAntialiasingElement, SoInt32Element, SoInt32ListElement, SoInteractionElement, SoLazyElement, SoLightModelElement, SoLocalBBoxMatrixElement, SoLogicalViewportElement, SoLogicOperationElement, SoModifyLogicalViewportElement, SoModifyViewVolumeElement, SoOverrideElement, SoPickRayElement, SoReplacedElement, SoReplacedTextureElement, SoShapeHintsElement, SoShapeStyleElement, SoStereoElement, SoTextureOverrideElement, SoUpdateAreaElement, SoViewportRegionElement, SoWindowElement

public abstract class SoElement
extends Inventor

Abstract base class for all state elements. This is the abstract base class for all state elements. This class defines the following features for all of its derived classes:

<B> Type identifiers: </B> Each class of element has a unique (static)
SoType identifier. The correct type id is also stored in each
instance for easy access.

<B> Copying: </B> Elements are copied into the list of elements used
in an SoCache. Performing any operation other than matches()
on a copied element is not guaranteed to work (and will not
work for things like Coordinates, if the coordinate they were
pointing to has been deleted).

<B> Stack indices: </B> Since a subclass of an element class needs to
be in the same state stack as the class from which it is
derived, stack indices are inherited.

<B> Capturing: </B> Each time an element's value is accessed, that
element is added to the elements-used list of all currently
open caches.

See also:

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 and Description
static <E extends SoElement> int	getClassStackIndex(java.lang.Class<E> elementClass) Returns the stack id for the element type.
void	pop(SoState state, SoElement prevTopElement) Pops element.
void	push(SoState state) Pushes element.

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

getClassStackIndex

public static <E extends SoElement> int getClassStackIndex(java.lang.Class<E> elementClass)

Returns the stack id for the element type.

Parameters:

elementClass - Type of element. The type must not be an abstract type.

Returns:

The stack id for the element type.

Throws:

java.lang.IllegalArgumentException - if the specified type is an abstract type.

push

public void push(SoState state)

Pushes element. Allows for side effects to occur. Default methods do nothing.

pop

public void pop(SoState state,
                SoElement prevTopElement)

Pops element. Allows for side effects to occur. Default methods do nothing.