.TH "SoVRMLParent" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoVRMLParent \- The \fBSoVRMLParent\fP node is a superclass for all VRML grouping nodes\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/VRMLnodes/SoVRMLParent\&.h>\fP
.PP
Inherits \fBSoGroup\fP\&.
.PP
Inherited by \fBSoVRMLAnchor\fP, \fBSoVRMLBillboard\fP, and \fBSoVRMLGroup\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBaffectsState\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaddChild\fP (\fBSoNode\fP *\fBchild\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBinsertChild\fP (\fBSoNode\fP *\fBchild\fP, int idx)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBgetChild\fP (int idx) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBfindChild\fP (\fBconst\fP \fBSoNode\fP *\fBchild\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetNumChildren\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBremoveChild\fP (int idx)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBremoveChild\fP (\fBSoNode\fP *\fBchild\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBremoveAllChildren\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBreplaceChild\fP (int idx, \fBSoNode\fP *\fBchild\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBreplaceChild\fP (\fBSoNode\fP *\fBold\fP, \fBSoNode\fP *\fBchild\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoChildList\fP * \fBgetChildren\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.in -1c

Public Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBSoGroup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoGroup\fP (int \fBnchildren\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetOverride\fP (\fBconst\fP SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetNodeType\fP (\fBconst\fP \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBcopy\fP (SbBool \fBcopyconnections\fP=FALSE) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsSetup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsCleanup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteInstance\fP (\fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBaddToCopyDict\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetToDefaults\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (\fBconst\fP \fBSoFieldContainer\fP *container) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyFieldValues\fP (\fBconst\fP \fBSoFieldContainer\fP *container, SbBool \fBcopyconnections\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBconst\fP fielddata)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetAllFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetField\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventIn\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventOut\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (\fBconst\fP \fBSoField\fP *\fBconst\fP \fBfield\fP, \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *\fBfield\fP, \fBvoid\fP *\fBnewval\fP)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetFieldsMemorySize\fP (size_t &\fBmanaged\fP, size_t &\fBunmanaged\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetUserData\fP (\fBvoid\fP *userdata) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP * \fBgetUserData\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunrefNoDelete\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "\fBvirtual\fP \fBSbName\fP \fBgetName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetName\fP (\fBconst\fP \fBSbName\fP &\fBnewname\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoAuditorList\fP & \fBgetAuditors\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBassertAlive\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBupdateChildList\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP *nodes, \fBconst\fP int \fBnumnodes\fP, \fBSoChildList\fP &\fBcl\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBupdateChildList\fP (\fBSoNode\fP *\fBnodewithsfnode\fP, \fBSoChildList\fP &\fBcl\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoNode\fP * \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name, \fBSoNodeList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBgetNextNodeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetActionMethodIndex\fP (\fBconst\fP \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitCopyDict\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBcheckCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBfindCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcopyDone\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBremoveName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBdecrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoBase\fP * \fBgetNamedBase\fP (\fBconst\fP \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNamedBases\fP (\fBconst\fP \fBSbName\fP &name, \fBSoBaseList\fP &\fBbaselist\fP, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP \fBexpectedtype\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetInstancePrefix\fP (\fBconst\fP \fBSbString\fP &c)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetTraceRefs\fP (SbBool \fBtrace\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBgetTraceRefs\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &\fBfromnodename\fP, \fBconst\fP \fBSbName\fP &\fBfromfieldname\fP, \fBconst\fP \fBSbName\fP &\fBtonodename\fP, \fBconst\fP \fBSbName\fP &\fBtofieldname\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoMFNode\fP \fBchildren\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoFieldData\fP * \fBgetFieldData\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoVRMLParent\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoVRMLParent\fP (int \fBapproxchildren\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoVRMLParent\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBlist\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadInstance\fP (\fBSoInput\fP *\fBin\fP, \fBunsigned\fP short flags)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBSoFieldContainer\fP *from, SbBool \fBcopyConn\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoGroup\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadChildren\fP (\fBSoInput\fP *\fBin\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetOperation\fP (\fBconst\fP \fBSoNotRec::OperationType\fP \fBopType\fP=SoNotRec::UNSPECIFIED, \fBconst\fP \fBSoNode\fP *\fBcc\fP=\fBNULL\fP, \fBconst\fP \fBSoNode\fP *\fBpc\fP=\fBNULL\fP, \fBconst\fP int \fBci\fP=\-1)"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoNode\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoBase\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdestroy\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisgroup\fP, SbBool \fBisengine\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwriteFooter\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP char * \fBgetFileFormatName\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype, \fBconst\fP uint32_t \fBbitmask\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataLock\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataUnlock\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSoMFNode\fP \fBaddChildren\fP"
.br
.ti -1c
.RI "\fBSoMFNode\fP \fBremoveChildren\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBSoChildList\fP * \fBchildren\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c

Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "\fBstatic\fP int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoVRMLParent\fP node is a superclass for all VRML grouping nodes\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoVRMLParent::SoVRMLParent (\fBvoid\fP)\fC [protected]\fP"
Constructor\&. 
.SS "SoVRMLParent::SoVRMLParent (int numchildren)\fC [protected]\fP"
Destructor\&. \fInumchildren\fP is the expected number of children\&. 
.SS "SoVRMLParent::~SoVRMLParent ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoVRMLParent::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoVRMLParent::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Reimplemented from \fBSoGroup\fP\&.
.PP
Reimplemented in \fBSoVRMLAnchor\fP, \fBSoVRMLBillboard\fP, \fBSoVRMLCollision\fP, \fBSoVRMLGroup\fP, and \fBSoVRMLTransform\fP\&.
.SS "\fBconst\fP \fBSoFieldData\fP ** SoVRMLParent::getFieldDataPtr (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.br
 
.SS "\fBconst\fP \fBSoFieldData\fP * SoVRMLParent::getFieldData (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.PP
Reimplemented in \fBSoVRMLAnchor\fP, \fBSoVRMLBillboard\fP, \fBSoVRMLCollision\fP, \fBSoVRMLGroup\fP, and \fBSoVRMLTransform\fP\&.
.SS "\fBvoid\fP SoVRMLParent::initClass (\fBvoid\fP)\fC [static]\fP"

.SS "SbBool SoVRMLParent::affectsState (\fBvoid\fP) const\fC [virtual]\fP"
Returns \fCTRUE\fP if the node could have any effect on the state during traversal\&.
.PP
If it returns \fCFALSE\fP, no data in the traversal state will change from the pre-traversal state to the post-traversal state\&. The \fBSoSeparator\fP node will for instance return \fCFALSE\fP, as it pushes and pops the state before and after traversal of its children\&. All \fBSoShape\fP nodes will also return \fCFALSE\fP, as just pushing out geometry data to the rendering engine won't affect the actual rendering state\&.
.PP
The default method returns \fCTRUE\fP, on a 'better safe than sorry' philosophy\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "\fBvoid\fP SoVRMLParent::addChild (\fBSoNode\fP * node)\fC [virtual]\fP"
Append a child \fInode\fP to the list of children nodes this group node is managing\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::insertChild (\fBSoNode\fP * child, int newchildindex)\fC [virtual]\fP"
Insert a \fIchild\fP node at position \fInewchildindex\fP\&.
.PP
\fInewchildindex\fP must be <= this->\fBgetNumChildren()\fP
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBSoNode\fP * SoVRMLParent::getChild (int index) const\fC [virtual]\fP"
Returns pointer to child node at \fIindex\fP\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "int SoVRMLParent::findChild (\fBconst\fP \fBSoNode\fP * node) const\fC [virtual]\fP"
Returns index in our list of children for child \fInode\fP, or -1 if \fInode\fP is not a child of this group node\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "int SoVRMLParent::getNumChildren (\fBvoid\fP) const\fC [virtual]\fP"
Returns number of child nodes managed by this group\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::removeChild (int childindex)\fC [virtual]\fP"
Remove node at \fIchildindex\fP in our list of children\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::removeChild (\fBSoNode\fP * child)\fC [virtual]\fP"
Remove \fIchild\fP from the set of children managed by this group node\&. Will decrease the reference count of \fIchild\fP by 1\&.
.PP
This is a convenience method\&. It will simply call \fBfindChild()\fP with \fIchild\fP as argument, and then call \fBremoveChild(int)\fP if the child is found\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::removeAllChildren (\fBvoid\fP)\fC [virtual]\fP"
Do not manage the children anymore\&. Will dereference all children by 1 as they are removed\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::replaceChild (int index, \fBSoNode\fP * newchild)\fC [virtual]\fP"
Replace child at \fIindex\fP with \fInewChild\fP\&.
.PP
Dereferences the child previously at \fIindex\fP, and increases the reference count of \fInewChild\fP by 1\&.
.PP
\fIindex\fP must be < this->\fBgetNumChildren()\fP
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::replaceChild (\fBSoNode\fP * oldchild, \fBSoNode\fP * newchild)\fC [virtual]\fP"
Replace \fIoldchild\fP with \fInewchild\fP\&.
.PP
Dereferences \fIoldchild\fP by 1, and increases the reference count of \fInewchild\fP by 1\&.
.PP
This is a convenience method\&. It will simply call \fBfindChild()\fP with \fIoldchild\fP as argument, and call \fBreplaceChild(int, SoNode*)\fP if the child is found\&.
.PP
Please note that this method is not virtual in the original SGI Inventor API\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBSoChildList\fP * SoVRMLParent::getChildren (\fBvoid\fP) const\fC [virtual]\fP"
Returns list of children\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::doAction (\fBSoAction\fP * action)\fC [virtual]\fP"
This function performs the typical operation of a node for any action\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.PP
Reimplemented in \fBSoVRMLBillboard\fP, \fBSoVRMLGroup\fP, and \fBSoVRMLTransform\fP\&.
.SS "\fBvoid\fP SoVRMLParent::search (\fBSoSearchAction\fP * action)\fC [virtual]\fP"
Action method for \fBSoSearchAction\fP\&.
.PP
Compares the search criteria from the \fIaction\fP to see if this node is a match\&. Searching is done by matching up \fIall\fP criteria set up in the \fBSoSearchAction\fP -- if \fIany\fP of the requested criteria is a miss, the search is not deemed successful for the node\&.
.PP
\fBSee also\fP
.RS 4
\fBSoSearchAction\fP 
.RE
.PP

.PP
Reimplemented from \fBSoGroup\fP\&.
.PP
Reimplemented in \fBSoVRMLBillboard\fP, and \fBSoVRMLGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::write (\fBSoWriteAction\fP * action)\fC [virtual]\fP"
Action method for \fBSoWriteAction\fP\&.
.PP
Writes out a node object, and any connected nodes, engines etc, if necessary\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.PP
Reimplemented in \fBSoVRMLGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::getPrimitiveCount (\fBSoGetPrimitiveCountAction\fP * action)\fC [virtual]\fP"
Action method for the \fBSoGetPrimitiveCountAction\fP\&.
.PP
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the \fIaction\fP\&.
.PP
Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.PP
Reimplemented in \fBSoVRMLGroup\fP, and \fBSoVRMLTransform\fP\&.
.SS "\fBvoid\fP SoVRMLParent::updateChildList (\fBconst\fP \fBSoNode\fP *\fBconst\fP * nodes, \fBconst\fP int numnodes, \fBSoChildList\fP & cl)\fC [static]\fP"
A convenience method that can be used to update \fIcl\fP to match the list of nodes in \fInodes\fP\&. 
.SS "\fBvoid\fP SoVRMLParent::updateChildList (\fBSoNode\fP * nodewithsfnode, \fBSoChildList\fP & cl)\fC [static]\fP"
A convenience method that is used to sync the nodes in \fIcl\fP with all nodes in \fBSoSFNode\fP fields in \fInodewithsfnode\fP\&. 
.SS "\fBvoid\fP SoVRMLParent::notify (\fBSoNotList\fP * l)\fC [protected]\fP, \fC [virtual]\fP"
Notifies all auditors for this instance when changes are made\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoVRMLBillboard\fP, \fBSoVRMLCollision\fP, \fBSoVRMLGroup\fP, and \fBSoVRMLTransform\fP\&.
.SS "SbBool SoVRMLParent::readInstance (\fBSoInput\fP * in, \fBunsigned\fP short flags)\fC [protected]\fP, \fC [virtual]\fP"
This method is mainly intended for internal use during file import operations\&.
.PP
It reads a definition of an instance from the input stream \fIin\fP\&. The input stream state points to the start of a serialized / persistent representation of an instance of this class type\&.
.PP
\fCTRUE\fP or \fCFALSE\fP is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not\&. The import process should be robust and handle corrupted input streams by returning \fCFALSE\fP\&.
.PP
\fIflags\fP is used internally during binary import when reading user extension nodes, group nodes or engines\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SS "\fBvoid\fP SoVRMLParent::copyContents (\fBconst\fP \fBSoFieldContainer\fP * from, SbBool copyconnections)\fC [protected]\fP, \fC [virtual]\fP"
Makes a deep copy of all data of \fIfrom\fP into this instance, \fIexcept\fP external scene graph references if \fIcopyconnections\fP is \fCFALSE\fP\&.
.PP
This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that are not handled automatically\&.
.PP
For copying nodes from application code, you should not invoke this function directly, but rather call the \fBSoNode::copy()\fP function:
.PP
.PP
.nf
SoNode * mynewnode = templatenode\->copy();
.fi
.PP
.PP
The same also goes for engines\&.
.PP
Make sure that when you override the \fBcopyContents()\fP method in your extension class that you also make it call upwards to its parent superclass in the inheritance hierarchy, as \fBcopyContents()\fP in for instance \fBSoNode\fP and \fBSoFieldContainer\fP does important work\&. It should go something like this:
.PP
.PP
.nf
void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc\&.)
  SoNode::copyContents(from, copyconnections);

  // [\&.\&.then copy internal data\&.\&.]
}
.fi
.PP
 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSoMFNode\fP SoVRMLParent::children"
The children nodes\&. 
.SS "\fBSoMFNode\fP SoVRMLParent::addChildren\fC [protected]\fP"
An eventIn that is used to add children to this node\&. 
.SS "\fBSoMFNode\fP SoVRMLParent::removeChildren\fC [protected]\fP"
An eventIn that is used to remove children from this node\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.