SoMFPath(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoMFPath 💖

okay bestie, gather round, because today we're talking about SoMFPath from the Coin library — and yes, it lives in the Library Functions Manual, section 3. it's giving "container for paths" and honestly? it ate. 💅

✨ NAME ✨

SoMFPath — the class that's literally just a container for paths. that's it. that's the whole job. queen behavior. 👑

🦋 SYNOPSIS 🦋

#include <Inventor/fields/SoMFPath.h>

Inherits SoMField.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoMFPath & operator= (const SoMFPath &field)
  • virtual SbBool isSame (const SoField &field) const
  • SoPath * operator[] (const int idx) const
  • const SoPath ** getValues (const int start) const
  • int find (SoPath *value, SbBool addifnotfound=0)
  • void setValues (const int start, const int num, const SoPath **newvals)
  • void set1Value (const int idx, SoPath *value)
  • void setValue (SoPath *value)
  • SoPath * operator= (SoPath *val)
  • SbBool operator== (const SoMFPath &field) const
  • SbBool operator!= (const SoMFPath &field) const
  • SoPath ** startEditing (void)
  • void finishEditing (void)
  • virtual void notify (SoNotList *l)
  • virtual void fixCopy (SbBool copyconnections)
  • virtual SbBool referencesCopy (void) const
  • virtual void deleteValues (int start, int num=-1)
  • virtual void insertSpace (int start, int num)

💜 Public Member Functions inherited from SoMField 💜

  • virtual ~SoMField ()
  • int getNum (void) const
  • void setNum (const 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)
  • 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
  • void copyConnection (const SoField *fromfield)
  • virtual SbBool read (SoInput *in, const SbName &name)
  • virtual void write (SoOutput *out, const SbName &name) 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 🌈

  • SoPath ** 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 👑

SoMFPath is a container for paths. full stop. main character energy, zero notes. 💖

This field container stores an array of pointers to paths. It takes care of the necessary functionality for handling copy, import and export operations. so like, it's not just holding your paths, bestie — it's handling all the messy admin so you don't have to. 💅

⚠️ Heads up: path pointers stored in field instances of this type may be NULL pointers. so if you dereference without checking, that's on you, and no cap, it will not be cute. 😭

See also

  • SoPath
  • SoSFPath

🔥 Member Function Documentation 🔥

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's the little ID badge this class wears so everybody knows exactly which field class they're dealing with. 🪪✨

See also

  • getClassTypeId()
  • SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field. like, same type only, bestie — we're not doing weird cross-type shenanigans here. 🚫

Implements SoField.

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

Check for equal type and value(s). it's the vibe check — type matches? values match? then yeah, they're the same. 💅

Implements SoField.

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

Implements SoMField.

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

Implements SoMField.

const SoPath ** SoMFPath::getValues (const int start) const [inline]

Returns a pointer to the values array. boom, there it is. 🎀

void SoMFPath::notify (SoNotList * nlist) [virtual]

Notify auditors that this field has changed. like sending out a "hey besties, something moved" group text. 📣

Reimplemented from SoField.

References

  • SoBase::addAuditor()
  • SoPath::getHead()
  • SoMField::getNum()
  • SoField::notify()
  • SoBase::ref()
  • SoBase::removeAuditor()
  • SoBase::unref()

void SoMFPath::fixCopy (SbBool copyconnections) [virtual]

This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing.

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation. tl;dr: unless you're building fancy custom field types with fresh references to containers, you can leave this alone. mind your business, it'll handle itself. 💅

Reimplemented from SoField.

References

  • SoBase::assertAlive()
  • SoPath::copy()
  • SoField::enableNotify()
  • SoFieldContainer::findCopy()
  • SoMField::getNum()
  • SoField::valueChanged()

SbBool SoMFPath::referencesCopy (void ) const [virtual]

Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

⚠️ Note that this method only is valid to call during copy operations. outside of that window? it's not giving what it's supposed to give. 🙈

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method aswell.

Reimplemented from SoField.

References

  • SoFieldContainer::checkCopy()
  • SoMField::getNum()
  • SoField::referencesCopy()

virtual void SoMFPath::deleteValues (int start, int numarg = -1) [virtual]

Remove value elements from index start up to and including index start + num - 1.

Elements with indices larger than the last deleted element will be moved downwards in the value array. so like, everyone shuffles up to fill the gap. iconic teamwork honestly. 🫶

If num equals -1, delete from index start and to the end of the array. yeah, it just keeps going. gone. poof. 💀

Reimplemented from SoMField.

References

  • SoMField::num

virtual void SoMFPath::insertSpace (int start, int numarg) [virtual]

Insert num "slots" for new value elements from start. The elements already present from start will be moved "upward" in the extended array. making room for the new girls, respectfully. ✨

Reimplemented from SoMField.

References

  • SoMField::num

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. not a human hand in sight, and yet it served. 🤖💖

and that's the whole page, bestie!! this was SoMFPath(3) from Coin, Version 2.5.0, dated back on the classic SoMFPath(3) page — stay slay, stay compiled, and remember: check for NULL pointers before you dereference, iykyk. 🎀🦋💅

📦 where this page comes from