SoAction

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.actions.SoAction

Direct Known Subclasses:

SoBevelAction, SoCallbackAction, SoCSGAction, SoDistributeAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoGetPrimitiveCountAction, SoGLRenderAction, SoHandleEventAction, SoIntersectionDetectionAction, SoNurbsBREPAction, SoPickAction, SoSearchAction, SoSimplifyAction, SoSplitGeometryAction, SoToHTMLAction, SoToVRMLAction, SoVectorizeAction, SoWriteAction
```
public abstract class SoAction
extends Inventor
```
Abstract base class for all actions. SoAction is the base class for all actions. Classes derived from 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 (SoNode), a path (SoPath) or a list of paths (SoPathList).
Hidden references:
Some actions, e.g. SoSearchAction and SoRayPickAction, create one or more SoPath objects when they are applied to the scene graph. The 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 SoPath object exists. These SoPath objects are stored internally in the action and exist until the action object itself is reclaimed or reset. See also:
SoNode, SoPath, SoPathList, SoCallbackAction, SoGLRenderAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction, SoPickAction, SoRayPickAction, SoSearchAction, SoWriteAction

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SoAction.AppliedCodes`
`static class`	`SoAction.DistribModes` This is used to define the way an action is distributed across a cluster.
`static class`	`SoAction.PathCodes`
`static class`	`SoAction.PathIndices`

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL` Deprecated. Use `SoAction.DistribModes.ALL` instead.
`static int`	`BELOW_PATH` Deprecated. Use `SoAction.PathCodes.BELOW_PATH` instead.
`static int`	`CLUSTER_ONLY` Deprecated. Use `SoAction.DistribModes.CLUSTER_ONLY` instead.
`static int`	`IN_PATH` Deprecated. Use `SoAction.PathCodes.IN_PATH` instead.
`static int`	`LOCAL_ONLY` Deprecated. Use `SoAction.DistribModes.LOCAL_ONLY` instead.
`static int`	`NO_PATH` Deprecated. Use `SoAction.PathCodes.NO_PATH` instead.
`static int`	`NODE` Deprecated. Use `SoAction.AppliedCodes.NODE` instead.
`static int`	`OFF_PATH` Deprecated. Use `SoAction.PathCodes.OFF_PATH` instead.
`static int`	`PATH` Deprecated. Use `SoAction.AppliedCodes.PATH` instead.
`static int`	`PATH_LIST` Deprecated. Use `SoAction.AppliedCodes.PATH_LIST` instead.

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(SoNode node)` Initiates an action on the graph defined by a node.
`void`	`apply(SoPath path)` Initiates an action on the graph defined by a path.
`void`	`clearApplyResult()` When applied, an action may reference nodes or create objects (e.g.
`void`	`forwardTraversal(SoNode node)` Traverse a node that is not part of the current scenegraph.
`boolean`	`getContinueActionInBranchFlag()` This function indicates if the action must stop in the current branch.
`SoPath`	`getCurPath()`
`SoNode`	`getNodeAppliedTo()`
`java.util.Vector<SoPath>`	`getOriginalPathListAppliedTo()`
`SoPath`	`getPathAppliedTo()`
`SoAction.PathIndices`	`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.
`java.util.Vector<SoPath>`	`getPathListAppliedTo()`
`int`	`getPipeId()` Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.
`SoSceneManager`	`getSceneManager()` Return the `SoSceneManager` associated with this action.
`SoState`	`getState()`
`SoAction.AppliedCodes`	`getWhatAppliedTo()`
`boolean`	`hasTerminated()`
`void`	`invalidateState()` Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.
`boolean`	`isBeingApplied()` Returns true if this action is currently being applied.
`boolean`	`isLastPathListAppliedTo()`
`boolean`	`isUsingAlternateRep()` Returns true if current action is using alternate representations.
`static void`	`nullAction(SoAction name_8676, SoNode name_8677)`
`void`	`postDelayedTraversal()` Method called by SoMultiPassManager after delayed pass traversals.
`boolean`	`preDelayedTraversal()` Method called by SoMultiPassManager before delayed pass traversals.
`void`	`resetContinueActionInBranchFlag()` This function resets the continue action flag.
`void`	`setPipeId(int id)` Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.
`void`	`setSceneManager(SoSceneManager mgr)` Set the scene manager associated with this action (if any ).
`void`	`setUpState()`
`void`	`stopActionInBranch()` This function stops the action in the current Scene Graph branch.
`void`	`traverse(SoNode node)`
`void`	`useAlternateRep(boolean enable)` Tell the action to use alternate representations during traversal when available.

Methods inherited from class com.openinventor.inventor.Inventor
dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCAL_ONLY
```
@Deprecated
public static final int LOCAL_ONLY
```
    Deprecated. Use SoAction.DistribModes.LOCAL_ONLY instead.
  - CLUSTER_ONLY
```
@Deprecated
public static final int CLUSTER_ONLY
```
    Deprecated. Use SoAction.DistribModes.CLUSTER_ONLY instead.
  - ALL
```
@Deprecated
public static final int ALL
```
    Deprecated. Use SoAction.DistribModes.ALL instead.
  - NODE
```
@Deprecated
public static final int NODE
```
    Deprecated. Use SoAction.AppliedCodes.NODE instead.
  - PATH
```
@Deprecated
public static final int PATH
```
    Deprecated. Use SoAction.AppliedCodes.PATH instead.
  - PATH_LIST
```
@Deprecated
public static final int PATH_LIST
```
    Deprecated. Use SoAction.AppliedCodes.PATH_LIST instead.
  - NO_PATH
```
@Deprecated
public static final int NO_PATH
```
    Deprecated. Use SoAction.PathCodes.NO_PATH instead.
  - IN_PATH
```
@Deprecated
public static final int IN_PATH
```
    Deprecated. Use SoAction.PathCodes.IN_PATH instead.
  - BELOW_PATH
```
@Deprecated
public static final int BELOW_PATH
```
    Deprecated. Use SoAction.PathCodes.BELOW_PATH instead.
  - OFF_PATH
```
@Deprecated
public static final int OFF_PATH
```
    Deprecated. Use SoAction.PathCodes.OFF_PATH instead.
- Method Detail
  - resetContinueActionInBranchFlag
```
public void resetContinueActionInBranchFlag()
```
    This function resets the continue action flag.
  - getContinueActionInBranchFlag
```
public boolean getContinueActionInBranchFlag()
```
    This function indicates if the action must stop in the current branch.
    
    Returns:
    
    true if the action must continue for this branch.
  - traverse
```
public void traverse(SoNode node)
```
  - getPathListAppliedTo
```
public java.util.Vector<SoPath> getPathListAppliedTo()
```
  - getOriginalPathListAppliedTo
```
public java.util.Vector<SoPath> getOriginalPathListAppliedTo()
```
  - hasTerminated
```
public boolean hasTerminated()
```
  - apply
```
public void apply(SoNode node)
```
    Initiates an action on the graph defined by a node.
  - isLastPathListAppliedTo
```
public boolean isLastPathListAppliedTo()
```
  - getPathCode
```
public SoAction.PathIndices 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. If this returns IN_PATH, indices is set to point to an array of indices corresponding to the children that must be traversed for a correct traversal of all the paths to which the action is being applied. numIndices is set to the number of such children.
  - apply
```
public void apply(SoPath path)
```
    Initiates an action on the graph defined by a path.
  - stopActionInBranch
```
public void stopActionInBranch()
```
    This function stops the action in the current Scene Graph branch. Note: It doesn't mean we kill the action!
    It is mainly used to stop the GetBoundingBox action in the SoBBox node.
  - invalidateState
```
public void invalidateState()
```
    Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. This is typically unnecessary in most applications.
  - clearApplyResult
```
public void clearApplyResult()
```
    When applied, an action may reference nodes or create objects (e.g. SoPath) that reference nodes. This is especially true for SoSearchAction and SoRayPickAction. These references will prevent the nodes from being destroyed and so may appear to be a "memory leak".
    All references are cleared when the action is destroyed or re-applied. However it may be useful to clear them explicitly to remove references to nodes.
  - getPathAppliedTo
```
public SoPath getPathAppliedTo()
```
  - isBeingApplied
```
public boolean isBeingApplied()
```
    Returns true if this action is currently being applied.
  - setSceneManager
```
public void setSceneManager(SoSceneManager mgr)
```
    Set the scene manager associated with this action (if any ). When appropriate, this allows the action to query information like the OpenGL rendering context. The SoSCeneManager class calls this method automatically for the actions that it creates (SoHandleEventAction, SoRayPickAction, etc).
  - getPipeId
```
public int getPipeId()
```
    Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.
  - getSceneManager
```
public SoSceneManager getSceneManager()
```
    Return the SoSceneManager associated with this action.
  - postDelayedTraversal
```
public void postDelayedTraversal()
```
    Method called by SoMultiPassManager after delayed pass traversals. Overriding this method can be useful for actions that want to apply some post processing after all delayed pass traversals.
    
    Since:
    
    Open Inventor 9.1
  - useAlternateRep
```
public void useAlternateRep(boolean enable)
```
    Tell the action to use alternate representations during traversal when available.
    See SoNode.getAternateRep(). Default is false. When true, it is the responsibility of each SoNode derived object to choose to provide or not an alternate representation for a given action.
  - preDelayedTraversal
```
public boolean preDelayedTraversal()
```
    Method called by SoMultiPassManager before delayed pass traversals. Overriding this method can be useful for actions that want to skip the traversal of all delayed passes. Returning false skips the delayed pass traversals.
    
    Since:
    
    Open Inventor 9.1
  - isUsingAlternateRep
```
public boolean isUsingAlternateRep()
```
    Returns true if current action is using alternate representations. Default is false.
  - getState
```
public SoState getState()
```
  - getWhatAppliedTo
```
public SoAction.AppliedCodes getWhatAppliedTo()
```
  - getCurPath
```
public SoPath getCurPath()
```
  - getNodeAppliedTo
```
public SoNode getNodeAppliedTo()
```
  - setPipeId
```
public void setPipeId(int id)
```
    Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.
  - forwardTraversal
```
public void forwardTraversal(SoNode node)
```
    Traverse a node that is not part of the current scenegraph. Like an SoNodeKit, the contents of the specified sub-scenegraph won't be visible as an SoPath. Casting the path to a SoFullPath allows access to the whole path.
    This method can be used to delegate an action to an internal/private scene graph. So a node can have an internal scene graph without actually being a "group" node. This is a convenient way to implement "composite" nodes that create their behavior using other Open Inventor nodes.
    The node parameter can be of any type. Sensors may still be attached directly to nodes and fields in the internal scene graph.
    This method must not be called from a node derived from SoGroup or SoBaseKit. This method should not be called on nodes that are part of the public/visible scene graph.
  - setUpState
```
public void setUpState()
```
  - nullAction
```
public static void nullAction(SoAction name_8676,
                              SoNode name_8677)
```

Class SoAction

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

Method Summary

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

LOCAL_ONLY

CLUSTER_ONLY

ALL

NODE

PATH

PATH_LIST

NO_PATH

IN_PATH

BELOW_PATH

OFF_PATH

Method Detail

resetContinueActionInBranchFlag

getContinueActionInBranchFlag

traverse

getPathListAppliedTo

getOriginalPathListAppliedTo

hasTerminated

apply

isLastPathListAppliedTo

getPathCode

apply

stopActionInBranch

invalidateState

clearApplyResult

getPathAppliedTo

isBeingApplied

setSceneManager

getPipeId

getSceneManager

postDelayedTraversal

useAlternateRep

preDelayedTraversal

isUsingAlternateRep

getState

getWhatAppliedTo

getCurPath

getNodeAppliedTo

setPipeId

forwardTraversal

setUpState

nullAction