.TH "SoExtSelection" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoExtSelection \- The \fBSoExtSelection\fP class can be used for extended selection functionality\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/nodes/SoExtSelection\&.h>\fP
.PP
Inherits \fBSoSelection\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBLassoType\fP { \fBNOLASSO\fP, \fBLASSO\fP, \fBRECTANGLE\fP }"
.br
.ti -1c
.RI "enum \fBLassoPolicy\fP { \fBFULL_BBOX\fP, \fBPART_BBOX\fP, \fBFULL\fP, \fBPART\fP }"
.br
.ti -1c
.RI "enum \fBLassoMode\fP { \fBALL_SHAPES\fP, \fBVISIBLE_SHAPES\fP }"
.br
.in -1c

Public Types inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "enum \fBPolicy\fP { \fBSINGLE\fP, \fBTOGGLE\fP, \fBSHIFT\fP, \fBDISABLE\fP }"
.br
.in -1c

Public Types inherited from \fBSoSeparator\fP
.in +1c
.ti -1c
.RI "enum \fBCacheEnabled\fP { \fBOFF\fP, \fBON\fP, \fBAUTO\fP }"
.br
.in -1c

Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "\fBSoExtSelection\fP (void)"
.br
.ti -1c
.RI "void \fBuseOverlay\fP (SbBool overlay=TRUE)"
.br
.ti -1c
.RI "SbBool \fBisUsingOverlay\fP (void)"
.br
.ti -1c
.RI "\fBSoSeparator\fP * \fBgetOverlaySceneGraph\fP (void)"
.br
.ti -1c
.RI "void \fBsetOverlayLassoColorIndex\fP (const int index)"
.br
.ti -1c
.RI "int \fBgetOverlayLassoColorIndex\fP (void)"
.br
.ti -1c
.RI "void \fBsetLassoColor\fP (const \fBSbColor\fP &color)"
.br
.ti -1c
.RI "const \fBSbColor\fP & \fBgetLassoColor\fP (void)"
.br
.ti -1c
.RI "void \fBsetLassoWidth\fP (const float width)"
.br
.ti -1c
.RI "float \fBgetLassoWidth\fP (void)"
.br
.ti -1c
.RI "void \fBsetOverlayLassoPattern\fP (const unsigned short pattern)"
.br
.ti -1c
.RI "unsigned short \fBgetOverlayLassoPattern\fP (void)"
.br
.ti -1c
.RI "void \fBanimateOverlayLasso\fP (const SbBool animate=TRUE)"
.br
.ti -1c
.RI "SbBool \fBisOverlayLassoAnimated\fP (void)"
.br
.ti -1c
.RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "void \fBselect\fP (\fBSoNode\fP *root, int numcoords, \fBSbVec2f\fP *lasso, const \fBSbViewportRegion\fP &vp, SbBool shiftpolicy)"
.br
.ti -1c
.RI "void \fBselect\fP (\fBSoNode\fP *root, int numcoords, \fBSbVec3f\fP *lasso, const \fBSbViewportRegion\fP &vp, SbBool shiftkeypolicy)"
.br
.ti -1c
.RI "const \fBSbVec2s\fP * \fBgetLassoCoordsDC\fP (int &numCoords)"
.br
.ti -1c
.RI "const \fBSbVec3f\fP * \fBgetLassoCoordsWC\fP (int &numCoords)"
.br
.ti -1c
.RI "const \fBSoPathList\fP & \fBgetSelectionPathList\fP () const"
.br
.ti -1c
.RI "void \fBsetLassoFilterCallback\fP (SoLassoSelectionFilterCB *f, void *userdata=NULL, const SbBool callonlyifselectable=TRUE)"
.br
.ti -1c
.RI "void \fBsetTriangleFilterCallback\fP (SoExtSelectionTriangleCB *func, void *userdata=NULL)"
.br
.ti -1c
.RI "void \fBsetLineSegmentFilterCallback\fP (SoExtSelectionLineSegmentCB *func, void *userdata=NULL)"
.br
.ti -1c
.RI "void \fBsetPointFilterCallback\fP (SoExtSelectionPointCB *func, void *userdata=NULL)"
.br
.ti -1c
.RI "SbBool \fBwasShiftDown\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "\fBSoSelection\fP (void)"
.br
.ti -1c
.RI "\fBSoSelection\fP (const int nChildren)"
.br
.ti -1c
.RI "void \fBselect\fP (const \fBSoPath\fP *path)"
.br
.ti -1c
.RI "void \fBselect\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "void \fBdeselect\fP (const \fBSoPath\fP *path)"
.br
.ti -1c
.RI "void \fBdeselect\fP (const int which)"
.br
.ti -1c
.RI "void \fBdeselect\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "void \fBtoggle\fP (const \fBSoPath\fP *path)"
.br
.ti -1c
.RI "void \fBtoggle\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "SbBool \fBisSelected\fP (const \fBSoPath\fP *path) const"
.br
.ti -1c
.RI "SbBool \fBisSelected\fP (\fBSoNode\fP *node) const"
.br
.ti -1c
.RI "void \fBdeselectAll\fP (void)"
.br
.ti -1c
.RI "int \fBgetNumSelected\fP (void) const"
.br
.ti -1c
.RI "const \fBSoPathList\fP * \fBgetList\fP (void) const"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBgetPath\fP (const int index) const"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBoperator[]\fP (const int i) const"
.br
.ti -1c
.RI "void \fBaddSelectionCallback\fP (SoSelectionPathCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBremoveSelectionCallback\fP (SoSelectionPathCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBaddDeselectionCallback\fP (SoSelectionPathCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBremoveDeselectionCallback\fP (SoSelectionPathCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBaddStartCallback\fP (SoSelectionClassCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBremoveStartCallback\fP (SoSelectionClassCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBaddFinishCallback\fP (SoSelectionClassCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBremoveFinishCallback\fP (SoSelectionClassCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBsetPickFilterCallback\fP (SoSelectionPickCB *f, void *userData=NULL, const SbBool callOnlyIfSelectable=TRUE)"
.br
.ti -1c
.RI "void \fBsetPickMatching\fP (const SbBool \fBpickMatching\fP)"
.br
.ti -1c
.RI "SbBool \fBisPickMatching\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBgetPickMatching\fP (void) const"
.br
.ti -1c
.RI "void \fBaddChangeCallback\fP (SoSelectionClassCB *f, void *userData=NULL)"
.br
.ti -1c
.RI "void \fBremoveChangeCallback\fP (SoSelectionClassCB *f, void *userData=NULL)"
.br
.in -1c

Public Member Functions inherited from \fBSoSeparator\fP
.in +1c
.ti -1c
.RI "\fBSoSeparator\fP (void)"
.br
.ti -1c
.RI "\fBSoSeparator\fP (const int nchildren)"
.br
.ti -1c
.RI "virtual void \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBnotify\fP (\fBSoNotList\fP *nl)"
.br
.ti -1c
.RI "virtual SbBool \fBaffectsState\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBSoGroup\fP (void)"
.br
.ti -1c
.RI "\fBSoGroup\fP (int nchildren)"
.br
.ti -1c
.RI "virtual void \fBaddChild\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "virtual void \fBinsertChild\fP (\fBSoNode\fP *child, int newchildindex)"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBgetChild\fP (int index) const"
.br
.ti -1c
.RI "virtual int \fBfindChild\fP (const \fBSoNode\fP *node) const"
.br
.ti -1c
.RI "virtual int \fBgetNumChildren\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBremoveChild\fP (int childindex)"
.br
.ti -1c
.RI "virtual void \fBremoveChild\fP (\fBSoNode\fP *child)"
.br
.ti -1c
.RI "virtual void \fBremoveAllChildren\fP (void)"
.br
.ti -1c
.RI "virtual void \fBreplaceChild\fP (int index, \fBSoNode\fP *newchild)"
.br
.ti -1c
.RI "virtual void \fBreplaceChild\fP (\fBSoNode\fP *oldchild, \fBSoNode\fP *newchild)"
.br
.ti -1c
.RI "virtual void \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "virtual \fBSoChildList\fP * \fBgetChildren\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBaddWriteReference\fP (\fBSoOutput\fP *out, SbBool isfromfield=FALSE)"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "void \fBsetOverride\fP (const SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (void) const"
.br
.ti -1c
.RI "void \fBsetNodeType\fP (const \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBcopy\fP (SbBool copyconnections=FALSE) const"
.br
.ti -1c
.RI "virtual void \fBgrabEventsSetup\fP (void)"
.br
.ti -1c
.RI "virtual void \fBgrabEventsCleanup\fP (void)"
.br
.ti -1c
.RI "virtual void \fBstartNotify\fP (void)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBwriteInstance\fP (\fBSoOutput\fP *out)"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBaddToCopyDict\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "void \fBsetToDefaults\fP (void)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (const \fBSoFieldContainer\fP *container) const"
.br
.ti -1c
.RI "void \fBcopyFieldValues\fP (const \fBSoFieldContainer\fP *container, SbBool copyconnections=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *const fielddata)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "virtual int \fBgetFields\fP (\fBSoFieldList\fP &l) const"
.br
.ti -1c
.RI "virtual int \fBgetAllFields\fP (\fBSoFieldList\fP &l) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetField\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetEventIn\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetEventOut\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (const \fBSoField\fP *const field, \fBSbName\fP &name) const"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (const SbBool flag)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *out)"
.br
.ti -1c
.RI "virtual SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *field, void *newval)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBgetFieldsMemorySize\fP (size_t &managed, size_t &unmanaged) const"
.br
.ti -1c
.RI "void \fBsetUserData\fP (void *userdata) const"
.br
.ti -1c
.RI "void * \fBgetUserData\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "void \fBref\fP (void) const"
.br
.ti -1c
.RI "void \fBunref\fP (void) const"
.br
.ti -1c
.RI "void \fBunrefNoDelete\fP (void) const"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (void) const"
.br
.ti -1c
.RI "void \fBtouch\fP (void)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const"
.br
.RI "Returns \fRTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "virtual \fBSbName\fP \fBgetName\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBsetName\fP (const \fBSbName\fP &newname)"
.br
.ti -1c
.RI "void \fBaddAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "void \fBremoveAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "const \fBSoAuditorList\fP & \fBgetAuditors\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (void)"
.br
.ti -1c
.RI "void \fBassertAlive\fP (void) const"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.in -1c

Static Public Member Functions inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.in -1c

Static Public Member Functions inherited from \fBSoSeparator\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static void \fBsetNumRenderCaches\fP (const int howmany)"
.br
.ti -1c
.RI "static int \fBgetNumRenderCaches\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetCompatibilityTypes\fP (const \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static \fBSoNode\fP * \fBgetByName\fP (const \fBSbName\fP &name)"
.br
.ti -1c
.RI "static int \fBgetByName\fP (const \fBSbName\fP &name, \fBSoNodeList\fP &l)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static void \fBinitClasses\fP (void)"
.br
.ti -1c
.RI "static SbUniqueId \fBgetNextNodeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetActionMethodIndex\fP (const \fBSoType\fP type)"
.br
.ti -1c
.RI "static void \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.    "
.ti -1c
.RI "static void \fBcleanupClass\fP (void)"
.br
.ti -1c
.RI "static void \fBinitCopyDict\fP (void)"
.br
.ti -1c
.RI "static void \fBaddCopy\fP (const \fBSoFieldContainer\fP *orig, const \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "static \fBSoFieldContainer\fP * \fBcheckCopy\fP (const \fBSoFieldContainer\fP *orig)"
.br
.ti -1c
.RI "static \fBSoFieldContainer\fP * \fBfindCopy\fP (const \fBSoFieldContainer\fP *orig, const SbBool copyconnections)"
.br
.ti -1c
.RI "static void \fBcopyDone\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "static void \fBaddName\fP (\fBSoBase\fP *const base, const char *const name)"
.br
.ti -1c
.RI "static void \fBremoveName\fP (\fBSoBase\fP *const base, const char *const name)"
.br
.ti -1c
.RI "static void \fBincrementCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static void \fBdecrementCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static \fBSoBase\fP * \fBgetNamedBase\fP (const \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "static int \fBgetNamedBases\fP (const \fBSbName\fP &name, \fBSoBaseList\fP &baselist, \fBSoType\fP type)"
.br
.ti -1c
.RI "static SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP expectedtype)"
.br
.ti -1c
.RI "static void \fBsetInstancePrefix\fP (const \fBSbString\fP &c)"
.br
.ti -1c
.RI "static void \fBsetTraceRefs\fP (SbBool trace)"
.br
.ti -1c
.RI "static SbBool \fBgetTraceRefs\fP (void)"
.br
.ti -1c
.RI "static SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, const \fBSbName\fP &fromnodename, const \fBSbName\fP &fromfieldname, const \fBSbName\fP &tonodename, const \fBSbName\fP &tofieldname)"
.br
.ti -1c
.RI "static SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFEnum\fP \fBlassoType\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBlassoPolicy\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBlassoMode\fP"
.br
.in -1c

Public Attributes inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "\fBSoSFEnum\fP \fBpolicy\fP"
.br
.in -1c

Public Attributes inherited from \fBSoSeparator\fP
.in +1c
.ti -1c
.RI "\fBSoSFEnum\fP \fBrenderCaching\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBboundingBoxCaching\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBrenderCulling\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBpickCulling\fP"
.br
.in -1c

Public Attributes inherited from \fBSoBase\fP
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const"
.br
.ti -1c
.RI "virtual \fB~SoExtSelection\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoSelection\fP ()"
.br
.ti -1c
.RI "void \fBinvokeSelectionPolicy\fP (\fBSoPath\fP *path, SbBool shiftDown)"
.br
.ti -1c
.RI "void \fBperformSingleSelection\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "void \fBperformToggleSelection\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBcopyFromThis\fP (const \fBSoPath\fP *path) const"
.br
.ti -1c
.RI "void \fBaddPath\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "void \fBremovePath\fP (const int which)"
.br
.ti -1c
.RI "int \fBfindPath\fP (const \fBSoPath\fP *path) const"
.br
.in -1c

Protected Member Functions inherited from \fBSoSeparator\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoSeparator\fP ()"
.br
.ti -1c
.RI "virtual SbBool \fBcullTest\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "virtual SbBool \fBcullTest\fP (\fBSoGLRenderAction\fP *action, int &cullresults)"
.br
.ti -1c
.RI "virtual SbBool \fBreadInstance\fP (\fBSoInput\fP *in, unsigned short flags)"
.br
.in -1c

Protected Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoGroup\fP ()"
.br
.ti -1c
.RI "virtual SbBool \fBreadChildren\fP (\fBSoInput\fP *in)"
.br
.ti -1c
.RI "virtual void \fBcopyContents\fP (const \fBSoFieldContainer\fP *from, SbBool copyconnections)"
.br
.ti -1c
.RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (void)"
.br
.ti -1c
.RI "void \fBsetOperation\fP (const \fBSoNotRec::OperationType\fP opType=SoNotRec::UNSPECIFIED, const \fBSoNode\fP *cc=NULL, const \fBSoNode\fP *pc=NULL, const int ci=\-1)"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoNode\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoBase\fP ()"
.br
.ti -1c
.RI "virtual void \fBdestroy\fP (void)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *out, SbBool isgroup, SbBool isengine) const"
.br
.ti -1c
.RI "void \fBwriteFooter\fP (\fBSoOutput\fP *out) const"
.br
.ti -1c
.RI "virtual const char * \fBgetFileFormatName\fP (void) const"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoSeparator\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.ti -1c
.RI "static void \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "static int \fBgetNextActionMethodIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBincNextActionMethodIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBsetCompatibilityTypes\fP (const \fBSoType\fP &nodetype, const uint32_t bitmask)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static void \fBstaticDataLock\fP (void)"
.br
.ti -1c
.RI "static void \fBstaticDataUnlock\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Protected Attributes inherited from \fBSoSelection\fP
.in +1c
.ti -1c
.RI "\fBSoPathList\fP \fBselectionList\fP"
.br
.ti -1c
.RI "\fBSoCallbackList\fP * \fBselCBList\fP"
.br
.ti -1c
.RI "\fBSoCallbackList\fP * \fBdeselCBList\fP"
.br
.ti -1c
.RI "\fBSoCallbackList\fP * \fBstartCBList\fP"
.br
.ti -1c
.RI "\fBSoCallbackList\fP * \fBfinishCBList\fP"
.br
.ti -1c
.RI "SoSelectionPickCB * \fBpickCBFunc\fP"
.br
.ti -1c
.RI "void * \fBpickCBData\fP"
.br
.ti -1c
.RI "SbBool \fBcallPickCBOnlyIfSelectable\fP"
.br
.ti -1c
.RI "\fBSoCallbackList\fP * \fBchangeCBList\fP"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBmouseDownPickPath\fP"
.br
.ti -1c
.RI "SbBool \fBpickMatching\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBSoChildList\fP * \fBchildren\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "static int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoExtSelection\fP class can be used for extended selection functionality\&. 

This class enables you to select geometry by specifying a lasso (a polygon) or a rectangle on screen\&. When objects are selected, you'll receive the same callbacks as for the \fBSoSelection\fP node\&.

.PP
The application programmer interface of this class is somewhat complex, due to its non-trivial functionality\&. To see an \fIextensive\fP usage example of the \fBSoExtSelection\fP node, we advise you to go look at the 'extselection' example application in the 'nodes/' directory of the SoGuiExamples Mercurial repository\&. Further information and links for downloading and building this module should be available at \fRgithub\&.com/coin3d/soguiexamples\fP\&.

.PP
This node class is an extension versus the original SGI Inventor v2\&.1 API\&. It is based on the API of VSG (was TGS) Inventor's \fBSoExtSelection\fP, and we aim to be fully compatible with this node to enable users to switch between using Coin and VSG Inventor\&. Please contact us if you find discrepancies between Coin's \fBSoExtSelection\fP and VSG's \fBSoExtSelection\fP node\&.

.PP
\fBFILE FORMAT/DEFAULTS:\fP 
.PP
.nf
ExtSelection {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    policy SHIFT
    lassoType NOLASSO
    lassoPolicy FULL_BBOX
    lassoMode ALL_SHAPES
}

.fi
.PP

.PP
\fBSince\fP
.RS 4
TGS Inventor 2\&.5 

.PP
Coin 1\&.0 
.RE
.PP

.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBSoExtSelection::LassoType\fP"
Enum for type of lasso selection\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BINOLASSO \fP
Makes this node behave like a normal \fBSoSelection\fP node\&. 
.TP
\f(BILASSO \fP
Select objects using a lasso\&. Selections can be aborted by the end-user by hitting the \fREND\fP key on the keyboard\&. 
.TP
\f(BIRECTANGLE \fP
Select objects using a rectangle\&. Selections can be aborted by the end-user by hitting the \fREND\fP key on the keyboard\&. 
.SS "enum \fBSoExtSelection::LassoPolicy\fP"
Enum for specifying how objects are selected\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIFULL_BBOX \fP
The entire bounding box must be inside the lasso/rectangle\&. 
.TP
\f(BIPART_BBOX \fP
Some part of the bounding box must intersect the lasso/rectangle\&. 
.TP
\f(BIFULL \fP
All primitives must be completely inside the lasso/rectangle\&. 
.TP
\f(BIPART \fP
Some primitive must intersect the lasso/rectangle\&. 
.SS "enum \fBSoExtSelection::LassoMode\fP"
Enum for specifying selection mode\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIALL_SHAPES \fP
All primitives inside the lasso/rectangle will be selected\&. 
.TP
\f(BIVISIBLE_SHAPES \fP
All \fIvisible\fP primitives inside the lasso/rectangle will be selected\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoExtSelection::SoExtSelection (void )"
Constructor\&. 
.SS "SoExtSelection::~SoExtSelection ()\fR [protected]\fP, \fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoExtSelection::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoExtSelection::getTypeId (void ) const\fR [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Reimplemented from \fBSoSelection\fP\&.
.SS "const \fBSoFieldData\fP ** SoExtSelection::getFieldDataPtr (void )\fR [static]\fP, \fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.br
 
.SS "const \fBSoFieldData\fP * SoExtSelection::getFieldData (void ) const\fR [protected]\fP, \fR [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fRNULL\fP\&. 
.PP
Reimplemented from \fBSoSelection\fP\&.
.SS "void SoExtSelection::useOverlay (SbBool overlay = \fRTRUE\fP)"
Specifies whether the overlay planes should be used to render the lasso\&.

.PP
This method has been obsoleted in Coin, as most graphics cards comes without support for overlay rendering\&. A better strategy is to just 'overlay' the lasso graphics on top of the scene after everything else has been rendered -- and this is the strategy we apply in Coin\&. 
.SS "SbBool SoExtSelection::isUsingOverlay (void )"
Returns whether overlay planes are used to draw the lasso\&.

.PP
\fBSee also\fP
.RS 4
\fBuseOverlay()\fP\&. 
.RE
.PP

.SS "\fBSoSeparator\fP * SoExtSelection::getOverlaySceneGraph (void )"
Returns the scene graph for overlay rendering\&. Will always return NULL in Coin, as this method has been obsoleted\&.

.PP
(It is probably used in TGS Inventor from the SoXt / SoWin libraries' So[Xt|Win]RenderArea class to fetch the overlay graph to draw, and as such should be treated as an internal method\&.) 
.SS "void SoExtSelection::setOverlayLassoColorIndex (const int index)"
Obsoleted in Coin, use \fBSoExtSelection::setLassoColor()\fP instead\&. 
.SS "int SoExtSelection::getOverlayLassoColorIndex (void )"
Obsoleted in Coin, use \fBSoExtSelection::getLassoColor()\fP instead\&.

.PP
\fBSee also\fP
.RS 4
\fBsetOverlayLassoColorIndex()\fP\&. 
.RE
.PP

.SS "void SoExtSelection::setLassoColor (const \fBSbColor\fP & color)"
Sets the lasso/rectangle line color\&. Default value is (1\&.0, 1\&.0, 1\&.0)\&. 
.SS "const \fBSbColor\fP & SoExtSelection::getLassoColor (void )"
Returns the lasso color\&. 
.SS "void SoExtSelection::setLassoWidth (const float width)"
Sets the lasso line width\&. Default value is 1\&.0\&. 
.SS "float SoExtSelection::getLassoWidth (void )"
Returns the lasso line width\&. 
.SS "void SoExtSelection::setOverlayLassoPattern (const unsigned short pattern)"
Sets the lasso line pattern\&. Default value is 0xf0f0\&. 
.SS "unsigned short SoExtSelection::getOverlayLassoPattern (void )"
Returns the lasso line pattern\&. 
.SS "void SoExtSelection::animateOverlayLasso (const SbBool animate = \fRTRUE\fP)"
Sets whether the lasso should be animated by scrolling the line pattern\&. 
.SS "SbBool SoExtSelection::isOverlayLassoAnimated (void )"
Returns whether the lasso is set to animate or not\&. 
.SS "void SoExtSelection::handleEvent (\fBSoHandleEventAction\fP * action)\fR [virtual]\fP"
Action method for \fBSoHandleEventAction\fP\&.

.PP
Inspects the event data from \fIaction\fP, and processes it if it is something which this node should react to\&.

.PP
Nodes influencing relevant state variables for how event handling is done also override this method\&. 
.PP
Reimplemented from \fBSoSelection\fP\&.
.SS "void SoExtSelection::GLRenderBelowPath (\fBSoGLRenderAction\fP * action)\fR [virtual]\fP"
SGI Open Inventor v2\&.1 obsoleted support for \fBSoGLRenderAction::addMethod()\fP\&. Instead, \fBGLRender()\fP might be called directly, and to optimize traversal, the \fBSoSeparator\fP node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change)\&. To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect\&.

.PP
\fBSoSeparator::GLRenderBelowPath()\fP does not traverse its children using \fBSoChildList::traverse()\fP, but calls \fBGLRenderBelowPath()\fP directly for all its children\&. 
.PP
Reimplemented from \fBSoSeparator\fP\&.
.SS "void SoExtSelection::select (\fBSoNode\fP * root, int numcoords, \fBSbVec2f\fP * lasso, const \fBSbViewportRegion\fP & vp, SbBool shiftpolicy)"
Simulate lasso selection programmatically\&.

.PP
This function is currently just stubbed\&. 
.SS "void SoExtSelection::select (\fBSoNode\fP * root, int numcoords, \fBSbVec3f\fP * lasso, const \fBSbViewportRegion\fP & vp, SbBool shiftpolicy)"
Simulate lasso selection programmatically\&.

.PP
This function is currently just stubbed\&. 
.SS "const \fBSbVec2s\fP * SoExtSelection::getLassoCoordsDC (int & numCoords)"
Returns lasso coordinates in device coordinates\&.

.PP
This function is currently just stubbed\&. 
.SS "const \fBSbVec3f\fP * SoExtSelection::getLassoCoordsWC (int & numCoords)"
Returns lasso coordinates in world coordinates\&.

.PP
This function is currently just stubbed\&. 
.SS "const \fBSoPathList\fP & SoExtSelection::getSelectionPathList () const"
Returns a path list containing selected objects\&.

.PP
This function is currently just stubbed\&. 
.SS "void SoExtSelection::setLassoFilterCallback (SoLassoSelectionFilterCB * f, void * userdata = \fRNULL\fP, const SbBool callonlyifselectable = \fRTRUE\fP)"
The lasso selection filter callback is called when a node is about to be selected, and enables the application programmer to return a new path to be used when selecting\&. The new returned path should not be ref'd\&. \fBSoExtSelection\fP will \fBref()\fP and \fBunref()\fP it\&.

.PP
To cancel the selection, return NULL from the callback\&.

.PP
if \fIcallonlyifselectable\fP is TRUE, the callback will only be invoked when the path to the new node pass through the \fBSoExtSelection\fP node\&.

.PP
This method is specific to Coin, and is not part of TGS OIV\&. 
.SS "void SoExtSelection::setTriangleFilterCallback (SoExtSelectionTriangleCB * func, void * userdata = \fRNULL\fP)"
Sets the callback that will be called for every triangle inside the lasso/rectangle when selecting\&.

.PP
The callback should return \fRFALSE\fP if it wants to continue being invoked\&. When the callback returns \fRTRUE\fP, the object/shape is selected, and no more callbacks will be invoked for the object\&.

.PP
\fBSee also\fP
.RS 4
\fBsetLineSegmentFilterCallback\fP, \fBsetPointFilterCallback\fP 
.RE
.PP

.SS "void SoExtSelection::setLineSegmentFilterCallback (SoExtSelectionLineSegmentCB * func, void * userdata = \fRNULL\fP)"
Sets the callback that will be called for every line segment inside the lasso/rectangle when selecting\&.

.PP
The callback should return \fRFALSE\fP if it wants to continue being invoked\&. When the callback returns \fRTRUE\fP, the object/shape is selected, and no more callbacks will be invoked for the object\&.

.PP
\fBSee also\fP
.RS 4
\fBsetTriangleFilterCallback\fP, \fBsetPointFilterCallback\fP 
.RE
.PP

.SS "void SoExtSelection::setPointFilterCallback (SoExtSelectionPointCB * func, void * userdata = \fRNULL\fP)"
Sets the callback that will be called for every point inside the lasso/rectangle when selecting\&.

.PP
The callback should return \fRFALSE\fP if it wants to continue being invoked\&. When the user returns \fRTRUE\fP, the object/shape is selected, and no more callbacks will be invoked for the object\&.

.PP
\fBSee also\fP
.RS 4
\fBsetLineSegmentFilterCallback\fP, \fBsetTriangleFilterCallback\fP 
.RE
.PP

.SS "SbBool SoExtSelection::wasShiftDown (void ) const"
Returns whether the \fRSHIFT\fP key was pressed during the latest user interaction\&. This is useful if you want to respect the shift policy while selecting primitives\&.

.PP
This method is specific to Coin, and is not part of TGS OIV\&. 
.SH "Member Data Documentation"
.PP 
.SS "\fBSoSFEnum\fP SoExtSelection::lassoType"
Field for lasso type\&. Default value is \fBSoExtSelection::NOLASSO\fP\&.

.PP
Selections with type \fBSoExtSelection::RECTANGLE\fP or \fBSoExtSelection::LASSO\fP can be aborted by the end-user by hitting the \fREND\fP key on the keyboard\&. 
.SS "\fBSoSFEnum\fP SoExtSelection::lassoPolicy"
Field for lasso policy\&. Default value is FULL_BBOX\&. 
.SS "\fBSoSFEnum\fP SoExtSelection::lassoMode"
Field for lasso mode\&. Default value is ALL_SHAPES\&.

.PP
Set this field to VISIBLE_SHAPES to make only the primitives visible from the current viewpoint be selected\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.