SoMFName(3)

๐Ÿ“ฆ version 3.1.3, in fedora 43, fedora 44

๐Ÿ’– SoMFName ๐Ÿ’–

okay so bestie, welcome to the Library Functions Manual page for SoMFName(3) โ€” yes it's a whole container situation and yes it's iconic, let's get into it ๐Ÿซถ


โœจ NAME โœจ

SoMFName โ€” the class that's literally a container for SbName values. that's it, that's the whole job ๐Ÿ’…


๐ŸŽ€ SYNOPSIS ๐ŸŽ€

#include <Inventor/fields/SoMFName.h>

Inherits SoMField. yes she's got a whole family tree, we love lineage ๐Ÿ‘‘

๐ŸŒˆ Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoMFName & operator= (const SoMFName &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbName & operator[] (const int idx) const
  • const SbName * getValues (const int start) const
  • int find (const SbName &value, SbBool addifnotfound=FALSE)
  • void setValues (const int start, const int num, const SbName *newvals)
  • void set1Value (const int idx, const SbName &value)
  • void setValue (const SbName &value)
  • const SbName & operator= (const SbName &val)
  • SbBool operator== (const SoMFName &field) const
  • SbBool operator!= (const SoMFName &field) const
  • SbName * startEditing (void)
  • void finishEditing (void)
  • void setValues (const int start, const int num, const char *strings[])
  • void setValue (const char *str)

๐Ÿฆ‹ 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) const

๐ŸŒธ Public Member Functions inherited from SoField

  • virtual ~SoField ()
  • void setIgnored (SbBool ignore)
  • SbBool isIgnored (void) const
  • void setDefault (SbBool defaultVal)
  • SbBool isDefault (void) const
  • SbBool isOfType (const SoType type) const
  • void enableConnection (SbBool flag)
  • SbBool isConnectionEnabled (void) const
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
  • void disconnect (SoEngineOutput *engineoutput)
  • SbBool isConnectedFromEngine (void) const
  • SbBool getConnectedEngine (SoEngineOutput *&master) const
  • SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
  • SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
  • 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 *input, 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 atexit_cleanup (void)
  • static void initClass (void)

๐ŸŒŸ Static Public Member Functions inherited from SoField

  • static void initClass (void)
  • static void initClasses (void)
  • static void cleanupClass (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)

๐Ÿงš 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=TRUE)
  • virtual void evaluateConnection (void) const
  • virtual SbBool readConnection (SoInput *in)
  • virtual void writeConnection (SoOutput *out) const
  • SbBool isDestructing (void) const

๐Ÿ‘‘ Protected Attributes

  • SbName * values

๐Ÿ’œ 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 ๐ŸŒธ

bestie. listen. SoMFName is a container for SbName values. that's the whole vibe check, and it passes โœ…

this field is the one you reach for when nodes, engines, or other field containers need to store arrays of names. multi-value, name-flavored, no cap ๐ŸŽ€

See also

  • SoSFName โ€” her single-value sister, also iconic

๐Ÿ’… MEMBER FUNCTION DOCUMENTATION ๐Ÿ’…

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

hands you the type identification instance that uniquely identifies the Coin field class this object belongs to. like a little name tag but for types, obsessed โœจ

See also

  • getClassTypeId(), SoType

Implements SoField.

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

copies the value(s) from f straight into this field. heads up though โ€” f must be the same type as this field, no mixing, that's the rule ๐Ÿšซ

Implements SoField.

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

checks for equal type and value(s). both. type and values. she's thorough ๐Ÿ’…

Implements SoField.

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

this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. so likeโ€ฆ not your business bestie, it's library business ๐Ÿ™ˆ

Implements SoMField.

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

this one moves values around internally inside a multivalue field. it has to be overridden in each field so it automatically handles running copy constructors whenever that's needed. very behind-the-scenes, very stage crew energy ๐ŸŽญ

Implements SoMField.

const SbName * SoMFName::getValues (const int start) const [inline]

returns a pointer to the values array. justโ€ฆ here's the pointer, take it ๐Ÿซด

void SoMFName::setValues (const int start, const int numarg, const char * strings[])

sets num strings starting at index start in this multiple-value field instance. bulk assignment era ๐Ÿ”ฅ

void SoMFName::setValue (const char * str)

sets this field so it contains only a single name, given by str. one name, one field, main character energy ๐Ÿ‘‘


๐Ÿซถ AUTHOR ๐Ÿซถ

Generated automatically by Doxygen for Coin from the source code. not a human, just a very diligent robot doing its lil thing ๐Ÿค–๐Ÿ’–


and that's the whole page bestie!! this one came from the Coin library, Version 3.1.3, manual page SoMFName(3) โ€” go forth and store your arrays of names, slay ๐Ÿ’…โœจ๐Ÿฆ‹

๐Ÿ“ฆ where this page comes from