| SoSearchStepAction Class |
Searches for nodes in the scene graph step by step.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.ActionsSoAction
OIV.Inventor.ActionsSoSearchAction
OIV.Inventor.ActionsSoSearchStepAction
Namespace: OIV.Inventor.Actions
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoSearchStepAction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoSearchStepAction | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AddPath | (Inherited from SoSearchAction.) |
| 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). (Inherited from SoAction.) |
| 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. |
 | EnableElement | |
| EnableElements | (Overrides SoSearchActionEnableElements.) |
| 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). |
| GetFind | Returns what to look for. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetInterest | Returns which paths to return. |
| GetName | Returns the name of the node to search for. |
| GetNode | Returns the node to search for. |
| GetNodeAppliedTo | Returns the node the action is being applied to. |
| GetOriginalPathListAppliedTo | Returns the original path list the action is being applied to. |
| GetPath | Returns resulting path, or NULL if no path was found. |
| 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. |
| GetPaths | Returns resulting path list. |
| 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.) |
| GetType(Boolean) | Returns the node type to search for. |
| 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. |
| IsFound | (Inherited from SoSearchAction.) |
| IsLastPathListAppliedTo | Returns true if the current list is the last one from the original. |
| IsSearchingAll | Returns false if searching uses regular traversal, true if it traverses every single node. |
| IsUsingAlternateRep | Returns true if current action is using alternate representations. |
| PostDelayedTraversal | Method called by SoMultiPassManager after delayed pass traversals. |
| PreDelayedTraversal | Method called by SoMultiPassManager before delayed pass traversals. |
| Reset | Resets options back to default values; clears list of returned paths. |
| ResetContinueActionInBranchFlag | This function resets the continue action flag. |
| SetFind | Sets what to look for; what is a bitmask of LookFor enum values. |
| SetFound | (Overrides SoSearchActionSetFound.) |
| SetInterest | Sets which paths to return. |
| SetName | Sets the name of the node to search for. |
| SetNode | Sets the node to search for. |
| 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 ). |
| SetSearchingAll | Sets whether searching uses regular traversal or whether it traverses every single node. |
| SetType(Type) | Calls SetType(t, true). (Inherited from SoSearchAction.) |
| SetType(Type, Boolean) | Sets the node type to search for. |
| 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. |
Properties| Name | Description | |
|---|---|---|
 | AddingPathCallBack |
Sets/gets the user callback that the search action must call while building
the path list.
|
RemarksThis class extends OIV.Inventor.Actions.SoSearchAction. This class allows the user to add a delegateto control which paths are added to the path list. This user delegateis called just before the found path would be added to the list. It determines whether or not the path will be added to the list. The use of this class is particularly interesting when the found paths are potentially numerous and the user wants to filter the returned path list to retrieve only some of them.
See Also