TransformObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Grouping.TransformObject

All Implemented Interfaces:

X3DChildNode, X3DNode, Transform, X3DBoundedObject, X3DGroupingNode
```
public class TransformObject
extends X3DConcreteNode
implements Transform
```
X3D node tooltip: [X3DGroupingNode] Transform is a Grouping node that can contain most nodes. Transform translates, orients and scales child geometry within the local world coordinate system.
- Hint: each transformation creates a new coordinate system relative to the parent coordinate system.
- Hint: +Y axis is the up direction. (Similarly some scenes may consider +X is North and +Z is East.)
- Hint: best authoring approach is to keep +Y axis pointing towards local up direction, supporting scene composability and effective navigation response (which is based on gravity direction).
- Hint: insert a Shape node before adding geometry or Appearance.
- Hint: translation/rotation/scaling field attributes can be defined in any order in the scene. The applied order of translation/rotation/scaling transformation-matrix operations remains consistent.
- Hint: authors can modify order of translation/rotation/scaling operations by splitting them into separate nested parent/child Transform nodes.
- Warning: Transform contained by CADFace can only hold a single LOD or Shape node.
- Hint: X3D Scene Authoring Hints, Coordinate Systems
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#CoordinateSystems
- Hint: X3D Scene Authoring Hints, Scale Factors and Unit Conversions
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scale
- Hint: apply containerField='shape' if parent node is CADFace.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: Transform, X3D Tooltips: Transform, X3D Scene Authoring Hints: CoordinateSystems

Field Summary

Fields
Modifier and Type	Field and Description
`static float[]`	`BBOXCENTER_DEFAULT_VALUE` SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static float[]`	`BBOXSIZE_DEFAULT_VALUE` SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
`static float[]`	`CENTER_DEFAULT_VALUE` SFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the Transform element: Grouping
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_CENTER` fromField ROUTE name for SFVec3f field named center.
`static java.lang.String`	`fromField_CHILDREN` fromField ROUTE name for MFNode field named children.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_ROTATION` fromField ROUTE name for SFRotation field named rotation.
`static java.lang.String`	`fromField_SCALE` fromField ROUTE name for SFVec3f field named scale.
`static java.lang.String`	`fromField_SCALEORIENTATION` fromField ROUTE name for SFRotation field named scaleOrientation.
`static java.lang.String`	`fromField_TRANSLATION` fromField ROUTE name for SFVec3f field named translation.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Grouping component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: Transform.
`static float[]`	`ROTATION_DEFAULT_VALUE` SFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
`static float[]`	`SCALE_DEFAULT_VALUE` SFVec3f field named scale has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
`static float[]`	`SCALEORIENTATION_DEFAULT_VALUE` SFRotation field named scaleOrientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
`static java.lang.String`	`toField_ADDCHILDREN` toField ROUTE name for MFNode field named addChildren.
`static java.lang.String`	`toField_CENTER` toField ROUTE name for SFVec3f field named center.
`static java.lang.String`	`toField_CHILDREN` toField ROUTE name for MFNode field named children.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_REMOVECHILDREN` toField ROUTE name for MFNode field named removeChildren.
`static java.lang.String`	`toField_ROTATION` toField ROUTE name for SFRotation field named rotation.
`static java.lang.String`	`toField_SCALE` toField ROUTE name for SFVec3f field named scale.
`static java.lang.String`	`toField_SCALEORIENTATION` toField ROUTE name for SFRotation field named scaleOrientation.
`static java.lang.String`	`toField_TRANSLATION` toField ROUTE name for SFVec3f field named translation.
`static float[]`	`TRANSLATION_DEFAULT_VALUE` SFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

Constructor Summary

Constructors
Constructor and Description
`TransformObject()` Constructor for TransformObject to initialize member variables with default values.
`TransformObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransformObject`	`addChild(X3DChildNode newValue)` Utility method to add single child element to contained list of existing children nodes (if any).
`void`	`addChildren(X3DNode newValue)` Add single node to existing array of children nodes (if any).
`void`	`addChildren(X3DNode[] newValue)` Add array of children nodes to array of existing nodes (if any).
`TransformObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to children field
`TransformObject`	`addComments(java.lang.String newComment)` Add comment as CommentsBlock to children field
`TransformObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to children field
`TransformObject`	`clearChildren()` Utility method to clear MFNode value of children field.
`TransformObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`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.
`float[]`	`getBboxCenter()` Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
`float[]`	`getBboxSize()` Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
`float[]`	`getCenter()` Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
`X3DNode[]`	`getChildren()` Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
`java.util.ArrayList<X3DNode>`	`getChildrenList()` Utility method to get ArrayList value of MFNode children field, similar to `getChildren()`.
`java.lang.String`	`getComponent()` Defines X3D component for the Transform element: Grouping
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: Transform
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getRotation()` Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
`float[]`	`getScale()` Provide array of 3-tuple float results from inputOutput SFVec3f field named scale.
`float[]`	`getScaleOrientation()` Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.
`float[]`	`getTranslation()` Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
`boolean`	`hasChildren()` Indicate whether an object is available for inputOutput MFNode field children.
`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`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`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.
`TransformObject`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`TransformObject`	`setBboxCenter(float x, float y, float z)` Assign values to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`TransformObject`	`setBboxCenter(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`TransformObject`	`setBboxSize(float[] newValue)` Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
`TransformObject`	`setBboxSize(float x, float y, float z)` Assign values to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`TransformObject`	`setBboxSize(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`TransformObject`	`setCenter(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named center.
`TransformObject`	`setCenter(float x, float y, float z)` Assign values to SFVec3f center field, similar to `setCenter(float[])`.
`TransformObject`	`setCenter(SFVec3fObject newValue)` Assign typed object value to SFVec3f center field, similar to `setCenter(float[])`.
`TransformObject`	`setChildren(java.util.ArrayList<X3DChildNode> newValue)` Assign ArrayList value of MFNode children field, similar to `setChildren(X3DNode[])`.
`void`	`setChildren(X3DNode newValue)` Set single children node, replacing prior array of existing nodes (if any).
`TransformObject`	`setChildren(X3DNode[] newValue)` Assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
`TransformObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`TransformObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`TransformObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`TransformObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`TransformObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`TransformObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`TransformObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`TransformObject`	`setRotation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
`TransformObject`	`setRotation(float x, float y, float z, float angleRadians)` Assign values to SFRotation rotation field, similar to `setRotation(float[])`.
`TransformObject`	`setRotation(SFRotationObject newValue)` Assign typed object value to SFRotation rotation field, similar to `setRotation(float[])`.
`TransformObject`	`setScale(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named scale.
`TransformObject`	`setScale(float x, float y, float z)` Assign values to SFVec3f scale field, similar to `setScale(float[])`.
`TransformObject`	`setScale(SFVec3fObject newValue)` Assign typed object value to SFVec3f scale field, similar to `setScale(float[])`.
`TransformObject`	`setScaleOrientation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.
`TransformObject`	`setScaleOrientation(float x, float y, float z, float angleRadians)` Assign values to SFRotation scaleOrientation field, similar to `setScaleOrientation(float[])`.
`TransformObject`	`setScaleOrientation(SFRotationObject newValue)` Assign typed object value to SFRotation scaleOrientation field, similar to `setScaleOrientation(float[])`.
`TransformObject`	`setTranslation(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named translation.
`TransformObject`	`setTranslation(float x, float y, float z)` Assign values to SFVec3f translation field, similar to `setTranslation(float[])`.
`TransformObject`	`setTranslation(SFVec3fObject newValue)` Assign typed object value to SFVec3f translation field, similar to `setTranslation(float[])`.
`TransformObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`TransformObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`TransformObject`	`setUSE(TransformObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`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.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: Transform.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the Transform element: Grouping
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Grouping component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - BBOXCENTER_DEFAULT_VALUE
```
public static final float[] BBOXCENTER_DEFAULT_VALUE
```
    SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - BBOXSIZE_DEFAULT_VALUE
```
public static final float[] BBOXSIZE_DEFAULT_VALUE
```
    SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
  - CENTER_DEFAULT_VALUE
```
public static final float[] CENTER_DEFAULT_VALUE
```
    SFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - ROTATION_DEFAULT_VALUE
```
public static final float[] ROTATION_DEFAULT_VALUE
```
    SFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
  - SCALE_DEFAULT_VALUE
```
public static final float[] SCALE_DEFAULT_VALUE
```
    SFVec3f field named scale has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
  - SCALEORIENTATION_DEFAULT_VALUE
```
public static final float[] SCALEORIENTATION_DEFAULT_VALUE
```
    SFRotation field named scaleOrientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
  - TRANSLATION_DEFAULT_VALUE
```
public static final float[] TRANSLATION_DEFAULT_VALUE
```
    SFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - toField_ADDCHILDREN
```
public static final java.lang.String toField_ADDCHILDREN
```
    toField ROUTE name for MFNode field named addChildren.
    
    See Also:
    
    Constant Field Values
  - fromField_CENTER
```
public static final java.lang.String fromField_CENTER
```
    fromField ROUTE name for SFVec3f field named center.
    
    See Also:
    
    Constant Field Values
  - toField_CENTER
```
public static final java.lang.String toField_CENTER
```
    toField ROUTE name for SFVec3f field named center.
    
    See Also:
    
    Constant Field Values
  - fromField_CHILDREN
```
public static final java.lang.String fromField_CHILDREN
```
    fromField ROUTE name for MFNode field named children.
    
    See Also:
    
    Constant Field Values
  - toField_CHILDREN
```
public static final java.lang.String toField_CHILDREN
```
    toField ROUTE name for MFNode field named children.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_REMOVECHILDREN
```
public static final java.lang.String toField_REMOVECHILDREN
```
    toField ROUTE name for MFNode field named removeChildren.
    
    See Also:
    
    Constant Field Values
  - fromField_ROTATION
```
public static final java.lang.String fromField_ROTATION
```
    fromField ROUTE name for SFRotation field named rotation.
    
    See Also:
    
    Constant Field Values
  - toField_ROTATION
```
public static final java.lang.String toField_ROTATION
```
    toField ROUTE name for SFRotation field named rotation.
    
    See Also:
    
    Constant Field Values
  - fromField_SCALE
```
public static final java.lang.String fromField_SCALE
```
    fromField ROUTE name for SFVec3f field named scale.
    
    See Also:
    
    Constant Field Values
  - toField_SCALE
```
public static final java.lang.String toField_SCALE
```
    toField ROUTE name for SFVec3f field named scale.
    
    See Also:
    
    Constant Field Values
  - fromField_SCALEORIENTATION
```
public static final java.lang.String fromField_SCALEORIENTATION
```
    fromField ROUTE name for SFRotation field named scaleOrientation.
    
    See Also:
    
    Constant Field Values
  - toField_SCALEORIENTATION
```
public static final java.lang.String toField_SCALEORIENTATION
```
    toField ROUTE name for SFRotation field named scaleOrientation.
    
    See Also:
    
    Constant Field Values
  - fromField_TRANSLATION
```
public static final java.lang.String fromField_TRANSLATION
```
    fromField ROUTE name for SFVec3f field named translation.
    
    See Also:
    
    Constant Field Values
  - toField_TRANSLATION
```
public static final java.lang.String toField_TRANSLATION
```
    toField ROUTE name for SFVec3f field named translation.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransformObject
```
public TransformObject()
```
    Constructor for TransformObject to initialize member variables with default values.
  - TransformObject
```
public TransformObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: Transform
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the Transform element: Grouping
    
    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 node
    
    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 node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getBboxCenter
```
public float[] getBboxCenter()
```
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
    
    Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
    - Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
    - Hint: X3D Architecture, 10.2.2 Bounding boxes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxCenter in interface Transform
    
    Specified by:
    
    getBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    getBboxCenter in interface X3DGroupingNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
public TransformObject setBboxCenter(float[] newValue)
```
    Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    
    Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    Specified by:
    
    setBboxCenter in interface Transform
    
    Specified by:
    
    setBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    setBboxCenter in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxCenter
```
public TransformObject setBboxCenter(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxCenter
```
public TransformObject setBboxCenter(float x,
                                     float y,
                                     float z)
```
    Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getBboxSize
```
public float[] getBboxSize()
```
    Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
    
    Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
    - Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
    - Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
    - Hint: X3D Architecture, 10.2.2 Bounding boxes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxSize in interface Transform
    
    Specified by:
    
    getBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    getBboxSize in interface X3DGroupingNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
public TransformObject setBboxSize(float[] newValue)
```
    Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
    
    Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    Specified by:
    
    setBboxSize in interface Transform
    
    Specified by:
    
    setBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    setBboxSize in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxSize
```
public TransformObject setBboxSize(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxSize
```
public TransformObject setBboxSize(float x,
                                   float y,
                                   float z)
```
    Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getCenter
```
public float[] getCenter()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
    
    Tooltip: Translation offset from origin of local coordinate system, applied prior to rotation or scaling.
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getCenter in interface Transform
    
    Returns:
    
    value of center field
  - setCenter
```
public TransformObject setCenter(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named center.
    
    Tooltip: Translation offset from origin of local coordinate system, applied prior to rotation or scaling. Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setCenter in interface Transform
    
    Parameters:
    
    newValue - is new value for the center field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCenter
```
public TransformObject setCenter(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f center field, similar to setCenter(float[]).
    
    Parameters:
    
    newValue - is new value for the center field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCenter
```
public TransformObject setCenter(float x,
                                 float y,
                                 float z)
```
    Assign values to SFVec3f center field, similar to setCenter(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getChildren
```
public X3DNode[] getChildren()
```
    Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
    
    Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
    - Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
    - Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
    - Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
    - Hint: X3D Architecture 10.2.1 Grouping and children node types,
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
    Specified by:
    
    getChildren in interface Transform
    
    Specified by:
    
    getChildren in interface X3DGroupingNode
    
    Returns:
    
    value of children field
    
    See Also:
    
    X3DChildNode
  - getChildrenList
```
public java.util.ArrayList<X3DNode> getChildrenList()
```
    Utility method to get ArrayList value of MFNode children field, similar to getChildren().
    
    Returns:
    
    value of children field
  - setChildren
```
public TransformObject setChildren(X3DNode[] newValue)
```
    Assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
    
    Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes. Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy. Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored. Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored. Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
    
    Specified by:
    
    setChildren in interface Transform
    
    Specified by:
    
    setChildren in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setChildren
```
public TransformObject setChildren(java.util.ArrayList<X3DChildNode> newValue)
```
    Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addChildren
```
public void addChildren(X3DNode newValue)
```
    Add single node to existing array of children nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.
    
    Parameters:
    
    newValue - is new value to be appended the children field.
  - addChild
```
public TransformObject addChild(X3DChildNode newValue)
```
    Utility method to add single child element to contained list of existing children nodes (if any).
    
    Parameters:
    
    newValue - is new node value to be appended the children field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addChildren
```
public void addChildren(X3DNode[] newValue)
```
    Add array of children nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
    
    Specified by:
    
    addChildren in interface Transform
    
    Specified by:
    
    addChildren in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new value array to be appended the children field.
  - setChildren
```
public void setChildren(X3DNode newValue)
```
    Set single children node, replacing prior array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.
    
    Specified by:
    
    setChildren in interface Transform
    
    Specified by:
    
    setChildren in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new node for the children field (restricted to X3DChildNode)
  - clearChildren
```
public TransformObject clearChildren()
```
    Utility method to clear MFNode value of children field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasChildren
```
public boolean hasChildren()
```
    Indicate whether an object is available for inputOutput MFNode field children.
    
    Returns:
    
    whether a properly typed node or ProtoInstance array or CommentsBlock is available.
    
    See Also:
    
    getChildren()
  - addComments
```
public TransformObject addComments(java.lang.String newComment)
```
    Add comment as CommentsBlock to children field
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public TransformObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to children field
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public TransformObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to children field
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface Transform
    
    Specified by:
    
    getMetadata in interface X3DGroupingNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public TransformObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface Transform
    
    Specified by:
    
    setMetadata in interface X3DGroupingNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public TransformObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public TransformObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getRotation
```
public float[] getRotation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
    
    Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getRotation in interface Transform
    
    Returns:
    
    value of rotation field
  - setRotation
```
public TransformObject setRotation(float[] newValue)
```
    Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
    
    Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system. Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setRotation in interface Transform
    
    Parameters:
    
    newValue - is new value for the rotation field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setRotation
```
public TransformObject setRotation(SFRotationObject newValue)
```
    Assign typed object value to SFRotation rotation field, similar to setRotation(float[]).
    
    Parameters:
    
    newValue - is new value for the rotation field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setRotation
```
public TransformObject setRotation(float x,
                                   float y,
                                   float z,
                                   float angleRadians)
```
    Assign values to SFRotation rotation field, similar to setRotation(float[]).
    
    Parameters:
    
    x - first component of axis
    
    y - second component of axis
    
    z - third component of axis
    
    angleRadians - fourth component of rotation around axis
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getScale
```
public float[] getScale()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named scale.
    
    Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getScale in interface Transform
    
    Returns:
    
    value of scale field
  - setScale
```
public TransformObject setScale(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named scale.
    
    Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation. Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setScale in interface Transform
    
    Parameters:
    
    newValue - is new value for the scale field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setScale
```
public TransformObject setScale(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f scale field, similar to setScale(float[]).
    
    Parameters:
    
    newValue - is new value for the scale field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setScale
```
public TransformObject setScale(float x,
                                float y,
                                float z)
```
    Assign values to SFVec3f scale field, similar to setScale(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getScaleOrientation
```
public float[] getScaleOrientation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.
    
    Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations).
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getScaleOrientation in interface Transform
    
    Returns:
    
    value of scaleOrientation field
  - setScaleOrientation
```
public TransformObject setScaleOrientation(float[] newValue)
```
    Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.
    
    Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations). Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setScaleOrientation in interface Transform
    
    Parameters:
    
    newValue - is new value for the scaleOrientation field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setScaleOrientation
```
public TransformObject setScaleOrientation(SFRotationObject newValue)
```
    Assign typed object value to SFRotation scaleOrientation field, similar to setScaleOrientation(float[]).
    
    Parameters:
    
    newValue - is new value for the scaleOrientation field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setScaleOrientation
```
public TransformObject setScaleOrientation(float x,
                                           float y,
                                           float z,
                                           float angleRadians)
```
    Assign values to SFRotation scaleOrientation field, similar to setScaleOrientation(float[]).
    
    Parameters:
    
    x - first component of axis
    
    y - second component of axis
    
    z - third component of axis
    
    angleRadians - fourth component of rotation around axis
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTranslation
```
public float[] getTranslation()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
    
    Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getTranslation in interface Transform
    
    Returns:
    
    value of translation field
  - setTranslation
```
public TransformObject setTranslation(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named translation.
    
    Tooltip: Position (x, y, z in meters) of children relative to local coordinate system. Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setTranslation in interface Transform
    
    Parameters:
    
    newValue - is new value for the translation field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setTranslation
```
public TransformObject setTranslation(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f translation field, similar to setTranslation(float[]).
    
    Parameters:
    
    newValue - is new value for the translation field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setTranslation
```
public TransformObject setTranslation(float x,
                                      float y,
                                      float z)
```
    Assign values to SFVec3f translation field, similar to setTranslation(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final TransformObject setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. 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
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface Transform
    
    Specified by:
    
    setDEF in interface X3DGroupingNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public TransformObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final TransformObject setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface Transform
    
    Specified by:
    
    setUSE in interface X3DGroupingNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public TransformObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final TransformObject setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface Transform
    
    Specified by:
    
    setCssClass in interface X3DGroupingNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public TransformObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public TransformObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public TransformObject setUSE(TransformObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    TransformObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - 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 TransformObject

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

BBOXCENTER_DEFAULT_VALUE

BBOXSIZE_DEFAULT_VALUE

CENTER_DEFAULT_VALUE

ROTATION_DEFAULT_VALUE

SCALE_DEFAULT_VALUE

SCALEORIENTATION_DEFAULT_VALUE

TRANSLATION_DEFAULT_VALUE

containerField_DEFAULT_VALUE

toField_ADDCHILDREN

fromField_CENTER

toField_CENTER

fromField_CHILDREN

toField_CHILDREN

fromField_METADATA

toField_METADATA

toField_REMOVECHILDREN

fromField_ROTATION

toField_ROTATION

fromField_SCALE

toField_SCALE

fromField_SCALEORIENTATION

toField_SCALEORIENTATION

fromField_TRANSLATION

toField_TRANSLATION

Constructor Detail

TransformObject

TransformObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

getBboxSize

setBboxSize

setBboxSize

setBboxSize

getCenter

setCenter

setCenter

setCenter

getChildren

getChildrenList

setChildren

setChildren

addChildren

addChild

addChildren

setChildren

clearChildren

hasChildren

addComments

addComments

addComments

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getRotation

setRotation