SoExtSelection(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– NAME πŸ’–

SoExtSelection β€” bestie, this is the class that unlocks extended selection functionality. It's giving selection, but make it ✨extra✨. πŸŽ€


🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoExtSelection.h>

Inherits SoSelection. So yeah, everything SoSelection can do, this baby can do too. Periodt. πŸ‘‘

πŸ¦‹ Public Types

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 }

πŸ’œ 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 }

🫢 Public Member Functions

Okay so these are her own functions, the main character ones: πŸ’…

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

🌈 Public Member Functions inherited from SoSelection

She got it from her mama. Here's the whole family tree, no skips:

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

🌈 Public Member Functions inherited from SoNode

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

🌈 Public Member Functions inherited from SoFieldContainer

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

🌈 Public Member Functions inherited from SoBase

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

⭐ Static Public Member Functions

The ones you call on the class itself, not on an instance. Very "I don't need a relationship, I have me" energy: πŸ’…

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

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

okay that's the whole API surface for part 1 bestie, and there's more coming so don't go anywhere πŸ’–

✨ Static Public Member Functions inherited from SoBase

Okay so these are the static goodies you get for free from SoBase β€” all of them, no gatekeeping:

  • static void initClass (void) β€” sets the class up, does the whole registration thing.
  • static SoType getClassTypeId (void) β€” hands you the type id for this class.
  • static void addName (SoBase *const base, const char *const name) β€” slaps a name onto a base object.
  • static void removeName (SoBase *const base, const char *const name) β€” takes that name right back off.
  • static void incrementCurrentWriteCounter (void) β€” bumps the current write counter up.
  • static void decrementCurrentWriteCounter (void) β€” and bumps it back down.
  • static SoBase * getNamedBase (const SbName &name, SoType type) β€” finds a base by its name and type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) β€” collects all the matching named bases into a list.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) β€” reads a base in from input.
  • static void setInstancePrefix (const SbString &c) β€” sets the instance prefix string.
  • static void setTraceRefs (SbBool trace) β€” turns reference tracing on or off.
  • static SbBool getTraceRefs (void) β€” tells you if reference tracing is on.
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) β€” wires up a route between two fields.
  • static SbBool readRoute (SoInput *input) β€” reads a route in from input.

🌸 Public Attributes

These are your main character fields, bestie:

  • SoSFEnum lassoType β€” the field holding the lasso type.
  • SoSFEnum lassoPolicy β€” the field holding the lasso policy.
  • SoSFEnum lassoMode β€” the field holding the lasso mode.

Public Attributes inherited from SoSelection

  • SoSFEnum policy β€” the selection policy field.

Public Attributes inherited from SoSeparator

  • SoSFEnum renderCaching β€” render caching mode.
  • SoSFEnum boundingBoxCaching β€” bounding box caching mode.
  • SoSFEnum renderCulling β€” render culling mode.
  • SoSFEnum pickCulling β€” pick culling mode.

πŸŽ€ Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const β€” returns the field data for this class.
  • virtual ~SoExtSelection () β€” the destructor.

Protected Member Functions inherited from SoSelection

  • virtual ~SoSelection () β€” destructor.
  • void invokeSelectionPolicy (SoPath *path, SbBool shiftDown) β€” runs the selection policy for a path.
  • void performSingleSelection (SoPath *path) β€” does a single selection on that path.
  • void performToggleSelection (SoPath *path) β€” toggles the selection on that path.
  • SoPath * copyFromThis (const SoPath *path) const β€” copies a path from this node.
  • void addPath (SoPath *path) β€” adds a path to the selection.
  • void removePath (const int which) β€” removes the path at that index.
  • int findPath (const SoPath *path) const β€” finds a path and gives you its index.

Protected Member Functions inherited from SoSeparator

  • virtual ~SoSeparator () β€” destructor.
  • virtual SbBool cullTest (SoState *state) β€” runs the cull test for a state.
  • virtual SbBool cullTest (SoGLRenderAction *action, int &cullresults) β€” runs the cull test for a render action.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) β€” reads an instance in from input.

Protected Member Functions inherited from SoGroup

  • virtual ~SoGroup () β€” destructor.
  • virtual SbBool readChildren (SoInput *in) β€” reads the children in.
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) β€” copies contents over, optionally with connections.

Protected Member Functions inherited from SoNode

  • SoNode (void) β€” constructor.
  • virtual ~SoNode () β€” destructor.

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) β€” constructor.
  • virtual ~SoFieldContainer () β€” destructor.

Protected Member Functions inherited from SoBase

  • SoBase (void) β€” constructor.
  • virtual ~SoBase () β€” destructor.
  • virtual void destroy (void) β€” destroys the thing.
  • SbBool hasMultipleWriteRefs (void) const β€” checks whether there are multiple write refs.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const β€” writes the header out.
  • void writeFooter (SoOutput *out) const β€” writes the footer out.
  • virtual const char * getFileFormatName (void) const β€” gives you the file format name.

πŸ’œ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) β€” returns a pointer to the field data pointer.

Static Protected Member Functions inherited from SoSelection

  • static const SoFieldData ** getFieldDataPtr (void) β€” same deal, for SoSelection.

Static Protected Member Functions inherited from SoSeparator

  • static const SoFieldData ** getFieldDataPtr (void) β€” and for SoSeparator.

Static Protected Member Functions inherited from SoGroup

  • static const SoFieldData ** getFieldDataPtr (void) β€” and for SoGroup.

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) β€” and for SoNode.
  • static void setNextActionMethodIndex (int index) β€” sets the next action method index.
  • static int getNextActionMethodIndex (void) β€” gets the next action method index.
  • static void incNextActionMethodIndex (void) β€” increments the next action method index.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) β€” sets the compatibility types for a node type and bitmask.

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) β€” returns the current write counter.
  • static void staticDataLock (void) β€” locks the static data.
  • static void staticDataUnlock (void) β€” unlocks the static data.

πŸ¦‹ Additional Inherited Members

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } β€” the base flags enum.

Protected Attributes inherited from SoSelection

  • SoPathList selectionList β€” the list of selected paths.
  • SoCallbackList * selCBList β€” the selection callback list.
  • SoCallbackList * deselCBList β€” the deselection callback list.
  • SoCallbackList * startCBList β€” the start callback list.
  • SoCallbackList * finishCBList β€” the finish callback list.
  • SoSelectionPickCB * pickCBFunc β€” the pick callback function.
  • void * pickCBData β€” the data for that pick callback.
  • SbBool callPickCBOnlyIfSelectable β€” whether to only call the pick callback if the thing is selectable.
  • SoCallbackList * changeCBList β€” the change callback list.
  • SoPath * mouseDownPickPath β€” the path picked on mouse down.
  • SbBool pickMatching β€” pick matching flag.

Protected Attributes inherited from SoGroup

  • SoChildList * children β€” the child list.

Protected Attributes inherited from SoNode

  • uint32_t uniqueId β€” this node's unique id.

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn β€” whether it's built in.

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 β€” the next unique id, starting at 1.
  • static int nextActionMethodIndex = 0 β€” the next action method index, starting at 0.

πŸ‘‘ Detailed Description

So the SoExtSelection class is literally your girl for extended selection functionality. Periodt.

This class lets you select geometry by specifying a lasso (a polygon) or a rectangle on screen. And when stuff gets selected? You receive the same callbacks as for the SoSelection node. No cap. πŸ’…

The application programmer interface of this class is somewhat complex β€” like, highkey non-trivial, because it's doing non-trivial stuff. If you want to see an extensive usage example of the SoExtSelection node, the manual is being so real with you: go look at the "extselection" example application in the "nodes/" directory of the Kongsberg Oil & Gas Technologies SoGuiExamples CVS module. Further info and links for downloading and building that module should be available at www.coin3d.org.

This node class is an extension versus the original SGI Inventor v2.1 API. It's based on the API of TGS Inventor's SoExtSelection, and the goal is to be fully compatible with this node so users can switch between using Coin and TGS Inventor. And if you find discrepancies between Coin's SoExtSelection and TGS's SoExtSelection node β€” please contact them. 🫢

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. Obsessed with the options honestly:

  • NOLASSO β€” makes this node behave like a normal SoSelection node. Just chilling.
  • 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. And yeah, selections can also be aborted by the end-user by hitting the END key on the keyboard.

enum SoExtSelection::LassoPolicy

Enum for specifying how objects are selected. It's giving very ✨precise✨:

  • 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.
  • VISIBLE_SHAPES β€” all visible primitives inside the lasso/rectangle will be selected.

🧚 Constructor & Destructor Documentation

SoExtSelection::SoExtSelection (void )

Constructor. Hi bestie, you're alive now. πŸ’–

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

Destructor. Bye bestie. πŸ¦‹

πŸ’… Member Function Documentation πŸ’…

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

okay bestie, this one is the type-identification queen πŸ‘‘ It returns the type identification of an object derived from a class inheriting SoBase. This is 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
  }
}

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. periodt πŸ’…


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


void SoExtSelection::useOverlay (SbBool overlay = TRUE)

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. no cap πŸ’€


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.) lowkey internal vibes only πŸ™ˆ


void SoExtSelection::setOverlayLassoColorIndex (const int index)

Obsoleted in Coin, use SoExtSelection::setLassoColor() instead. bestie it's giving deprecated πŸ’…


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

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. πŸ”₯


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. periodt πŸ’…


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

Simulate lasso selection programmatically.

This function is currently just stubbed. 😭


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

Simulate lasso selection programmatically.

This function is currently just stubbed. 😭


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

Returns lasso coordinates in device coordinates.

This function is currently just stubbed. πŸ’€


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

Returns lasso coordinates in world coordinates.

This function is currently just stubbed. πŸ’€


const SoPathList & SoExtSelection::getSelectionPathList () const

Returns a pathlist containing selected objects.

This function is 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 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. iykyk πŸ’…


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. bestie that's your emergency exit πŸšͺ


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 me being auto-generated fr fr πŸ€–


okay bestie that's the whole iconic page πŸ’– this was generated automatically by Doxygen for Coin from the source code, and it's stamped as Coin Version 3.1.3, the SoExtSelection(3) manpage β€” mwah πŸ’‹ periodt.

πŸ“¦ where this page comes from