Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoSelection Class Reference

The SoSelection class manages a list of selected nodes. More...

#include <Inventor/nodes/SoSelection.h>

Inheritance diagram for SoSelection:
SoSeparator SoGroup SoNode SoFieldContainer SoBase SoExtSelection

Public Types

enum  Policy { SINGLE, TOGGLE, SHIFT, DISABLE }
 
- Public Types inherited from SoSeparator
enum  CacheEnabled { OFF, ON, AUTO }
 
- 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, COIN_4_0 = 0x20000
}
 

Public Member Functions

virtual SoType getTypeId (void) const
 Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. More...
 
 SoSelection (void)
 
 SoSelection (const int nChildren)
 
void select (const SoPath *path)
 
void select (SoNode *node)
 
void deselect (const SoPath *path)
 
void deselect (const int which)
 
void deselect (SoNode *node)
 
void toggle (const SoPath *path)
 
void toggle (SoNode *node)
 
SbBool isSelected (const SoPath *path) const
 
SbBool isSelected (SoNode *node) const
 
void deselectAll (void)
 
int getNumSelected (void) const
 
const SoPathListgetList (void) const
 
SoPathgetPath (const int index) const
 
SoPathoperator[] (const int i) const
 
void addSelectionCallback (SoSelectionPathCB *f, void *userData=NULL)
 
void removeSelectionCallback (SoSelectionPathCB *f, void *userData=NULL)
 
void addDeselectionCallback (SoSelectionPathCB *f, void *userData=NULL)
 
void removeDeselectionCallback (SoSelectionPathCB *f, void *userData=NULL)
 
void addStartCallback (SoSelectionClassCB *f, void *userData=NULL)
 
void removeStartCallback (SoSelectionClassCB *f, void *userData=NULL)
 
void addFinishCallback (SoSelectionClassCB *f, void *userData=NULL)
 
void removeFinishCallback (SoSelectionClassCB *f, void *userData=NULL)
 
void setPickFilterCallback (SoSelectionPickCB *f, void *userData=NULL, const SbBool callOnlyIfSelectable=TRUE)
 
void setPickMatching (const SbBool pickMatching)
 
SbBool isPickMatching (void) const
 
SbBool getPickMatching (void) const
 
void addChangeCallback (SoSelectionClassCB *f, void *userData=NULL)
 
void removeChangeCallback (SoSelectionClassCB *f, void *userData=NULL)
 
- 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 SoNodegetChild (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 SoChildListgetChildren (void) const
 
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
- 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 SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual void grabEventsSetup (void)
 
virtual void grabEventsCleanup (void)
 
virtual void startNotify (void)
 
SbUniqueId getNodeId (void) const
 
virtual void writeInstance (SoOutput *out)
 
virtual SoNodeaddToCopyDict (void) const
 
virtual SoFieldContainercopyThroughConnection (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 SoFieldgetField (const SbName &name) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (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)
 
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
 Returns TRUE if the type of this object is either of the same type or inherited from type. More...
 
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 SoAuditorListgetAuditors (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 SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static void initClass (void)
 
static void initClasses (void)
 
static SbUniqueId 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 SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static void copyDone (void)
 
- Static Public Member Functions inherited from SoBase
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
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 SoBasegetNamedBase (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
 
- Public Attributes inherited from SoSeparator
SoSFEnum renderCaching
 
SoSFEnum boundingBoxCaching
 
SoSFEnum renderCulling
 
SoSFEnum pickCulling
 

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 
virtual ~SoSelection ()
 
void invokeSelectionPolicy (SoPath *path, SbBool shiftDown)
 
void performSingleSelection (SoPath *path)
 
void performToggleSelection (SoPath *path)
 
SoPathcopyFromThis (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)
 
virtual SoNotRec createNotRec (void)
 
void setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode *cc=NULL, const SoNode *pc=NULL, const int ci=-1)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual void destroy (void)
 
SbBool hasMultipleWriteRefs (void) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName (void) const
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
- 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

SoPathList selectionList
 
SoCallbackListselCBList
 
SoCallbackListdeselCBList
 
SoCallbackListstartCBList
 
SoCallbackListfinishCBList
 
SoSelectionPickCBpickCBFunc
 
void * pickCBData
 
SbBool callPickCBOnlyIfSelectable
 
SoCallbackListchangeCBList
 
SoPathmouseDownPickPath
 
SbBool pickMatching
 
- Protected Attributes inherited from SoGroup
SoChildListchildren
 
- Protected Attributes inherited from SoNode
SbUniqueId 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 SbUniqueId nextUniqueId = 1
 
static int nextActionMethodIndex = 0
 

Detailed Description

The SoSelection class manages a list of selected nodes.

Inserting an SoSelection node in your scene graph enables you to let the user "pick" with the left mouse button to select/deselect objects below the SoSelection node.

Using an SoBoxHighlightRenderAction or an SoLineHighlightRenderAction to render scene graphs containing SoSelection nodes provides a convenient way of providing visual feedback about the selections to the application user.

Beware that one common faulty assumption which is made about the node is that the scene will automatically be re-rendered whenever the user is picking objects. This is not the case, the application programmer must himself schedule a redraw. A straightforward way to accomplish this is to SoNode::touch() the SoSelection node in the selection / deselection callback.

A "skeleton" for basic use of SoSelection nodes is given below:

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;
}

This node is not initialized in SoDB::init(), since it is part of the interaction kit "add-on". Before using this node, you should therefore call SoInteraction::init(). If you're using one of the standard GUI-toolkits (SoXt / SoQt / SoWin) SoInteraction::init() will be called for you from the So[Xt|Qt|Win]::init() method and you don't have to worry about it.

With regard to using multiple SoSelection nodes at the same time in the same scene graph: this is possible, but it is not straightforward. The standard viewers provided by SoQt, SoWin, et al., will only snoop on one SoSelection node (part of the legacy API from SGI's InventorXt), so selection changes on the others don't trigger redraws. You don't necessarily see what's happening in other words. You'll have to hook up manually and trigger redraws yourself.

Also be aware that when having multiple SoSelection nodes in the scene graph active 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 will be clicking outside the selectable objects. You'll therefore also have to manually override that behaviour, if you want selection change on one SoSelection node to not affect the others.

FILE FORMAT/DEFAULTS:

Member Enumeration Documentation

◆ Policy

Enum for different pick policies.

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.

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.

DISABLE 

Disables selection handling.

Constructor & Destructor Documentation

◆ SoSelection() [1/2]

SoSelection::SoSelection ( void  )

Default constructor.

◆ SoSelection() [2/2]

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.

◆ ~SoSelection()

SoSelection::~SoSelection ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ getTypeId()

SoType SoSelection::getTypeId ( void  ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

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 predefined 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 top level superclasses for the various class groups.

Reimplemented from SoSeparator.

Reimplemented in SoExtSelection.

◆ getFieldData()

const SoFieldData * SoSelection::getFieldData ( void  ) const
protectedvirtual

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

Reimplemented from SoSeparator.

Reimplemented in SoExtSelection.

◆ select() [1/2]

void SoSelection::select ( const SoPath path)

Adds path to the list of selected objects.

◆ select() [2/2]

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.

◆ deselect() [1/3]

void SoSelection::deselect ( const SoPath path)

Remove path from the list of selected objects.

◆ deselect() [2/3]

void SoSelection::deselect ( const int  which)

Remove objects which from the list of selected objects.

◆ deselect() [3/3]

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.

◆ toggle() [1/2]

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() [2/2]

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.

◆ isSelected() [1/2]

SbBool SoSelection::isSelected ( const SoPath path) const

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

◆ isSelected() [2/2]

SbBool SoSelection::isSelected ( SoNode node) const

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

◆ deselectAll()

void SoSelection::deselectAll ( void  )

Clears the selection list.

◆ getNumSelected()

int SoSelection::getNumSelected ( void  ) const

Returns the number of selected objects.

◆ getList()

const SoPathList * SoSelection::getList ( void  ) const

Returns the list of selected objects.

◆ getPath()

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

Returns the index'th selected objects.

◆ operator[]()

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

Operator for accessing selected objects.

◆ addSelectionCallback()

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

Adds a callback which will be called every time an object is selected.

See also
removeSelectionCallback()

◆ removeSelectionCallback()

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

Removes one of the selection callbacks.

See also
addSelectionCallback()

◆ addDeselectionCallback()

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

Adds a callback which will be called every time an object is deselected.

See also
removeDeselectionCallback()

◆ removeDeselectionCallback()

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

Removes one of the deselection callbacks.

See also
addDeselctionCallback()

◆ addStartCallback()

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

Adds a callback which will be invoked when the user starts an interactive change to the list of selected objects.

This callback is useful for storing the old selection list for undo/redo functionality.

See also
addFinishCallback()

◆ removeStartCallback()

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

Removes f from the list of start callbacks.

See also
addStartCallback()

◆ addFinishCallback()

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.

See also
addStartCallback()

◆ removeFinishCallback()

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

Removes f from the list of finish callbacks.

See also
addFinishCallback()

◆ setPickFilterCallback()

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.

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.

◆ setPickMatching()

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.

This flag should normally not be of interest to application programmers.

◆ isPickMatching()

SbBool SoSelection::isPickMatching ( void  ) const

Returns TRUE if pick matching is enabled.

See also
setPickMatching()

◆ getPickMatching()

SbBool SoSelection::getPickMatching ( void  ) const

Returns TRUE if pick matching is enabled.

See also
setPickMatching()

◆ addChangeCallback()

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.

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

◆ removeChangeCallback()

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.

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

◆ invokeSelectionPolicy()

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.

◆ performSingleSelection()

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.

◆ performToggleSelection()

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.

◆ copyFromThis()

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.

◆ addPath()

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.

◆ removePath()

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.

◆ findPath()

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.

◆ handleEvent()

void SoSelection::handleEvent ( SoHandleEventAction action)
protectedvirtual

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

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

Reimplemented from SoSeparator.

Reimplemented in SoExtSelection.

Member Data Documentation

◆ policy

SoSFEnum SoSelection::policy

Field for selection policy. Default value is SHIFT.

◆ selectionList

SoPathList SoSelection::selectionList
protected

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

◆ selCBList

SoCallbackList * SoSelection::selCBList
protected

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

◆ deselCBList

SoCallbackList * SoSelection::deselCBList
protected

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

◆ startCBList

SoCallbackList * SoSelection::startCBList
protected

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

◆ finishCBList

SoCallbackList * SoSelection::finishCBList
protected

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

◆ pickCBFunc

SoSelectionPickCB * SoSelection::pickCBFunc
protected

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

◆ pickCBData

void * SoSelection::pickCBData
protected

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

◆ callPickCBOnlyIfSelectable

SbBool SoSelection::callPickCBOnlyIfSelectable
protected

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

◆ changeCBList

SoCallbackList * SoSelection::changeCBList
protected

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

◆ mouseDownPickPath

SoPath * SoSelection::mouseDownPickPath
protected

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

◆ pickMatching

SbBool SoSelection::pickMatching
protected

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


The documentation for this class was generated from the following files: