.TH "SoProfileElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoProfileElement \- The \fBSoProfileElement\fP class is yet to be documented\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoAccumulatedElement\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBProfile\fP { \fBSTART_FIRST\fP, \fBSTART_NEW\fP, \fBADD_TO_CURRENT\fP }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpush\fP (\fBSoState\fP *state)" .br .in -1c Public Member Functions inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *element) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBconst\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int \fBgetStackIndex\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevTopElement\fP)" .br .ti -1c .RI "\fBvoid\fP \fBsetDepth\fP (\fBconst\fP int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP=\fBstdout\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fB~SoElement\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 int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBadd\fP (\fBSoState\fP *\fBconst\fP state, \fBSoProfile\fP *\fBconst\fP profile)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoNodeList\fP & \fBget\fP (\fBSoState\fP *\fBconst\fP state)" .br .in -1c Static Public Member Functions inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitElements\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNumStackIndices\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetIdFromStackIndex\fP (\fBconst\fP int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoProfileElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoAccumulatedElement\fP ()" .br .ti -1c .RI "\fBvoid\fP \fBclearNodeIds\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBaddNodeId\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)" .br .ti -1c .RI "\fBvoid\fP \fBsetNodeId\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)" .br .ti -1c .RI "\fBvoid\fP \fBcopyNodeIds\fP (\fBconst\fP \fBSoAccumulatedElement\fP *\fBcopyfrom\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBcapture\fP (\fBSoState\fP *\fBconst\fP state) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetTypeId\fP (\fBconst\fP \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "\fBvoid\fP \fBsetStackIndex\fP (\fBconst\fP int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSoNodeList\fP \fBprofiles\fP" .br .in -1c Protected Attributes inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "\fBSbList\fP< SbUniqueId > \fBnodeIds\fP" .br .in -1c Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoType\fP \fBtypeId\fP" .br .ti -1c .RI "int \fBstackIndex\fP" .br .ti -1c .RI "int \fBdepth\fP" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBcreateStackIndex\fP (\fBconst\fP \fBSoType\fP id)" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP int \fBclassStackIndex\fP" .br .ti -1c .RI "\fBstatic\fP \fBSoTypeList\fP * \fBstackToType\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoProfileElement\fP class is yet to be documented\&. FIXME: write doc\&. .SH "Member Enumeration Documentation" .PP .SS "\fBenum\fP \fBSoProfileElement::Profile\fP" FIXME: write doc\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoProfileElement::~SoProfileElement (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP" The destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoProfileElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoProfileElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoProfileElement::createInstance (\fBvoid\fP)\fC [static]\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 Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .br .SS "\fBvoid\fP SoProfileElement::init (\fBSoState\fP * state)\fC [virtual]\fP" This function initializes the element type in the given \fBSoState\fP\&. It is called for the first element of each enabled element type in \fBSoState\fP objects\&. .PP Reimplemented from \fBSoAccumulatedElement\fP\&. .SS "\fBvoid\fP SoProfileElement::push (\fBSoState\fP * state)\fC [virtual]\fP" This method is called every time a new element is required in one of the stacks\&. This happens when a writable element is requested, using \fBSoState::getElement()\fP or indirectly \fBSoElement::getElement()\fP, and the depth of the current element is less than the state depth\&. .PP Override this method if your element needs to copy data from the previous top of stack\&. The \fBpush()\fP method is called on the new element, and the previous element can be found using \fBSoElement::getNextInStack()\fP\&. .PP Reimplemented from \fBSoAccumulatedElement\fP\&. .SS "\fBvoid\fP SoProfileElement::add (\fBSoState\fP *\fBconst\fP state, \fBSoProfile\fP *\fBconst\fP profile)\fC [static]\fP" Adds \fIprofile\fP to the list of profiles\&. .SS "\fBconst\fP \fBSoNodeList\fP & SoProfileElement::get (\fBSoState\fP *\fBconst\fP state)\fC [static]\fP" Returns current list of profiles\&. .SH "Member Data Documentation" .PP .SS "SoProfileElement::profiles\fC [protected]\fP" FIXME: write doc\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.