Package org.web3d.x3d.sai.Navigation

Interface X3DViewpointNode

All Superinterfaces:
X3DBindableNode, X3DChildNode, X3DNode
All Known Subinterfaces:
GeoViewpoint, OrthoViewpoint, Viewpoint
All Known Implementing Classes:
GeoViewpointObject, OrthoViewpointObject, ViewpointObject
public interface X3DViewpointNode
extends X3DBindableNode
Node type X3DViewpointNode defines a specific location in the local coordinate system from which the user may view the scene, and also defines a viewpoint binding stack.


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: TODO, X3D Tooltips, X3D Scene Authoring Hints: Viewpoints

  • Method Summary

    Modifier and Type Method Description
    double getBindTime()
    Provide double value in seconds from outputOnly SFTime field named bindTime.
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    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.
    boolean getRetainUserOffsets()
    Provide boolean value from inputOutput SFBool field named retainUserOffsets.
    X3DViewpointNode setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    X3DViewpointNode setJump​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named jump.
    X3DViewpointNode setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DViewpointNode setOrientation​(float[] newValue)
    Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
    X3DViewpointNode setRetainUserOffsets​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.

  • Method Details

    • getBindTime

      double getBindTime()
      Provide double value in seconds from outputOnly SFTime field named bindTime.
      Specified by:
      getBindTime in interface X3DBindableNode
      Returns:
      value of bindTime field

    • getDescription

      java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.
      Returns:
      value of description field

    • setDescription

      X3DViewpointNode setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Parameters:
      newValue - is new value for the description field.
      Returns:
      X3DViewpointNode - 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.
      Specified by:
      getIsBound in interface X3DBindableNode
      Returns:
      value of isBound field

    • getJump

      boolean getJump()
      Provide boolean value from inputOutput SFBool field named jump.
      Returns:
      value of jump field

    • setJump

      X3DViewpointNode setJump​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named jump.
      Parameters:
      newValue - is new value for the jump field.
      Returns:
      X3DViewpointNode - 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
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      X3DViewpointNode setMetadata​(X3DMetadataObject newValue)
      Accessor method to 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
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DViewpointNode - 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.
      Returns:
      value of orientation field

    • setOrientation

      X3DViewpointNode setOrientation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
      Parameters:
      newValue - is new value for the orientation field.
      Returns:
      X3DViewpointNode - 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.
      Returns:
      value of retainUserOffsets field

    • setRetainUserOffsets

      X3DViewpointNode setRetainUserOffsets​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      X3DViewpointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).