|
Open Inventor Release 2023.2.3
|
|
| |
|
Open Inventor Release 2023.2.3
|
|
|
| |
Searches for nodes in the scene graph step by step.
More...
#include <Inventor/actions/SoSearchStepAction.h>
Inheritance diagram for SoSearchStepAction:Public Types | |
| typedef SbBool | AddingPathCallback(SoFullPath *foundPath, void *userData, SoSearchStepAction *thisSSA) |
| SoSearchStepAction callback function prototype. | |
| Public Types inherited from SoSearchAction | |
| enum | LookFor { NODE = 0x01 , TYPE = 0x02 , NAME = 0x04 } |
| Enum that defines the search criterion. More... | |
| enum | Interest { FIRST , LAST , ALL } |
| Enum that defines which paths to return. More... | |
| 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... | |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| SoSearchStepAction () | |
| Constructor. | |
| virtual | ~SoSearchStepAction () |
| Destructor. | |
| void | setAddingPathCallBack (AddingPathCallback *ap_cb, void *u_data) |
| Add the user callback that the SearchAction must call while building the path list. | |
| Public Member Functions inherited from SoSearchAction | |
| SoSearchAction () | |
| Constructor. | |
| virtual void | reset () |
| Resets options back to default values; clears list of returned paths. | |
| virtual void | clearApplyResult () |
| When applied, an action may reference nodes or create objects (e.g. | |
| void | setFind (int what) |
| Sets what to look for; what is a bitmask of LookFor enum values. | |
| int | getFind () |
| Returns what to look for. | |
| SoNode * | getNode () const |
| Returns the node to search for. | |
| void | setNode (SoNode *n) |
| Sets the node to search for. | |
| SoType | getType (SbBool &derivedIsOk) const |
| Returns the node type to search for. | |
| void | setType (SoType t, SbBool derivedIsOk=TRUE) |
| Sets the node type to search for. | |
| const SbName & | getName () const |
| Returns the name of the node to search for. | |
| void | setName (const SbName &n) |
| Sets the name of the node to search for. | |
| Interest | getInterest () const |
| Returns which paths to return. | |
| void | setInterest (Interest i) |
| Sets which paths to return. | |
| SbBool | isSearchingAll () const |
| Returns FALSE if searching uses regular traversal, TRUE if it traverses every single node. | |
| void | setSearchingAll (SbBool flag) |
| Sets whether searching uses regular traversal or whether it traverses every single node. | |
| SoPath * | getPath () const |
| Returns resulting path, or NULL if no path was found. | |
| SoPathList & | getPaths () |
| Returns resulting path list. | |
| 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 | 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 SoSearchAction | |
| 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. | |
Searches for nodes in the scene graph step by step.
This class extends SoSearchAction. This class allows the user to add a callback to control which paths are added to the path list. This user callback is 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.
SoSearchAction, SoSearchPathAction
Definition at line 51 of file SoSearchStepAction.h.
| typedef SbBool SoSearchStepAction::AddingPathCallback(SoFullPath *foundPath, void *userData, SoSearchStepAction *thisSSA) |
SoSearchStepAction callback function prototype.
| foundPath | Corresponds to the current found path. |
| userData | Is the data passed by user. |
| thisSSA | Retrieves the inquiring SoSearchStepAction instance. |
Definition at line 73 of file SoSearchStepAction.h.
| SoSearchStepAction::SoSearchStepAction | ( | ) |
Constructor.
|
virtual |
Destructor.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoSearchAction.
| void SoSearchStepAction::setAddingPathCallBack | ( | AddingPathCallback * | ap_cb, |
| void * | u_data | ||
| ) |
Add the user callback that the SearchAction must call while building the path list.
1.9.8 