unitObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteStatement
  - - org.web3d.x3d.jsail.Core.unitObject

```
public class unitObject
extends X3DConcreteStatement
```
Functional summary: unit statement defines data-conversion factors for typed values defined in a scene. This concrete class represents an X3D unit statement.

X3D statement tooltip: (X3D version 3.3 or later) [X3D statement] A unit statement defines data-conversion factors for typed values defined within a scene.
- Hint: unit statements are optional secondary children of head statement (add a head statement and optionally any component elements first).
- Hint: unit conversionFactor scale values only affect node definitions in the current Scene, leaving Inline and ExternProtoDeclare content subject to their own independent unit statements.
- Hint: a good practice is to always include unit statements in CAD scenes in order to ensure correct model composition.
- Hint: X3D XML Encoding
  http://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
- Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale
- Warning: the UNIT statement is capitalized in the ClassicVRML Encoding.
- Hint: X3D Architecture 7.2.5.5 UNIT statement
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#UNITStatement
` X3D specification: 4.3.6 Standard units and coordinate system defines how scale factors can modify an entire scene. Scale-conversion constants provide correct names and values for common conversion factors. References:
- Unit conversion website
- Wikipedia Conversion factors, units of force
- Unit conversion website
See Also:

X3D Abstract Specification: unit, X3D Tooltips: unit, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CATEGORY_ANGLE` SFString field named category can equal this enumeration value "angle" (Java syntax) or angle (XML syntax).
`static java.lang.String`	`CATEGORY_DEFAULT_VALUE` SFString field named category has default value equal to an empty string.
`static java.lang.String`	`CATEGORY_FORCE` SFString field named category can equal this enumeration value "force" (Java syntax) or force (XML syntax).
`static java.lang.String`	`CATEGORY_LENGTH` SFString field named category can equal this enumeration value "length" (Java syntax) or length (XML syntax).
`static java.lang.String`	`CATEGORY_MASS` SFString field named category can equal this enumeration value "mass" (Java syntax) or mass (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the unit element: Core
`static double`	`CONVERSIONFACTOR_ANGLES_toRadiansFromDegrees` unit statement conversionFactor for converting scene values of angles to Radians from Degrees
`static double`	`CONVERSIONFACTOR_ANGLES_toRadiansFromFullCircle` unit statement conversionFactor for converting scene values of angles to Radians from FullCircle
`static double`	`CONVERSIONFACTOR_ANGLES_toRadiansFromGrads` unit statement conversionFactor for converting scene values of angles to Radians from Grads
`static double`	`CONVERSIONFACTOR_DEFAULT_VALUE` SFDouble field named conversionFactor has default value 1.0 (Java syntax) or 1.0 (XML syntax).
`static double`	`CONVERSIONFACTOR_FORCE_toNewtonsFromDynes` unit statement conversionFactor for converting scene values of force to Newtons from Dynes
`static double`	`CONVERSIONFACTOR_FORCE_toNewtonsFromKilogramForce` unit statement conversionFactor for converting scene values of force to Newtons from Kilogram-force
`static double`	`CONVERSIONFACTOR_FORCE_toNewtonsFromPoundal` unit statement conversionFactor for converting scene values of force to Newtons from Poundal
`static double`	`CONVERSIONFACTOR_FORCE_toNewtonsFromPoundsForce` unit statement conversionFactor for converting scene values of force to Newtons from Pounds-force
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromCentimeters` unit statement conversionFactor for converting scene values of length to Meters from Centimeters
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromFathoms` unit statement conversionFactor for converting scene values of length to Meters from Fathoms
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromFeet` unit statement conversionFactor for converting scene values of length to Meters from Feet
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromFurlongs` unit statement conversionFactor for converting scene values of length to Meters from Furlongs
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromInches` unit statement conversionFactor for converting scene values of length to Meters from Inches
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromKilometers` unit statement conversionFactor for converting scene values of length to Meters from Kilometers
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromMicrons` unit statement conversionFactor for converting scene values of length to Meters from Microns
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromMiles` unit statement conversionFactor for converting scene values of length to Meters from Miles
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromMillimeters` unit statement conversionFactor for converting scene values of length to Meters from Millimeters
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromNauticalMiles` unit statement conversionFactor for converting scene values of length to Meters from Nautical Miles
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromPica` unit statement conversionFactor for converting scene values of length to Meters from Pica
`static double`	`CONVERSIONFACTOR_LENGTH_toMetersFromYards` unit statement conversionFactor for converting scene values of length to Meters from Yards
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFrom` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Micrograms
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromCarats` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Carats
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromCentigrams` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Centigrams
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromDekagrams` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Dekagrams
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromDrams` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Drams Avoirdupois (dr)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromGrains` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Grains Avoirdupois (gr)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromGrams` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Grams (g)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromMetricTonnes` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Metric Tonnes (t)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromMilligrams` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Milligrams
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromOunces` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Ounces Avoirdupois (oz)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromPounds` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Pounds Avoirdupois (lb)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromStone` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Stone, i.e. 14 Pounds Avoirdupois (lb)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromTons` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Tons (U.S. short)
`static double`	`CONVERSIONFACTOR_MASS_toKilogramsFromTroyOunces` unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Troy Ounces (toz)
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Core component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: unit.
`static java.lang.String`	`NAME_DEFAULT_VALUE` SFString field named name has default value equal to an empty string.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description

unitObject()
Constructor for unitObject to initialize member variables with default values.

Constructors
Constructor and Description
`unitObject()` Constructor for unitObject to initialize member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`unitObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`unitObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`unitObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getCategory()` Provide String enumeration value ['angle'\|'force'\|'length'\|'mass'] from initializeOnly SFString field named category.
`java.lang.String`	`getComponent()` Defines X3D component for the unit element: Core
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`double`	`getConversionFactor()` Provide double value within allowed range of (0,infinity) from inputOutput SFDouble field named conversionFactor.
`java.lang.String`	`getElementName()` Provides name of this element: unit
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`java.lang.String`	`getName()` Provide String value from inputOutput SFString field named name.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`unitObject`	`setCategory(SFStringObject newValue)` Assign typed object value to SFString category field, similar to `setCategory(String)`.
`unitObject`	`setCategory(java.lang.String newValue)` Assign String enumeration value ("angle"\|"force"\|"length"\|"mass") ['angle'\|'force'\|'length'\|'mass'] to initializeOnly SFString field named category.
`unitObject`	`setConversionFactor(double newValue)` Assign double value within allowed range of (0,infinity) to inputOutput SFDouble field named conversionFactor.
`unitObject`	`setConversionFactor(SFDoubleObject newValue)` Assign typed object value to SFDouble conversionFactor field, similar to `setConversionFactor(double)`.
`unitObject`	`setName(SFStringObject newValue)` Assign typed object value to SFString name field, similar to `setName(String)`.
`unitObject`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteStatement
isNode, isStatement

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONVERSIONFACTOR_ANGLES_toRadiansFromDegrees
```
public static final double CONVERSIONFACTOR_ANGLES_toRadiansFromDegrees
```
    unit statement conversionFactor for converting scene values of angles to Radians from Degrees
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_ANGLES_toRadiansFromFullCircle
```
public static final double CONVERSIONFACTOR_ANGLES_toRadiansFromFullCircle
```
    unit statement conversionFactor for converting scene values of angles to Radians from FullCircle
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_ANGLES_toRadiansFromGrads
```
public static final double CONVERSIONFACTOR_ANGLES_toRadiansFromGrads
```
    unit statement conversionFactor for converting scene values of angles to Radians from Grads
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromPica
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromPica
```
    unit statement conversionFactor for converting scene values of length to Meters from Pica
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromInches
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromInches
```
    unit statement conversionFactor for converting scene values of length to Meters from Inches
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromFeet
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromFeet
```
    unit statement conversionFactor for converting scene values of length to Meters from Feet
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromYards
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromYards
```
    unit statement conversionFactor for converting scene values of length to Meters from Yards
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromFathoms
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromFathoms
```
    unit statement conversionFactor for converting scene values of length to Meters from Fathoms
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromFurlongs
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromFurlongs
```
    unit statement conversionFactor for converting scene values of length to Meters from Furlongs
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromMiles
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromMiles
```
    unit statement conversionFactor for converting scene values of length to Meters from Miles
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromNauticalMiles
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromNauticalMiles
```
    unit statement conversionFactor for converting scene values of length to Meters from Nautical Miles
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromMicrons
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromMicrons
```
    unit statement conversionFactor for converting scene values of length to Meters from Microns
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromMillimeters
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromMillimeters
```
    unit statement conversionFactor for converting scene values of length to Meters from Millimeters
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromCentimeters
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromCentimeters
```
    unit statement conversionFactor for converting scene values of length to Meters from Centimeters
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_LENGTH_toMetersFromKilometers
```
public static final double CONVERSIONFACTOR_LENGTH_toMetersFromKilometers
```
    unit statement conversionFactor for converting scene values of length to Meters from Kilometers
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_FORCE_toNewtonsFromDynes
```
public static final double CONVERSIONFACTOR_FORCE_toNewtonsFromDynes
```
    unit statement conversionFactor for converting scene values of force to Newtons from Dynes
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_FORCE_toNewtonsFromKilogramForce
```
public static final double CONVERSIONFACTOR_FORCE_toNewtonsFromKilogramForce
```
    unit statement conversionFactor for converting scene values of force to Newtons from Kilogram-force
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_FORCE_toNewtonsFromPoundsForce
```
public static final double CONVERSIONFACTOR_FORCE_toNewtonsFromPoundsForce
```
    unit statement conversionFactor for converting scene values of force to Newtons from Pounds-force
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_FORCE_toNewtonsFromPoundal
```
public static final double CONVERSIONFACTOR_FORCE_toNewtonsFromPoundal
```
    unit statement conversionFactor for converting scene values of force to Newtons from Poundal
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromGrains
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromGrains
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Grains Avoirdupois (gr)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromDrams
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromDrams
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Drams Avoirdupois (dr)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromOunces
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromOunces
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Ounces Avoirdupois (oz)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromTroyOunces
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromTroyOunces
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Troy Ounces (toz)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromPounds
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromPounds
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Pounds Avoirdupois (lb)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromStone
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromStone
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Stone, i.e. 14 Pounds Avoirdupois (lb)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromTons
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromTons
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Tons (U.S. short)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFrom
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFrom
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Micrograms
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromMilligrams
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromMilligrams
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Milligrams
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromCentigrams
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromCentigrams
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Centigrams
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromCarats
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromCarats
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Carats
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromGrams
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromGrams
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Grams (g)
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromDekagrams
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromDekagrams
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Dekagrams
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_MASS_toKilogramsFromMetricTonnes
```
public static final double CONVERSIONFACTOR_MASS_toKilogramsFromMetricTonnes
```
    unit statement conversionFactor for converting scene values of mass to Kilograms (kg) from Metric Tonnes (t)
    
    See Also:
    
    Constant Field Values
  - CATEGORY_ANGLE
```
public static final java.lang.String CATEGORY_ANGLE
```
    SFString field named category can equal this enumeration value "angle" (Java syntax) or angle (XML syntax).
    
    See Also:
    
    Constant Field Values
  - CATEGORY_FORCE
```
public static final java.lang.String CATEGORY_FORCE
```
    SFString field named category can equal this enumeration value "force" (Java syntax) or force (XML syntax).
    
    See Also:
    
    Constant Field Values
  - CATEGORY_LENGTH
```
public static final java.lang.String CATEGORY_LENGTH
```
    SFString field named category can equal this enumeration value "length" (Java syntax) or length (XML syntax).
    
    See Also:
    
    Constant Field Values
  - CATEGORY_MASS
```
public static final java.lang.String CATEGORY_MASS
```
    SFString field named category can equal this enumeration value "mass" (Java syntax) or mass (XML syntax).
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: unit.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the unit element: Core
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Core component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - CATEGORY_DEFAULT_VALUE
```
public static final java.lang.String CATEGORY_DEFAULT_VALUE
```
    SFString field named category has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - CONVERSIONFACTOR_DEFAULT_VALUE
```
public static final double CONVERSIONFACTOR_DEFAULT_VALUE
```
    SFDouble field named conversionFactor has default value 1.0 (Java syntax) or 1.0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - NAME_DEFAULT_VALUE
```
public static final java.lang.String NAME_DEFAULT_VALUE
```
    SFString field named name has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - unitObject
```
public unitObject()
```
    Constructor for unitObject to initialize member variables with default values.
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: unit
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the unit element: Core
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D statement
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D statement
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteStatement
  - getCategory
```
public java.lang.String getCategory()
```
    Provide String enumeration value ['angle'|'force'|'length'|'mass'] from initializeOnly SFString field named category.
    
    Tooltip: Base-unit category as defined in X3D Specification.
    - Hint: X3D Specification 4.3.6 Standard units and coordinate system
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates
    Available enumeration values for string comparison: ANGLE, FORCE, LENGTH, MASS.
    Returns:
    
    value of category field
  - setCategory
```
public unitObject setCategory(java.lang.String newValue)
```
    Assign String enumeration value ("angle"|"force"|"length"|"mass") ['angle'|'force'|'length'|'mass'] to initializeOnly SFString field named category.
    
    Warning: authors can only choose from a strict list of enumeration values (ANGLE, FORCE, LENGTH, MASS).
    
    Tooltip: Base-unit category as defined in X3D Specification. Hint: X3D Specification 4.3.6 Standard units and coordinate system http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates
    
    Parameters:
    
    newValue - is new value for the category field.
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCategory
```
public unitObject setCategory(SFStringObject newValue)
```
    Assign typed object value to SFString category field, similar to setCategory(String).
    
    Parameters:
    
    newValue - is new value for the category field.
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getConversionFactor
```
public double getConversionFactor()
```
    Provide double value within allowed range of (0,infinity) from inputOutput SFDouble field named conversionFactor.
    
    Tooltip: [0,+infinity) Positive double-precision factor that converts new base unit to default base unit.
    - Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale
    Returns:
    
    value of conversionFactor field
  - setConversionFactor
```
public unitObject setConversionFactor(double newValue)
```
    Assign double value within allowed range of (0,infinity) to inputOutput SFDouble field named conversionFactor.
    
    Tooltip: [0,+infinity) Positive double-precision factor that converts new base unit to default base unit. Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale
    
    Parameters:
    
    newValue - is new value for the conversionFactor field.
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setConversionFactor
```
public unitObject setConversionFactor(SFDoubleObject newValue)
```
    Assign typed object value to SFDouble conversionFactor field, similar to setConversionFactor(double).
    
    Parameters:
    
    newValue - is new value for the conversionFactor field.
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getName
```
public java.lang.String getName()
```
    Provide String value from inputOutput SFString field named name.
    
    Tooltip: Author-defined name for this unit conversionFactor value (for example, FeetToMeters).
    - Hint: well-defined names can simplify design and debugging through improved author understanding.
    - Hint: X3D Scene Authoring Hints, Naming Conventions
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    Returns:
    
    value of name field
  - setName
```
public final unitObject setName(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named name.
    
    Tooltip: Author-defined name for this unit conversionFactor value (for example, FeetToMeters). Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    @see X3D Scene Authoring Hints: Naming Conventions
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setName
```
public unitObject setName(SFStringObject newValue)
```
    Assign typed object value to SFString name field, similar to setName(String).
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public unitObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public unitObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public unitObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    unitObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class unitObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteStatement

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

CONVERSIONFACTOR_ANGLES_toRadiansFromDegrees

CONVERSIONFACTOR_ANGLES_toRadiansFromFullCircle

CONVERSIONFACTOR_ANGLES_toRadiansFromGrads

CONVERSIONFACTOR_LENGTH_toMetersFromPica

CONVERSIONFACTOR_LENGTH_toMetersFromInches

CONVERSIONFACTOR_LENGTH_toMetersFromFeet

CONVERSIONFACTOR_LENGTH_toMetersFromYards

CONVERSIONFACTOR_LENGTH_toMetersFromFathoms

CONVERSIONFACTOR_LENGTH_toMetersFromFurlongs

CONVERSIONFACTOR_LENGTH_toMetersFromMiles

CONVERSIONFACTOR_LENGTH_toMetersFromNauticalMiles

CONVERSIONFACTOR_LENGTH_toMetersFromMicrons

CONVERSIONFACTOR_LENGTH_toMetersFromMillimeters

CONVERSIONFACTOR_LENGTH_toMetersFromCentimeters

CONVERSIONFACTOR_LENGTH_toMetersFromKilometers

CONVERSIONFACTOR_FORCE_toNewtonsFromDynes

CONVERSIONFACTOR_FORCE_toNewtonsFromKilogramForce

CONVERSIONFACTOR_FORCE_toNewtonsFromPoundsForce

CONVERSIONFACTOR_FORCE_toNewtonsFromPoundal

CONVERSIONFACTOR_MASS_toKilogramsFromGrains

CONVERSIONFACTOR_MASS_toKilogramsFromDrams

CONVERSIONFACTOR_MASS_toKilogramsFromOunces

CONVERSIONFACTOR_MASS_toKilogramsFromTroyOunces

CONVERSIONFACTOR_MASS_toKilogramsFromPounds

CONVERSIONFACTOR_MASS_toKilogramsFromStone

CONVERSIONFACTOR_MASS_toKilogramsFromTons

CONVERSIONFACTOR_MASS_toKilogramsFrom

CONVERSIONFACTOR_MASS_toKilogramsFromMilligrams

CONVERSIONFACTOR_MASS_toKilogramsFromCentigrams

CONVERSIONFACTOR_MASS_toKilogramsFromCarats

CONVERSIONFACTOR_MASS_toKilogramsFromGrams

CONVERSIONFACTOR_MASS_toKilogramsFromDekagrams

CONVERSIONFACTOR_MASS_toKilogramsFromMetricTonnes

CATEGORY_ANGLE

CATEGORY_FORCE

CATEGORY_LENGTH

CATEGORY_MASS

NAME

COMPONENT

LEVEL

CATEGORY_DEFAULT_VALUE

CONVERSIONFACTOR_DEFAULT_VALUE

NAME_DEFAULT_VALUE

Constructor Detail

unitObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getCategory

setCategory

setCategory

getConversionFactor

setConversionFactor

setConversionFactor

getName

setName

setName

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF