.TH "SoProfileCoordinateElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoProfileCoordinateElement \- The \fBSoProfileCoordinateElement\fP class is yet to be documented\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoReplacedElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "int32_t \fBgetNum\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec2f\fP & \fBget2\fP (\fBconst\fP int index) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec3f\fP & \fBget3\fP (\fBconst\fP int index) \fBconst\fP" .br .ti -1c .RI "SbBool \fBis2D\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec2f\fP * \fBgetArrayPtr2\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec3f\fP * \fBgetArrayPtr3\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *element) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP () \fBconst\fP" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP () \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP) \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 \fBpush\fP (\fBSoState\fP *state)" .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 \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 \fBset2\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int32_t \fBnumCoords\fP, \fBconst\fP \fBSbVec2f\fP *\fBconst\fP coords)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBset3\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int32_t \fBnumCoords\fP, \fBconst\fP \fBSbVec3f\fP *\fBconst\fP coords)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoProfileCoordinateElement\fP * \fBgetInstance\fP (\fBSoState\fP *\fBconst\fP state)" .br .ti -1c .RI "\fBstatic\fP \fBSbVec2f\fP \fBgetDefault2\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSbVec3f\fP \fBgetDefault3\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoReplacedElement\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~SoProfileCoordinateElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoReplacedElement\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 "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\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 "int32_t \fBnumCoords\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec2f\fP * \fBcoords2\fP" .br .ti -1c .RI "\fBconst\fP \fBSbVec3f\fP * \fBcoords3\fP" .br .ti -1c .RI "SbBool \fBcoordsAre2D\fP" .br .in -1c Protected Attributes inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "SbUniqueId \fBnodeId\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 \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP, \fBSoNode\fP *\fBconst\fP node)" .br .in -1c 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 \fBSoProfileCoordinateElement\fP class is yet to be documented\&. FIXME: write doc\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoProfileCoordinateElement::~SoProfileCoordinateElement (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoProfileCoordinateElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoProfileCoordinateElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoProfileCoordinateElement::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 SoProfileCoordinateElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "\fBvoid\fP SoProfileCoordinateElement::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 \fBSoReplacedElement\fP\&. .SS "\fBvoid\fP SoProfileCoordinateElement::set2 (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int32_t numCoords, \fBconst\fP \fBSbVec2f\fP *\fBconst\fP coords)\fC [static]\fP" Sets the profile coordinates\&. .SS "\fBvoid\fP SoProfileCoordinateElement::set3 (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int32_t numCoords, \fBconst\fP \fBSbVec3f\fP *\fBconst\fP coords)\fC [static]\fP" Sets the profile coordinates\&. .SS "\fBconst\fP \fBSoProfileCoordinateElement\fP * SoProfileCoordinateElement::getInstance (\fBSoState\fP *\fBconst\fP state)\fC [static]\fP" Returns the current element\&. .SS "int32_t SoProfileCoordinateElement::getNum (\fBvoid\fP) const" Returns the number of profile coordinates in this element\&. .SS "\fBconst\fP \fBSbVec2f\fP & SoProfileCoordinateElement::get2 (\fBconst\fP int index) const" Returns the \fIindex'th\fP 2D coordinate\&. .PP \fBSee also\fP .RS 4 \fBis2D()\fP .RE .PP .SS "\fBconst\fP \fBSbVec3f\fP & SoProfileCoordinateElement::get3 (\fBconst\fP int index) const" Returns the \fIindex'th\fP 3D coordinate\&. .PP \fBSee also\fP .RS 4 \fBis2D()\fP .RE .PP .SS "SbBool SoProfileCoordinateElement::is2D (\fBvoid\fP) const" Returns if this element contains 2D coordinates\&. .SS "\fBSbVec2f\fP SoProfileCoordinateElement::getDefault2 (\fBvoid\fP)\fC [static]\fP" Returns the default 2D coordinate\&. .SS "\fBSbVec3f\fP SoProfileCoordinateElement::getDefault3 (\fBvoid\fP)\fC [static]\fP" Returns the default 3D coordinate\&. .SS "\fBconst\fP \fBSbVec2f\fP * SoProfileCoordinateElement::getArrayPtr2 (\fBvoid\fP) const" Returns a pointer to the 2D coordinates\&. .SS "\fBconst\fP \fBSbVec3f\fP * SoProfileCoordinateElement::getArrayPtr3 (\fBvoid\fP) const" Returns a pointer to the 3D coordinates\&. .SH "Member Data Documentation" .PP .SS "SoProfileCoordinateElement::numCoords\fC [protected]\fP" FIXME: write doc\&. .SS "SoProfileCoordinateElement::coords2\fC [protected]\fP" FIXME: write doc\&. .SS "SoProfileCoordinateElement::coords3\fC [protected]\fP" FIXME: write doc\&. .SS "SoProfileCoordinateElement::coordsAre2D\fC [protected]\fP" FIXME: write doc\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.