SoUnitsElement Class Reference

Element that stores the current units type. More...

#include <Inventor/elements/SoUnitsElement.h>

Inheritance diagram for SoUnitsElement:

Public Types
enum	Units {   METERS , CENTIMETERS , MILLIMETERS , MICROMETERS ,   MICRONS , NANOMETERS , ANGSTROMS , KILOMETERS ,   FEET , INCHES , POINTS , YARDS ,   MILES , NAUTICAL_MILES }
	These are the available types of units: More...

Public Member Functions
virtual void	init (SoState *state)
	Initializes element. More...
virtual void	print (FILE *fp) const
	Prints element (for debugging) More...
Public Member Functions inherited from SoInt32Element
virtual bool	matches (const SoElement *elt) const
	Comparison based on value of int32_ts. More...
virtual SoElement *	copyMatchInfo () const
	Copy method, takes care copying the data. More...
virtual void	setElt (int32_t value)
	Virtual set that subclasses can override to implement side-effect behaviors. More...
Public Member Functions inherited from SoElement
virtual void	push (SoState *state)
	Pushes/pops element. More...
virtual void	pop (SoState *state, const SoElement *prevTopElement)
SoType	getTypeId () const
	Returns type identifier for element instance. More...
int	getStackIndex () const
	Returns the stack index for an element instance. More...
void	setDepth (int dpth)
	Sets stuff in an element instance. More...
void	setNext (SoElement *nxt)
void	setNextInStack (SoElement *nxt)
void	setNextFree (SoElement *nxt)
int	getDepth () const
	Returns stuff from element instance. More...
SoElement *	getNext () const
virtual	~SoElement ()
	Destructor. More...

Static Public Member Functions
static void	set (SoState *state, Units units)
	Sets the current units in the state. More...
static void	set (SoState *state, SoNode *, Units units)
static Units	get (SoState *state)
	Returns current units from the state. More...
static Units	getDefault ()
	Returns the default units. More...
static void	initClass ()
	Initializes the SoUnitsElement class. More...
Static Public Member Functions inherited from SoInt32Element
static void	initClass ()
	Initializes the SoInt32Element class. More...
static void	set (int stackIndex, SoState *state, int32_t value)
	Set value. More...
static void	set (int stackIndex, SoState *state, SoNode *, int32_t value)
static void	set (int stackIndex, SoState *state, SoNode *, long value)
static int32_t	get (int stackIndex, SoState *state)
	Get value. More...
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class. More...
static void	initElements ()
	Initialize ALL Inventor element classes. More...
static void	initClass ()
	Initializes the SoElement class. More...
static int	getNumStackIndices ()
	Returns the number of stack indices allocated. More...
static SoType	getIdFromStackIndex (int stackIndex)
	Returns the id for the element with the given stack index. More...

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

Additional Inherited Members
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. More...
static const SoElement *	getConstElement (SoState *state, int stackIndex)
	Returns a read-only pointer to the top instance in the given element stack. More...
static int	createStackIndex (SoType id)
	Creates and returns a new stack index. More...
Protected Attributes inherited from SoInt32Element
int32_t	data
	Storage for data. More...
Static Protected Attributes inherited from SoElement
static int	classStackIndex
	Stack index for SoElement class. More...

Detailed Description

Definition at line 69 of file SoUnitsElement.h.

Member Enumeration Documentation

Units

enum SoUnitsElement::Units

Enumerator
METERS
CENTIMETERS
MILLIMETERS
MICROMETERS
MICRONS
NANOMETERS
ANGSTROMS
KILOMETERS
FEET
INCHES
POINTS
YARDS
MILES
NAUTICAL_MILES

Definition at line 75 of file SoUnitsElement.h.

Constructor & Destructor Documentation

~SoUnitsElement()

virtual SoUnitsElement::~SoUnitsElement ( )

protectedvirtual

Member Function Documentation

get()

static Units SoUnitsElement::get ( SoState *  state )

inlinestatic

Definition at line 105 of file SoUnitsElement.h.

References SoInt32Element::get().

getDefault()

static Units SoUnitsElement::getDefault ( )

inlinestatic

Definition at line 109 of file SoUnitsElement.h.

init()

virtual void SoUnitsElement::init ( SoState *  state )

virtual

Reimplemented from SoElement.

initClass()

static void SoUnitsElement::initClass ( )

static

print()

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

virtual

Reimplemented from SoInt32Element.

set() [1/2]

static void SoUnitsElement::set ( SoState *  state, SoNode *  , Units  units  )

inlinestatic

Definition at line 100 of file SoUnitsElement.h.

References SoInt32Element::set().

set() [2/2]

static void SoUnitsElement::set ( SoState *  state, Units  units  )

inlinestatic

Definition at line 96 of file SoUnitsElement.h.

References SoInt32Element::set().

---

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

• /home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/elements/SoUnitsElement.h