SoChildList(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoChildList πŸ’–

okay bestie, welcome to SoChildList(3) β€” the Coin library page for the class that holds all the node children. Sit down, hydrate, and let's get into it 🫢


🌸 NAME 🌸

SoChildList β€” the class that is literally a container for node children. that's it, that's the job, and she does it beautifully ✨


✨ SYNOPSIS ✨

#include <Inventor/misc/SoChildList.h>

Inherits SoNodeList. yes bestie, she's got a whole family tree πŸ‘‘

πŸ’… Public Member Functions

SoChildList (SoNode *const parent)
SoChildList (SoNode *const parent, const int size)
SoChildList (SoNode *const parent, const SoChildList &cl)
~SoChildList ()
void append (SoNode *const node)
void insert (SoNode *const ptr, const int addbefore)
void remove (const int index)
void truncate (const int length)
void copy (const SoChildList &cl)
void set (const int index, SoNode *const node)
void traverseInPath (SoAction *const action, const int numindices, const
    int *indices)
void traverse (SoAction *const action)
void traverse (SoAction *const action, const int index)
void traverse (SoAction *const action, SoNode *node)
void traverse (SoAction *const action, const int first, const int last)
void addPathAuditor (SoPath *const path)
void removePathAuditor (SoPath *const path)

🌈 Public Member Functions inherited from SoNodeList

SoNodeList (void)
SoNodeList (const int size)
SoNodeList (const SoNodeList &nl)
~SoNodeList ()
void append (SoNode *const ptr)
SoNode * operator[] (const int i) const
SoNodeList & operator= (const SoNodeList &nl)

πŸŽ€ Public Member Functions inherited from SoBaseList

SoBaseList (void)
SoBaseList (const int size)
SoBaseList (const SoBaseList &l)
~SoBaseList ()
void append (SoBase *ptr)
void insert (SoBase *ptr, const int addbefore)
void remove (const int index)
void removeItem (SoBase *item)
void truncate (const int length)
void copy (const SoBaseList &l)
SoBaseList & operator= (const SoBaseList &l)
SoBase * operator[] (const int i) const
void set (const int i, SoBase *const ptr)
void addReferences (const SbBool flag)
SbBool isReferencing (void) const

πŸ¦‹ Public Member Functions inherited from SbPList

SbPList (const int sizehint=DEFAULTSIZE)
SbPList (const SbPList &l)
~SbPList ()
void copy (const SbPList &l)
SbPList & operator= (const SbPList &l)
void fit (void)
void append (void *item)
int find (void *item) const
void insert (void *item, const int insertbefore)
void removeItem (void *item)
void remove (const int index)
void removeFast (const int index)
int getLength (void) const
void truncate (const int length, const int fit=0)
void ** getArrayPtr (const int start=0) const
void *& operator[] (const int index) const
int operator== (const SbPList &l) const
int operator!= (const SbPList &l) const
void * get (const int index) const
void set (const int index, void *item)

πŸ’œ Additional Inherited Members

πŸ”’ Protected Member Functions inherited from SbPList

void expand (const int size)
int getArraySize (void) const

🌟 Detailed Description 🌟

SoChildList is a container for node children. periodt πŸ’…

The way this class works? She does automatic notification on the parent nodes whenever you add or remove children. no manual pinging required, she handles it 🫢

She also comes with methods for action traversal of the children, because of course she does πŸ”₯


πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoChildList::SoChildList (SoNode *const parentptr)

Default constructor. Sets up the parent container and initializes a minimal list. tiny but mighty ✨

SoChildList::SoChildList (SoNode *const parentptr, const int size)

Constructor with a hint about the list size, so she can get comfy before the party starts πŸŽ‰

See also

  • SoNodeList::SoNodeList(const int)

SoChildList::SoChildList (SoNode *const parentptr, const SoChildList & cl)

Copy constructor. twin energy, no cap πŸ‘―

See also

  • SoNodeList::SoNodeList(const SoNodeList &)

SoChildList::~SoChildList ()

Destructor. she's logging off, bye bestie 😭


πŸ’– Member Function Documentation πŸ’–

void SoChildList::append (SoNode *const node)

Append a brand new node instance as a child of our parent container. she's joining the group chat 🫢

Automatically notifies the parent node, plus any SoPath instances auditing paths with nodes from this list. she tells everyone πŸ’…

void SoChildList::insert (SoNode *const node, const int addbefore)

Insert a new node instance as a child of our parent container, at position addbefore. not at the end, not at the front β€” right there ✨

Automatically notifies the parent node, plus any SoPath instances auditing paths with nodes from this list. yes, again. consistent queen πŸ‘‘

void SoChildList::remove (const int index)

Remove the child node pointer at index. gone. blocked. 🚫

Automatically notifies the parent node, plus any SoPath instances auditing paths with nodes from this list. the receipts go out regardless πŸ“¬

void SoChildList::copy (const SoChildList & cl)

Copy the contents of cl into this list. steal her whole look, respectfully πŸ’–

void SoChildList::set (const int index, SoNode *const node)

Index operator to set the element at index.

⚠️ Heads up bestie: this does not expand the array bounds if index is outside the list. it is what it is, don't test her πŸ’€

void SoChildList::traverseInPath (SoAction *const action, const int numindices, const int * indices)

Optimized IN_PATH traversal method. she's fast, she's efficient, she's that girl πŸ”₯

This method is an extension versus the Open Inventor API. special edition ✨

void SoChildList::traverse (SoAction *const action)

Traverse all the nodes in the list, invoking their methods for the given action. everybody gets a turn 🌈

void SoChildList::traverse (SoAction *const action, const int index)

Traverse the node at index (and possibly its children too, if it's a group node), applying the node's method for the given action. main character energy, plus her entourage πŸ‘‘

void SoChildList::traverse (SoAction *const action, SoNode * node)

Traverse node (and possibly its children too, if it's a group node), applying the node's method for the given action. same vibe, different entry point πŸ¦‹

void SoChildList::traverse (SoAction *const action, const int first, const int last)

Traverse the child nodes in the list from index first up to and including index last β€” or until the SoAction::hasTerminated() flag of action has been set. she stops when she's told to stop, no drama πŸ›‘

void SoChildList::addPathAuditor (SoPath *const path)

Notify path whenever this list of node children changes. she's on the list, she gets the updates πŸ“²

void SoChildList::removePathAuditor (SoPath *const path)

Remove path as an auditor for our list of node children. unsubscribe, respectfully πŸ™ˆ


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code. the robots wrote this one, and honestly? they ate πŸ€–βœ¨


and that's the whole page bestie!! this one came from Coin, Version 3.1.3, and it lives at the page name SoChildList(3). take care of her, she's iconic πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from