SoSelectOne(3)

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

💖 SoSelectOne 💖

okay bestie, gather round, because we're reading SoSelectOne(3) from the Coin manual (that's section 3, the library-functions section, iykyk) and honestly? it's giving "tiny engine, big personality". no cap. let's get into it 💅

✨ NAME ✨

SoSelectOne — the class that picks one value out of a whole set of values. one (1) single value. out of a set. iconic behaviour, fr fr 🎀

🌸 SYNOPSIS 🌸

#include <Inventor/engines/SoSelectOne.h>

Inherits SoEngine.

👑 Public Member Functions

  • virtual SoType getTypeId (void) const — hands you the type ID of an object that inherits from SoBase. it's the thing you use for runtime type checking and "downward" casting. (that little quote mark situation is literally how it's written, bestie, i'm not fixing it 🙈)
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • SoSelectOne (SoType inputtype)

🦋 Public Member Functions inherited from SoEngine

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (const SbName &outputname) const
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
  • SbBool isNotifying (void) const
  • virtual void notify (SoNotList *nl)
  • SoEngine * copy (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const
  • SbBool shouldCopy (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 the same type, or inherited from type.
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • virtual void startNotify (void)
  • 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 * createInstance (void)
  • static void initClass (void) — sets up the initialization for data shared by every instance of this class, like submitting the necessary info to the Coin type system. the whole "get your paperwork in order" moment 🫶

🌸 Static Public Member Functions inherited from SoEngine

  • static void initClass (void) — sets up the initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • static SoEngine * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoEngineList &el)

🎀 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

  • SoSFInt32 index
  • SoMField * input
  • SoEngineOutput * output

🦋 Static Protected Member Functions

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

💫 Static Protected Member Functions inherited from SoEngine

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

✨ 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 Member Functions inherited from SoEngine

  • SoEngine (void)
  • virtual ~SoEngine (void)
  • virtual void inputChanged (SoField *which)
  • void writeOutputTypes (SoOutput *out)

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

Protected Member Functions inherited from SoBase

  • SoBase (void)
  • virtual ~SoBase ()
  • 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)

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🦋 Detailed Description 🦋

okay so the whole point of SoSelectOne: it selects one value from a set of values. that's the vibe. 💫

the output field is literally the index'th value of the input multivalue field. that's it. that's the whole job. she's a specialist, not a generalist 👑

now listen closely bestie, because this next bit is the part that makes SoSelectOne lowkey different from her engine sisters: this engine's output field deviates a little from the "standard" output mechanism that the majority of engine classes use. the SoSelectOne::output is not a permanent SoEngineOutput instance — it's a pointer to a SoEngineOutput instance. and why?? because the output field has to be allocated dynamically so it can match whatever SoSelectOne::input is connected to, since the type of SoSelectOne::output should always be the same as the type of SoSelectOne::input. it's giving "we match energies" and honestly? respect. 😌

the file format for this field is a bit special too — peep the leading type specification, which is not necessary for most other field types:

SelectOne {
  type <multivaluefieldtype>
  [...fields...]
}

🛠 Constructor & Destructor Documentation 🛠

SoSelectOne::SoSelectOne (SoType inputtype)

constructor! it sets the type of the input field. heads up though: the input field must be of type SoMField. no exceptions, no wiggle room, that's the rule 📏

💅 Member Function Documentation 💅

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

returns the type identification of an object derived from a class inheriting SoBase. this is what you use for runtime type checking and "downward" casting. usage example, so you can see it in the wild:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

and for the application programmers out there who want to extend the library with new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. typically you do that as part of setting up the full type system for your extension classes, which is usually accomplished by using the predefined 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 info on writing Coin extensions, go read the class documentation of the top level superclasses for the various class groups. 💖

Implements SoBase.

virtual const SoFieldData * SoSelectOne::getFieldData (void ) const [virtual]

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

Reimplemented from SoFieldContainer.

virtual const SoEngineOutputData * SoSelectOne::getOutputData (void ) const [virtual]

ngl, this API member is considered internal to the library — it's not likely to be of interest to the application programmer. it's a backstage pass, not a main stage moment 🎭

Implements SoEngine.

🍓 Member Data Documentation 🍓

SoSFInt32 SoSelectOne::index

the index of the value from the input field that's gonna get put on the output. that's the one she's picking 👉👈

SoMField* SoSelectOne::input

the multivalue input field that we'll be selecting a single value from for our output. she's the whole buffet, index is the plate 🍽️

SoEngineOutput* SoSelectOne::output

(SoSField) this is the singlevalue field output containing the index'th value of SoSelectOne::input.

and of course the type of the field will match the type of the input field — so if SoSelectOne::input is an SoMFFloat, then SoSelectOne::output will be an SoSFFloat, etc. matching sets, always 💅✨

📝 Author 📝

Generated automatically by Doxygen for Coin from the source code. (not a human, just a very diligent robot doing its thing 🤖💖)

and that's the whole page, bestie!! this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you can find her filed under SoSelectOne(3). slay, go select exactly one (1) value, no more no less 💖✨🎀🦋

📦 where this page comes from