Click or drag to resize
SoFrontBufferGroup Class

Note: This API is now obsolete.

Delayed rendering group node.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[ObsoleteAttribute("See documentation for more details")]
public class SoFrontBufferGroup : SoSeparator

The SoFrontBufferGroup type exposes the following members.

Constructors
  NameDescription
Public methodSoFrontBufferGroup

Creates a FrontBufferGroup node with default settings.

Top
Methods
  NameDescription
Public methodAddChild

Adds a child as last one in group.

(Inherited from SoGroup.)
Public methodAffectsState
(Inherited from SoSeparator.)
Public methodCallback
(Inherited from SoSeparator.)
Public methodClearCacheList
(Inherited from SoSeparator.)
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 SoSeparator.)
Public methodDoAction
(Inherited from SoSeparator.)
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
(Inherited from SoSeparator.)
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
(Inherited from SoSeparator.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumChildren

Returns number of children.

(Inherited from SoGroup.)
Public methodGetPrimitiveCount
(Inherited from SoSeparator.)
Public methodGetRenderUnitID
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
(Inherited from SoSeparator.)
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
(Inherited from SoSeparator.)
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
(Inherited from SoSeparator.)
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

Whether to cache during bounding box traversal.

(Inherited from SoSeparator.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoGroup.)
Public propertydirectVizCaching

Whether to cache during OpenRTRT rendering traversal.

(Inherited from SoSeparator.)
Public propertyenable

Controls whether children are delayed.

Public propertyfastEditing

Specifies the fast edit mode of the separator node.

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

Whether to cull during picking traversal.

(Inherited from SoSeparator.)
Public propertyrenderCaching

Whether to cache during rendering traversal.

(Inherited from SoSeparator.)
Public propertyrenderCulling

Whether to cull during rendering traversal.

(Inherited from SoSeparator.)
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.

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

This group node delays rendering its children until all other nodes have been rendered and (for a double buffered drawable) the OpenGL buffer swap has occurred. The result is that the shapes under this node are always rendered in the OpenGL front buffer.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

This node is derived from SoSeparator, so it saves and restores traversal state for all actions. The behavior is similar to SoAnnotation, but that node only delays until the end of traversal (before the buffer swap) and also disables the OpenGL depth buffer test. This node delays until after the buffer swap and renders with normal depth buffer testing.

If more than one FrontBufferGroup node is present in a graph, the order in which they are traversed determines the stacking order - later nodes are rendered on top of earlier ones.

Objects under this node are subject to the current settings for transparency type and antialiasing/smoothing, but they will not be rendered in stereo. Since SoFrontBufferGroup is intended for rendering very large/slow objects that cannot be moved interactively, it would not be desirable to draw them twice (i.e. left and right images).

The FrontBufferGroup node does nothing special when picking along a ray. That is, it does not modify the sorting order of intersected objects based on which ones are under this node. If your application uses this node and you want to ensure that objects under it are picked "in front of" other objects, you can tell the pick action that you want to pick all objects along the ray and then scan through the paths in the resulting picked point instances to see if any of them passes through a FrontBufferGroup node. Your program can then decide what to do in such a case.

FILE FORMAT/DEFAULT

FrontBufferGroup {
enable true
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
fastEditing DISABLE
}

ACTION BEHAVIOR

SoGLRenderAction Delays rendering its children until all other nodes have been traversed and the buffer swap has occurred, then renders in the front buffer.

SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoRayPickAction, SoSearchAction Same as SoSeparatorObsoletesince Open Inventor 9610 Use SoAnnotation instead

See Also