Transform (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode

All Known Implementing Classes:

TransformObject
```
public interface Transform
extends X3DGroupingNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: Transform, X3D Tooltips: Transform, X3D Scene Authoring Hints: CoordinateSystems

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChildren(X3DNode[] newValue)` Add array of children nodes to array of existing nodes (if any).
`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 X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
`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.
`Transform`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`Transform`	`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.
`Transform`	`setCenter(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named center.
`void`	`setChildren(X3DNode newValue)` Set single children node, replacing prior array of existing nodes (if any).
`Transform`	`setChildren(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
`Transform`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Transform`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Transform`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`Transform`	`setRotation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
`Transform`	`setScale(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named scale.
`Transform`	`setScaleOrientation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.
`Transform`	`setTranslation(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named translation.
`Transform`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getBboxCenter
```
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 X3DBoundedObject
    
    Specified by:
    
    getBboxCenter in interface X3DGroupingNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
Transform 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 X3DBoundedObject
    
    Specified by:
    
    setBboxCenter in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getBboxSize
```
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 X3DBoundedObject
    
    Specified by:
    
    getBboxSize in interface X3DGroupingNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
Transform 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 X3DBoundedObject
    
    Specified by:
    
    setBboxSize in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getCenter
```
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.
    Returns:
    
    value of center field
  - setCenter
```
Transform 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.
    
    Parameters:
    
    newValue - is new value for the center field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getChildren
```
X3DNode[] getChildren()
```
    Provide array of X3DNode 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 X3DGroupingNode
    
    Returns:
    
    value of children field
    
    See Also:
    
    X3DChildNode
  - setChildren
```
Transform setChildren(X3DNode[] newValue)
```
    Assign X3DNode 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 X3DGroupingNode
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addChildren
```
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 X3DGroupingNode
    
    Parameters:
    
    newValue - is new value array to be appended the children field.
  - setChildren
```
void setChildren(X3DNode newValue)
```
    Set single children node, replacing prior array of existing nodes (if any).
    
    Specified by:
    
    setChildren in interface X3DGroupingNode
    
    Parameters:
    
    newValue - is new node for the children field
  - getMetadata
```
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 X3DGroupingNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
Transform 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 X3DGroupingNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getRotation
```
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.
    Returns:
    
    value of rotation field
  - setRotation
```
Transform 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.
    
    Parameters:
    
    newValue - is new value for the rotation field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getScale
```
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.
    Returns:
    
    value of scale field
  - setScale
```
Transform 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.
    
    Parameters:
    
    newValue - is new value for the scale field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getScaleOrientation
```
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.
    Returns:
    
    value of scaleOrientation field
  - setScaleOrientation
```
Transform 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.
    
    Parameters:
    
    newValue - is new value for the scaleOrientation field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTranslation
```
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.
    Returns:
    
    value of translation field
  - setTranslation
```
Transform 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.
    
    Parameters:
    
    newValue - is new value for the translation field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
Transform 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 X3DGroupingNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Transform 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 X3DGroupingNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Transform 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 X3DGroupingNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Transform - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Transform

Method Summary

Method Detail

getBboxCenter

setBboxCenter

getBboxSize

setBboxSize

getCenter

setCenter

getChildren

setChildren

addChildren

setChildren

getMetadata

setMetadata

getRotation

setRotation

getScale

setScale

getScaleOrientation

setScaleOrientation

getTranslation

setTranslation

setDEF

setUSE

setCssClass