| SoOverlayGroup Class |
Group node dedicated to render multiple co-planar shapes.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoGroup
OIV.Inventor.NodesSoOverlayGroup
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoOverlayGroup type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoOverlayGroup | Creates an empty overlay group node. |
Methods| Name | Description | |
|---|---|---|
| AddChild | Adds a child as last one in group. |
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Overrides SoGroupCallback(SoCallbackAction).) |
| 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 SoNode.) |
| DoAction | (Overrides SoGroupDoAction(SoAction).) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (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 SoGroupGetBoundingBox(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. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Overrides SoGroupGetMatrix(SoGetMatrixAction).) |
| GetName | Returns the name of an instance. |
| GetNumChildren | Returns number of children. |
| GetPrimitiveCount | (Overrides SoGroupGetPrimitiveCount(SoGetPrimitiveCountAction).) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Overrides SoGroupGLRender(SoGLRenderAction).) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Overrides SoGroupHandleEvent(SoHandleEventAction).) |
| 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. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Overrides SoGroupPick(SoPickAction).) |
| RayPick | (Inherited from SoNode.) |
| RemoveAllChildren | Removes all children from group. |
| RemoveChild(Int32) | Removes child with given index from group. |
| RemoveChild(SoNode) | Removes first instance of given child from group. |
| ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. |
| ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. |
| Search | (Overrides SoGroupSearch(SoSearchAction).) |
| 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. |
| SetName | (Inherited from SoBase.) |
| 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 | (Overrides SoGroupWrite(SoWriteAction).) |
Properties| Name | Description | |
|---|---|---|
 | boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksDerived from the class OIV.Inventor.Nodes.SoGroup, the OIV.Inventor.Nodes.SoOverlayGroup node renders multiple co-planar shapes without any Z-fighting artifacts.
Overlapping co-planar shapes should be inserted as children of a OIV.Inventor.Nodes.SoOverlayGroup. The shapes are stacked for the rendering according to their places in the child list: the i th shape will be drawn above the i-1 th shape.
For instance, in the following picture the red square is the first shape child, and the green triangle is the second shape child of a OIV.Inventor.Nodes.SoOverlayGroup.
The OIV.Inventor.Nodes.SoOverlayGroup is only designed to correctly render planar shapes. Inserting in OIV.Inventor.Nodes.SoOverlayGroup spheres, cylinders, cubes or any shape whose vertices are not on a single euclidean plane may cause an unexpected rendering. However, this does not limit the OIV.Inventor.Nodes.SoOverlayGroup to 2D rendering. You can create several OIV.Inventor.Nodes.SoOverlayGroup instances, but all the shapes under an overlay group must be a planar shape and must be located on the same 3D plane. One different 3D plane per instance of OIV.Inventor.Nodes.SoOverlayGroup is possible as in the following picture from the example "Inventor\Features\OverlayPanels" in which each panel corresponds to one instance of an OIV.Inventor.Nodes.SoOverlayGroup.
The OIV.Inventor.Nodes.SoOverlayGroup is not designed to solve any Z-fighting artifact on 3D shapes. For instance, a correct rendering of meridian circles onto a sphere requires using either OIV.Inventor.Nodes.SoPolygonOffset or OIV.Inventor.Nodes.SoDepthOffset.
# Limitations of the overlay group:
Picking: All shapes contained in a OIV.Inventor.Nodes.SoOverlayGroup can be picked except the parts of a shape hidden by an overlapping shape.
Highlighting:
The OIV.Inventor.Actions.SoHaloHighlightRenderAction can be used to highlight any shape in a OIV.Inventor.Nodes.SoOverlayGroup, but the alwaysVisible option must be true. See OIV.Inventor.Actions.SoHaloHighlightRenderAction.SetHaloAlwaysVisible(System.Boolean).
Do not use the OIV.Inventor.Actions.SoColorHighlightRenderAction with a OIV.Inventor.Nodes.SoOverlayGroup.
Transparency: The OIV.Inventor.Nodes.SoOverlayGroup only supports the SORTED_PIXEL transparency modes correctly. The other modes may generate incorrect rendering such as transparent shapes hidden by opaque shapes.
FILE FORMAT/DEFAULT
OverlayGroup {
ACTION BEHAVIOR
Similar behavior as described in OIV.Inventor.Nodes.SoGroup.
 Note |
|---|
Node available since Open Inventor 2024.1 |
See Also