SoSelectOne(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoSelectOne 💖

okay bestie, welcome to the SoSelectOne(3) glow-up — straight out of the Library Functions Manual and into ur brain 🧠✨. grab a boba, this one's short and slay.

🌸 NAME 🌸

SoSelectOne — the class that picks one value out of a whole set of values. it's giving "choose ur fighter" energy fr fr 👑

🦋 SYNOPSIS 🦋

#include <Inventor/engines/SoSelectOne.h>

it Inherits SoEngine — so all that engine rizz comes with it, no cap.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • 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
  • 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)

💖 Static Public Member Functions inherited from SoEngine

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

  • 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
  • Protected Attributes inherited from SoFieldContainer
    • SbBool isBuiltIn

✨ Detailed Description ✨

so like. SoSelectOne is the class u use to select one value from a set of values. that's the whole vibe 🫶

the output field will be the index'th value of the input multivalue field. literally just "gimme number index from that list" 💅

⚠️ okay important lil plot twist: this engine's output field deviates a little from the "standard" output mechanism that basically every other engine class uses. SoSelectOne::output is not a permanent SoEngineOutput instance — it's a pointer to a SoEngineOutput instance. why?? because it's necessary to allocate the output field dynamically to make it match what SoSelectOne::input is connected to, since the type of SoSelectOne::output should always be the same as the type of SoSelectOne::input. matching fits, periodt 👯

the file format for this field is a bit special too. note 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, bestie. it Sets the type of the input field. and the input field must be of type SoMField — that part is not optional, no cap 🚨

🎀 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 used for run-time type checking and "downward" casting. very main character of it ✨

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. iykyk 🧠

for more information on writing Coin extensions, see the class documentation of the toplevel 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. shrug, empty is empty 🙈

Reimplemented from SoFieldContainer.

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

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like, stay in ur lane bestie, it's fine 💅

Implements SoEngine.

🍓 Member Data Documentation 🍓

🌸 SoSFInt32 SoSelectOne::index 🌸

Index of the value from the input field which will be put on the output. ur lil picker-upper 🎯

🌸 SoMField* SoSelectOne::input 🌸

The multivalue input field which we will select a single value from for our output. the whole squad, and ur picking exactly one 🫶

🌸 SoEngineOutput* SoSelectOne::output 🌸

(SoSField) this is the singlevalue field output containing the index'th value of SoSelectOne::input. it's giving "one winner, everyone else go home" 👑

the type of the field will of course match the type of the input field, i.e. if SoSelectOne::input is an SoMFFloat, SoSelectOne::output will be an SoSFFloat etc. twinning fr fr 👯💖

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code. not me getting autogenerated by a doc tool, iconic behavior 😭✨

and that's the whole page bestie 💅 this one came from Coin, Version 3.1.3, and yeah it's SoSelectOne(3) — go select something slay 🔥🌈🦋

📦 where this page comes from