SoMFShort(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoMFShort(3) 💖

okay so bestie, welcome to the SoMFShort(3) page from the Library Functions Manual — yes the manual name is literally that, we're in the library functions manual, it's giving "I live in a header file and I'm thriving". grab a boba, this one's actually adorable. 🍓✨

✨ NAME ✨

SoMFShort — the SoMFShort class is a container for short integer values. that's the whole vibe, that's the entire job description, periodt. 💅

🌈 SYNOPSIS 🌈

#include <Inventor/fields/SoMFShort.h>

Inherits SoMField. (so it's got a whole family tree, iykyk 🌳)

🎀 Public Member Functions 🎀

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

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

  • short * 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 the SoMFShort class is a container for short integer values. that's literally the first line and it's the truth.

this field is used where nodes, engines or other field containers needs to store a group of multiple short integer values. (grammar? not the point. the point is multiple short ints, all snuggled together in one field. it's a whole squad. 👯‍♀️)

this field supports application data sharing through a setValuesPointer() method. see SoMField documentation for information on how to use this function. (go read that page bestie, it's the whole tutorial, don't skip it 🙈)

See also: SoSFShort

🛠️ Member Function Documentation 🛠️

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

returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's the ✨ who-am-I ✨ of the object world.

See also: getClassTypeId(), SoType

Implements SoField.

void SoMFShort::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, no substituting, no "close enough". 🚫

Implements SoField.

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

check for equal type and value(s). the vibe check, but for fields. ✅

Implements SoField.

void SoMFShort::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. (translation: not for you bestie, it's backstage 💀)

Implements SoMField.

void SoMFShort::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. (yes, "contructors", that's exactly how it's written in the original, we don't fix typos around here, we preserve them 💅)

Implements SoMField.

const short * SoMFShort::getValues (const int start) const [inline]

returns a pointer to the values array. just hands you the pointer. iconic behaviour honestly. 👑

💌 Author 💌

Generated automatically by Doxygen for Coin from the source code. (so nobody actually wrote this by hand, it just... materialized. main character energy fr fr 🌈)

and that's the page bestie!! thanks for reading the whole thing, you ate. 🫶

Coin · Version 3.1.3 · SoMFShort(3) — that's the source, the version and the page name all wrapped up in a little bow at the bottom, exactly where the footer said they'd be. 💖🎀🦋

📦 where this page comes from