Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoUnitsElement Class Reference

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 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 set (SoState *state, Units units)
 Sets the current units in the state.
 
static void set (SoState *state, SoNode *, Units units)
 Sets the current units in the state.
 
static Units get (SoState *state)
 Returns current units from the state.
 
static Units getDefault ()
 Returns the default units.
 
- Static Public Member Functions inherited from SoInt32Element
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 units type.

This element stores the current units type.

SEE ALSO

SoUnits

Definition at line 67 of file SoUnitsElement.h.

Member Enumeration Documentation

◆ Units

These are the available types of 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.

Member Function Documentation

◆ get()

static Units SoUnitsElement::get ( SoState state)
inlinestatic

Returns current units from the state.

Definition at line 107 of file SoUnitsElement.h.

◆ getClassStackIndex()

static int SoUnitsElement::getClassStackIndex ( )
static

Returns the stack id for this element.


◆ getClassTypeId()

static SoType SoUnitsElement::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getDefault()

static Units SoUnitsElement::getDefault ( )
inlinestatic

Returns the default units.

Definition at line 113 of file SoUnitsElement.h.

◆ print()

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

Prints element (for debugging).

Reimplemented from SoInt32Element.

◆ set() [1/2]

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

Sets the current units in the state.

Definition at line 101 of file SoUnitsElement.h.

◆ set() [2/2]

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

Sets the current units in the state.

Definition at line 95 of file SoUnitsElement.h.


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