Package org.web3d.x3d.sai.Navigation

Interface X3DViewpointNode

All Superinterfaces:
X3DBindableNode, X3DChildNode, X3DNode
All Known Subinterfaces:
GeoViewpoint, OrthoViewpoint, Viewpoint
All Known Implementing Classes:
GeoViewpoint, OrthoViewpoint, Viewpoint
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.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getBindTime()
    Provide double value in seconds from outputOnly SFTime field named bindTime.
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    float
    getFarDistance()
    Provide float value from inputOutput SFFloat field named farDistance.
    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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    NavigationInfo
    getNavigationInfo()
    Provide org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) from inputOutput SFNode field navigationInfo.
    float
    getNearDistance()
    Provide float value from inputOutput SFFloat field named nearDistance.
    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.
    boolean
    getViewAll()
    Provide boolean value from inputOutput SFBool field named viewAll.
    X3DViewpointNode
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    X3DViewpointNode
    setFarDistance(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named farDistance.
    X3DViewpointNode
    setJump(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named jump.
    X3DViewpointNode
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DViewpointNode
    setNavigationInfo(NavigationInfo newValue)
    Accessor method to assign org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) to inputOutput SFNode field navigationInfo.
    X3DViewpointNode
    setNearDistance(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named nearDistance.
    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.
    X3DViewpointNode
    setViewAll(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named viewAll.

  • 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

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

    • setDescription

      X3DViewpointNode setDescription(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).

    • getFarDistance

      float getFarDistance()
      Provide float value from inputOutput SFFloat field named farDistance.
      Returns:
      value of farDistance field

    • setFarDistance

      X3DViewpointNode setFarDistance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named farDistance.
      Parameters:
      newValue - is new value for the farDistance 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 org.web3d.x3d.sai.Core.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:

    • setMetadata

      X3DViewpointNode setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.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:

    • getNavigationInfo

      NavigationInfo getNavigationInfo()
      Provide org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) from inputOutput SFNode field navigationInfo.
      Returns:
      value of navigationInfo field

    • setNavigationInfo

      X3DViewpointNode setNavigationInfo(NavigationInfo newValue)
      Accessor method to assign org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) to inputOutput SFNode field navigationInfo.
      Parameters:
      newValue - is new value for the navigationInfo field.
      Returns:
      X3DViewpointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getNearDistance

      float getNearDistance()
      Provide float value from inputOutput SFFloat field named nearDistance.
      Returns:
      value of nearDistance field

    • setNearDistance

      X3DViewpointNode setNearDistance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named nearDistance.
      Parameters:
      newValue - is new value for the nearDistance field.
      Returns:
      X3DViewpointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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).

    • getViewAll

      boolean getViewAll()
      Provide boolean value from inputOutput SFBool field named viewAll.
      Returns:
      value of viewAll field

    • setViewAll

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