SoMFVec4ub(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoMFVec4ub — the manual, but make it cute 💖

okay bestie, welcome to SoMFVec4ub from the Coin library, manual page SoMFVec4ub(3). it's a container class, it holds SbVec4ub vectors, and it's lowkey iconic. let's get into it 🫶

✨ NAME ✨

SoMFVec4ub — the class that is a container for SbVec4ub vectors. that's it, that's the whole vibe. 💅

✨ SYNOPSIS ✨

#include <Inventor/fields/SoMFVec4ub.h>

Inherits SoMField. yes she has a whole family tree, and we're gonna meet all of them, because we respect our elders. 🌸

🎀 Public Member Functions 🎀

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

🦋 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)

🌸 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 🍓

  • SbVec4ub * 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 ✨

okay so. SoMFVec4ub is a container for SbVec4ub vectors. periodt. 💅

this field is the one you reach for when nodes, engines, or other field containers need to store an array of vectors with four elements. four elements, no more, no less, she's structured like that. 🎀

she also supports application data sharing through a setValuesPointer() method. head over to the SoMField documentation for the tea on how to actually use that function, iykyk. 🫶

See also

  • SbVec4ub, SoSFVec4ub

Since

  • Coin 2.5

✨ Member Function Documentation ✨

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

returns the type identification instance that uniquely identifies the Coin field class this object belongs to. it's giving "who am i, really" but in a type-system way. 🔥

See also

  • getClassTypeId(), SoType

Implements SoField.

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

copy the value(s) from f into this field. heads up bestie: f must be of the same type as this field, no mixing, no matching, no chaos. 🙈

Implements SoField.

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

check for equal type and value(s). both. not just one. both. 💯

Implements SoField.

void SoMFVec4ub::deleteAllValues (void ) [protected], [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, not your business, respectfully. 💀

Implements SoMField.

void SoMFVec4ub::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 constructors where necessary. very "behind the scenes, doing the work, no credit" of her. 👑

Implements SoMField.

const SbVec4ub * SoMFVec4ub::getValues (const int start) const [inline]

returns a pointer to the values array. simple, clean, slay. ✨

References SoMField::num.

void SoMFVec4ub::setValues (int start, int numarg, const uint8_t xyzw[][4])

set num vector array elements from xyzw, starting at index start. 🫶

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

void SoMFVec4ub::set1Value (int idx, uint8_t x, uint8_t y, uint8_t z, uint8_t w)

set the vector at idx. one vector, four numbers, done. 💅

void SoMFVec4ub::set1Value (int idx, const uint8_t xyzw[4])

set the vector at idx. same energy, array-flavored. 🌸

void SoMFVec4ub::setValue (uint8_t x, uint8_t y, uint8_t z, uint8_t w)

set this field to contain a single vector with the given element values. one and only one, she's monogamous now. 🎀

void SoMFVec4ub::setValue (const uint8_t xyzw[4])

set this field to contain a single vector with the given element values. again, but with the array. 🌈

References SoMField::setNum().

✨ Author ✨

generated automatically by Doxygen for Coin from the source code. so technically the robot wrote it, but i translated it into feelings. 😭

and that's the whole page bestie!! 💖 this was Coin Version 2.5.0, and the page was SoMFVec4ub(3). go forth and store your four-element vectors, you absolute icon. 👑✨🦋

📦 where this page comes from