| SoVolumeMaskGroup Class |
Volume mask group.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoGroup
OIV.VolumeViz.NodesSoVolumeMaskGroup
Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoVolumeMaskGroup type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVolumeMaskGroup | Constructor. |
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 | (Inherited from SoGroup.) |
| 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 | (Inherited from SoGroup.) |
| 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 | (Inherited from SoGroup.) |
| GetName | Returns the name of an instance. |
| GetNumChildren | Returns number of children. |
| GetPrimitiveCount | (Inherited from SoGroup.) |
| 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 | (Inherited from SoGroup.) |
| 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 | (Inherited from SoGroup.) |
| 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 | (Inherited from SoGroup.) |
Properties| Name | Description | |
|---|---|---|
 | boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
 | TRANSFERFUNCTION_INTERSECTION_ID | Intersections between masks will be rendered with the transfer function with id = TRANSFERFUNCTION_INTERSECTION_ID. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node is used to define a collection of one or more volume masks. See OIV.VolumeViz.Nodes.SoVolumeMask for details about using volume masks. Every volume mask node in the scene graph must have an OIV.VolumeViz.Nodes.SoVolumeMaskGroup as its parent node. The OIV.VolumeViz.Nodes.SoVolumeMaskGroup node, as well as the OIV.VolumeViz.Nodes.SoVolumeData node, must be the child of an OIV.LDM.Nodes.SoMultiDataSeparator node because the masks are effectively multiple data volumes.
This class also defines the constant TRANSFERFUNCTION_INTERSECTION_ID. If a transfer function (OIV.LDM.Nodes.SoTransferFunction) with this id exists in the traversal state, that transfer function will be used to color voxels which belong to more than one mask. See OIV.VolumeViz.Nodes.SoVolumeMask for details about the regions defined by volume masks.
Note that when not using volume masks, the traversal order of transfer functions is important, because each VolumeViz rendering node uses the current (last traversed) transfer function independent of the transfer function ids. However if an OIV.VolumeViz.Nodes.SoVolumeMaskGroup node is traversed before the rendering node (regardless of whether there are any OIV.VolumeViz.Nodes.SoVolumeMask nodes in the group), the volume will only be rendered using the transfer function (if any) with the same id value as the volume data node.
FILE FORMAT/DEFAULT
VolumeMaskGroup {
See Also