SOMFNAME(3iv)

🌸 SoMFName — the multiple-value field that holds ALL the names 💖

okay bestie, welcome to SoMFName(3IV) — yes that's the manual page name, we're not copying the whole header line, we're just vibing with it up here at the top 🎀

---

✨ NAME ✨

SoMFName — a multiple-value field containing any number of names 🦋

---

🧬 INHERITS FROM

SoField > SoMField > SoMFName

(it's giving legacy, it's giving dynasty, it's giving family tree 👑)

---

📜 SYNOPSIS 📜

#include <Inventor/fields/SoMFName.h>

💫 Methods from class SoMFName

void                setValues(int start, int num, const char *strings[])
void                setValue(const char *string)
static SoType       getClassTypeId()
virtual void        getTypeId() const
const SbName &      operator [](int i) const
const SbName *      getValues(int start) const
int                 find(const SbName & targetValue, SbBool addIfNotFound
                         = FALSE)
void                setValues(int start, int num, const SbName *newValues)
void                set1Value(int index, const SbName & newValue)
const SbName &      operator=(const SbName & newValue)
void                setValue(const SbName & newValue)
int                 operator ==(const SoMFName &f) const
int                 operator !=(const SoMFName &f) const
SbName *            startEditing()
void                finishEditing()

💫 Methods from class SoMField

int                 getNum() const
void                setNum(int num)
virtual void        deleteValues(int start, int num = -1)
virtual void        insertSpace(int start, int num)
SbBool              set1(int index, const char *valueString)
void                get1(int index, SbString &valueString)

💫 Methods from class SoField

void                setIgnored(SbBool ignore)
SbBool              isIgnored() const
SbBool              isDefault() const
virtual SbBool      isOfType(SoType type) const
SbBool              set(const char *valueString)
void                get(SbString &valueString)
void                touch()
SbBool              connectFrom(SoField *fromField)
SbBool              connectFrom(SoEngineOutput *fromEngine)
void                disconnect()
SbBool              isConnected() const
SbBool              isConnectedFromField() const
SbBool              getConnectedField(SoField *&writingField) const
SbBool              isConnectedFromEngine() const
SbBool              getConnectedEngine(SoEngineOutput *&engineOutput)
                         const
void                enableConnection(SbBool flag)
SbBool              isConnectionEnabled() const
int                 getForwardConnections(SoFieldList &list) const
SoFieldContainer *  getContainer() const

---

💅 DESCRIPTION 💅

So picture this: a multiple-valued field that can hold any number of names. Names are these short little series of characters that people generally use for labels or names, and they get stored in a special table designed to allow fast lookup and comparison — like a VIP list at the club, but for characters ✨

ngl, for most purposes an SoMFString field is probably more appropriate. just saying 🫶

SoMFNames get written to file as one or more strings of characters. Here's the rule, no cap: names must begin with an underscore or an alphabetic character, and must consist entirely of underscores, alphabetic characters, or numbers.

When more than one value is present, all of the values are enclosed in square brackets and separated by commas — for example:

[ Fred, Wilma, _Part_01, translationField ]

it's giving Flintstones meets field system, iconic honestly 🍓

---

🛠️ METHODS 🛠️

• void setValues(int start, int num, const char *strings[]) — sets num values beginning at index start to the names contained in the given set of character strings.
• void setValue(const char *string) — sets this field to contain one and only one value, given by string. monogamy era 💜
• static SoType getClassTypeId() and virtual void getTypeId() const — returns the type for this class, or for a particular object of this class.
• const SbName & operator [](int i) const — returns the i'th value of the field.

⚠️ bestie, indexing past the end of the field (passing in i greater than getNum()) will return garbage. not the cute kind. 💀

• const SbName * getValues(int start) const — returns a pointer into the array of values in the field, starting at index start. The values are read-only; see the startEditing()/finishEditing() methods for a way of modifying values in place.
• int find(const SbName & targetValue, SbBool addIfNotFound = FALSE) — finds the given value in the array and returns the index of that value in the array. If the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is added to the end of the array — but -1 is still returned. yes really. it adds it and then tells you it didn't find it. make it make sense 😭
• void setValues(int start, int num, const SbName *newValues) — sets num values starting at index start to the values in newValues. The array will automatically be made larger to accommodate the new values, if necessary. glow-up, but for arrays ✨
• void set1Value(int index, const SbName & newValue) — sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary.
• const SbName & operator=(const SbName & newValue) and void setValue(const SbName & newValue) — sets the first value in the array to newValue, and deletes the second and subsequent values. ruthless. periodt 💅
• int operator ==(const SoMFName &f) const and int operator !=(const SoMFName &f) const — returns TRUE if all of the values of this field equal (do not equal) those of the given field. If the fields are different types, FALSE will always be returned — even if one field is an SoMFFloat with one value of 1.0 and the other is an SoMFInt with a value of 1, for example. type is not a vibe, it's a boundary 🌈
• SbName * startEditing() and void finishEditing() — startEditing() returns a pointer to the internally-maintained array that can be modified. The values in the array may be changed, but values cannot be added or removed.

🚨 It is illegal to call any other editing methods between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc). do not test this. it will not go well. 🙈

Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to FALSE and informs engines and sensors that the field changed — even if none of the values actually were changed. so it's out here announcing a change that never happened. main character energy fr fr 👑

---

and that's the whole page bestie!! this was SoMFName(3IV)(), the one and only, and yes the footer is literally just SoMFName(3IV)() again — it said its own name twice and honestly? relatable. slay, go forth, and may your names always start with an underscore or an alphabetic character 🦋💖🎀