Click or drag to resize
SoSeparator Class

Group node that saves and restores traversal state.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.2.0 (2024.1.2)
Syntax
public class SoSeparator : SoGroup

The SoSeparator type exposes the following members.

Constructors
  NameDescription
Public methodSoSeparator

Creates a separator node with default settings.

Public methodSoSeparator(Int32)

Constructor that takes approximate number of children.

Top
Methods
  NameDescription
Public methodAddChild

Adds a child as last one in group.

(Inherited from SoGroup.)
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Overrides SoNodeAffectsState.)
Public methodCallback
Public methodClearCacheList
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodFindChild

Finds index of given child within group.

(Inherited from SoGroup.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
Public methodGetChild

Returns pointer the child node with the given index.

(Inherited from SoGroup.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumChildren

Returns number of children.

(Inherited from SoGroup.)
Public methodGetPrimitiveCount
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
Public methodGLRenderBelowPath
Public methodGLRenderInPath
Public methodGLRenderOffPath
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInsertChild

Adds a child so that it becomes the one with the given index.

(Inherited from SoGroup.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to known if bounding box computation should be ignored or not.

(Inherited from SoGroup.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoGroup.)
Public methodRayPick
Public methodRemoveAllChildren

Removes all children from group.

(Inherited from SoGroup.)
Public methodRemoveChild(Int32)

Removes child with given index from group.

(Inherited from SoGroup.)
Public methodRemoveChild(SoNode)

Removes first instance of given child from group.

(Inherited from SoGroup.)
Public methodReplaceChild(Int32, SoNode)

Replaces child with given index with new child.

(Inherited from SoGroup.)
Public methodReplaceChild(SoNode, SoNode)

Replaces first instance of given child with new child.

(Inherited from SoGroup.)
Public methodSearch
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoGroup.)
Top
Properties
  NameDescription
Public propertyboundingBoxCaching
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoGroup.)
Public propertyfastEditing

Specifies the fast edit mode of the separator node.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypickCulling

Whether to cull during picking traversal.

Public propertyrenderCaching Obsolete.

Whether to cache during rendering traversal.

Public propertyrenderCulling

Whether to cull during rendering traversal.

Public propertyrenderUnitId

Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This group node performs a push (save) of the traversal state before traversing its children and a pop (restore) after traversing them. This isolates the separator's children from the rest of the scene graph. A separator can include lights, cameras, coordinates, normals, bindings, and all other properties. Separators are relatively inexpensive (the push/pop operation is highly optimized), so they can be used freely within scenes.

Caching:

The OIV.Inventor.Nodes.SoSeparator node provides caching of state during bounding box computation. This feature can be explicitly enabled or disabled by setting the OIV.Inventor.Nodes.SoSeparator.boundingBoxCaching field. By default, this field is set to AUTO, which means that Open Inventor decides whether to build a cache based on internal heuristics.

Culling:

Separators can also perform culling during rendering and picking. Culling skips over traversal of the separator's children if they are not going to be rendered or picked, based on the comparison of the separator's bounding box with the current view volume. Culling is controlled by the OIV.Inventor.Nodes.SoSeparator.renderCulling and OIV.Inventor.Nodes.SoSeparator.pickCulling fields. These are also set to AUTO by default; however, render culling can be expensive (and can interfere with render caching), so the AUTO heuristics leave it disabled unless specified otherwise. Note that if renderCulling is ON, the OIV.Inventor.Nodes.SoSeparator will prohibit auto-caching, so that no OIV.Inventor.Nodes.SoSeparator (or other render caching node) above this node in the scene graph will automatically create a render cache.

Fast edit:

The fast editing feature allows you to modify parts of a scene without redrawing the entire scene. For example, you could use it to interactively move a small object in a large scene that takes a long time to redraw. Fast editing must be enabled using OIV.Inventor.Actions.SoGLRenderAction.SetFastEditSavePolicy(OIV.Inventor.Actions.SoGLRenderAction.FastEditSavePolicies, System.Boolean).

The OIV.Inventor.Nodes.SoSeparator.fastEditing field enables fast editing for the sub-graph under the OIV.Inventor.Nodes.SoSeparator. Possible values are DISABLE, KEEP_ZBUFFER, and CLEAR_ZBUFFER. Using KEEP_ZBUFFER means that the fast edit geometry is depth buffered against the other objects in the scene, and using CLEAR_ZBUFFER means that the fast edit geometry will be drawn on top of the other objects of the scene. If several SoSeparators have the CLEAR_ZBUFFER flag set, they are drawn in the order in which they appear in the scene. The last separator in the scene will be topmost on the screen.

Fast edit performance:

  • This feature is most efficient when the parts of a scene graph to be fast edited contain a relatively small number of triangles.

  • The topmost OIV.Inventor.Nodes.SoSeparator of your scene graph should not enable the fast editing feature. Otherwise, performance will be very poor.

  • Currently, the entire viewport is saved and restored during fast editing. Therefore, fast editing performance is linked to the size of the viewport: the larger the viewport, the longer it will take to save and restore it.

Fast edit limitations:

  • Hardware: Fast editing performance depends on your graphics hardware and driver. To use the fast editing feature, the ARB_bufferRegion OpenGL extension is required.

  • Clip planes: When a fast edit object is moved outside the clip planes limit, fast editing is temporarily disabled and the entire scene is redrawn.

  • All fast editing sub-graphs are rendered even if only one fast editing sub-graph has changed.

  • Transparency: If the scene contains partially transparent objects, there is a possibility of visual artifacts regardless of what transparency algorithm is used. The fast edit shapes are necessarily rendered on top of the rest of the scene, which may not be the order required for correct transparency.

  • Stereo rendering: Fast edit is not compatible with stereo rendering. Fast edit is disabled when switching to stereo rendering.

FILE FORMAT/DEFAULT

Separator {
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
fastEditing DISABLE
renderUnitID -1
}

ACTION BEHAVIOR

OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction, OIV.Inventor.Actions.SoGetBoundingBoxAction, OIV.Inventor.Actions.SoGetMatrixAction, OIV.Inventor.Actions.SoHandleEventAction, OIV.Inventor.Actions.SoRayPickAction, OIV.Inventor.Actions.SoSearchAction Saves the current traversal state, traverses all children, and restores the previous traversal state. Sets: OIV.Inventor.Elements.SoCacheElement

See Also
Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoGroup
              OIV.Inventor.NodesSoSeparator
                OIV.Inventor.NodesSoAnnotation
                OIV.Inventor.NodesSoBillboard
                OIV.Inventor.NodesSoLocateHighlight
                OIV.Inventor.NodesSoRenderToTarget
                OIV.Inventor.NodesSoSelection
                OIV.Inventor.NodesSoVertexAttribFeedback
                OIV.Inventor.ViewerComponents.NodesSceneInteractor
                OIV.LDM.NodesSoMultiDataSeparator
                OIV.Medical.NodesPlaneGeometryIntersection
                OIV.Medical.NodesRuler
                OIV.VolumeViz.NodesSoVolumeGroup