SoSelection(3)

๐Ÿ“ฆ
version 3.1.3 ยท 2 versions
, in fedora 43

okay bestie, welcome to the SoSelection(3) page from the Library Functions Manual โœจ get comfy, grab a strawberry ๐Ÿ“, because we're about to talk about the class that manages a list of selected nodes and she is literally the moment ๐Ÿ’…

๐Ÿ’– NAME ๐Ÿ’–

  • SoSelection โ€” the class that manages a list of selected nodes. that's the whole job. she does it flawlessly. periodt. ๐Ÿ‘‘

โœจ SYNOPSIS โœจ

here's how you invite her into your code, no cap:

#include <Inventor/nodes/SoSelection.h>
  • Inherits SoSeparator โ€” yes bestie, she's a separator at heart, she just has โœจopinionsโœจ about selection.
  • Inherited by SoExtSelection โ€” so SoExtSelection is her iconic little descendant ๐Ÿฆ‹.

๐ŸŽ€ Public Types ๐ŸŽ€

  • enum Policy { SINGLE, TOGGLE, SHIFT } โ€” the three selection moods she can be in. that's the whole roster, no more, no less ๐Ÿ’…

Public Types inherited from SoSeparator

  • enum CacheEnabled { OFF, ON, AUTO } โ€” the caching options she inherited from her parent.

Public Types inherited from SoNode

  • enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 } โ€” the full node-type roster, straight from SoNode, every single hex value intact ๐Ÿซถ

๐Ÿ’… Public Member Functions ๐Ÿ’…

  • virtual SoType getTypeId (void) const โ€” grab her type id, the classic flex.
  • SoSelection (void) โ€” default constructor, no children, fresh start ๐ŸŒธ
  • SoSelection (const int nChildren) โ€” constructor that takes nChildren, for when you already know how many kiddos you're adding.
  • void select (const SoPath *path) โ€” bestie, select the thing at path. ๐Ÿ’–
  • void select (SoNode *node) โ€” select the thing at node.
  • void deselect (const SoPath *path) โ€” unselect the thing at path.
  • void deselect (const int which) โ€” unselect by index, which.
  • void deselect (SoNode *node) โ€” unselect the thing at node.
  • void toggle (const SoPath *path) โ€” toggle the thing at path.
  • void toggle (SoNode *node) โ€” toggle the thing at node.
  • SbBool isSelected (const SoPath *path) const โ€” is the thing at path selected? yes or no, that's it.
  • SbBool isSelected (SoNode *node) const โ€” is the thing at node selected? yes or no.
  • void deselectAll (void) โ€” clear the whole list, everyone out. ๐Ÿ˜ญ
  • int getNumSelected (void) const โ€” how many things are selected rn.
  • const SoPathList * getList (void) const โ€” hand over the list.
  • SoPath * getPath (const int index) const โ€” grab the path at index.
  • SoPath * operator[] (const int i) const โ€” the cute bracket accessor, index i, same energy.
  • void addSelectionCallback (SoSelectionPathCB *f, void *userData=NULL) โ€” add a selection callback f, with optional userData.
  • void removeSelectionCallback (SoSelectionPathCB *f, void *userData=NULL) โ€” remove that selection callback.
  • void addDeselectionCallback (SoSelectionPathCB *f, void *userData=NULL) โ€” add a deselection callback f, with optional userData.
  • void removeDeselectionCallback (SoSelectionPathCB *f, void *userData=NULL) โ€” remove that deselection callback.
  • void addStartCallback (SoSelectionClassCB *f, void *userData=NULL) โ€” add a start callback f, with optional userData.
  • void removeStartCallback (SoSelectionClassCB *f, void *userData=NULL) โ€” remove that start callback.
  • void addFinishCallback (SoSelectionClassCB *f, void *userData=NULL) โ€” add a finish callback f, with optional userData.
  • void removeFinishCallback (SoSelectionClassCB *f, void *userData=NULL) โ€” remove that finish callback.
  • void setPickFilterCallback (SoSelectionPickCB *f, void *userData=NULL, const SbBool callOnlyIfSelectable=TRUE) โ€” set the pick filter callback f, with userData, and callOnlyIfSelectable defaults to TRUE.
  • void setPickMatching (const SbBool pickMatching) โ€” set the pick matching flag pickMatching.
  • SbBool isPickMatching (void) const โ€” is pick matching on?
  • SbBool getPickMatching (void) const โ€” get the pick matching value.
  • void addChangeCallback (SoSelectionClassCB *f, void *userData=NULL) โ€” add a change callback f, with optional userData.
  • void removeChangeCallback (SoSelectionClassCB *f, void *userData=NULL) โ€” remove that change callback.

๐Ÿซถ Public Member Functions inherited from SoSeparator ๐Ÿซถ

  • SoSeparator (void)
  • SoSeparator (const int nchildren)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void notify (SoNotList *nl)
  • virtual SbBool affectsState (void) const

๐ŸŒˆ Public Member Functions inherited from SoGroup ๐ŸŒˆ

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void addChild (SoNode *node)
  • virtual void insertChild (SoNode *child, int newchildindex)
  • virtual SoNode * getChild (int index) const
  • virtual int findChild (const SoNode *node) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int childindex)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int index, SoNode *newchild)
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
  • virtual void pick (SoPickAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual SoChildList * getChildren (void) const

๐Ÿฆ‹ Public Member Functions inherited from SoNode ๐Ÿฆ‹

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const

๐Ÿ’œ Public Member Functions inherited from SoFieldContainer ๐Ÿ’œ

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

๐ŸŽ€ Public Member Functions inherited from SoBase ๐ŸŽ€

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

โญ Static Public Member Functions โญ

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoSeparator

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void setNumRenderCaches (const int howmany)
  • static int getNumRenderCaches (void)

Static Public Member Functions inherited from SoGroup

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
  • static void initClasses (void)
  • static uint32_t getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

Static Public Member Functions inherited from SoBase

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

๐ŸŒธ Public Attributes ๐ŸŒธ

  • SoSFEnum policy โ€” the policy field, right there for you to set. ๐Ÿ’…

Public Attributes inherited from SoSeparator

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

๐Ÿงš Protected Member Functions ๐Ÿงš

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoSelection ()
  • void invokeSelectionPolicy (SoPath *path, SbBool shiftDown)
  • void performSingleSelection (SoPath *path)
  • void performToggleSelection (SoPath *path)
  • SoPath * copyFromThis (const SoPath *path) const
  • void addPath (SoPath *path)
  • void removePath (const int which)
  • int findPath (const SoPath *path) const
  • virtual void handleEvent (SoHandleEventAction *action)

Protected Member Functions inherited from SoSeparator

  • virtual ~SoSeparator ()
  • virtual SbBool cullTest (SoState *state)
  • virtual SbBool cullTest (SoGLRenderAction *action, int &cullresults)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

Protected Member Functions inherited from SoGroup

  • virtual ~SoGroup ()
  • virtual SbBool readChildren (SoInput *in)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

and that's the whole class skeleton, bestie โ€” every single member, inherited or otherwise, accounted for ๐Ÿ’– more of this page is coming, so don't go anywhere ๐Ÿ‘€

๐Ÿ›ก๏ธ Protected Member Functions inherited from SoBase

bestie these are the behind-the-scenes ones your subclass can poke at ๐Ÿ’…

  • SoBase(void) โ€” the plain constructor.
  • virtual ~SoBase() โ€” virtual destructor, she cleans up.
  • virtual void destroy(void) โ€” destroys the thing.
  • SbBool hasMultipleWriteRefs(void) const โ€” does it have multiple write refs? returns an SbBool.
  • SbBool writeHeader(SoOutput *out, SbBool isgroup, SbBool isengine) const โ€” writes the header out.
  • void writeFooter(SoOutput *out) const โ€” writes the footer out.
  • virtual const char * getFileFormatName(void) const โ€” hands you the file format name as a const char *.

โœจ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr(void) โ€” grabs the pointer to the field data.

โœจ Static Protected Member Functions inherited from SoSeparator

  • static const SoFieldData ** getFieldDataPtr(void)

โœจ Static Protected Member Functions inherited from SoGroup

  • static const SoFieldData ** getFieldDataPtr(void)

โœจ Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr(void)
  • static void setNextActionMethodIndex(int index)
  • static int getNextActionMethodIndex(void)
  • static void incNextActionMethodIndex(void)
  • static void setCompatibilityTypes(const SoType &nodetype, const uint32_t bitmask)

โœจ Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter(void)
  • static void staticDataLock(void)
  • static void staticDataUnlock(void)

๐Ÿ” Protected Attributes

the vibes you can literally touch from inside ๐Ÿ’–

  • SoPathList selectionList โ€” the actual list of selected paths.
  • SoCallbackList * selCBList โ€” the select callback list.
  • SoCallbackList * deselCBList โ€” the deselect callback list.
  • SoCallbackList * startCBList โ€” the start callback list.
  • SoCallbackList * finishCBList โ€” the finish callback list.
  • SoSelectionPickCB * pickCBFunc โ€” the pick callback function pointer.
  • void * pickCBData โ€” user data handed to that pick callback.
  • SbBool callPickCBOnlyIfSelectable โ€” only call the pick callback if the thing is selectable.
  • SoCallbackList * changeCBList โ€” the change callback list.
  • SoPath * mouseDownPickPath โ€” the pick path from mouse down.
  • SbBool pickMatching โ€” whether picking is matching.

๐Ÿ” Protected Attributes inherited from SoGroup

  • SoChildList * children

๐Ÿ” Protected Attributes inherited from SoNode

  • uint32_t uniqueId

๐Ÿ” Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

๐ŸŽ Additional Inherited Members

๐ŸŽ€ Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

๐ŸŽ€ Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

๐Ÿ“– Detailed Description

okay so, the SoSelection class manages a list of selected nodes. periodt. ๐Ÿ‘‘

Drop an SoSelection node into your scene graph and boom โ€” you've enabled your user to "pick" with the left mouse button to select/deselect objects sitting below that SoSelection node. iconic behaviour honestly.

If you want actual visual feedback for your user about what's selected, using an SoBoxHighlightRenderAction or an SoLineHighlightRenderAction to render scenegraphs that contain SoSelection nodes is the convenient way to do it. ๐ŸŽ€

โš ๏ธ Beware bestie: there's one common faulty assumption people make about this node โ€” that the scene will automatically re-render whenever the user picks objects. It does NOT. The application programmer must schedule a redraw themselves. The straightforward way to do this is to SoNode::touch() the SoSelection node inside the selection / deselection callback. no cap.

A "skeleton" for basic use of SoSelection nodes is given below, so you can copy-paste your way to greatness:

extern SoSeparator * make_scenegraph( void );
static SoSelection * selection = NULL;

// Callback function triggered for selection / deselection.
void made_selection( void * userdata, SoPath * path )
{
  (void)fprintf( stdout, "%sselected %s\n",
                 userdata == (void *)1L ? "" : "de",
                 path->getTail()->getTypeId().getName().getString() );

  selection->touch(); // to redraw
}

// *************************************************************************

// Print a quick instructions notice on stdout.
void show_instructions( void )
{
  (void)fprintf( stdout, "\nThis example program demonstrates the use of the SoSelection node type.\n" );
  (void)fprintf( stdout, "\nQuick instructions:\n\n" );
  (void)fprintf( stdout, "  * pick with left mouse button\n" );
  (void)fprintf( stdout, "  * hold SHIFT to select multiple objects\n" );
  (void)fprintf( stdout, "  * hit ESC to toggle back and forth to view mode\n" );
  (void)fprintf( stdout, "\n" );
}

// *************************************************************************

int main( int argc, char ** argv )
{
  QWidget * window = SoQt::init( argv[0] );
  show_instructions();

  selection = new SoSelection;
  selection->policy = SoSelection::SHIFT;
  selection->ref();

  selection->addChild( make_scenegraph() );
  selection->addSelectionCallback( made_selection, (void *)1L );
  selection->addDeselectionCallback( made_selection, (void *)0L );

  SoQtExaminerViewer * examinerviewer = new SoQtExaminerViewer( window );
  examinerviewer->setSceneGraph( selection );
  examinerviewer->setGLRenderAction( new SoBoxHighlightRenderAction );
  examinerviewer->setViewing( FALSE );
  examinerviewer->show();

  SoQt::show( window );
  SoQt::mainLoop();

  delete examinerviewer;
  selection->unref();

  return 0;
}

Now, important tea โ˜•: this node is not initialized in SoDB::init(), because it's part of the interaction kit "add-on". So before using this node, you should call SoInteraction::init(). BUT โ€” if you're using one of the standard GUI-toolkits (SoXt / SoQt / SoWin), then SoInteraction::init() gets called for you from the So[Xt|Qt|Win]init() method and you literally don't have to worry about it. slay. ๐Ÿ’…

Now about running multiple SoSelection nodes at the same time in the same scene graph: it's possible, bestie, but it is not straightforward. The standard viewers from SoQt, SoWin, et al, will only snoop on one SoSelection node (that's part of the legacy API from SGI's InventorXt), so selection changes on the others won't trigger redraws. Translation: you don't necessarily see what's happening. You'll have to hook things up manually and trigger the redraws yourself. ๐Ÿ˜ญ

Also be aware that when you've got multiple SoSelection nodes active in the scene graph at the same time, the SoHandleEventAction traversals that you intend for selection-change on one SoSelection node will also affect all the other SoSelection nodes in the scene โ€” usually deselecting everything below them, since you'll be clicking outside the selectable objects. So you'll also have to manually override that behaviour if you want selection change on one SoSelection node to not mess with the others. ๐Ÿซถ


FILE FORMAT/DEFAULTS:

Selection {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    policy SHIFT
}

๐Ÿ”ฎ Member Enumeration Documentation

enum SoSelection::Policy

Enum for different pick policies. it's giving options, bestie ๐ŸŒˆ

Enumerator

  • SINGLE โ€” Only one object can be selected at any time. When the user picks a new object, the previous selection will be unselected. If the user picks on nothing, the current selection will be unselected.
๐Ÿซง Note that if a new selection matches one already present in the selection list, neither a deselect nor a select notification callback will be made about that selection path. so don't go waiting for a callback that isn't coming ๐Ÿ’€
  • TOGGLE โ€” Picking an object toggles its selection state.
  • SHIFT โ€” Same as SINGLE, but when shift key is pressed the selection policy will be changed to TOGGLE.

๐Ÿ› ๏ธ Constructor & Destructor Documentation

SoSelection::SoSelection(void)

Default constructor. the standard entrance โœจ

SoSelection::SoSelection(const int nChildren)

Constructor.

The argument should be the approximate number of children which is expected to be inserted below this node. The number need not be exact, as it is only used as a hint for better memory resource allocation. it's just a lil heads-up for the allocator, not a contract ๐ŸŽ€

SoSelection::~SoSelection() [protected], [virtual]

Destructor. she's leaving the group chat ๐Ÿ’œ

โœจ Member Function Documentation โœจ

okay bestie, buckle up because this is the big one โ€” all the member functions, no skips, no cuts ๐Ÿ’…

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

okay so this one hands you the type ID for any object that descends from a class inheriting SoBase. It's literally for run-time type checking and "downward" casting, iykyk ๐Ÿ˜Œ

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: 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 for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoSeparator.

Reimplemented in SoExtSelection.

const SoFieldData * SoSelection::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. no cap ๐Ÿ“ฆ

Reimplemented from SoSeparator.

Reimplemented in SoExtSelection.

void SoSelection::select (const SoPath * path)

Adds path to the list of selected objects. slay โœจ

void SoSelection::select (SoNode * node)

Adds node to the list of selected objects. The scene graph below the Selection node will be searched, and the path to node will be added if found. ๐Ÿ” the way it searchesโ€ฆ

void SoSelection::deselect (const SoPath * path)

Remove path from the list of selected objects. bye bye ๐Ÿ‘‹

void SoSelection::deselect (const int which)

Remove objects which from the list of selected objects. (yes, that's literally what it says ๐Ÿ’€)

void SoSelection::deselect (SoNode * node)

Remove node from the list of selected objects. The scene graph below the Selection node will be searched, and the path to node will be removed if found.

void SoSelection::toggle (const SoPath * path)

If path is not already selected, add path to the list of selected objects. Otherwise remove path from the list of selected objects. ๐Ÿ” toggle toggle

void SoSelection::toggle (SoNode * node)

If node is not already selected, add path to the list of selected objects. Otherwise remove node from the list of selected objects.

SbBool SoSelection::isSelected (const SoPath * path) const

Return TRUE if path is in the list of selected objects. โœ…

SbBool SoSelection::isSelected (SoNode * node) const

Return TRUE if the path to node is in the list of selected objects.

void SoSelection::deselectAll (void )

Clears the selection list. ๐Ÿงน clean slate

int SoSelection::getNumSelected (void ) const

Returns the number of selected objects. count 'em ๐Ÿ”ข

const SoPathList * SoSelection::getList (void ) const

Returns the list of selected objects. ๐Ÿ“‹

SoPath * SoSelection::getPath (const int index) const

Returns the index'th selected objects. the chosen one โœจ

SoPath * SoSelection::operator[] (const int i) const

Operator for accessing selected objects. fancy bracket energy ๐Ÿ’…

void SoSelection::addSelectionCallback (SoSelectionPathCB * f, void * userData = NULL)

Adds a callback which will be called every time an object is selected. call me maybe ๐Ÿ“ž

  • See also: removeSelectionCallback()

void SoSelection::removeSelectionCallback (SoSelectionPathCB * f, void * userData = NULL)

Removes one of the selection callbacks. unsubscribe ๐Ÿ˜ญ

  • See also: addSelectionCallback()

void SoSelection::addDeselectionCallback (SoSelectionPathCB * f, void * userData = NULL)

Adds a callback which will be called every time an object is deselected. deselect tea โ˜•๏ธ

  • See also: removeDeselectionCallback()

void SoSelection::removeDeselectionCallback (SoSelectionPathCB * f, void * userData = NULL)

Removes one of the deselection callbacks. no more ๐Ÿšซ

  • See also: addDeselctionCallback()

void SoSelection::addStartCallback (SoSelectionClassCB * f, void * userData = NULL)

Adds a callback which will be invoked when the user start an interactive change to the list of selected objects. started ๐Ÿ

This callback is useful for storing the old selection list for undo/redo functionality. undo/redo queen ๐Ÿ‘‘

  • See also: addFinishCallback()

void SoSelection::removeStartCallback (SoSelectionClassCB * f, void * userData = NULL)

Removes f from the list of start callbacks. removed ๐Ÿ—‘๏ธ

  • See also: addStartCallback()

void SoSelection::addFinishCallback (SoSelectionClassCB * f, void * userData = NULL)

Adds a callback which will be invoked when the user has finished an interactive change to the list of selected objects. finished ๐Ÿ

  • See also: addStartCallback()

void SoSelection::removeFinishCallback (SoSelectionClassCB * f, void * userData = NULL)

Removes f from the list og finish callbacks. (og? yes, og. we don't fix typos here ๐Ÿ’…)

  • See also: addFinishCallback()

void SoSelection::setPickFilterCallback (SoSelectionPickCB * f, void * userData = NULL, const SbBool callOnlyIfSelectable = TRUE)

Sets the pick filter callback. This callback will be called when a path is about to be added to or removed from the list of selected objects. The callback function should return a replacement path that should be used instead of the picked path. The returned path will be ref'ed, copied, and then unref'ed again by the SoSelection node. ref, copy, unref โ€” the whole cycle ๐Ÿ”„

If no callback is set (the default), the picked path will be used for selecting/deselecting.

Possible return values from the callback:

  • NULL: simulate that nothing was picked. This will clear the selection for the SINGLE policy. The handle event action will be halted.
  • A path: the path will be selected/deselected. The handle event action will be halted.
  • A path containing only the Selection node: as NULL, but action will not be halted.
  • An empty path or a path not containing the Selection node: the pick will be ignored.

if callOnlyIfSelectable is TRUE, the callback will only be called if the Selection node is in the picked path.

void SoSelection::setPickMatching (const SbBool pickmatchflag)

When pickmatchflag is TRUE (the default), the mouse button release pick must match the mouse button press pick before object is selected/deselected. matchy matchy ๐Ÿ–ฑ๏ธ

This flag should normally not be of interest to application programmers. not your business, bestie ๐Ÿ™ˆ

SbBool SoSelection::isPickMatching (void ) const

Returns TRUE if pick matching is enabled. โœ…

  • See also: setPickMatching()

SbBool SoSelection::getPickMatching (void ) const

Returns TRUE if pick matching is enabled. โœ…

  • See also: setPickMatching()

void SoSelection::addChangeCallback (SoSelectionClassCB * f, void * userData = NULL)

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

. Used by render area to receive notification when the selection list changes.

void SoSelection::removeChangeCallback (SoSelectionClassCB * f, void * userData = NULL)

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

Used by render area to receive notification when the selection list changes.

void SoSelection::invokeSelectionPolicy (SoPath * path, SbBool shiftdown) [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

void SoSelection::performSingleSelection (SoPath * path) [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

void SoSelection::performToggleSelection (SoPath * path) [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

SoPath * SoSelection::copyFromThis (const SoPath * path) const [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

void SoSelection::addPath (SoPath * path) [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

void SoSelection::removePath (const int which) [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

int SoSelection::findPath (const SoPath * path) const [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. internal tea โ˜•๏ธ

void SoSelection::handleEvent (SoHandleEventAction * action) [protected], [virtual]

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to. main character energy ๐ŸŽฌ

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoSeparator.

Reimplemented in SoExtSelection.

โœจ MEMBER DATA DOCUMENTATION โœจ

ok so these are the data members, bestie โ€” the actual fields living inside the class. Some of them are public-ish fields you'd actually set, and a whole lil pile of them are marked [protected] which means the library keeps them for itself. ๐Ÿ’…


๐ŸŒธ Public-ish Fields (the ones that are yours)

  • SoSFEnum SoSelection::policy โ€” this is the field for selection policy, like, THE field you set when you want to tell your selection node how to behave. Default value is SHIFT. ๐ŸŽ€ That's it, that's the one you'll actually touch. Slay.

๐Ÿ”’ Protected Members (internal, not for you)

ok so heads up, bestie: every single one of these is tagged [protected] and the docs say the exact same thing about all of them โ€” this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So likeโ€ฆ they're living in the source, they're doing their job, but they're not your business. Do not build on them, fr fr. ๐Ÿ™ˆ

  • SoPathList SoSelection::selectionList [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoCallbackList* SoSelection::selCBList [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoCallbackList* SoSelection::deselCBList [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoCallbackList* SoSelection::startCBList [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoCallbackList* SoSelection::finishCBList [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoSelectionPickCB* SoSelection::pickCBFunc [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • void* SoSelection::pickCBData [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SbBool SoSelection::callPickCBOnlyIfSelectable [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoCallbackList* SoSelection::changeCBList [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SoPath* SoSelection::mouseDownPickPath [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
  • SbBool SoSelection::pickMatching [protected] โ€” internal to the library, not likely to be of interest to the application programmer.
bestie pls note: [protected] is not a vibe check you get to argue with. These are internal. If you're poking at them directly, you're in the source code, not the API. ๐Ÿ˜ญ

๐Ÿ’œ AUTHOR ๐Ÿ’œ

Generated automatically by Doxygen for Coin from the source code.


and that's the whole page, babes!! ๐Ÿซถ you read all of it, every last member, which is genuinely iconic of you. this was Coin, Version 3.1.3, served up as the SoSelection(3) page โ€” Doxygen did the generating, Coin did the vibing, and you did the reading. go forth and select things. ๐Ÿ‘‘โœจ

๐Ÿ“ฆ where this page comes from