SoPickStyle(3)

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

✨ NAME ✨

SoPickStyle — okay so this is the Coin node that sets up how picking works. The manual name is SoPickStyle(3), and yes bestie, this is that page. The SoPickStyle class is a node for setting up how to do picking. periodt.

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoPickStyle.h>

Inherits SoNode.

👑 Public Types 👑

  • enum Style { SHAPE = SoPickStyleElement::SHAPE, BOUNDING_BOX = SoPickStyleElement::BOUNDING_BOX, UNPICKABLE = SoPickStyleElement::UNPICKABLE, SHAPE_ON_TOP = SoPickStyleElement::SHAPE_ON_TOP, BOUNDING_BOX_ON_TOP = SoPickStyleElement::BOUNDING_BOX_ON_TOP, SHAPE_FRONTFACES = SoPickStyleElement::SHAPE_FRONTFACES } — the whole style enum, your pick-style menu.

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 } — inherited node type flags, not your fave but part of the family.

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const — gets the type id, the whole identity check.
  • SoPickStyle (void) — constructor, the birth of a pick style node.
  • virtual void doAction (SoAction *action) — does the action thing.
  • virtual void callback (SoCallbackAction *action) — callback action handling.
  • virtual void pick (SoPickAction *action) — pick action handling, the main character of this node.

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 SbBool affectsState (void) const
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • SbUniqueId getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • 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 — Returns TRUE if the type of this object is either of the same type or inherited from type. So bestie, it's the type-checking vibe.
  • 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. Yes, it's the setup era.

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)

Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • static void 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)

Static Public Member Functions inherited from SoBase

  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static 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 🎀

  • SoSFEnum style — the style field, the whole vibe selector.

🦋 Protected Member Functions 🦋

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

Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

Protected Member Functions inherited from SoBase

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const
  • virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions ⭐

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

🌈 Additional Inherited Members 🌈

Protected Types inherited from SoBase

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

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 SoPickStyle is literally the node that sets up how picking goes down. That's its whole job.

By default, every single bit of geometry in a scene is available for picking. But when you're writing applications with interaction possibilities, that's often not the vibe you want. To yeet parts of the scene graph out of pick actions, use SoPickStyle::UNPICKABLE.

You can also optimize pick operations by using the SoPickStyle::BOUNDING_BOX pick style. Optimize, bestie.

FILE FORMAT/DEFAULTS:

PickStyle {
    style SHAPE
}

🌸 See also 🌸

  • SoRayPickAction — go read that one too, iykyk.

✨ MEMBER ENUMERATION DOCUMENTATION ✨

🦋 enum SoPickStyle::Style

This enum is the enumeration of the available picking strategies, bestie. Obsessed. 💅

🌈 Enumerator

  • SHAPE — Does the "exact" picks, like finding the correct intersection point(s) and all that jazz. No cap, it's precise. ✨
  • BOUNDING_BOX — Only compares the pick intersection with the bounding boxes of shapes. This is usually much faster than SoPickStyle::SHAPE, like lowkey speedrun mode. 🏎️
  • UNPICKABLE — The geometry that follows this node in the scene will not be available for picking. Like, it's invisible to picks. Nope, not today. 🙈
  • SHAPE_ON_TOP — Does exact picks, just like SHAPE, but it sorts the shape to the front of the list of picked points so it appears to be the frontmost item. This does not affect the SoPickedPoint pick coordinate though, just the sorting by depth done on the picked point list. Main character energy, but only for sorting. 👑

Since Coin 3.0

  • BOUNDING_BOX_ON_TOP — Does picks against the enclosing bounding box of the object, like BOUNDING_BOX, but sorts the shape to the front of the list of picked points so it appears to be the frontmost item. This does not affect the SoPickedPoint pick coordinate though, just the sorting by depth done on the picked point list. Same fronting vibe, but with bounding boxes. 📦

Since Coin 3.0

  • SHAPE_FRONTFACES — Does exact picks, like SHAPE, but culls all the backface intersections from the list. Note that this logic is relative to the ray, not the view, in case the ray and the view direction are not aligned. So it's all about the ray's perspective, bestie. 🌟

The behaviour of this setting will also depend on the SoShapeStyle vertexOrdering and shapeType setting, which are used to flip front faces to become back faces and vice versa and to turn backface culling on and off. So yeah, it's a whole team effort. 💖

Since Coin 3.0

🎀 Constructor & Destructor Documentation

💖 SoPickStyle::SoPickStyle (void )

Constructor. Like, it makes the thing. Periodt.

🫶 SoPickStyle::~SoPickStyle () [protected], [virtual]

Destructor. It cleans up. Bye bestie, thanks for the memories. ✨

🌸 Member Function Documentation

⭐ SoType SoPickStyle::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. It's the class's ID card, basically. 💅

💜 SoType SoPickStyle::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. So you can check what's what at runtime. Implements SoBase. 🔥

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

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So like, don't worry about it unless you're deep in the source. It returns the SoFieldData class which holds information about fields in this node. 🤫

🍓 const SoFieldData * SoPickStyle::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 SoFieldContainer. So it's the field data hookup. 🌸

🌈 void SoPickStyle::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. It's the default action behavior. Reimplemented from SoNode. ✨

🦋 void SoPickStyle::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Reimplemented from SoNode. So it's all about keeping things in sync for callbacks. 💖

👑 void SoPickStyle::pick (SoPickAction * action) [virtual]

Action method for SoPickAction. Does common processing for SoPickAction action instances. Reimplemented from SoNode. So it handles the shared pick logic. 🔥

💎 Member Data Documentation

🌟 SoSFEnum SoPickStyle::style

Which strategy to use for the picking actions for subsequent shapes in the scene graph. Default value is SoPickStyle::SHAPE. So you set this and it decides how picks go down. Default is exact picks, no cap. 💅

👑 Author

Generated automatically by Doxygen for Coin from the source code.

And that's the whole vibe, bestie! This page was auto-generated by Doxygen for Coin from the source code, version 4.0.10, on Thu Jun 25 2026 00:00:00. SoPickStyle(3) out. Stay slaying. 💖✨🦋

📦 where this page comes from