Click or drag to resize
SoAction Class

Baseclass for all actions.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.ActionsSoAction
      More...

Namespace: OIV.Inventor.Actions
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.12.0 (9.9.12.0)
Syntax
public class SoAction : SoNetBase

The SoAction type exposes the following members.

Methods
  NameDescription
Public methodApply(SoNode)

Initiates an action on the graph defined by a node.

Public methodApply(SoPath)

Initiates an action on the graph defined by a path.

Public methodApply(SoPathList)
Calls Apply(pathList, false).
Public methodApply(SoPathList, Boolean)

Initiates an action on the graph defined by a list of paths.

Public methodClearApplyResult

When applied, an action may reference nodes or create objects (e.g.

Public methodEnableElements

Returns the list of enabled elements for a given action subclass .

Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodForwardTraversal

Traverse a node that is not part of the current scenegraph.

Public methodGetContinueActionInBranchFlag

This function indicates if the action must stop in the current branch.

Public methodGetCurPath
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodStatic memberGetInstanceManagedType
Gets a managed action for the given native action handle.
Public methodGetNodeAppliedTo
Public methodGetOriginalPathListAppliedTo
Public methodGetPathAppliedTo
Public methodGetPathCode(SbNativeArrayInt32)

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.

Public methodGetPathCode(SbNativeInt32Array) Obsolete.

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.

Public methodGetPathListAppliedTo
Public methodGetPipeId

Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

Public methodGetSceneManager

Return the SoSceneManager associated with this action.

Public methodGetState
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWhatAppliedTo
Public methodHasTerminated
Public methodInvalidateState

Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.

Public methodIsBeingApplied

Returns true if this action is currently being applied.

Public methodIsLastPathListAppliedTo
Public methodIsUsingAlternateRep

Returns true if current action is using alternate representations.

Public methodStatic memberNullAction
Public methodPostDelayedTraversal

Method called by SoMultiPassManager after delayed pass traversals.

Public methodPreDelayedTraversal

Method called by SoMultiPassManager before delayed pass traversals.

Public methodResetContinueActionInBranchFlag

This function resets the continue action flag.

Public methodSetPipeId

Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

Public methodSetSceneManager

Set the scene manager associated with this action (if any ).

Public methodSetUpState
Public methodStopActionInBranch

This function stops the action in the current Scene Graph branch.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraverse
Public methodUseAlternateRep

Tell the action to use alternate representations during traversal when available.

Top
Remarks

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
Inheritance Hierarchy
SystemObject
  OIV.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.ActionsSoToVRMLAction
      OIV.Inventor.ActionsSoWriteAction
      OIV.Inventor.CollisionSoIntersectionDetectionAction
      OIV.SolidViz.ActionsSoCSGAction