SoUnits(3IV)

NAME
     SoUnits (SoUnits) - node that scales to convert units of length

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoTransformation > SoUnits

SYNOPSIS
     #include <Inventor_c/nodes/SoUnits.h>

     enum SoUnitsUnits {
          SO_UNITS_METERS
          SO_UNITS_CENTIMETERS
          SO_UNITS_MILLIMETERS
          SO_UNITS_MICROMETERS
          SO_UNITS_MICRONS
          SO_UNITS_NANOMETERS
          SO_UNITS_ANGSTROMS
          SO_UNITS_KILOMETERS
          SO_UNITS_FEET
          SO_UNITS_INCHES
          SO_UNITS_POINTS
          SO_UNITS_YARDS
          SO_UNITS_MILES
          SO_UNITS_NAUTICAL_MILES
     }

          Fields from class SoUnits:

     SoSFEnum            units

          Functions from class SoUnits:

     SoUnits *           SoUnitsCreate()
     SoType              SoUnitsGetClassTypeId()

          Functions from class SoNode:

     void                SoUnitsSetOverride(SoUnits *this, SbBool state)
     SbBool              SoUnitsIsOverride(const SoUnits *this)
     SoNode *            SoUnitsCopy(const SoUnits *this, SbBool
                              copyConnections = FALSE)
     SbBool              SoUnitsAffectsState(const SoUnits *this)
     SoNode *            SoUnitsGetByName(const char *name)
     int                 SoUnitsGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoUnitsSetToDflts(SoUnits *this)
     SbBool              SoUnitsHasDfltVals(const SoUnits *this)
     SbBool              SoUnitsFldsAreEq(const SoUnits *this, const
                              SoFieldContainer *fc)
     void                SoUnitsCopyFieldVals(SoUnits *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoUnitsSet(SoUnits *this, const char
                              *fieldDataString)
     void                SoUnitsGet(SoUnits *this, SbString *fieldDataString)
     int                 SoUnitsGetFields(const SoUnits *this, SoFieldList
                              *resultList)
     SoField *           SoUnitsGetField(const SoUnits *this, const char
                              *fieldName)
     SbBool              SoUnitsGetFieldName(const SoUnits *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoUnitsIsNotifyEnabled(const SoUnits *this)
     SbBool              SoUnitsEnableNotify(SoUnits *this, SbBool flag)

          Functions from class SoBase:

     void                SoUnitsRef(SoUnits *this)
     void                SoUnitsUnref(const SoUnits *this)
     void                SoUnitsUnrefNoDelete(const SoUnits *this)
     void                SoUnitsTouch(SoUnits *this)
     SoType              SoUnitsGetTypeId(const SoUnits *this)
     SbBool              SoUnitsIsOfType(const SoUnits *this, SoType type)
     void                SoUnitsSetName(SoUnits *this, const char *name)
     SbName              SoUnitsGetName(const SoUnits *this)


DESCRIPTION
     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.

FIELDS
     SoSFEnum            units
          Defines the current unit.


FUNCTIONS
     SoUnits *           SoUnitsCreate()
          Creates a unit conversion node with default settings.

     SoType              SoUnitsGetClassTypeId()
          Returns type identifier for this class.

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.

     SoGetMatrixAction
          Returns the matrix corresponding to the units scaling.


FILE FORMAT/DEFAULTS
     Units {
          units  METERS
     }

SEE ALSO
     SoScale, SoTransform