|
Open Inventor Release 2025.2.0
|
|
| |
|
Open Inventor Release 2025.2.0
|
|
|
| |
Abstract base class for picking objects in a scene. More...
#include <Inventor/actions/SoPickAction.h>
Inheritance diagram for SoPickAction:Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| void | setViewportRegion (const SbViewportRegion &newRegion) |
| Sets current viewport region to use for action. | |
| const SbViewportRegion & | getViewportRegion () const |
| Returns current viewport region to use for action. | |
| void | enableCulling (SbBool flag) |
| SbBool | isCullingEnabled () const |
| Public Member Functions inherited from SoAction | |
| virtual | ~SoAction () |
| Destructor. | |
| virtual void | apply (SoNode *node) |
| Initiates an action on the graph defined by a node. | |
| virtual void | apply (SoPath *path) |
| Initiates an action on the graph defined by a path. | |
| virtual void | apply (const SoPathList &pathList, SbBool obeysRules=FALSE) |
| Initiates an action on the graph defined by a list of paths. | |
| virtual void | clearApplyResult () |
| When applied, an action may reference nodes or create objects (e.g. | |
| virtual void | invalidateState () |
| Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. | |
| void | stopActionInBranch () |
| This function stops the action in the current Scene Graph branch. | |
| SbBool | getContinueActionInBranchFlag () const |
| This function indicates if the action must stop in the current branch. | |
| void | resetContinueActionInBranchFlag () |
| This function resets the continue action flag. | |
| void | useAlternateRep (const SbBool enable) |
| Tell the action to use alternate representations during traversal when available. | |
| SbBool | isUsingAlternateRep () const |
| Returns TRUE if current action is using alternate representations. | |
| void | setSceneManager (SoSceneManager *mgr) |
| Set the scene manager associated with this action (if any ). | |
| SoSceneManager * | getSceneManager () const |
| Return the SoSceneManager associated with this action. | |
| virtual void | forwardTraversal (SoNode *node) |
| Traverse a node that is not part of the current scenegraph. | |
| virtual void | forwardTraversal (SoPath *path) |
| Traverse a path that is not part of the current scenegraph. | |
| DistribMode | getDistribMode () const |
| Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only). | |
| AppliedCode | getWhatAppliedTo () const |
| Returns code indicating what action is being applied to. | |
| SoNode * | getNodeAppliedTo () const |
| Returns the node the action is being applied to. | |
| SoPath * | getPathAppliedTo () const |
| Returns the path the action is being applied to. | |
| const SoPathList * | getPathListAppliedTo () const |
| Returns the path list the action is being applied to. | |
| const SoPathList * | getOriginalPathListAppliedTo () const |
| Returns the original path list the action is being applied to. | |
| SbBool | isLastPathListAppliedTo () const |
| Returns TRUE if the current list is the last one from the original. | |
| PathCode | getPathCode (int &numIndices, const int *&indices) |
| 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. | |
| PathCode | getPathCodeMI (int &numIndices, const int *&indices, const int *&instanceIndices) |
| Extender API: available to programmers who wish to extend the toolkit | |
| void | traverse (SoNode *node) |
| Does traversal of a graph rooted by a node. | |
| SbBool | hasTerminated () const |
| Returns TRUE if the traversal has reached a termination condition. | |
| const SoPath * | 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. | |
| SoState * | getState () const |
| Gets the state from the action. | |
| virtual void | setUpState () |
| Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created. | |
| void | setPipeId (int id) |
| Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. | |
| int | getPipeId () const |
| Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. | |
| bool | isBeingApplied () |
| Returns TRUE if this action is currently being applied. | |
| virtual bool | preDelayedTraversal () |
| Method called by SoMultiPassManager before delayed pass traversals. | |
| virtual void | postDelayedTraversal () |
| Method called by SoMultiPassManager after delayed pass traversals. | |
| Public Member Functions inherited from SoTypedObject | |
| SbBool | isOfType (const SoType &type) const |
| Returns TRUE if this object is of the type specified in type or is derived from that type. | |
| template<typename TypedObjectClass> | |
| SbBool | isOfType () const |
| Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| Static Public Member Functions inherited from SoAction | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static void | nullAction (SoAction *, SoNode *) |
| Null action method that can be stored in lookup table when desired. | |
| Static Public Member Functions inherited from SoTypedObject | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
Additional Inherited Members | |
| Public Types inherited from SoAction | |
| enum | DistribMode { LOCAL_ONLY , CLUSTER_ONLY , ALL } |
| This is used to define the way an action is distributed across a cluster. More... | |
| enum | AppliedCode { NODE , PATH , PATH_LIST } |
| This enum is used to determine what the action is being applied to. More... | |
| enum | PathCode { NO_PATH , IN_PATH , BELOW_PATH , OFF_PATH } |
| This enum may be used during traversal of nodes to indicate where the node is with respect to the path being traversed. More... | |
Abstract base class for picking objects in a scene.
This is an abstract base class for all picking actions. Currently, the only supported subclass is the SoRayPickAction.
Definition at line 79 of file SoPickAction.h.
|
inline |
Definition at line 104 of file SoPickAction.h.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Implements SoTypedObject.
Reimplemented in SoRayPickAction.
|
inline |
Returns current viewport region to use for action.
Definition at line 94 of file SoPickAction.h.
|
inline |
Definition at line 105 of file SoPickAction.h.
| void SoPickAction::setViewportRegion | ( | const SbViewportRegion & | newRegion | ) |
Sets current viewport region to use for action.
Even though the picking operation may not involve a window per se, some nodes need this information to determine their size and placement.
1.13.2 