SoProfileCoordinateElement Class Reference

Element storing the current profile coordinates, as either 2-D or 3-D points. More...

#include <Inventor/elements/SoProfileCoordinateElement.h>

Inheritance diagram for SoProfileCoordinateElement:

Public Member Functions
virtual void	init (SoState *state)
	Initializes element.
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 2- or 3-vector, converting if necessary.
const SbVec3f &	get3 (int index) const
bool	is2D () const
	TRUE if set2() was called.
virtual void	print (FILE *fp) const
	Prints element (for debugging)
Public Member Functions inherited from SoReplacedElement
virtual void	init (SoState *state)
	Initializes node id in element.
virtual bool	matches (const SoElement *elt) const
	Returns TRUE if the element matches another element, based on node-id.
virtual void	print (FILE *fp) const
	Prints element (for debugging)
virtual SoElement *	copyMatchInfo () const
	Create and return a copy of this element.
SbNodeIdType	getNodeId () const
	Return nodeId.
Public Member Functions inherited from SoElement
virtual void	init (SoState *state)
	Initializes element.
virtual void	push (SoState *state)
	Pushes/pops element.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	print (FILE *fp) const
	Prints element (for debugging)
virtual bool	matches (const SoElement *elt) const =0
	Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
virtual SoElement *	copyMatchInfo () const =0
	Create a copy that we can put in a cache used list and call matches() on later.
SoType	getTypeId () const
	Returns type identifier for element instance.
int	getStackIndex () const
	Returns the stack index for an element instance.
void	setDepth (int dpth)
	Sets stuff in an element instance.
void	setNext (SoElement *nxt)
void	setNextInStack (SoElement *nxt)
void	setNextFree (SoElement *nxt)
int	getDepth () const
	Returns stuff from element instance.
SoElement *	getNext () const
virtual	~SoElement ()
	Destructor.

Static Public Member Functions
static void	set2 (SoState *state, SoNode *node, int32_t numCoords, const SbVec2f *coords)
	Sets the current profile coordinates.
static void	set3 (SoState *state, SoNode *node, int32_t numCoords, const SbVec3f *coords)
static const SoProfileCoordinateElement *	getInstance (SoState *state)
	Returns the top (current) instance of the element in the state.
static SbVec2f	getDefault2 ()
	Returns the default profile coordinate.
static SbVec3f	getDefault3 ()
static void	initClass ()
	Initializes the SoCoordinateElement class.
Static Public Member Functions inherited from SoReplacedElement
static void	initClass ()
	Initializes the SoReplacedElement class.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
static void	initElements ()
	Initialize ALL Inventor element classes.
static void	initClass ()
	Initializes the SoElement class.
static int	getNumStackIndices ()
	Returns the number of stack indices allocated.
static SoType	getIdFromStackIndex (int stackIndex)
	Returns the id for the element with the given stack index.

Protected Member Functions
virtual	~SoProfileCoordinateElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
	Destructor.
Protected Member Functions inherited from SoElement
	SoElement ()
	Constructor; use typeId.createInstance to create elements.
void	capture (SoState *state) const
	Does whatever is necessary in state to capture this element for caching purposes.
virtual void	captureThis (SoState *state) const
	Really captures this element, once it has been determined that a cache is open to capture it.
void	setTypeId (SoType id)
	Sets typeId in instance.
void	setStackIndex (int index)
	Sets stackIndex in instance.
SoElement *	getNextInStack () const
	Returns next instance in specific element stack.
SoElement *	getNextFree () const
	Returns next free element in a specific element stack.

Protected Attributes
int32_t	numCoords
const SbVec2f *	coords2
const SbVec3f *	coords3
bool	coordsAre2D
Protected Attributes inherited from SoReplacedElement
SbNodeIdType	nodeId

Additional Inherited Members
Static Protected Member Functions inherited from SoReplacedElement
static SoElement *	getElement (SoState *state, int stackIndex, SoNode *node)
	Overrides SoElement::getElement() to set the nodeId in the element instance before returning it.
Static Protected Member Functions inherited from SoElement
static SoElement *	getElement (SoState *state, int stackIndex)
	Returns an instance of an element from the stack with the given index in the given state.
static const SoElement *	getConstElement (SoState *state, int stackIndex)
	Returns a read-only pointer to the top instance in the given element stack.
static int	createStackIndex (SoType id)
	Creates and returns a new stack index.
Static Protected Attributes inherited from SoElement
static int	classStackIndex
	Stack index for SoElement class.

Detailed Description

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.

Definition at line 75 of file SoProfileCoordinateElement.h.

Constructor & Destructor Documentation

~SoProfileCoordinateElement()

virtual SoProfileCoordinateElement::~SoProfileCoordinateElement ( )

protectedvirtual

Member Function Documentation

get2()

const SbVec2f & SoProfileCoordinateElement::get2

(

int

index

)

const

get3()

const SbVec3f & SoProfileCoordinateElement::get3

(

int

index

)

const

getDefault2()

static SbVec2f SoProfileCoordinateElement::getDefault2 ( )

inlinestatic

Definition at line 104 of file SoProfileCoordinateElement.h.

getDefault3()

static SbVec3f SoProfileCoordinateElement::getDefault3 ( )

inlinestatic

Definition at line 105 of file SoProfileCoordinateElement.h.

getInstance()

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

static

getNum()

int32_t SoProfileCoordinateElement::getNum ( ) const

inline

Definition at line 93 of file SoProfileCoordinateElement.h.

init()

virtual void SoProfileCoordinateElement::init ( SoState *  state )

virtual

Reimplemented from SoReplacedElement.

initClass()

static void SoProfileCoordinateElement::initClass ( )

static

is2D()

bool SoProfileCoordinateElement::is2D ( ) const

inline

Definition at line 101 of file SoProfileCoordinateElement.h.

print()

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

virtual

Reimplemented from SoReplacedElement.

set2()

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

static

set3()

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

static

Member Data Documentation

coords2

const SbVec2f* SoProfileCoordinateElement::coords2

protected

Definition at line 115 of file SoProfileCoordinateElement.h.

coords3

const SbVec3f* SoProfileCoordinateElement::coords3

protected

Definition at line 116 of file SoProfileCoordinateElement.h.

coordsAre2D

bool SoProfileCoordinateElement::coordsAre2D

protected

Definition at line 117 of file SoProfileCoordinateElement.h.

numCoords

int32_t SoProfileCoordinateElement::numCoords

protected

Definition at line 114 of file SoProfileCoordinateElement.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/elements/SoProfileCoordinateElement.h