OrthoViewpoint (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBindableNode, X3DChildNode, X3DNode, X3DViewpointNode

All Known Implementing Classes:

OrthoViewpointObject
```
public interface OrthoViewpoint
extends X3DViewpointNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DViewpointNode] OrthoViewpoint provides an orthographic perspective-free view of a scene from a specific location and direction.
- Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
- Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
- Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
- Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation between user's view and defined position/orientation is stored for later use when un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
- Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView' fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
- Hint: X3D Scene Authoring Hints, Viewpoints
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints
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: OrthoViewpoint, X3D Tooltips: OrthoViewpoint, X3D Scene Authoring Hints: Viewpoints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getBindTime()` Provide double value in seconds from outputOnly SFTime field named bindTime.
`float[]`	`getCenterOfRotation()` Provide array of 3-tuple float results unit axis, angle (in radians) from inputOutput SFVec3f field named centerOfRotation.
`java.lang.String`	`getDescription()` Provide String value from inputOutput SFString field named description.
`float[]`	`getFieldOfView()` Provide array of float results from inputOutput MFFloat field named fieldOfView.
`boolean`	`getIsBound()` Provide boolean value from outputOnly SFBool field named isBound.
`boolean`	`getJump()` Provide boolean value from inputOutput SFBool field named jump.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getOrientation()` Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
`float[]`	`getPosition()` Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
`boolean`	`getRetainUserOffsets()` Provide boolean value from inputOutput SFBool field named retainUserOffsets.
`OrthoViewpoint`	`setCenterOfRotation(float[] newValue)` Assign 3-tuple float array unit axis, angle (in radians) to inputOutput SFVec3f field named centerOfRotation.
`OrthoViewpoint`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`OrthoViewpoint`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`OrthoViewpoint`	`setDescription(java.lang.String newValue)` Assign String value to inputOutput SFString field named description.
`OrthoViewpoint`	`setFieldOfView(float[] newValue)` Assign float array to inputOutput MFFloat field named fieldOfView.
`OrthoViewpoint`	`setJump(boolean newValue)` Assign boolean value to inputOutput SFBool field named jump.
`OrthoViewpoint`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`OrthoViewpoint`	`setOrientation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
`OrthoViewpoint`	`setPosition(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named position.
`OrthoViewpoint`	`setRetainUserOffsets(boolean newValue)` Assign boolean value to inputOutput SFBool field named retainUserOffsets.
`OrthoViewpoint`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getBindTime
```
double getBindTime()
```
    Provide double value in seconds from outputOnly SFTime field named bindTime.
    
    Tooltip: Event sent reporting timestamp when node becomes active/inactive.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getBindTime in interface X3DBindableNode
    
    Specified by:
    
    getBindTime in interface X3DViewpointNode
    
    Returns:
    
    value of bindTime field
  - getCenterOfRotation
```
float[] getCenterOfRotation()
```
    Provide array of 3-tuple float results unit axis, angle (in radians) from inputOutput SFVec3f field named centerOfRotation.
    
    Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *
    
    Returns:
    
    value of centerOfRotation field
  - setCenterOfRotation
```
OrthoViewpoint setCenterOfRotation(float[] newValue)
```
    Assign 3-tuple float array unit axis, angle (in radians) to inputOutput SFVec3f field named centerOfRotation.
    
    Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode.
    
    Parameters:
    
    newValue - is new value for the centerOfRotation field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDescription
```
java.lang.String getDescription()
```
    Provide String value from inputOutput SFString field named description.
    
    Tooltip: Text description or navigation hint to describe the significance of this model Viewpoint.
    - Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided tour of a model.
    - Hint: the currently bound NavigationInfo node has a major effect on how a user might change viewing position and orientation after reaching this Viewpoint.
    - Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections between corresponding isBound/set_bind fields.
    - Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
    - Warning: without description, this OrthoViewpoint is unlikely to appear on browser Viewpoint menus.
    - Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
    Specified by:
    
    getDescription in interface X3DViewpointNode
    
    Returns:
    
    value of description field
  - setDescription
```
OrthoViewpoint setDescription(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named description.
    
    Tooltip: Text description or navigation hint to describe the significance of this model Viewpoint. Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided tour of a model. Hint: the currently bound NavigationInfo node has a major effect on how a user might change viewing position and orientation after reaching this Viewpoint. Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections between corresponding isBound/set_bind fields. Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable. Warning: without description, this OrthoViewpoint is unlikely to appear on browser Viewpoint menus. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
    
    Specified by:
    
    setDescription in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getFieldOfView
```
float[] getFieldOfView()
```
    Provide array of float results from inputOutput MFFloat field named fieldOfView.
    
    Tooltip: Minimum and maximum extents of view in units of local coordinate system. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
    - Warning: minimum corner must remain less than maximum corner.
    - Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
    Returns:
    
    value of fieldOfView field
  - setFieldOfView
```
OrthoViewpoint setFieldOfView(float[] newValue)
```
    Assign float array to inputOutput MFFloat field named fieldOfView.
    
    Tooltip: Minimum and maximum extents of view in units of local coordinate system. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. Warning: minimum corner must remain less than maximum corner. Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
    
    Parameters:
    
    newValue - is new value for the fieldOfView field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsBound
```
boolean getIsBound()
```
    Provide boolean value from outputOnly SFBool field named isBound.
    
    Tooltip: Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated.
    - Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsBound in interface X3DBindableNode
    
    Specified by:
    
    getIsBound in interface X3DViewpointNode
    
    Returns:
    
    value of isBound field
  - getJump
```
boolean getJump()
```
    Provide boolean value from inputOutput SFBool field named jump.
    
    Tooltip: Transition instantly by jumping, otherwise smoothly adjust offsets in place when changing to this Viewpoint.
    - Hint: see NavigationInfo.transitionType for the manner in which animated Viewpoint transistions occur.
    - Hint: set jump=true for instantaneous camera motion when going to this viewpoint.
    - Warning: for VR/AR/MAR users wearing head-mounted displays, animating transitions between viewpoints may induce motion sickness.
    Specified by:
    
    getJump in interface X3DViewpointNode
    
    Returns:
    
    value of jump field
  - setJump
```
OrthoViewpoint setJump(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named jump.
    
    Tooltip: Transition instantly by jumping, otherwise smoothly adjust offsets in place when changing to this Viewpoint. Hint: see NavigationInfo.transitionType for the manner in which animated Viewpoint transistions occur. Hint: set jump=true for instantaneous camera motion when going to this viewpoint. Warning: for VR/AR/MAR users wearing head-mounted displays, animating transitions between viewpoints may induce motion sickness.
    
    Specified by:
    
    setJump in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the jump field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DBindableNode
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DViewpointNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
OrthoViewpoint setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DBindableNode
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    OrthoViewpoint - 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
  - getOrientation
```
float[] getOrientation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
    
    Tooltip: Rotation (axis, angle in radians) of Viewpoint, relative to default -Z axis direction in local coordinate system.
    - Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
    - Hint: this is orientation _change_ from default direction (0 0 -1).
    - Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
    Specified by:
    
    getOrientation in interface X3DViewpointNode
    
    Returns:
    
    value of orientation field
  - setOrientation
```
OrthoViewpoint setOrientation(float[] newValue)
```
    Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
    
    Tooltip: Rotation (axis, angle in radians) of Viewpoint, relative to default -Z axis direction in local coordinate system. Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness. Hint: this is orientation _change_ from default direction (0 0 -1). Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
    
    Specified by:
    
    setOrientation in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the orientation field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getPosition
```
float[] getPosition()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
    
    Tooltip: position (x, y, z in meters) relative to local coordinate system. *
    
    Returns:
    
    value of position field
  - setPosition
```
OrthoViewpoint setPosition(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named position.
    
    Tooltip: position (x, y, z in meters) relative to local coordinate system.
    
    Parameters:
    
    newValue - is new value for the position field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getRetainUserOffsets
```
boolean getRetainUserOffsets()
```
    Provide boolean value from inputOutput SFBool field named retainUserOffsets.
    
    Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *
    
    Specified by:
    
    getRetainUserOffsets in interface X3DViewpointNode
    
    Returns:
    
    value of retainUserOffsets field
  - setRetainUserOffsets
```
OrthoViewpoint setRetainUserOffsets(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named retainUserOffsets.
    
    Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation.
    
    Specified by:
    
    setRetainUserOffsets in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the retainUserOffsets field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
OrthoViewpoint 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 X3DBindableNode
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
OrthoViewpoint 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 X3DBindableNode
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
OrthoViewpoint 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 X3DBindableNode
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface OrthoViewpoint

Method Summary

Method Detail

getBindTime

getCenterOfRotation

setCenterOfRotation

getDescription

setDescription

getFieldOfView

setFieldOfView

getIsBound

getJump

setJump

getMetadata

setMetadata

getOrientation

setOrientation

getPosition

setPosition

getRetainUserOffsets

setRetainUserOffsets

setDEF

setUSE

setCssClass