SoProfileCoordinateElement Class Reference

The SoProfileCoordinateElement class is yet to be documented. More...

#include <Inventor/elements/SoProfileCoordinateElement.h>

Inheritance diagram for SoProfileCoordinateElement:

Public Member Functions
const SbVec2f &	get2 (const int index) const
const SbVec3f &	get3 (const int index) const
const SbVec2f *	getArrayPtr2 (void) const
const SbVec3f *	getArrayPtr3 (void) const
int32_t	getNum (void) const
virtual void	init (SoState *state)
SbBool	is2D (void) const
Public Member Functions inherited from SoReplacedElement
virtual SoElement *	copyMatchInfo () const
SbUniqueId	getNodeId () const
virtual SbBool	matches (const SoElement *element) const
virtual void	print (FILE *file) const
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SbVec2f	getDefault2 (void)
static SbVec3f	getDefault3 (void)
static const SoProfileCoordinateElement *	getInstance (SoState *const state)
static void	initClass (void)
static void	set2 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec2f *const coords)
static void	set3 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords)
Static Public Member Functions inherited from SoReplacedElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Member Functions
virtual	~SoProfileCoordinateElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
const SbVec2f *	coords2
const SbVec3f *	coords3
SbBool	coordsAre2D
int32_t	numCoords
Protected Attributes inherited from SoReplacedElement
SbUniqueId	nodeId
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
Static Protected Member Functions inherited from SoReplacedElement
static SoElement *	getElement (SoState *const state, const int stackIndex, SoNode *const node)
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

Detailed Description

The SoProfileCoordinateElement class is yet to be documented.

FIXME: write doc.

Constructor & Destructor Documentation

~SoProfileCoordinateElement()

SoProfileCoordinateElement::~SoProfileCoordinateElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

createInstance()

void * SoProfileCoordinateElement::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

get2()

const SbVec2f & SoProfileCoordinateElement::get2

(

const int

index

)

const

Returns the index'th 2D coordinate.

See also

is2D()

get3()

const SbVec3f & SoProfileCoordinateElement::get3

(

const int

index

)

const

Returns the index'th 3D coordinate.

See also

is2D()

getArrayPtr2()

const SbVec2f * SoProfileCoordinateElement::getArrayPtr2

(

void

)

const

Returns a pointer to the 2D coordinates.

getArrayPtr3()

const SbVec3f * SoProfileCoordinateElement::getArrayPtr3

(

void

)

const

Returns a pointer to the 3D coordinates.

getClassStackIndex()

int SoProfileCoordinateElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoProfileCoordinateElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getDefault2()

SbVec2f SoProfileCoordinateElement::getDefault2 ( void )

static

Returns the default 2D coordinate.

getDefault3()

SbVec3f SoProfileCoordinateElement::getDefault3 ( void )

static

Returns the default 3D coordinate.

getInstance()

const SoProfileCoordinateElement * SoProfileCoordinateElement::getInstance ( SoState *const state )

static

Returns the current element.

getNum()

int32_t SoProfileCoordinateElement::getNum

(

void

)

const

Returns the number of profile coordinates in this element.

init()

void SoProfileCoordinateElement::init ( SoState * state )

virtual

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoReplacedElement.

initClass()

void SoProfileCoordinateElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

is2D()

SbBool SoProfileCoordinateElement::is2D

(

void

)

const

Returns if this element contains 2D coordinates.

set2()

void SoProfileCoordinateElement::set2 ( SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec2f *const coords )

static

Sets the profile coordinates.

set3()

void SoProfileCoordinateElement::set3 ( SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords )

static

Sets the profile coordinates.

Member Data Documentation

coords2

SoProfileCoordinateElement::coords2

protected

FIXME: write doc.

coords3

SoProfileCoordinateElement::coords3

protected

FIXME: write doc.

coordsAre2D

SoProfileCoordinateElement::coordsAre2D

protected

FIXME: write doc.

numCoords

SoProfileCoordinateElement::numCoords

protected

FIXME: write doc.

---

The documentation for this class was generated from the following files:

• SoProfileCoordinateElement.h
• SoProfileCoordinateElement.cpp