SoOctreeOrdering Class |
Note: This API is now obsolete.
Group node derived from SoRenderList that maintains a transparent octree organization of the shapes below it.
Namespace: OIV.Inventor.Nodes
The SoOctreeOrdering type exposes the following members.
Name | Description | |
---|---|---|
![]() | SoOctreeOrdering | Default constructor. |
![]() | SoOctreeOrdering(Int32) | Constructor that takes approximate number of children as a hint. |
Name | Description | |
---|---|---|
![]() | AddChild | Adds a child as last one in group. |
![]() | AddRenderObjectName | Adds a new name to the search list. |
![]() | AddRenderObjectType | Adds a new type to the search list. |
![]() | AffectsState | (Inherited from SoSeparator.) |
![]() | Callback | (Inherited from SoSeparator.) |
![]() | ClearCacheList | (Inherited from SoSeparator.) |
![]() | Copy | Calls Copy(false). (Inherited from SoNode.) |
![]() | Copy(Boolean) | Creates and returns an exact copy of the node. |
![]() | CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
![]() | CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
![]() | Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
![]() | Distribute | (Inherited from SoSeparator.) |
![]() | DoAction | (Inherited from SoSeparator.) |
![]() | EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
![]() | Equals | (Inherited from Object.) |
![]() | FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
![]() | FindChild | Finds index of given child within group. |
![]() | Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
![]() | GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
![]() | GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
![]() | GetBoundingBox | (Overrides SoSeparatorGetBoundingBox(SoGetBoundingBoxAction).) |
![]() | GetChild | Returns pointer the child node with the given index. |
![]() | GetEventIn | Returns a the eventIn with the given name. |
![]() | GetEventOut | Returns the eventOut with the given name. |
![]() | GetField | Returns a the field of this object whose name is fieldName. |
![]() | GetFieldName | Returns the name of the given field in the fieldName argument. |
![]() | GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
![]() | GetHandleTransparency | |
![]() | GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
![]() | GetMatrix | (Inherited from SoSeparator.) |
![]() | GetName | Returns the name of an instance. |
![]() | GetNumChildren | Returns number of children. |
![]() | GetNumRenderObjectNames | Returns number of names in the search list. |
![]() | GetNumRenderObjectTypes | Returns number of types in the search list. |
![]() | GetPrimitiveCount | (Overrides SoSeparatorGetPrimitiveCount(SoGetPrimitiveCountAction).) |
![]() | GetRenderObjectName | Returns the i th name of the search list. |
![]() | GetRenderObjectType | Returns the i th type of the search list. |
![]() | GetRenderUnitID | (Inherited from SoNode.) |
![]() | GetStringName | (Inherited from SoBase.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GLRender | (Inherited from SoSeparator.) |
![]() | GLRenderBelowPath | (Overrides SoSeparatorGLRenderBelowPath(SoGLRenderAction).) |
![]() | GLRenderInPath | (Inherited from SoSeparator.) |
![]() | GLRenderOffPath | (Inherited from SoSeparator.) |
![]() | GrabEventsCleanup | (Inherited from SoNode.) |
![]() | GrabEventsSetup | (Inherited from SoNode.) |
![]() | HandleEvent | (Inherited from SoSeparator.) |
![]() | HasDefaultValues | Returns true if all of the object's fields have their default values. |
![]() | InsertChild | Adds a child so that it becomes the one with the given index. |
![]() | IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. |
![]() | IsChainingOn | Returns true if the octree is chained with another culling node. |
![]() | IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
![]() | IsOctreeDrawing | Returns true if octree drawing is enabled. |
![]() | IsOverride | Returns the state of the override flag. |
![]() | IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
![]() | Pick | (Inherited from SoGroup.) |
![]() | RayPick | (Overrides SoSeparatorRayPick(SoRayPickAction).) |
![]() | RemoveAllChildren | Removes all children from group. |
![]() | RemoveAllRenderObjectNames | Clears all names from the search list. |
![]() | RemoveChild(Int32) | Removes child with given index from group. |
![]() | RemoveChild(SoNode) | Removes first instance of given child from group. |
![]() | RemoveRenderObjectName | Removes a name from the search list. |
![]() | RemoveRenderObjectType | Removes a type from the search list. |
![]() | ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. |
![]() | ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. |
![]() | Reset | Allows to rebuild the octree from scratch. |
![]() | Search | (Inherited from SoSeparator.) |
![]() | Set | 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. |
![]() | SetHandleTransparency | If handle transparency is turned on, the octree will handle transparency and render cache transparent objects. |
![]() | SetName | (Inherited from SoBase.) |
![]() | SetOctreeDrawing | Enables/disables octree drawing. |
![]() | SetOverride | Turns the override flag on or off. |
![]() | SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
![]() | SetToDefaults | Sets all fields in this object to their default values. |
![]() | ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
![]() | Touch | Marks an instance as modified, simulating a change to it. |
![]() | Write | (Inherited from SoGroup.) |
Name | Description | |
---|---|---|
![]() | adjustDecimation | If true, the octree will alter the decimation percentage for objects depending on how large they are in the view. |
![]() | boundingBoxCaching | Whether to cache during bounding box traversal. |
![]() | boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
![]() | boundingBoxSubstitutes | Enables use of bounding boxes for cells in the octree that contain shapes, but would appear on the screen smaller than the dropScreenArea threshold. |
![]() | directVizCaching | Whether to cache during OpenRTRT rendering traversal. |
![]() | dropCulling | Enables culling of shapes that are too small on the screen. |
![]() | dropScreenArea | Sets threshold in pixels for drop culling and bounding box substitutes. |
![]() | fastEditing | Specifies the fast edit mode of the separator node. |
![]() | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
![]() | isHead | Normally each culling node maintains its own render list. |
![]() | pickCulling | Whether to cull during picking traversal. |
![]() | renderCaching | Whether to cache during rendering traversal. |
![]() | renderCulling | Whether to cull during rendering traversal. |
![]() | renderUnitId | Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. |
![]() ![]() | ReportCallback | This callback can be used to get render statistics: the number of objects in the octree, and the number of objects actually rendered. |
![]() | useMovingQueue | Sets how this node should handle moving render objects. |
![]() | UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
This speeds view frustum culling in large scenes in which the viewer moves through the scene and much of the scene is not visible at any given time.
The SoOctreeOrdering node uses the functionality from SoRenderList to create a list of paths to the shapes beneath it. It then reorganizes the list of shapes into an octree division of space. During action traversal, it traverses the octree instead of the scene graph. This results in a front to back traversal that quickly skips sections of space that would be culled by the view frustum.
<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.
The OctreeOrdering node draws a bounding box to replace cells in the octree that contain shapes but that are too small, based on an approximate screen size. If a larger shape had already been rendered that passes through this cell, the cell will be culled instead of using the bounding box so that no rendered geometry will be covered by a bounding box. This behavior can be altered by the fields listed below.
To specify the maximum depth during octree ordering, use environment variable IV_OCTREE_MAX_DEPTH. The default is 8.
To request an outline of the octree quadrants be drawn as a debugging aid to allow you to see how your scene is distributed throughout the octree, set environment variable OIV_DRAW_OCTREE to 1 or use the method setOctreeDrawing.
Note: If an SoOcclusionCulling node is inserted below the SoOctreeOrdering node, the latter can pass its view-frustum-culled renderObject list to the occlusion node, which will perform an occlusion culling test to reduce even further the number of objects to render. See the isHead field of SoRenderList for additional info.
OctreeOrdering {
dropCulling | true |
dropScreenArea | 5 |
boundingBoxSubstitutes | true |
useMovingQueue | true |
adjustDecimation | true |
renderCaching | AUTO |
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
fastEditing | DISABLE |
isHead | true |
SoGLRenderAction, SoGetPrimitiveCountAction Uses octree spatial traversal, rendering front to back. All other actions use standard SoSeparator traversal. Sets: SoRenderObjectListElement