SoPickStyle(3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 SoPickStyle — the NAME section, bestie 🌸

okay so first things first: this is part of the Library Functions Manual, and the star of the show is SoPickStyle(3) — the SoPickStyle class. It's a node for setting up how to do picking. that's it, that's the whole vibe, but stick around because there's a LOT of inherited lore below 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoPickStyle.h>

Inherits SoNode. yes queen, it's part of the family tree 🫶

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

🦋 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

virtual SoType getTypeId (void) const
SoPickStyle (void)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)

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

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

🎀 Static Public Member Functions inherited from `SoBase`

static void initClass (void)
static SoType getClassTypeId (void)
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 one field this whole node is built around, no cap

🔥 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

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

uint32_t uniqueId

Protected Attributes inherited from `SoFieldContainer`

SbBool isBuiltIn

Static Protected Attributes inherited from `SoNode`

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

okay so, The SoPickStyle class is a node for setting up how to do picking. like that's literally its whole job and it does it flawlessly 💅

By default, all geometry in a scene is available for picking. lowkey iconic behaviour but also sometimes NOT the move. Upon writing applications with interaction possibilities, this is often not what you want. So if you need to exclude parts of the scene graph from pick actions, use the SoPickStyle::UNPICKABLE and thank yourself later, bestie 🫶

You can also optimize pick operations by using the SoPickStyle::BOUNDING_BOX pickstyle. speed? we have it ✨

FILE FORMAT/DEFAULTS:

PickStyle {
    style SHAPE
}

ngl the default is SHAPE — that's the vibe it ships with unless you say otherwise 🌸

👀 See also

SoRayPickAction

<div align="center">✨ and that's part 1, don't go anywhere because there is MORE ✨</div>

✨ Member Enumeration Documentation ✨

okay bestie, this is the enum lore and it's giving choices 🌈

🎀 enum `SoPickStyle::Style`

Enumeration of the available picking strategies.

🌸 Enumerator

SHAPE — Do "exact" picks, finding the correct intersection point(s), etc. precision queen 💅
BOUNDING_BOX — Only compare pick intersection with the bounding boxes of shapes. This is usually much faster than SoPickStyle::SHAPE. speedrun mode ⚡
UNPICKABLE — The geometry following this node in the scene will not be available for picking. hands off, bestie 🙈
SHAPE_ON_TOP — Do exact picks, like SHAPE, but sort 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 👑

Since: Coin 3.0

BOUNDING_BOX_ON_TOP — Do picks against the enclosing bounding box of the object, like BOUNDING_BOX, but sort 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. front of the line, no cap ✨

Since: Coin 3.0

SHAPE_FRONTFACES — Do exact picks, like SHAPE, but cull 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. frontfaces only, we don't do backface drama 💖

The behaviour of this setting will also depend on the SoShapeStyle vertexOrdering and shapeType setting, which are used to flip frontfaces to become backfaces and vice versa and to turn backface culling on and off.

Since: Coin 3.0

🛠️ Constructor & Destructor Documentation 🛠️

`SoPickStyle::SoPickStyle (void )`

Constructor. welcome to the world, little node 👶

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

Destructor. bye bye, clean up your mess 🧹

💖 Member Function Documentation 💖

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. iykyk 🪪

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.

Implements SoBase.

`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. no fields? NULL it is 🫥

Reimplemented from SoFieldContainer.

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

This function performs the typical operation of a node for any action. just doing node things ✨

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. callback cutie 📞

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances. pick me, pick me 💅

Reimplemented from SoNode.

📦 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. the one and only field, periodt 🌟

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. thanks Doxygen, bestie 🤖

That's the whole page, bestie! This footer situation says Coin, Version 3.1.3, manual page SoPickStyle(3) — and there's no date printed, so I'm not inventing one. Stay iconic, stay picked. 💖

📦 where this page comes from

fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoPickStyle(3)

🌸 SoPickStyle — the NAME section, bestie 🌸

✨ SYNOPSIS ✨

🌈 Public Types

🦋 Public Types inherited from SoNode

💖 Public Member Functions

🧚 Public Member Functions inherited from SoNode

💜 Public Member Functions inherited from SoFieldContainer

🍓 Public Member Functions inherited from SoBase

⭐ Static Public Member Functions

🌟 Static Public Member Functions inherited from SoNode

✨ Static Public Member Functions inherited from SoFieldContainer

🎀 Static Public Member Functions inherited from SoBase

👑 Public Attributes

🔥 Protected Member Functions

🌸 Protected Member Functions inherited from SoNode

🌈 Protected Member Functions inherited from SoFieldContainer

💀 Protected Member Functions inherited from SoBase

🧚 Static Protected Member Functions

🦋 Static Protected Member Functions inherited from SoNode

🍓 Static Protected Member Functions inherited from SoBase

💅 Additional Inherited Members

Protected Types inherited from SoBase

Protected Attributes inherited from SoNode

Protected Attributes inherited from SoFieldContainer

Static Protected Attributes inherited from SoNode

💖 Detailed Description 💖

👀 See also

✨ Member Enumeration Documentation ✨

🎀 enum SoPickStyle::Style

🌸 Enumerator

🛠️ Constructor & Destructor Documentation 🛠️

SoPickStyle::SoPickStyle (void )

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

💖 Member Function Documentation 💖

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

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

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

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

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

📦 Member Data Documentation 📦

SoSFEnum SoPickStyle::style

👑 Author 👑

🦋 Public Types inherited from `SoNode`

🧚 Public Member Functions inherited from `SoNode`

💜 Public Member Functions inherited from `SoFieldContainer`

🍓 Public Member Functions inherited from `SoBase`

🌟 Static Public Member Functions inherited from `SoNode`

✨ Static Public Member Functions inherited from `SoFieldContainer`

🎀 Static Public Member Functions inherited from `SoBase`

🌸 Protected Member Functions inherited from `SoNode`

🌈 Protected Member Functions inherited from `SoFieldContainer`

💀 Protected Member Functions inherited from `SoBase`

🦋 Static Protected Member Functions inherited from `SoNode`

🍓 Static Protected Member Functions inherited from `SoBase`

Protected Types inherited from `SoBase`

Protected Attributes inherited from `SoNode`

Protected Attributes inherited from `SoFieldContainer`

Static Protected Attributes inherited from `SoNode`

🎀 enum `SoPickStyle::Style`

`SoPickStyle::SoPickStyle (void )`

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

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

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

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

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

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

`SoSFEnum SoPickStyle::style`