SoMFNode(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

🌸 SoMFNode(3) — Coin 🌸

okay so bestie, this is the SoMFNode(3) page from Coin, and it's giving "container for nodes" main character energy. Buckle up, it's a two-parter 💖

🎀 NAME 🎀

SoMFNode — the class that is literally a container for nodes. That's the whole job description, and it eats. 💅

✨ SYNOPSIS ✨

First things first, you gotta pull it in:

#include <Inventor/fields/SoMFNode.h>

And it Inherits SoMField — that's the family tree, iykyk 🧬

🫶 Public Member Functions 🫶

the actual roster, one by one, no skips:

virtual SoType getTypeId (void) const — hands you back the type id, virtual edition ✨
virtual void copyFrom (const SoField &field) — copy everything over from another field
const SoMFNode & operator= (const SoMFNode &field) — assignment operator, but for a whole other SoMFNode
virtual SbBool isSame (const SoField &field) const — are you and that field the same? 👀
SoNode * operator[] (const int idx) const — index in, node pointer out
const SoNode ** getValues (const int start) const — grab the values array, starting at start
int find (SoNode *value, SbBool addifnotfound=FALSE) — go hunt for a node, and addifnotfound defaults to FALSE 🌸
void setValues (const int start, const int num, const SoNode **newvals) — set num values starting at start, sourced from newvals
void set1Value (const int idx, SoNode *value) — set exactly one value, at idx
void setValue (SoNode *value) — set the value, singular
SoNode * operator= (SoNode *val) — assignment operator, single node pointer style
SbBool operator== (const SoMFNode &field) const — equality check 💫
SbBool operator!= (const SoMFNode &field) const — inequality check 💫
SoNode ** startEditing (void) — kick off editing and get the pointer back
void finishEditing (void) — okay we're done editing, wrap it up
virtual void fixCopy (SbBool copyconnections) — fix things up post-copy
virtual SbBool referencesCopy (void) const — does it reference the copy? answering that
void addNode (SoNode *node) — add a node, simple as
void insertNode (SoNode *node, int idx) — insert a node at position idx
SoNode * getNode (int idx) const — get the node sitting at idx
int findNode (const SoNode *node) const — find that specific node
int getNumNodes (void) const — how many nodes are we even working with
void removeNode (int index) — remove a node by index
void removeNode (SoNode *node) — remove a node by pointer (yes, same name, overloaded, iconic)
void removeAllNodes (void) — remove ALL of them, clean slate 🧹
void replaceNode (int idx, SoNode *newnode) — swap a node out by index
void replaceNode (SoNode *oldnode, SoNode *newnode) — swap a node out by pointer
virtual void deleteValues (int start, int num=-1) — delete values, and num defaults to -1
virtual void insertSpace (int start, int num) — make room for num values at start

👑 Public Member Functions inherited from `SoMField` 👑

your inheritance, bestie, all of it:

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

🦋 Public Member Functions inherited from `SoField` 🦋

okay this part is LONG but we don't skip, we never skip:

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
void copyConnection (const SoField *fromfield)
virtual SbBool read (SoInput *input, 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 ⭐

the static girlies (no instance needed, they just exist):

static void * createInstance (void) — spin up an instance
static SoType getClassTypeId (void) — the class type id
static void initClass (void) — initialize the class

🌈 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 💜

for the inner circle only 🔒

virtual void deleteAllValues (void) — delete all the values
virtual void copyValue (int to, int from) — copy a value from from to to
virtual int fieldSizeof (void) const — the size of the field
virtual void * valuesPtr (void) — pointer to the values
virtual void setValuesPtr (void *ptr) — set that values pointer to ptr
virtual void allocValues (int num) — allocate space for num values

🔒 Protected Member Functions inherited from `SoMField` 🔒

SoMField (void)
virtual void makeRoom (int newnum)
virtual SoNotRec createNotRec (SoBase *container)
void setChangedIndex (const int chgidx)
void setChangedIndices (const int chgidx=-1, const int numchgind=0)

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

SoNode ** values — the values array itself, protected but present

🍓 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 here's the tea: the SoMFNode class is a container for nodes. That's it, that's the vibe. 🫶

This field container stores an array of pointers to nodes. It handles all the necessary functionality for dealing with copy, import and export operations. very "does it all so you don't have to" of it 💅

heads up bestie — node pointers stored in field instances of this type may be NULL pointers. so like, don't assume they're all filled in, okay? 😭

🌟 See also 🌟

SoNode, SoSFNode

and that's only the first half, so don't go anywhere — the rest is still coming 👀✨

✨ MEMBER FUNCTION DOCUMENTATION ✨

okay bestie, this is the part where we go function by function 💅 — grab a snack, there's a whole lot of them, but they're all little guys, promise.

void * SoMFNode::createInstance(void) [static] — okay so this one is internal to the library, and the docs are like, bestie, this is not likely to be of interest to the application programmer 🙈. What it actually does: creates a new instance of the class type that corresponds to the SoType object. That's it, that's the whole gig.
SoType SoMFNode::getClassTypeId(void) [static] — a static method that hands you back the SoType object associated with objects of this class. type-system core, yk? 🫶
SoType SoMFNode::getTypeId(void) const [virtual] — returns the type identification of an object derived from a class inheriting SoField. this is what makes runtime type checking and "downward" casting happen ✨.

Implements SoField.

void SoMFNode::copyFrom(const SoField & f) [virtual] — copies value(s) from f into this field. ⚠️ important: f must be of the same type as this field, no mixing, no swapping, no shortcuts.

Implements SoField.

SbBool SoMFNode::isSame(const SoField & f) const [virtual] — checks for equal type and value(s). both. the whole package 💖.

Implements SoField.

virtual void SoMFNode::deleteAllValues(void) [protected], [virtual] — yeah, it's a SoMField thing.

Implements SoMField.

virtual void SoMFNode::copyValue(int to, int from) [protected], [virtual] — also a SoMField thing, copy from one slot to another, internal business 🔧.

Implements SoMField.

const SoNode ** SoMFNode::getValues(const int start) const [inline] — returns a pointer to the values array. raw access, handle with care bestie 💅.
void SoMFNode::initClass(void) [static] — internal method that gets called when the library initializes (from SoDB::init()) so the type system can get set up 🌱.
void SoMFNode::fixCopy(SbBool copyconnections) [virtual] — so this one gets called internally, right after SoField::copyFrom() during scene graph copies, and it's supposed to do whatever operations are necessary to fix up the field instance after it's gotten a new value.

The default method in the SoField superclass does nothing. literally nothing. a whole vibe of emptiness 💀.

The application programmer should normally not need to consider this method — unless you're constructing a complex field type that contains new references to container instances (i.e. nodes or engines). In that case, overriding this method becomes necessary, because you have to update those reference pointers: they could have been duplicated during the copy operation 😭.

Reimplemented from SoField.

SbBool SoMFNode::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.

heads up: this method is only valid to call during copy operations. no copy, no call 🚫.

Also go read the note about the relevance of the fixCopy() method for application programmers, because that note applies to this method too 🫶.

Reimplemented from SoField.

🦋 The Coin-Extension Squad 🦋

okay so this whole lil crew is Coin-only — these functions are extensions for Coin, and they are not available in the original SGI Open Inventor v2.1 API. every single one of them landed in Coin 2.0. iconic behavior honestly 👑

void SoMFNode::addNode(SoNode * node) — adds a node at the end of the array. 📥