SoUnits Class Reference

Node that scales to convert units of length. More...

#include <Inventor/nodes/SoUnits.h>

Inheritance diagram for SoUnits:

Public Types
enum	Units {   METERS ,   CENTIMETERS ,   MILLIMETERS ,   MICROMETERS ,   MICRONS ,   NANOMETERS ,   ANGSTROMS ,   KILOMETERS ,   FEET ,   INCHES ,   POINTS ,   YARDS ,   MILES ,   NAUTICAL_MILES }
	Units. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoUnits ()
	Creates a unit conversion node with default settings.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this 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 Public Member Functions inherited from SoTransformation
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	units
	Defines the current unit.

Detailed Description

Node that scales to convert units of length.

This node defines a uniform 3D scale about the origin relative to the previously defined units. The default units for all data are meters. Adding a units node with the value INCHES will have the same effect as adding an SoScale node with the scaleFactor of (.0254, .0254, .0254). Any subsequent SoUnits node will take the previous units into account. When building a composite object out of a bunch of pieces, it would be a good practice to add an SoUnits node at the beginning of each of the pieces, under an SoSeparator node, to make sure all the pieces fit together with the same scale.

FILE FORMAT/DEFAULT

Units {

units

METERS

}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoRayPickAction
Accumulates the scale that is the ratio of the size from the previous unit to the current unit into the current transformation. Sets: SoModelMatrixElement, SoUnitsElement

SoGetMatrixAction
Returns the matrix corresponding to the units scaling.

SEE ALSO

SoScale, SoTransform

Definition at line 103 of file SoUnits.h.

Member Enumeration Documentation

Units

enum SoUnits::Units

Units.

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

Definition at line 109 of file SoUnits.h.

Constructor & Destructor Documentation

SoUnits()

SoUnits::SoUnits

(

)

Creates a unit conversion node with default settings.

Member Function Documentation

getClassTypeId()

static SoType SoUnits::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoUnits::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoTransformation.

Member Data Documentation

units

SoSFEnum SoUnits::units

Defines the current unit.

Use enum Units. Default is METERS.

Definition at line 145 of file SoUnits.h.

---

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

• Inventor/nodes/SoUnits.h