Searches for nodes in the scene graph step by step. More...
#include <Inventor/actions/SoSearchStepAction.h>
Public Types | |
typedef SbBool | AddingPathCallback (SoFullPath *foundPath, void *userData, SoSearchStepAction *thisSSA) |
Public Member Functions | |
virtual SoType | getTypeId () const |
SoSearchStepAction () | |
virtual | ~SoSearchStepAction () |
void | setAddingPathCallBack (AddingPathCallback *ap_cb, void *u_data) |
Static Public Member Functions | |
static SoType | getClassTypeId () |
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
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. |
SoSearchStepAction::SoSearchStepAction | ( | ) |
Constructor.
virtual SoSearchStepAction::~SoSearchStepAction | ( | ) | [virtual] |
Destructor.
static SoType SoSearchStepAction::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoSearchAction.
virtual SoType SoSearchStepAction::getTypeId | ( | ) | const [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.