SoExtSelection(3)

📦 version 2.5.0, in fedora 43, fedora 44

🦋 NAME 🦋

okay so, bestie, meet SoExtSelection — the class that unlocks extended selection functionality. ✨

(this is the manual page for SoExtSelection(3), from the Library Functions Manual — iykyk 💅)

🎀 SYNOPSIS 🎀

First things first, you gotta pull her in:

#include <Inventor/nodes/SoExtSelection.h>

and she Inherits SoSelection — so everything SoSelection can do, she does too, plus her own extra main-character moves. 👑

💖 Public Types 💖

  • enum LassoType { NOLASSO, LASSO, RECTANGLE } — the vibe check for what kind of lasso you're drawing, no cap.
  • enum LassoPolicy { FULL_BBOX, PART_BBOX, FULL, PART } — the policy options, literally right there.
  • enum LassoMode { ALL_SHAPES, VISIBLE_SHAPES } — are we talking all the shapes or just the ones you can actually see? Both options live here.

🌸 Public Types inherited from SoSelection

  • enum Policy { SINGLE, TOGGLE, SHIFT }

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

look at all those little hex numbers, she's so organized 🫶

💅 Public Member Functions 💅

these are hers, the homegrown ones:

  • virtual SoType getTypeId (void) const — hands you back her SoType. classic.
  • SoExtSelection (void) — the constructor, obviously. every icon has an origin story.
  • void useOverlay (SbBool overlay=1) — turn the overlay on or off. overlay=1 is the default, it's right there in the signature, bestie.
  • SbBool isUsingOverlay (void) — the lil getter that tells you if the overlay is on. yes she's a setter/getter duo, we love a matching pair 💞
  • SoSeparator * getOverlaySceneGraph (void) — returns the overlay scene graph, as an SoSeparator *.
  • void setOverlayLassoColorIndex (const int index) — set the overlay lasso's color index, takes an int.
  • int getOverlayLassoColorIndex (void) — and here's the getter for it. returns an int.
  • void setLassoColor (const SbColor &color) — set the lasso color with an SbColor.
  • const SbColor & getLassoColor (void) — get it back as a const SbColor &.
  • void setLassoWidth (const float width) — lasso width, in a float.
  • float getLassoWidth (void) — the width getter. float, bestie.
  • void setOverlayLassoPattern (const unsigned short pattern) — the overlay lasso pattern, as an unsigned short.
  • unsigned short getOverlayLassoPattern (void) — and the getter for that pattern. unsigned short, periodt.
  • void animateOverlayLasso (const SbBool animate=1) — animate the overlay lasso. animate=1 is the default, she's animated unless you say otherwise 🦋
  • SbBool isOverlayLassoAnimated (void) — are we animating? SbBool says maybe. 💀
  • virtual void handleEvent (SoHandleEventAction *action) — handles the event action, virtual.
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — renders below the path, also virtual.
  • void select (SoNode *root, int numcoords, SbVec2f *lasso, const SbViewportRegion &vp, SbBool shiftpolicy) — one of the select overloads, this one taking an SbVec2f * lasso.
  • void select (SoNode *root, int numcoords, SbVec3f *lasso, const SbViewportRegion &vp, SbBool shiftkeypolicy) — and the SbVec3f * sibling. note the last param is spelled shiftkeypolicy here and shiftpolicy up there — that's literally how she wrote it, don't come for me 🙈
  • const SbVec2s * getLassoCoordsDC (int &numCoords) — lasso coords in DC, returned as a const SbVec2s *, with numCoords by reference.
  • const SbVec3f * getLassoCoordsWC (int &numCoords) — same energy, but WC, const SbVec3f *, numCoords by reference.
  • const SoPathList & getSelectionPathList () const — the selection path list, as a const SoPathList &, const method.
  • void setLassoFilterCallback (SoLassoSelectionFilterCB *f, void *userdata=NULL, const SbBool callonlyifselectable=1) — hook up a lasso filter callback. defaults: userdata=NULL, callonlyifselectable=1.
  • void setTriangleFilterCallback (SoExtSelectionTriangleCB *func, void *userdata=NULL) — triangle filter callback, userdata defaults to NULL.
  • void setLineSegmentFilterCallback (SoExtSelectionLineSegmentCB *func, void *userdata=NULL) — line segment filter callback, userdata=NULL default.
  • void setPointFilterCallback (SoExtSelectionPointCB *func, void *userdata=NULL) — point filter callback, userdata=NULL default. it's giving very consistent queen ✨
  • SbBool wasShiftDown (void) const — tells you whether shift was down. const method, no notes.

🧚 Public Member Functions inherited from SoSelection 🧚

she got all of these from her parent, slay:

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=1)
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)

okay and yes there are two pick-matching getters, isPickMatching and getPickMatching, and honestly? both ate. 🍓

🌈 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

⭐ 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=0) const
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual SoFieldContainer * copyThroughConnection (void) const

🫶 Public Member Functions inherited from SoFieldContainer 🫶

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

😭 Public Member Functions inherited from SoBase 😭

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

👑 Static Public Member Functions 👑

the static girlies for SoExtSelection herself:

  • static SoType getClassTypeId (void) — the class type id, static.
  • static void initClass (void) — init the class. call her, she's important.

🌸 Static Public Member Functions inherited from SoSelection

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

🌸 Static Public Member Functions inherited from SoSeparator

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

🌸 Static Public Member Functions inherited from SoGroup

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

🌸 Static Public Member Functions inherited from SoNode

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

🌸 Static Public Member Functions inherited from SoFieldContainer

static void initClass (void)
static SoType getClassTypeId (void)
static void 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)

and that's the whole synopsis, bestie — every single signature, accounted for, not a crumb left behind. 💖

✨ Static Public Member Functions inherited from SoBase ✨

These aren't SoExtSelection's own moves, bestie — they're the family inheritance, passed down from SoBase. Still gotta list every single one tho 💅

  • static void initClass(void) — the classic SoBase static, inherited and untouched.
  • static SoType getClassTypeId(void) — also inherited, also not ours.
  • static void addName(SoBase *const base, const char *const name) — yep, inherited.
  • static void removeName(SoBase *const base, const char *const name) — inherited too.
  • static void incrementCurrentWriteCounter(void) — inherited, still doing its counter thing.
  • static void decrementCurrentWriteCounter(void) — the matching decrement, also inherited.
  • static SoBase * getNamedBase(const SbName &name, SoType type) — inherited, no notes.
  • static int getNamedBases(const SbName &name, SoBaseList &baselist, SoType type) — inherited, no notes.
  • static SbBool read(SoInput *in, SoBase *&base, SoType expectedtype) — inherited, no notes.
  • static void setInstancePrefix(const SbString &c) — inherited, no notes.
  • static void setTraceRefs(SbBool trace) — inherited, no notes.
  • static SbBool getTraceRefs(void) — inherited, no notes.
  • static SbBool connectRoute(SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — inherited, no notes.
  • static SbBool readRoute(SoInput *in) — inherited, no notes.

🌸 Public Attributes 🌸

These are the ones that actually belong to this node, and they're the whole personality of it, honestly:

  • SoSFEnum lassoType — the field holding the lasso type. See LassoType below 👀
  • SoSFEnum lassoPolicy — the field holding the lasso policy. See LassoPolicy below 👀
  • SoSFEnum lassoMode — the field holding the lasso mode. See LassoMode below 👀

Public Attributes inherited from SoSelection

  • SoSFEnum policy

Public Attributes inherited from SoSeparator

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

🦋 Protected Member Functions 🦋

  • virtual const SoFieldData * getFieldData(void) const — yes, protected. Yes, virtual.
  • virtual ~SoExtSelection() — the destructor, protected and virtual, living its best private-ish life.

Protected Member Functions 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

Protected Member Functions inherited from SoSeparator

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

Protected Member Functions inherited from SoGroup

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

Protected Member Functions inherited from SoNode

  • SoNode(void)
  • virtual ~SoNode()

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer(void)
  • ~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 SoSelection

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

🫶 Friends 🫶

  • class SoExtSelectionP — the private-implementation bestie. Every icon needs one 💖

🌈 Additional Inherited Members 🌈

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

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

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

🎀 Detailed Description 🎀

The SoExtSelection 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 SoSelection node. (yes bestie, same callbacks, no extra homework)

The application programmer interface of this class is somewhat complex, due to it's non-trivial functionality. To see an extensive usage example of the SoExtSelection node, we advise you to go look at the "extselection" example application in the "nodes/" directory of Systems in Motion's SoGuiExamples CVS module. Further information and links for downloading and building this module should be available at www.coin3d.org.

This node class is an extension versus the original SGI Inventor v2.1 API. It is based on the API of TGS Inventor's SoExtSelection, and we aim to be fully compatible with this node to enable users to switch between using Coin and TGS Inventor. Please contact us if you find discrepancies between Coin's SoExtSelection and TGS's SoExtSelection node. (so if something's giving mismatched energy, tell them fr fr)

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 type of lasso selection. vibe check on how you're lassoing ✨

Enumerator

  • NOLASSO — Makes this node behave like a normal SoSelection node. (it's literally just cosplaying as its parent, iconic)
  • LASSO — Select objects using a lasso. Selections can be aborted by the end-user by hitting the END key on the keyboard.
  • RECTANGLE — Select objects using a rectangle. Selections can be aborted by the end-user by hitting the END key on the keyboard.
Both LASSO and RECTANGLE give the end-user an escape hatch: smash the END key and the selection gets aborted. 🛑

enum SoExtSelection::LassoPolicy

Enum for specifying how objects are selected. the how of it all 🧚

Enumerator

  • 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 selection mode. the which ones of it all 🍓

Enumerator

  • ALL_SHAPES — All primitives inside the lasso/rectangle will be selected.
  • VISIBLE_SHAPES — All visible primitives inside the lasso/rectangle will be selected.

🌟 Constructor & Destructor Documentation 🌟

SoExtSelection::SoExtSelection(void)

Constructor.

References ALL_SHAPES, FULL, FULL_BBOX, LASSO, lassoMode, lassoPolicy, lassoType, NOLASSO, PART, PART_BBOX, RECTANGLE, SoExtSelection(), and VISIBLE_SHAPES.

Referenced by getFieldData(), and SoExtSelection().

(look at it referencing literally every enum value it knows — main character energy for real 💅)

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

Destructor.

✨ Member Function Documentation ✨

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

Okay bestie, this one returns the type identification of an object derived from a class inheriting SoBase. It's used for run-time 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
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

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

Reimplemented from SoSelection.

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

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

Reimplemented from SoSelection.

References SoExtSelection().

void SoExtSelection::useOverlay (SbBool overlay = 1)

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

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.

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. Will always return NULL in Coin, as this method has been obsoleted. 😭

(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.)

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.

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 = 1)

Sets whether the lasso should be animated by scrolling the line pattern. 🌀

SbBool SoExtSelection::isOverlayLassoAnimated (void )

Returns whether the lasso is set to animate or not.

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

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 overrides this method.

Reimplemented from SoSelection.

References SoHandleEventAction::getEvent(), SoSelection::handleEvent(), SoSeparator::handleEvent(), SoHandleEventAction::isHandled(), LASSO, lassoType, NOLASSO, RECTANGLE, SoBase::touch(), and SoEvent::wasShiftDown().

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 (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.

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

Reimplemented from SoSeparator.

References SoGLRenderAction::addDelayedPath(), SoPath::copy(), SoAction::getCurPath(), SoAction::getState(), SbViewportRegion::getViewportOriginPixels(), SbViewportRegion::getViewportSizePixels(), SoNode::GLRenderBelowPath(), SoGLRenderAction::isRenderingDelayedPaths(), SoState::pop(), and SoState::push().

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

Simulate lasso selection programmatically.

This function is currently just stubbed.

Since: Coin 2.5

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

Simulate lasso selection programmatically.

This function is currently just stubbed.

Since: Coin 2.5

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

Returns lasso coordinates in device coordinates.

This function is currently just stubbed.

Since: Coin 2.5

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

Returns lasso coordinates in world coordinates.

This function is currently just stubbed.

Since: Coin 2.5

const SoPathList & SoExtSelection::getSelectionPathList (void ) const

Returns a pathlist containing selected objects.

This function is currently just stubbed.

Since: Coin 2.5

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

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. SoExtSelection will ref() and unref() it. 🫶

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 pass 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.

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. This is 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. Referenced by handleEvent(), and SoExtSelection().
  • SoSFEnum SoExtSelection::lassoPolicy — Field for lasso policy. Default value is FULL_BBOX. Referenced by SoExtSelection().
  • 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. Referenced by SoExtSelection().

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code.

And that's the whole vibe, bestie! 💖 This footer is giving Coin, Version 2.5.0, page SoExtSelection(3) — no date on this one, just version energy and main character manual-page behavior. Slay. 💅✨🦋

📦 where this page comes from