.TH "SoChildList" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoChildList \- .PP The \fBSoChildList\fP class is a container for node children\&. .PP This class does automatic notification on the parent nodes upon adding or removing children\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoNodeList\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBSoChildList\fP (\fBSoNode\fP *const parent)" .br .ti -1c .RI "\fBSoChildList\fP (\fBSoNode\fP *const parent, const int size)" .br .ti -1c .RI "\fBSoChildList\fP (\fBSoNode\fP *const parent, const \fBSoChildList\fP &cl)" .br .ti -1c .RI "\fB~SoChildList\fP ()" .br .ti -1c .RI "void \fBappend\fP (\fBSoNode\fP *const node)" .br .ti -1c .RI "void \fBinsert\fP (\fBSoNode\fP *const ptr, const int addbefore)" .br .ti -1c .RI "void \fBremove\fP (const int index)" .br .ti -1c .RI "void \fBtruncate\fP (const int length)" .br .ti -1c .RI "void \fBcopy\fP (const \fBSoChildList\fP &cl)" .br .ti -1c .RI "void \fBset\fP (const int index, \fBSoNode\fP *const node)" .br .ti -1c .RI "void \fBtraverseInPath\fP (\fBSoAction\fP *const action, const int numindices, const int *indices)" .br .ti -1c .RI "void \fBtraverse\fP (\fBSoAction\fP *const action)" .br .ti -1c .RI "void \fBtraverse\fP (\fBSoAction\fP *const action, const int index)" .br .ti -1c .RI "void \fBtraverse\fP (\fBSoAction\fP *const action, \fBSoNode\fP *node)" .br .ti -1c .RI "void \fBtraverse\fP (\fBSoAction\fP *const action, const int first, const int last)" .br .ti -1c .RI "void \fBaddPathAuditor\fP (\fBSoPath\fP *const path)" .br .ti -1c .RI "void \fBremovePathAuditor\fP (\fBSoPath\fP *const path)" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP The \fBSoChildList\fP class is a container for node children\&. .PP This class does automatic notification on the parent nodes upon adding or removing children\&. Methods for action traversal of the children are also provided\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoChildList::SoChildList (\fBSoNode\fP *constparentptr)" Default constructor, sets parent container and initializes a minimal list\&. .SS "SoChildList::SoChildList (\fBSoNode\fP *constparentptr, const intsize)" Constructor with hint about list size\&. .PP \fBSee Also:\fP .RS 4 \fBSoNodeList::SoNodeList(const int)\fP .RE .PP .SS "SoChildList::SoChildList (\fBSoNode\fP *constparentptr, const \fBSoChildList\fP &cl)" Copy constructor\&. .PP \fBSee Also:\fP .RS 4 \fBSoNodeList::SoNodeList(const SoNodeList &)\fP .RE .PP .SS "SoChildList::~SoChildList ()" Destructor\&. .SH "Member Function Documentation" .PP .SS "void SoChildList::append (\fBSoNode\fP *constnode)" Append a new \fInode\fP instance as a child of our parent container\&. .PP Automatically notifies parent node and any \fBSoPath\fP instances auditing paths with nodes from this list\&. .PP Reimplemented from \fBSoNodeList\fP\&. .SS "void SoChildList::insert (\fBSoNode\fP *constnode, const intaddbefore)" Insert a new \fInode\fP instance as a child of our parent container at position \fIaddbefore\fP\&. .PP Automatically notifies parent node and any \fBSoPath\fP instances auditing paths with nodes from this list\&. .SS "void SoChildList::remove (const intindex)" Remove the child node pointer at \fIindex\fP\&. .PP Automatically notifies parent node and any \fBSoPath\fP instances auditing paths with nodes from this list\&. .PP Reimplemented from \fBSoBaseList\fP\&. .SS "void SoChildList::truncate (const intlength)" Makes the list contain only the \fIlength\fP first items, removing all items from index \fIlength\fP and onwards to the end of the list\&. Dereferences the objects to be removed (unless \fBaddReferences()\fP has been set to \fCFALSE\fP)\&. .PP \fBSee Also:\fP .RS 4 \fBSbPList::truncate()\fP .RE .PP .PP Reimplemented from \fBSoBaseList\fP\&. .SS "void SoChildList::copy (const \fBSoChildList\fP &cl)" Copy contents of \fIcl\fP into this list\&. .SS "void SoChildList::set (const intindex, \fBSoNode\fP *constnode)" Index operator to set element at \fIindex\fP\&. Does \fInot\fP expand array bounds if \fIindex\fP is outside the list\&. .SS "void SoChildList::traverseInPath (\fBSoAction\fP *constaction, const intnumindices, const int *indices)" Optimized IN_PATH traversal method\&. .PP This method is an extension versus the Open Inventor API\&. .SS "void SoChildList::traverse (\fBSoAction\fP *constaction)" Traverse all nodes in the list, invoking their methods for the given \fIaction\fP\&. .SS "void SoChildList::traverse (\fBSoAction\fP *constaction, const intindex)" Traverse the node at \fIindex\fP (and possibly its children, if its a group node), applying the nodes' method for the given \fIaction\fP\&. .SS "void SoChildList::traverse (\fBSoAction\fP *constaction, \fBSoNode\fP *node)" Traverse the \fInode\fP (and possibly its children, if its a group node), applying the nodes' method for the given \fIaction\fP\&. .SS "void SoChildList::traverse (\fBSoAction\fP *constaction, const intfirst, const intlast)" Traverse child nodes in the list from index \fIfirst\fP up to and including index \fIlast\fP, or until the \fBSoAction::hasTerminated()\fP flag of \fIaction\fP has been set\&. .SS "void SoChildList::addPathAuditor (\fBSoPath\fP *constpath)" Notify \fIpath\fP whenever this list of node children changes\&. .SS "void SoChildList::removePathAuditor (\fBSoPath\fP *constpath)" Remove \fIpath\fP as an auditor for our list of node children\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.