SoMFEnum(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoMFEnum 💖

okay bestie, buckle up — this one's from the Coin Library Functions Manual, and it's literally the blueprint for enum-shaped multivalue fields. no cap. ✨

🎀 NAME 🎀

SoMFEnum — the class that's a container for a set of enumerated values. she holds enum vibes only. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoMFEnum.h>

She inherits SoMField.

She's inherited by SoMFBitMask. (yes she's a mother. main character energy. 👑)

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoMFEnum & operator= (const SoMFEnum &field)
  • virtual SbBool isSame (const SoField &field) const
  • int operator[] (const int idx) const
  • const int * getValues (const int start) const
  • int find (int value, SbBool addifnotfound=0)
  • void setValues (const int start, const int num, const int *newvals)
  • void set1Value (const int idx, int value)
  • void setValue (int value)
  • int operator= (int val)
  • SbBool operator== (const SoMFEnum &field) const
  • SbBool operator!= (const SoMFEnum &field) const
  • int * startEditing (void)
  • void finishEditing (void)
  • void setValue (const SbName name)
  • void set1Value (const int idx, const SbName name)
  • void setEnums (const int num, const int *const values, const SbName *const names)
  • int getNumEnums (void) const
  • int getEnum (const int idx, SbName &name) const

💫 Public Member Functions inherited from SoMField 💫

  • virtual ~SoMField ()
  • int getNum (void) const
  • void setNum (const int num)
  • virtual void deleteValues (int start, int num=-1)
  • virtual void insertSpace (int start, int num)
  • SbBool set1 (const int index, const char *const valuestring)
  • void get1 (const int index, SbString &valuestring)
  • virtual void enableDeleteValues (void)
  • virtual SbBool isDeleteValuesEnabled (void)

🦋 Public Member Functions inherited from SoField 🦋

  • virtual ~SoField ()
  • void setIgnored (SbBool ignore)
  • SbBool isIgnored (void) const
  • void setDefault (SbBool def)
  • SbBool isDefault (void) const
  • SbBool isOfType (const SoType type) const
  • void enableConnection (SbBool flag)
  • SbBool isConnectionEnabled (void) const
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0)
  • void disconnect (SoEngineOutput *engineoutput)
  • SbBool isConnectedFromEngine (void) const
  • SbBool getConnectedEngine (SoEngineOutput *&master) const
  • SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0)
  • SbBool appendConnection (SoField *master, SbBool notnotify=0)
  • void disconnect (SoField *field)
  • SbBool isConnectedFromField (void) const
  • SbBool getConnectedField (SoField *&master) const
  • int getNumConnections (void) const
  • int getForwardConnections (SoFieldList &slavelist) const
  • int getConnections (SoFieldList &masterlist) const
  • void disconnect (void)
  • SbBool isConnected (void) const
  • void setContainer (SoFieldContainer *cont)
  • SoFieldContainer * getContainer (void) const
  • SbBool set (const char *valuestring)
  • void get (SbString &valuestring)
  • SbBool shouldWrite (void) const
  • virtual void touch (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *nlist)
  • SbBool enableNotify (SbBool on)
  • SbBool isNotifyEnabled (void) const
  • void addAuditor (void *f, SoNotRec::Type type)
  • void removeAuditor (void *f, SoNotRec::Type type)
  • int operator== (const SoField &f) const
  • int operator!= (const SoField &f) const
  • virtual void connectionStatusChanged (int numconnections)
  • SbBool isReadOnly (void) const
  • virtual void fixCopy (SbBool copyconnections)
  • virtual SbBool referencesCopy (void) const
  • void copyConnection (const SoField *fromfield)
  • virtual SbBool read (SoInput *in, const SbName &name)
  • virtual void write (SoOutput *out, const SbName &name) const
  • virtual void countWriteRefs (SoOutput *out) const
  • void setFieldType (int type)
  • int getFieldType (void) const
  • SbBool getDirty (void) const
  • void setDirty (SbBool dirty)
  • void evaluate (void) const

⭐ Static Public Member Functions ⭐

  • static void * createInstance (void)
  • static SoType getClassTypeId (void)
  • static void initClass (void)

🌈 Static Public Member Functions inherited from SoMField 🌈

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

💜 Static Public Member Functions inherited from SoField 💜

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)

🎀 Protected Member Functions 🎀

  • virtual void deleteAllValues (void)
  • virtual void copyValue (int to, int from)
  • virtual int fieldSizeof (void) const
  • virtual void * valuesPtr (void)
  • virtual void setValuesPtr (void *ptr)
  • virtual void allocValues (int num)
  • virtual SbBool findEnumValue (const SbName &name, int &value)
  • virtual SbBool findEnumName (int value, const SbName *&name) const

🧚 Protected Member Functions inherited from SoMField 🧚

  • SoMField (void)
  • virtual void makeRoom (int newnum)

🍓 Protected Member Functions inherited from SoField 🍓

  • SoField (void)
  • void valueChanged (SbBool resetdefault=1)
  • virtual void evaluateConnection (void) const
  • virtual SbBool readConnection (SoInput *in)
  • virtual void writeConnection (SoOutput *out) const
  • SbBool isDestructing (void) const

👑 Protected Attributes 👑

  • int * values
  • SbBool legalValuesSet
  • int numEnums
  • int * enumValues
  • SbName * enumNames

🌸 Protected Attributes inherited from SoMField 🌸

  • int num
  • int maxNum
  • SbBool userDataIsUsed

✨ Additional Inherited Members ✨

🦄 Public Types inherited from SoField 🦄

enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD, EXPOSED_FIELD }

💖 Detailed Description 💖

The SoMFEnum class is a container for a set of enumerated values.

This field is used where nodes, engines or other field containers needs to store values constrained to be from an enumerated set.

A field of this type stores its values to file as the symbolic names, rather than the actual integer values. (so when you open that file it says the name, not the number. iconic behaviour honestly. 📝)

See also

  • SoSFEnum, SoMFBitMask

🔥 Member Function Documentation 🔥

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also

  • getClassTypeId(), SoType

Implements SoField.

Reimplemented in SoMFBitMask.

void SoMFEnum::copyFrom (const SoField & f) [virtual]

Copy value(s) from f into this field. f must be of the same type as this field. (no mixing, bestie — she's picky and honestly? valid. 💅)

Implements SoField.

Reimplemented in SoMFBitMask.

SbBool SoMFEnum::isSame (const SoField & f) const [virtual]

Check for equal type and value(s).

Implements SoField.

Reimplemented in SoMFBitMask.

void SoMFEnum::deleteAllValues (void ) [protected], [virtual]

🫶 heads up: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoMField.

void SoMFEnum::copyValue (int to, int from) [protected], [virtual]

This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy contructors where necessary.

Implements SoMField.

References enumNames, enumValues, legalValuesSet, and numEnums.

const int * SoMFEnum::getValues (const int start) const [inline]

Returns a pointer to the values array.

References findEnumName(), findEnumValue(), getEnum(), getNumEnums(), SoMField::num, and setEnums().

void SoMFEnum::setValue (const SbName name)

Set this field to contain a single value by specifying an enumeration string. (name it, don't number it ✨)

References findEnumValue(), SbName::getString(), and SoDebugError::post().

void SoMFEnum::set1Value (const int idx, const SbName name)

Set the value at idx to the enumeration value represented by name.

References findEnumValue(), SbName::getString(), and SoDebugError::post().

void SoMFEnum::setEnums (const int numarg, const int *const vals, const SbName *const names)

Makes a set of num enumeration names map to vals.

References enumNames, enumValues, legalValuesSet, and numEnums.

Referenced by getValues().

int SoMFEnum::getNumEnums (void ) const

Returns the number of enum names the SoSFEnum object understands.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. (so don't go looking for it in the old-school docs, bestie 🙈)

Since

  • Coin 2.0

References numEnums.

Referenced by getValues().

int SoMFEnum::getEnum (const int idx, SbName & name) const

Returns the value of the Nth enum this SoSFEnum object understands, and mutates name to contain the Nth enum's name.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

  • Coin 2.0

References enumNames, enumValues, numEnums, and SoDebugError::post().

Referenced by getValues().

SbBool SoMFEnum::findEnumValue (const SbName & name, int & val) [protected], [virtual]

Return in val the enumeration value which matches the given enumeration name.

Returns TRUE if name is a valid enumeration string, otherwise FALSE.

References enumNames, enumValues, and numEnums.

Referenced by getValues(), set1Value(), and setValue().

SbBool SoMFEnum::findEnumName (int value, const SbName *& name) const [protected], [virtual]

Set the enumeration name which matches the given enumeration value.

Returns TRUE if value is a valid enumeration value, otherwise FALSE.

References enumNames, enumValues, and numEnums.

Referenced by getValues().

🌈 Member Data Documentation 🌈

SbBool SoMFEnum::legalValuesSet [protected]

Is TRUE if a set of enum name-to-value mappings has been set.

Referenced by copyValue(), and setEnums().

int SoMFEnum::numEnums [protected]

Number of enumeration mappings.

Referenced by copyValue(), findEnumName(), findEnumValue(), getEnum(), getNumEnums(), and setEnums().

int* SoMFEnum::enumValues [protected]

Array of enumeration values. Maps 1-to-1 with the enumNames. (they're a matched set, fr fr 🫶)

Referenced by copyValue(), findEnumName(), findEnumValue(), getEnum(), and setEnums().

SbName* SoMFEnum::enumNames [protected]

Array of enumeration names. Maps 1-to-1 with the enumValues.

Referenced by copyValue(), findEnumName(), findEnumValue(), getEnum(), and setEnums().

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code.

that's the whole page bestie, every flag, every reference, every protected lil attribute — nothing skipped, nothing invented. periodt. 💅✨

signing off from the Coin era, Version 2.5.0 — and yes, the page number is SoMFEnum(3), because that's the whole vibe. mwah. 🦋💖

📦 where this page comes from