SoMFVec4us(3)

🎀 NAME 🎀

okay bestie, welcome to SoMFVec4us — she's a class, she's from the Library Functions Manual (section 3, iykyk), and she is literally a container for SbVec4us vectors. that's the whole gig. she holds your vec4us so you don't have to. 💅

---

🦋 SYNOPSIS 🦋

first things first, you gotta pull her in:

#include <Inventor/fields/SoMFVec4us.h>

she inherits SoMField. queen behavior, honestly.

✨ Public Member Functions ✨

here's every single thing she can do, no skips, no cuts:

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoMFVec4us & operator= (const SoMFVec4us &field)
virtual SbBool isSame (const SoField &field) const
const SbVec4us & operator[] (const int idx) const
const SbVec4us * getValues (const int start) const
int find (const SbVec4us &value, SbBool addifnotfound=0)
void setValues (const int start, const int num, const SbVec4us *newvals)
void set1Value (const int idx, const SbVec4us &value)
void setValue (const SbVec4us &value)
const SbVec4us & operator= (const SbVec4us &val)
SbBool operator== (const SoMFVec4us &field) const
SbBool operator!= (const SoMFVec4us &field) const
SbVec4us * startEditing (void)
void finishEditing (void)
void setValuesPointer (const int num, const SbVec4us *userdata)
void setValuesPointer (const int num, SbVec4us *userdata)
void setValuesPointer (const int num, const unsigned short *userdata)
void setValuesPointer (const int num, unsigned short *userdata)
void setValues (int start, int num, const unsigned short xyzw[][4])
void set1Value (int idx, unsigned short x, unsigned short y, unsigned short z, unsigned short w)
void set1Value (int idx, const unsigned short xyzw[4])
void setValue (unsigned short x, unsigned short y, unsigned short z, unsigned short w)
void setValue (const unsigned short xyzw[4])

🌸 Public Member Functions inherited from SoMField 🌸

the family she got it from:

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 💖

and up the chain we go, grandparent energy:

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 ⭐

the ones you can call without even having an object. iconic:

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 🧚

for the inner circle only, bestie:

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=1)
virtual void evaluateConnection (void) const
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const

🍓 Protected Attributes 🍓

SbVec4us * 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 💜

so, SoMFVec4us is a container for SbVec4us vectors. that's the assignment, and she ate. 🔥

you use this field when nodes, engines, or other field containers need to hold an array of vectors with four elements. four elements, four slots, no notes.

this field supports application data sharing through a setValuesPointer() method. head over to the SoMField documentation for the deets on how to use that function — she's not gonna explain it twice, bestie. 💅

👀 See also

SbVec4us, SoSFVec4us

🕰️ Since

Coin 2.5

---

🌸 MEMBER FUNCTION DOCUMENTATION 🌸

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

hands you the type identification instance that uniquely IDs the Coin field class this object belongs to. it's giving "who am I" but make it type-safe.

See also: getClassTypeId(), SoType

Implements SoField.

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

copies the value(s) from f into this field. heads up though — f must be the same type as this field, no mixing, no crossover episodes.

Implements SoField.

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

checks for equal type and equal value(s). both or nothing.

Implements SoField.

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

this API member is considered internal to the library, since it's not likely to be of interest to the application programmer. you can look but don't touch, fr fr.

Implements SoMField.

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

this method moves values around internally within a multivalue field. it has to be overridden in each field so it automatically handles running copy constructors where necessary. lowkey important plumbing, highkey invisible.

Implements SoMField.

const SbVec4us * SoMFVec4us::getValues (const int start) const [inline]

returns a pointer to the values array. you want the whole array, you got the whole array. ✨

References SoMField::num.

void SoMFVec4us::setValues (int start, int numarg, const unsigned short xyzw[][4])

sets num vector array elements from xyzw, starting at index start. note the parameter is written numarg here, keep it that way, don't come for me.

References SoMField::maxNum, SoMField::num, and SoField::valueChanged().

void SoMFVec4us::set1Value (int idx, unsigned short x, unsigned short y, unsigned short z, unsigned short w)

sets the vector at idx.

void SoMFVec4us::set1Value (int idx, const unsigned short xyzw[4])

sets the vector at idx. same job, array-shaped entrance. 💅

void SoMFVec4us::setValue (unsigned short x, unsigned short y, unsigned short z, unsigned short w)

sets this field to contain a single vector with the given element values. one vector, one moment, main character energy.

void SoMFVec4us::setValue (const unsigned short xyzw[4])

sets this field to contain a single vector with the given element values.

References SoMField::setNum().

---

🫶 AUTHOR 🫶

generated automatically by Doxygen for Coin from the source code. so like, not a human, but she still slayed. 💖

---

okay that's the whole page bestie, we made it. this was Coin, Version 2.5.0, and the page is SoMFVec4us(3) — go forth and store your four-element unsigned short vectors responsibly. no cap. 🦋🎀💜