'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoUnits(3IV)
.SH NAME
SoUnits \(em node that scales to convert units of length 
.SH INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoTransformation > SoUnits
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/nodes/SoUnits.h>
.sp
.in 0.5i
\*(Crenum \*(CbUnits\*(Cr {
.in 1i
.ta 25m
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::METERS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::CENTIMETERS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::MILLIMETERS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::MICROMETERS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::MICRONS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::NANOMETERS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::ANGSTROMS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::KILOMETERS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::FEET\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::INCHES\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::POINTS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::YARDS\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::MILES\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 1.5i+25n
.ti 1i
.ta 25m
.ds Pt \*(CbSoUnits::NAUTICAL_MILES\f1
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 1i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}

.br
.in 0.5i
\*(Cr}
.sp
.in 1i
\f1Fields from class SoUnits:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSoSFEnum
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunits
.sp
.in 1i
\f1Methods from class SoUnits:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoUnits\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.sp
.in 1i
\f1Methods from class SoNode:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetOverride\*(Cr(SbBool state)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOverride\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSoNode *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbcopy\*(Cr(SbBool copyConnections = FALSE) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbaffectsState\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic SoNode *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetByName\*(Cr(const SbName &name)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic int
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetByName\*(Cr(const SbName &name, SoNodeList &list)
.sp
.in 1i
\f1Methods from class SoFieldContainer:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetToDefaults\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbhasDefaultValues\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbfieldsAreEqual\*(Cr(const SoFieldContainer *fc) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbcopyFieldValues\*(Cr(const SoFieldContainer *fc, SbBool copyConnections = FALSE)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbset\*(Cr(const char *fieldDataString)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbget\*(Cr(SbString &fieldDataString)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual int
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetFields\*(Cr(SoFieldList &resultList) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SoField *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetField\*(Cr(const SbName &fieldName) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetFieldName\*(Cr(const SoField *field, SbName &fieldName) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisNotifyEnabled\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbenableNotify\*(Cr(SbBool flag)
.sp
.in 1i
\f1Methods from class SoBase:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbref\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunref\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbunrefNoDelete\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbtouch\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetTypeId\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOfType\*(Cr(SoType type) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual void
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetName\*(Cr(const SbName &name)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbName
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetName\*(Cr() const
.sp
.SH 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 \*(CrINCHES\f1 will have the same effect as
\&adding an \*(CbSoScale\f1 node with the \*(CbscaleFactor\f1 of (.0254, .0254, .0254). Any subsequent \*(CbSoUnits\f1 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 \*(CbSoUnits\f1 node at the beginning of each of the pieces, under an \*(CbSoSeparator\f1 node, to make sure all the pieces fit together with the same scale. 
.SH FIELDS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSoSFEnum
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunits
.br
.in 1i
\f1Defines the current unit. 
.sp
.in 0.5i
.SH METHODS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoUnits\*(Cr()
.br
.in 1i
\f1Creates a unit conversion node with default settings. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.br
.in 1i
\f1Returns type identifier for this class. 
.sp
.in 0.5i
.SH ACTION BEHAVIOR
\*(CbSoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoRayPickAction
.br
.in 1i
\f1Accumulates the scale that is the ratio of the size from the previous unit to the current unit into the current transformation. 
.sp
.in 0.5i
\*(CbSoGetMatrixAction
.br
.in 1i
\f1Returns the matrix corresponding to the units scaling. 
.sp
.in 0.5i
.SH FILE FORMAT/DEFAULTS
.nf
\*(CrUnits {
.in 1i
.ta 7m
units	METERS
.in 0.5i
}
.SH SEE ALSO
\*(CbSoScale, SoTransform