.TH "SoProfileCoordinateElement" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoProfileCoordinateElement \- 
.PP
The \fBSoProfileCoordinateElement\fP class is yet to be documented\&.
.PP
FIXME: write doc\&.  

.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBSoReplacedElement\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBinit\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "int32_t \fBgetNum\fP (void) const "
.br
.ti -1c
.RI "const \fBSbVec2f\fP & \fBget2\fP (const int index) const "
.br
.ti -1c
.RI "const \fBSbVec3f\fP & \fBget3\fP (const int index) const "
.br
.ti -1c
.RI "SbBool \fBis2D\fP (void) const "
.br
.ti -1c
.RI "const \fBSbVec2f\fP * \fBgetArrayPtr2\fP (void) const "
.br
.ti -1c
.RI "const \fBSbVec3f\fP * \fBgetArrayPtr3\fP (void) const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBset2\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int32_t \fBnumCoords\fP, const \fBSbVec2f\fP *const coords)"
.br
.ti -1c
.RI "static void \fBset3\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int32_t \fBnumCoords\fP, const \fBSbVec3f\fP *const coords)"
.br
.ti -1c
.RI "static const 
.br
\fBSoProfileCoordinateElement\fP * \fBgetInstance\fP (\fBSoState\fP *const state)"
.br
.ti -1c
.RI "static \fBSbVec2f\fP \fBgetDefault2\fP (void)"
.br
.ti -1c
.RI "static \fBSbVec3f\fP \fBgetDefault3\fP (void)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual \fB~SoProfileCoordinateElement\fP ()"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "int32_t \fBnumCoords\fP"
.br
.ti -1c
.RI "const \fBSbVec2f\fP * \fBcoords2\fP"
.br
.ti -1c
.RI "const \fBSbVec3f\fP * \fBcoords3\fP"
.br
.ti -1c
.RI "SbBool \fBcoordsAre2D\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoProfileCoordinateElement\fP class is yet to be documented\&.
.PP
FIXME: write doc\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoProfileCoordinateElement::~SoProfileCoordinateElement (void)\fC [protected]\fP, \fC [virtual]\fP"
The destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoProfileCoordinateElement::getClassTypeId (void)\fC [static]\fP"
This static method returns the class type\&. 
.PP
Reimplemented from \fBSoReplacedElement\fP\&.
.SS "int SoProfileCoordinateElement::getClassStackIndex (void)\fC [static]\fP"
This static method returns the state stack index for the class\&. 
.PP
Reimplemented from \fBSoReplacedElement\fP\&.
.SS "void * SoProfileCoordinateElement::createInstance (void)\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 
.SS "void SoProfileCoordinateElement::initClass (void)\fC [static]\fP"
Initialize relevant common data for all instances, like the type system\&. 
.PP
Reimplemented from \fBSoReplacedElement\fP\&.
.SS "void 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 "void SoProfileCoordinateElement::set2 (\fBSoState\fP *conststate, \fBSoNode\fP *constnode, const int32_tnumCoords, const \fBSbVec2f\fP *constcoords)\fC [static]\fP"
Sets the profile coordinates\&. 
.SS "void SoProfileCoordinateElement::set3 (\fBSoState\fP *conststate, \fBSoNode\fP *constnode, const int32_tnumCoords, const \fBSbVec3f\fP *constcoords)\fC [static]\fP"
Sets the profile coordinates\&. 
.SS "const \fBSoProfileCoordinateElement\fP * SoProfileCoordinateElement::getInstance (\fBSoState\fP *conststate)\fC [static]\fP"
Returns the current element\&. 
.SS "int32_t SoProfileCoordinateElement::getNum (void) const"
Returns the number of profile coordinates in this element\&. 
.SS "const \fBSbVec2f\fP & SoProfileCoordinateElement::get2 (const intindex) const"
Returns the \fIindex'th\fP 2D coordinate\&. 
.PP
\fBSee Also:\fP
.RS 4
\fBis2D()\fP 
.RE
.PP

.SS "const \fBSbVec3f\fP & SoProfileCoordinateElement::get3 (const intindex) const"
Returns the \fIindex'th\fP 3D coordinate\&. 
.PP
\fBSee Also:\fP
.RS 4
\fBis2D()\fP 
.RE
.PP

.SS "SbBool SoProfileCoordinateElement::is2D (void) const"
Returns if this element contains 2D coordinates\&. 
.SS "\fBSbVec2f\fP SoProfileCoordinateElement::getDefault2 (void)\fC [static]\fP"
Returns the default 2D coordinate\&. 
.SS "\fBSbVec3f\fP SoProfileCoordinateElement::getDefault3 (void)\fC [static]\fP"
Returns the default 3D coordinate\&. 
.SS "const \fBSbVec2f\fP * SoProfileCoordinateElement::getArrayPtr2 (void) const"
Returns a pointer to the 2D coordinates\&. 
.SS "const \fBSbVec3f\fP * SoProfileCoordinateElement::getArrayPtr3 (void) 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\&.