SoExtSelection(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoExtSelection(3) 💖

okay so this is the manual page for SoExtSelection(3) in the Coin library, and bestie, she is long — like, three-parts long — so buckle up 🫶 This is part 1, and we're doing it properly, no skimming, no "yeah yeah I get it". Every single thing is staying. Periodt. 💅

✨ NAME ✨

SoExtSelection — the class you grab when you want extended selection functionality. That's it, that's the name section, it's giving brevity 🎀

🦋 SYNOPSIS 🦋

First things first, you gotta pull her in:

#include <Inventor/nodes/SoExtSelection.h>

And she inherits SoSelection — so everything SoSelection can do, she can do too, plus her own extra main-character moves. 👑

🌸 Public Types 🌸

Her very own enums, freshly served:

  • enum LassoType { NOLASSO, LASSO, RECTANGLE }
  • enum LassoPolicy { FULL_BBOX, PART_BBOX, FULL, PART }
  • enum LassoMode { ALL_SHAPES, VISIBLE_SHAPES }

💜 Public Types inherited from SoSelection 💜

  • 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 }
not me listing every single hex value and meaning it. the numbers are the numbers, we do not round. 💀

🎀 Public Member Functions 🎀

Here's the whole lineup of what she can actually do, bestie:

  • virtual SoType getTypeId (void) const
  • SoExtSelection (void)
  • void useOverlay (SbBool overlay=TRUE)
  • SbBool isUsingOverlay (void)
  • SoSeparator * getOverlaySceneGraph (void)
  • void setOverlayLassoColorIndex (const int index)
  • int getOverlayLassoColorIndex (void)
  • void setLassoColor (const SbColor &color)
  • const SbColor & getLassoColor (void)
  • void setLassoWidth (const float width)
  • float getLassoWidth (void)
  • void setOverlayLassoPattern (const unsigned short pattern)
  • unsigned short getOverlayLassoPattern (void)
  • void animateOverlayLasso (const SbBool animate=TRUE)
  • SbBool isOverlayLassoAnimated (void)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • void select (SoNode *root, int numcoords, SbVec2f *lasso, const SbViewportRegion &vp, SbBool shiftpolicy)
  • void select (SoNode *root, int numcoords, SbVec3f *lasso, const SbViewportRegion &vp, SbBool shiftkeypolicy)
  • const SbVec2s * getLassoCoordsDC (int &numCoords)
  • const SbVec3f * getLassoCoordsWC (int &numCoords)
  • const SoPathList & getSelectionPathList () const
  • void setLassoFilterCallback (SoLassoSelectionFilterCB *f, void *userdata=NULL, const SbBool callonlyifselectable=TRUE)
  • void setTriangleFilterCallback (SoExtSelectionTriangleCB *func, void *userdata=NULL)
  • void setLineSegmentFilterCallback (SoExtSelectionLineSegmentCB *func, void *userdata=NULL)
  • void setPointFilterCallback (SoExtSelectionPointCB *func, void *userdata=NULL)
  • SbBool wasShiftDown (void) const
👀 two select() overloads up there, and yes, the last parameter is spelled differently in each one — shiftpolicy in the 2D one, shiftkeypolicy in the 3D one. that's not a typo, that's the source. we copy, we don't correct. 💖

🫶 Public Member Functions inherited from SoSelection 🫶

All of this comes down the family line:

  • 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 SoPathList * getList (void) const
  • SoPath * getPath (const int index) const
  • SoPath * operator[] (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 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
  • 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 SoNode * copy (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 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)
  • 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.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🌈 Static Public Member Functions inherited from SoSelection 🌈

  • static SoType getClassTypeId (void)
  • 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 Public Member Functions inherited from SoSeparator ⭐

  • static SoType getClassTypeId (void)
  • 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 void setNumRenderCaches (const int howmany)
  • static int getNumRenderCaches (void)

🎀 Static Public Member Functions inherited from SoGroup 🎀

  • static SoType getClassTypeId (void)
  • 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 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • 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)
okay that's the whole synopsis, and yes I listed every single inherited one because the rule is THE RULE. no skipping the "boring" parts, the boring parts are the parts. 💖

to be continued, bestie — part 2 is right there 👀

🧬 Static Public Member Functions (the ones you inherit, bestie)

These came free with the family, no cap. 💖

✨ inherited from SoFieldContainer

  • static void initClass (void) — does the setup for all the data that every single instance of this class shares, like handing the Coin type system everything it needs to know. boring-sounding, absolutely essential. 👑
  • static SoType getClassTypeId (void) — this static method hands you back the SoType object that belongs to objects of this class. that's the whole job, she's simple and she slays. 💅
  • 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)

🌸 inherited from SoBase

  • static void initClass (void) — same energy as above: sets up initialization for data common to all instances of this class, like submitting the necessary info to the Coin type system. ✨
  • static SoType getClassTypeId (void) — returns the SoType object associated with objects of this class. iconic, consistent, love that for her. 🎀
  • 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

the main character fields, literally right there for you to poke at:

  • SoSFEnum lassoType
  • SoSFEnum lassoPolicy
  • SoSFEnum lassoMode

🌈 inherited from SoSelection

  • SoSFEnum policy

🦋 inherited from SoSeparator

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

🔒 Protected Member Functions

💜 the SoExtSelection originals

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoExtSelection ()

🌸 inherited from SoSelection

  • 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

✨ 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)

🎀 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)

💫 inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

🫶 inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

💀 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

the SoExtSelection one

  • static const SoFieldData ** getFieldDataPtr (void)

💜 inherited from SoSelection

  • static const SoFieldData ** getFieldDataPtr (void)

🌸 inherited from SoSeparator

  • static const SoFieldData ** getFieldDataPtr (void)

✨ inherited from SoGroup

  • static const SoFieldData ** getFieldDataPtr (void)

🎀 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)

🦋 inherited from SoBase

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

🍓 Additional Inherited Members

all the extra lore the ancestors passed down. 🙈

Protected Types inherited from SoBase

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

🔥 Protected Attributes inherited from SoSelection

  • SoPathList selectionList
  • SoCallbackList * selCBList
  • SoCallbackList * deselCBList
  • SoCallbackList * startCBList
  • SoCallbackList * finishCBList
  • SoSelectionPickCB * pickCBFunc
  • void * pickCBData
  • SbBool callPickCBOnlyIfSelectable
  • SoCallbackList * changeCBList
  • SoPath * mouseDownPickPath
  • SbBool pickMatching

🌈 Protected Attributes inherited from SoGroup

  • SoChildList * children

💫 Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

🫶 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

⭐ Static Protected Attributes inherited from SoNode

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

📖 Detailed Description

okay so the SoExtSelection class exists so you can do extended selection stuff. she's the upgrade, the glow-up, the deluxe edition. 💅

with this class you can select geometry by drawing a lasso (which is just a polygon, bestie, a lil squiggle around your shapes) or a rectangle right there on screen. and when stuff gets selected? you get the exact same callbacks as you would from an SoSelection node. same energy, more power. 🫶

ngl the application programmer interface of this class is somewhat complex, and that's because its functionality is genuinely non-trivial — she does a lot. if you want to see an extensive usage example of the SoExtSelection node, we literally advise you to go look at the extselection example application in the nodes/ directory of the SoGuiExamples Mercurial repository. further info and links for downloading and building this module should be available at github.com/coin3d/soguiexamples. go look, it's worth it, fr fr. 📚

this node class is an extension versus the original SGI Inventor v2.1 API. it's based on the API of VSG (which used to be called TGS) Inventor's SoExtSelection, and the goal is to be fully compatible with this node so users can switch back and forth between Coin and VSG Inventor without drama. if you find any discrepancies between Coin's SoExtSelection and VSG's SoExtSelection node — please contact us. we wanna know. 💌

FILE FORMAT/DEFAULTS:

ExtSelection {
    renderCaching AUTO
    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    policy SHIFT
    lassoType NOLASSO
    lassoPolicy FULL_BBOX
    lassoMode ALL_SHAPES
}

🕰️ Since

  • TGS Inventor 2.5
  • Coin 1.0

🔮 Member Enumeration Documentation

enum SoExtSelection::LassoType

enum for the type of lasso selection. pick your fighter. 🥊

  • NOLASSO — makes this node behave like a totally normal SoSelection node. no lasso, no rectangle, just vibes.
  • LASSO — select objects using a lasso. heads up bestie: selections can be aborted by the end-user by hitting the END key on the keyboard. 😭
  • RECTANGLE — select objects using a rectangle. and same thing: selections can be aborted by the end-user by hitting the END key on the keyboard. 😭

enum SoExtSelection::LassoPolicy

enum for specifying how objects get selected. the rules of the game. ✨

  • FULL_BBOX — the entire bounding box must be inside the lasso/rectangle.
  • PART_BBOX — some part of the bounding box must intersect the lasso/rectangle.
  • FULL — all primitives must be completely inside the lasso/rectangle.
  • PART — some primitive must intersect the lasso/rectangle.

enum SoExtSelection::LassoMode

enum for specifying the selection mode. 👑

  • ALL_SHAPES — all primitives inside the lasso/rectangle will be selected. every single one. periodt.
  • VISIBLE_SHAPES — all visible primitives inside the lasso/rectangle will be selected. if she's hiding, she's safe. 🙈

🛠️ Constructor & Destructor Documentation

SoExtSelection::SoExtSelection (void )

constructor. she's born. 👶✨

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

destructor. she's [protected] and [virtual], so handle with care. 💀

💖 Member Function Documentation 💖

okay bestie, this is the part where we go through every single method this node has. grab a snack, hydrate, we're doing this ✨

SoType SoExtSelection::getClassTypeId (void ) [static]

A lil static method that hands you the SoType object tied to objects of this class. type-system stuff, you know how it is 💅

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

Gives you the type identification of an object derived from a class that inherits SoBase. this is the runtime type checking + "downward" casting machinery, fr fr.

Reimplemented from SoSelection.

const SoFieldData ** SoExtSelection::getFieldDataPtr (void ) [static], [protected]

okay so this one is internal to the library — the docs literally say it's "not likely to be of interest to the application programmer", so if you're just vibing with the public API, this is not your moment 🫶

It returns the SoFieldData class which holds info about the fields in this node.

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

Returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. simple as that 🎀

Reimplemented from SoSelection.

void SoExtSelection::useOverlay (SbBool overlay = TRUE)

Specifies whether the overlay planes should be used to render the lasso.

⚠️ bestie this has been obsoleted in Coin, because most graphics cards come without support for overlay rendering. The better strategy — and the one Coin actually applies — is to just "overlay" the lasso graphics on top of the scene after everything else has been rendered. periodt.

SbBool SoExtSelection::isUsingOverlay (void )

Returns whether overlay planes are used to draw the lasso.

👀 See also

useOverlay().

SoSeparator * SoExtSelection::getOverlaySceneGraph (void )

Returns the scene graph for overlay rendering. In Coin this will always return NULL, because the method has been obsoleted 💀

(it's probably used in TGS Inventor from the SoXt / SoWin libraries' So[Xt|Win]RenderArea class to fetch the overlay graph to draw — and because of that, it should be treated as an internal method.)

void SoExtSelection::setOverlayLassoColorIndex (const int index)

Obsoleted in Coin — use SoExtSelection::setLassoColor() instead 🦋

int SoExtSelection::getOverlayLassoColorIndex (void )

Obsoleted in Coin — use SoExtSelection::getLassoColor() instead.

👀 See also

setOverlayLassoColorIndex().

void SoExtSelection::setLassoColor (const SbColor & color)

Sets the lasso/rectangle line color. Default value is (1.0, 1.0, 1.0).

const SbColor & SoExtSelection::getLassoColor (void )

Returns the lasso color. that's it, that's the tweet ✨

void SoExtSelection::setLassoWidth (const float width)

Sets the lasso line width. Default value is 1.0.

float SoExtSelection::getLassoWidth (void )

Returns the lasso line width.

void SoExtSelection::setOverlayLassoPattern (const unsigned short pattern)

Sets the lasso line pattern. Default value is 0xf0f0.

unsigned short SoExtSelection::getOverlayLassoPattern (void )

Returns the lasso line pattern.

void SoExtSelection::animateOverlayLasso (const SbBool animate = TRUE)

Sets whether the lasso should be animated by scrolling the line pattern. cute, right? 🌀

SbBool SoExtSelection::isOverlayLassoAnimated (void )

Returns whether the lasso is set to animate or not.

void SoExtSelection::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction.

It inspects the event data from action, and processes it if it's something this node should react to.

Nodes that influence the relevant state variables for how event handling is done also override this method. iykyk 👑

Reimplemented from SoSelection.

void SoExtSelection::GLRenderBelowPath (SoGLRenderAction * action) [virtual]

SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod(). Instead, GLRender() might be called directly — and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (and the path code is guaranteed not to change). To stay compatible with SGI's Inventor (and thereby also TGS'), Coin chose to follow their implementation in this respect, no cap.

SoSeparator::GLRenderBelowPath() does not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children.

Reimplemented from SoSeparator.

void SoExtSelection::select (SoNode * root, int numcoords, SbVec2f * lasso, const SbViewportRegion & vp, SbBool shiftpolicy)

Simulate lasso selection programmatically.

🫠 heads up: this function is currently just stubbed.

void SoExtSelection::select (SoNode * root, int numcoords, SbVec3f * lasso, const SbViewportRegion & vp, SbBool shiftpolicy)

Simulate lasso selection programmatically.

🫠 also currently just stubbed.

const SbVec2s * SoExtSelection::getLassoCoordsDC (int & numCoords)

Returns lasso coordinates in device coordinates.

🫠 currently just stubbed.

const SbVec3f * SoExtSelection::getLassoCoordsWC (int & numCoords)

Returns lasso coordinates in world coordinates.

🫠 currently just stubbed.

const SoPathList & SoExtSelection::getSelectionPathList () const

Returns a path list containing the selected objects.

🫠 currently just stubbed.

void SoExtSelection::setLassoFilterCallback (SoLassoSelectionFilterCB * f, void * userdata = NULL, const SbBool callonlyifselectable = TRUE)

The lasso selection filter callback is called when a node is about to be selected, and it lets the application programmer return a new path to be used when selecting. The new returned path should not be ref'd — SoExtSelection will ref() and unref() it for you, so don't you dare double-dip 🙈

To cancel the selection, return NULL from the callback.

If callonlyifselectable is TRUE, the callback will only be invoked when the path to the new node passes through the SoExtSelection node.

This method is specific to Coin, and is not part of TGS OIV. 💅

void SoExtSelection::setTriangleFilterCallback (SoExtSelectionTriangleCB * func, void * userdata = NULL)

Sets the callback that will be called for every triangle inside the lasso/rectangle when selecting.

The callback should return FALSE if it wants to continue being invoked. When the callback returns TRUE, the object/shape is selected, and no more callbacks will be invoked for the object. slay 💖

👀 See also

setLineSegmentFilterCallback, setPointFilterCallback

void SoExtSelection::setLineSegmentFilterCallback (SoExtSelectionLineSegmentCB * func, void * userdata = NULL)

Sets the callback that will be called for every line segment inside the lasso/rectangle when selecting.

The callback should return FALSE if it wants to continue being invoked. When the callback returns TRUE, the object/shape is selected, and no more callbacks will be invoked for the object.

👀 See also

setTriangleFilterCallback, setPointFilterCallback

void SoExtSelection::setPointFilterCallback (SoExtSelectionPointCB * func, void * userdata = NULL)

Sets the callback that will be called for every point inside the lasso/rectangle when selecting.

The callback should return FALSE if it wants to continue being invoked. When the user returns TRUE, the object/shape is selected, and no more callbacks will be invoked for the object.

👀 See also

setLineSegmentFilterCallback, setTriangleFilterCallback

SbBool SoExtSelection::wasShiftDown (void ) const

Returns whether the SHIFT key was pressed during the latest user interaction. super useful if you want to respect the shift policy while selecting primitives 🌸

This method is specific to Coin, and is not part of TGS OIV.

📦 Member Data Documentation 📦

SoSFEnum SoExtSelection::lassoType

Field for lasso type. Default value is SoExtSelection::NOLASSO.

Selections with type SoExtSelection::RECTANGLE or SoExtSelection::LASSO can be aborted by the end-user by hitting the END key on the keyboard. so dramatic, honestly iconic 🔥

SoSFEnum SoExtSelection::lassoPolicy

Field for lasso policy. Default value is FULL_BBOX.

SoSFEnum SoExtSelection::lassoMode

Field for lasso mode. Default value is ALL_SHAPES.

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

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (not a human, just a very hardworking robot bestie 🤖💜)

and that's a wrap on the whole page, bestie!! 🎀 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you've officially survived all three parts of SoExtSelection(3) 🦋 go forth and lasso-select responsibly, mwah 💅💖

📦 where this page comes from