SoProfileCoordinateElement Class Reference

Stores the current profile coordinates. More...

#include <Inventor/elements/SoProfileCoordinateElement.h>

Inheritance diagram for SoProfileCoordinateElement:

Public Member Functions
int32_t	getNum () const
	Returns the number of coordinate points in an instance.
const SbVec2f &	get2 (int index) const
	Returns the indexed coordinate from an element as a 2D vector, converting if necessary.
const SbVec3f &	get3 (int index) const
	Returns the indexed coordinate from an element as a 3D vector, converting if necessary.
const SbVec2f *	getCoord2 () const
	Returns the array of SbVec2f without any conversion.
const SbVec3f *	getCoord3 () const
	Returns the array of SbVec3f without any conversion.
SbBool	is2D () const
	TRUE if set2() was called.
virtual void	print (FILE *fp) const
	Prints element (for debugging).
Public Member Functions inherited from SoElement
virtual void	push (SoState *state)
	Pushes element.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
	Pops element.
virtual SoType	getTypeId () const
	Returns type identifier for element instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
static void	set2 (SoState *state, SoNode *node, int32_t numCoords, const SbVec2f *coords)
	Sets the current 2D profile coordinates.
static void	set3 (SoState *state, SoNode *node, int32_t numCoords, const SbVec3f *coords)
	Sets the current 3D profile coordinates.
static const SoProfileCoordinateElement *	getInstance (SoState *state)
	Returns the top (current) instance of the element in the state.
static SbVec2f	getDefault2 ()
	Returns the default 2D profile coordinate.
static SbVec3f	getDefault3 ()
	Returns the default 3D profile coordinate.
Static Public Member Functions inherited from SoReplacedElement
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores the current profile coordinates.

This element stores the current profile coordinates, as either 2D or 3D points.

This class allows read-only access to the top element in the state to make accessing several values in it more efficient. Individual values must be accessed through this instance.

SEE ALSO

SoProfileCoordinate2, SoProfileCoordinate3

Definition at line 76 of file SoProfileCoordinateElement.h.

Member Function Documentation

get2()

const SbVec2f & SoProfileCoordinateElement::get2

(

int

index

)

const

Returns the indexed coordinate from an element as a 2D vector, converting if necessary.

get3()

const SbVec3f & SoProfileCoordinateElement::get3

(

int

index

)

const

Returns the indexed coordinate from an element as a 3D vector, converting if necessary.

getClassStackIndex()

static int SoProfileCoordinateElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoProfileCoordinateElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getCoord2()

const SbVec2f * SoProfileCoordinateElement::getCoord2 ( ) const

inline

Returns the array of SbVec2f without any conversion.

The pointer may be NULL if coordinates are specified as 3D vectors.

Definition at line 119 of file SoProfileCoordinateElement.h.

getCoord3()

const SbVec3f * SoProfileCoordinateElement::getCoord3 ( ) const

inline

Returns the array of SbVec3f without any conversion.

The pointer may be NULL if coordinates are specified as 2D vectors.

Definition at line 125 of file SoProfileCoordinateElement.h.

getDefault2()

static SbVec2f SoProfileCoordinateElement::getDefault2 ( )

inlinestatic

Returns the default 2D profile coordinate.

Definition at line 135 of file SoProfileCoordinateElement.h.

getDefault3()

static SbVec3f SoProfileCoordinateElement::getDefault3 ( )

inlinestatic

Returns the default 3D profile coordinate.

Definition at line 139 of file SoProfileCoordinateElement.h.

getInstance()

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

static

Returns the top (current) instance of the element in the state.

getNum()

int32_t SoProfileCoordinateElement::getNum ( ) const

inline

Returns the number of coordinate points in an instance.

Definition at line 102 of file SoProfileCoordinateElement.h.

is2D()

SbBool SoProfileCoordinateElement::is2D ( ) const

inline

TRUE if set2() was called.

Definition at line 130 of file SoProfileCoordinateElement.h.

print()

virtual void SoProfileCoordinateElement::print ( FILE *  fp ) const

virtual

Prints element (for debugging).

Reimplemented from SoReplacedElement.

set2()

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

static

Sets the current 2D profile coordinates.

set3()

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

static

Sets the current 3D profile coordinates.

---

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

• Inventor/elements/SoProfileCoordinateElement.h