| SoAction Class |
Baseclass for all actions.
Inheritance HierarchyNamespace: OIV.Inventor.Actions
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoAction type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Apply(SoNode) | Initiates an action on the graph defined by a node. |
| Apply(SoPath) | Initiates an action on the graph defined by a path. |
| Apply(SoPathList) | Calls Apply(pathList, false). |
| Apply(SoPathList, Boolean) | Initiates an action on the graph defined by a list of paths. |
| ClearApplyResult | When applied, an action may reference nodes or create objects (e.g. |
| EnableElements | Obsolete.
Returns the list of enabled elements for a given action subclass.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| ForwardTraversal(SoNode) | Traverse a node that is not part of the current scenegraph. |
| ForwardTraversal(SoPath) | Traverse a path that is not part of the current scenegraph. |
| GetContinueActionInBranchFlag | This function indicates if the action must stop in the current branch. |
| GetCurPath | Returns the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed. |
| GetDistribMode | Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only). |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
 | GetInstanceManagedType |
Gets a managed action for the given native action handle.
|
| GetNodeAppliedTo | Returns the node the action is being applied to. |
| GetOriginalPathListAppliedTo | Returns the original path list the action is being applied to. |
| GetPathAppliedTo | Returns the path the action is being applied to. |
| GetPathCode | Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to. |
| GetPathListAppliedTo | Returns the path list the action is being applied to. |
| GetPipeId | Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| GetSceneManager | Return the OIV.Inventor.SoSceneManager associated with this action. |
| GetState | Gets the state from the action. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWhatAppliedTo | Returns code indicating what action is being applied to. |
| HasTerminated | Returns true if the traversal has reached a termination condition. |
| InvalidateState | Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. |
| IsBeingApplied | Returns true if this action is currently being applied. |
| IsLastPathListAppliedTo | Returns true if the current list is the last one from the original. |
| IsUsingAlternateRep | Returns true if current action is using alternate representations. |
| NullAction | Null action method that can be stored in lookup table when desired. |
| PostDelayedTraversal | Method called by SoMultiPassManager after delayed pass traversals. |
| PreDelayedTraversal | Method called by SoMultiPassManager before delayed pass traversals. |
| ResetContinueActionInBranchFlag | This function resets the continue action flag. |
| SetPipeId | Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| SetSceneManager | Set the scene manager associated with this action (if any ). |
| SetUpState | Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created. |
| StopActionInBranch | This function stops the action in the current Scene Graph branch. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Traverse | Does traversal of a graph rooted by a node. |
| UseAlternateRep | Tell the action to use alternate representations during traversal when available. |
RemarksOIV.Inventor.Actions.SoAction is the base class for all actions. Classes derived from OIV.Inventor.Actions.SoAction define operations to be applied at each node encountered during traversal of a scene graph. The function that gets called to implement the action for a particular node type is determined by a lookup table in the global database.
An action may be applied to a node (OIV.Inventor.Nodes.SoNode), a path (OIV.Inventor.SoPath) or a list of paths (OIV.Inventor.SoPathList).
Hidden references:
Some actions, e.g. OIV.Inventor.Actions.SoSearchAction and OIV.Inventor.Actions.SoRayPickAction, create one or more OIV.Inventor.SoPath objects when they are applied to the scene graph. The OIV.Inventor.SoPath object references each node in the path. This reference will prevent the node and its associated memory from being reclaimed for as long as the OIV.Inventor.SoPath object exists. These OIV.Inventor.SoPath objects are stored internally in the action and exist until the action object itself is reclaimed or reset.
See AlsoReference
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.ActionsSoAction
OIV.HardCopySoVectorizeAction
OIV.Inventor.ActionsSoBevelAction
OIV.Inventor.ActionsSoCallbackAction
OIV.Inventor.ActionsSoDistributeAction
OIV.Inventor.ActionsSoGetBoundingBoxAction
OIV.Inventor.ActionsSoGetMatrixAction
OIV.Inventor.ActionsSoGetPrimitiveCountAction
OIV.Inventor.ActionsSoGLRenderAction
OIV.Inventor.ActionsSoHandleEventAction
OIV.Inventor.ActionsSoNurbsBREPAction
OIV.Inventor.ActionsSoPickAction
OIV.Inventor.ActionsSoSearchAction
OIV.Inventor.ActionsSoSimplifyAction
OIV.Inventor.ActionsSoSplitGeometryAction
OIV.Inventor.ActionsSoToHTMLAction
OIV.Inventor.ActionsSoWriteAction
OIV.Inventor.CollisionSoIntersectionDetectionAction