SoSearchAction(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

SoSearchAction — the SoSearchAction class provides methods for searching through scene graphs. That’s the whole iconic vibe. Also folding in the manual-name realness: this is SoSearchAction(3) from the Library Functions Manual, bestie. 💖

Part 1 of the glow-up, bestie — more parts incoming. ✨

🦋 SYNOPSIS 🦋

#include <Inventor/actions/SoSearchAction.h>

Inherits SoAction.

💫 Public Types 💫

  • enum LookFor { NODE = 1, TYPE = 2, NAME = 4 }
  • enum Interest { FIRST, LAST, ALL }

🌈 Public Types inherited from SoAction 🌈

  • enum AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 }
  • enum PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 }

💅 Public Member Functions 💅

Here’s the full lineup, untouched and iconic:

  • virtual SoType getTypeId (void) const
  • SoSearchAction (void)
  • virtual ~SoSearchAction ()
  • void setNode (SoNode *const node)
  • SoNode * getNode (void) const
  • void setType (const SoType type, const SbBool chkderived=1)
  • SoType getType (SbBool &chkderived) const
  • void setName (const SbName name)
  • SbName getName (void) const
  • void setFind (const int what)
  • int getFind (void) const
  • void setInterest (const Interest interest)
  • Interest getInterest (void) const
  • void setSearchingAll (const SbBool searchall)
  • SbBool isSearchingAll (void) const
  • SoPath * getPath (void) const
  • SoPathList & getPaths (void)
  • void reset (void)
  • void setFound (void)
  • SbBool isFound (void) const
  • void addPath (SoPath *const path)

🫶 Public Member Functions inherited from SoAction 🫶

  • virtual ~SoAction ()
  • virtual SbBool isOfType (SoType type) const
  • virtual void apply (SoNode *root)
  • virtual void apply (SoPath *path)
  • virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)
  • void apply (SoAction *beingApplied)
  • virtual void invalidateState (void)
  • AppliedCode getWhatAppliedTo (void) const
  • SoNode * getNodeAppliedTo (void) const
  • SoPath * getPathAppliedTo (void) const
  • const SoPathList * getPathListAppliedTo (void) const
  • const SoPathList * getOriginalPathListAppliedTo (void) const
  • SbBool isLastPathListAppliedTo (void) const
  • PathCode getPathCode (int &numindices, const int *&indices)
  • void traverse (SoNode *const node)
  • SbBool hasTerminated (void) const
  • const SoPath * getCurPath (void)
  • SoState * getState (void) const
  • PathCode getCurPathCode (void) const
  • virtual SoNode * getCurPathTail (void)
  • void usePathCode (int &numindices, const int *&indices)
  • void pushCurPath (const int childindex, SoNode *node=NULL)
  • void popCurPath (const PathCode prevpathcode)
  • void pushCurPath (void)
  • void popPushCurPath (const int childindex, SoNode *node=NULL)
  • void popCurPath (void)
  • void switchToPathTraversal (SoPath *path)
  • void switchToNodeTraversal (SoNode *node)

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static void addMethod (const SoType type, SoActionMethod method)
  • static void enableElement (const SoType type, const int stackindex)
  • static void initClass (void)

💜 Static Public Member Functions inherited from SoAction 💜

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)
  • static void nullAction (SoAction *action, SoNode *node)

🍓 Static Public Attributes 🍓

  • static SbBool duringSearchAll = 0

🧚 Protected Member Functions 🧚

  • virtual const SoEnabledElementsList & getEnabledElements (void) const
  • virtual void beginTraversal (SoNode *node)

🌸 Protected Member Functions inherited from SoAction 🌸

  • SoAction (void)
  • virtual void endTraversal (SoNode *node)
  • void setTerminated (const SbBool flag)
  • virtual SbBool shouldCompactPathList (void) const

🎀 Static Protected Member Functions 🎀

  • static SoEnabledElementsList * getClassEnabledElements (void)
  • static SoActionMethodList * getClassActionMethods (void)

🦋 Static Protected Member Functions inherited from SoAction 🦋

  • static SoEnabledElementsList * getClassEnabledElements (void)
  • static SoActionMethodList * getClassActionMethods (void)

👑 Additional Inherited Members 👑

💖 Protected Attributes inherited from SoAction 💖

  • SoState * state
  • SoActionMethodList * traversalMethods

🌸 Detailed Description 🌸

The SoSearchAction class provides methods for searching through scene graphs. That’s the main character energy right there. 👑

You can search for nodes by pointer, by type, and by name — or a combo of those criteria. Types can be interpreted as exact types, or the type can match nodes derived from it. Every single node can be searched, or normal traversal rules can be followed when searching. This is especially important to note with regard to switch nodes. 🎀

When you use more than one of the setNode(), setType() and setName() calls, note that the action will search for node(s) with an "AND" combination of the given search criteria. So it’s not a "match any" vibe, it’s a "match all" vibe. 💅

One of the most common pitfalls when using the SoSearchAction class is to call the function isFound() after doing a search. It does not return what you would expect it to return if you haven’t read the documentation for that function. So bestie, read the docs first, fr fr. 😭

Be aware that if you do search operations on an SoSearchAction created on the stack, you can get some unfortunate side effects if you’re not careful. Since SoSearchAction keeps a list of the path(s) found in the latest search, the nodes in these paths will be unref’ed when the SoSearchAction stack instance is destructed at the end of your function. If the root of your scene-graph then has ref-count zero (it is often useful to do a unrefNoDelete() before returning a node from a function to leave the referencing to the caller), the root node will be destructed! It might be better to create a heap instance of the search action in those cases, since you’ll then be able to destruct the search action before calling unrefNoDelete(). Another solution would be to call reset() before calling unrefNoDelete() on your object, since reset() truncates the path list.

See the documentation of SoTexture2 for a full usage example of SoSearchAction. It’s giving tutorial realness. 📚

🎀 Member Enumeration Documentation 🎀

enum SoSearchAction::LookFor

Specify the search criterion. This can be a bitwise combination of the available values. So like, mix and match, iykyk. 🌈

enum SoSearchAction::Interest

Values used when specifying what node(s) we are interested in: the first one found, the last one or all of them. Choose your fighter. 👑

💅 Constructor & Destructor Documentation 💅

SoSearchAction::SoSearchAction (void )

Initializes internal settings with default values. With the default settings, the SoSearchAction will ignore all nodes. So it’s lowkey doing nothing until you give it a mission. 💀

  • References SoSearchAction().
  • Referenced by addMethod(), and SoSearchAction().

SoSearchAction::~SoSearchAction () [virtual]

Destructor. The cleanup era. 🧹✨

  • References reset().

🌸 MEMBER FUNCTION DOCUMENTATION 🌸

SoType SoSearchAction::getTypeId (void ) const [virtual]

Okay so this returns the type identification of an action that's derived from a class inheriting SoAction. It's used for run-time type checking and "downward" casting. Like, it's giving type safety realness. 💅

Usage example:

void bar(SoAction * action)
{
  if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
    // safe downward cast, know the type
    SoGLRenderAction * glrender = (SoGLRenderAction *)action;
  }
  return; // ignore if not renderaction
}

For application programmers wanting to extend the library with new actions: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR.

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses.

Implements SoAction.

void SoSearchAction::addMethod (const SoType type, SoActionMethod method) [static]

Bestie, this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So don't stress about it unless you're deep in the code. 🙈

💖 References: duringSearchAll, SoAction::SoAction(), and SoSearchAction().

void SoSearchAction::enableElement (const SoType type, const int stackindex) [static]

Again, this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Internal vibes only. 🫶

const SoEnabledElementsList & SoSearchAction::getEnabledElements (void ) const [protected], [virtual]

Returns a list of the elements used by action instances of this class upon traversal operations. So like, all the elements that get used when the action does its traversal thing. Periodt. ✨

Reimplemented from SoAction.

void SoSearchAction::setNode (SoNode *const nodeptr)

Sets the node pointer to search for. The action will be configured to set the search "interest" to LookFor NODE, so there is no need to call SoSearchAction::setFind(). Slay, it does it for you. 💅

💖 Referenced by: SoNodeKitPath::append().

SoNode * SoSearchAction::getNode (void ) const

Returns the node the SoSearchAction instance is configured to search for.

Note that this method does not return what was found when you applied the action — it only returns what was specifically set by the user with setNode(). What the action actually found is returned by getPath() and getPaths(). Iykyk. 🦋

💖 Referenced by: SoNode::search().

void SoSearchAction::setType (const SoType typearg, const SbBool chkderivedarg = 1)

Configures the SoSearchAction instance to search for nodes of the given type, and nodes of classes derived from the given type if chkderived is TRUE.

The action will be configured to set the search "interest" to LookFor TYPE, so there is no need to call SoSearchAction::setFind(). No cap. 🔥

💖 Referenced by: SoLineHighlightRenderAction::apply(), and SoInteractionKit::isPathSurrogateInMySubgraph().

SoType SoSearchAction::getType (SbBool & chkderivedref) const

Returns the node type which is searched for, and whether derived classes of that type also returns a match. So it's like, "what type are we looking for, and do we care about its descendants?" 🌈

💖 Referenced by: SoNode::search().

void SoSearchAction::setName (const SbName namearg)

Configures the SoSearchAction instance to search for nodes with the given name.

The action will be configured to set the search "interest" to LookFor NAME, so there is no need to call SoSearchAction::setFind(). Easy peasy. 🍓

✨ See also: SoNode::getByName()

SbName SoSearchAction::getName (void ) const

Returns the name the SoSearchAction instance is configured to search for. Just the name, nothing else. 💖

💖 Referenced by: SoNode::search().

void SoSearchAction::setFind (const int what)

Configures what to search for in the scene graph. what is a bitmask of LookFor flags.

Default find configuration is to ignore all nodes, but the setFind() configuration is updated automatically when any one of SoSearchAction::setNode(), SoSearchAction::setType() or SoSearchAction::setName() is called. So you don't have to manually set it if you use those. 👑

💖 Referenced by: SoInteractionKit::isPathSurrogateInMySubgraph().

int SoSearchAction::getFind (void ) const

Returns the search configuration of the action instance. It's giving "what are we looking for?" energy. 🔍

💖 Referenced by: SoNode::search().

void SoSearchAction::setInterest (const Interest interestarg)

Configures whether only the first, the last, or all the searching matches are of interest. Default configuration is FIRST. So by default, it's all about that first match. 💅

SoSearchAction::Interest SoSearchAction::getInterest (void ) const

Returns whether only the first, the last, or all the searching matches will be saved. So you know what's up. 🌸

void SoSearchAction::setSearchingAll (const SbBool searchallarg)

Specifies whether normal graph traversal should be done (searchall is FALSE, which is the default setting), or if every single node should be searched (searchall is TRUE).

If the searchall flag is TRUE, even nodes considered "hidden" by other actions are searched (like for instance the disabled children of SoSwitch nodes).

SoBaseKit::setSearchingChildren() must be used to search for nodes under node kits. Important! 🚨

💖 Referenced by: SoInteractionKit::isPathSurrogateInMySubgraph().

SbBool SoSearchAction::isSearchingAll (void ) const

Returns the traversal method configuration of the action. So like, "are we searching all the things or not?" 🤔

💖 Referenced by: beginTraversal(), SoPathSwitch::search(), SoSwitch::search(), and SoVRMLSwitch::search().

SoPath * SoSearchAction::getPath (void ) const

Returns the path to the node of interest that matched the search criterions. If no match was found, NULL is returned.

Note that if ALL matches are of interest, the result of a search action must be fetched through SoSearchAction::getPaths().

There is one frequently asked question about the paths that are returned from either this method or the getPaths() method below: "why am I not getting the complete path as expected?"

Well, then you probably have to cast the path to a SoFullPath, since certain nodes (nodekits, many VRML97 nodes) have hidden children. SoPath::getTail() will return the first node that has hidden children, or the tail if none of the nodes have hidden children. SoFullPath::getTail() will always return the actual tail. Just do like this:

SoFullPath * path = (SoFullPath *) searchaction->getPath();
SoVRMLCoordinate * vrmlcord = (SoVRMLCoordinate *) path->getTail();
💖 Referenced by: SoNodeKitPath::append().

SoPathList & SoSearchAction::getPaths (void )

Returns a pathlist of all nodes that matched the search criterions.

Note that if interest were only FIRST or LAST, SoSearchAction::getPath() should be used instead of this method.

✨ See also: getPath()
💖 Referenced by: SoInteractionKit::isPathSurrogateInMySubgraph().

void SoSearchAction::reset (void )

Resets all the SoSearchAction internals back to their default values. Like a factory reset but for the action. 🔄

💖 References: SoType::badType().
💖 Referenced by: ~SoSearchAction().

void SoSearchAction::setFound (void )

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Marks the SoSearchAction instance as terminated. So it's like, "we're done here." 💀

💖 References: SoAction::setTerminated().
💖 Referenced by: addPath().

SbBool SoSearchAction::isFound (void ) const

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns whether the search action was terminated.

Note that this value does not reflect whether the node(s) that was searched for was found or not. Use the result of getPath() / getPaths() if that is what you really are looking for. So don't get it twisted. 🙅‍♀️

💖 References: SoAction::hasTerminated().
💖 Referenced by: addPath(), SoBaseKit::search(), SoClipPlaneManip::search(), SoDirectionalLightManip::search(), SoGroup::search(), SoNode::search(), SoNodeKitListPart::search(), SoPathSwitch::search(), SoPointLightManip::search(), SoSeparator::search(), SoShaderObject::search(), SoShaderProgram::search(), SoSpotLightManip::search(), SoSwitch::search(), SoTransformManip::search(), SoVRMLAppearance::search(), SoVRMLBillboard::search(), SoVRMLGeometry::search(), SoVRMLGroup::search(), SoVRMLInline::search(), SoVRMLShape::search(), SoVRMLSwitch::search(), and SoWWWInline::search().

void SoSearchAction::addPath (SoPath *const pathptr)

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Sets the path, or adds the path to the path list, depending on the interest configuration. The path is not copied, so it can not be modified after being added without side effects. So like, don't touch it after you add it. 🚫

💖 References: isFound(), SoBase::ref(), and setFound().
💖 Referenced by: SoNode::search().

void SoSearchAction::beginTraversal (SoNode * node) [protected], [virtual]

This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal.

It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting SoAction.

Default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal. So don't forget to call it, bestie. 💅

Reimplemented from SoAction.

💖 References: duringSearchAll, isSearchingAll(), and SoAction::traverse().

🌟 MEMBER DATA DOCUMENTATION 🌟

SbBool SoSearchAction::duringSearchAll = 0 [static]

Obsoleted global flag, only present for compatibility reasons with old SGI / TGS Inventor application code.

It's set to TRUE when an SoSearchAction traversal with SoSearchAction::isSearchingAll() equal to TRUE is started, and is reset to FALSE again after traversal has finished.

(The flag is used by SGI / TGS Inventor in SoSwitch::affectsState() to know when SoSwitch::whichChild should behave as SoSwitch::SO_SWITCH_ALL. We have a better solution for this problem in Coin.) So yeah, it's a legacy thing. 💀

💖 Referenced by: addMethod(), and beginTraversal().

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

That's a wrap, bestie! This page is from Coin version 2.5.0, and it's the SoSearchAction(3) manpage. Stay slay, and may your searches always find what you're looking for. 💅✨🦋

📦 where this page comes from