Click or drag to resize
SoState Class

Traversal state.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.MiscSoState

Namespace: OIV.Inventor.Misc
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.10.0.0 (10.10.0.0)
Syntax
public class SoState : SoNetBase

The SoState type exposes the following members.

Constructors
  NameDescription
Public methodSoState

Constructor.

Top
Methods
  NameDescription
Public methodEnableSendToGL
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAction

Returns the action instance the state is part of.

Public methodGetConstElement(Int32) Obsolete.

Returns the top (read-only) instance of the given element stack.

Public methodGetConstElement(Type, Int32)

Returns the top (read-only) instance of the given element stack.

Public methodGetElement(Int32) Obsolete.

Returns a writable instance of the element on the top of the stack with the given stack index.

Public methodGetElement(Type, Int32)

Returns a writable instance of the element on the top of the stack with the given index and type.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSendToGLEnabled

Gets sendToGL activation flag.

Public methodPop

Pops the state, restoring the state to just before the last OIV.Inventor.Misc.SoState.Push().

Public methodPush

Pushes (saves) the current state until a OIV.Inventor.Misc.SoState.Pop() restores it.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

An OIV.Inventor.Misc.SoState collects and holds state while traversing a scene graph. A state is composed of a variety of elements, each of which holds some specific information, such as coordinates or diffuse color of the surface material.

Each element is stored in its own stack so that save and restore can be implemented as push and pop. These stack operations are performed lazily, so that pushing of a value occurs only when the value would be overwritten, for efficiency.

See Also