Class GeoViewpointObject

  • All Implemented Interfaces:
    X3DBindableNode, X3DChildNode, X3DNode, GeoViewpoint, X3DViewpointNode

    public class GeoViewpointObject
    extends X3DConcreteNode
    implements GeoViewpoint
    X3D node tooltip: [X3DViewpointNode] GeoViewpoint specifies viewpoints using geographic coordinates. GeoViewpoint can contain a GeoOrigin node. Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system, it includes both Viewpoint and NavigationInfo attributes.
    • Hint: alternatively can use GeoLocation or GeoTransform as parent of a Viewpoint node to orient geospatial views.
    • Hint: include <component name='Geospatial' level='1'/>
    • Hint: when a GeoViewpoint node is bound, it also overrides the currently bound NavigationInfo node in the scene and controls user navigation for smoother geospatial interaction.
    • 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.
    • Warning: GeoViewpoint navType and headlight fields were removed as part of X3D version 3.3, authors can instead use a NavigationInfo node for those fields in prior X3D versions 3.0, 3.1 or 3.2. Upgrading such legacy scenes to version 3.3 or greater is preferred and recommended.
    • 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'/>
    • Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoViewpoint, since multiple geospatial transformations then occur with unpredictable results.
    • Hint: X3D Scene Authoring Hints, Viewpoints http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints

    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: GeoViewpoint, X3D Tooltips: GeoViewpoint, X3D Scene Authoring Hints: Viewpoints
    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: GeoViewpoint.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the GeoViewpoint element: Geospatial
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Geospatial component level for this element: 1
        See Also:
        Constant Field Values
      • CENTEROFROTATION_DEFAULT_VALUE

        public static final double[] CENTEROFROTATION_DEFAULT_VALUE
        SFVec3d field named centerOfRotation has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
      • DESCRIPTION_DEFAULT_VALUE

        public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
        SFString field named description has default value equal to an empty string.
        See Also:
        Constant Field Values
      • FIELDOFVIEW_DEFAULT_VALUE

        public static final float FIELDOFVIEW_DEFAULT_VALUE
        SFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).
        See Also:
        Constant Field Values
      • GEOORIGIN_DEFAULT_VALUE

        public static final GeoOriginObject GEOORIGIN_DEFAULT_VALUE
        SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).
      • GEOSYSTEM_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> GEOSYSTEM_DEFAULT_VALUE
        MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • JUMP_DEFAULT_VALUE

        public static final boolean JUMP_DEFAULT_VALUE
        SFBool field named jump has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • ORIENTATION_DEFAULT_VALUE

        public static final float[] ORIENTATION_DEFAULT_VALUE
        SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
      • POSITION_DEFAULT_VALUE

        public static final double[] POSITION_DEFAULT_VALUE
        SFVec3d field named position has default value {0,0,100000} (Java syntax) or 0 0 100000 (XML syntax).
      • RETAINUSEROFFSETS_DEFAULT_VALUE

        public static final boolean RETAINUSEROFFSETS_DEFAULT_VALUE
        SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • SPEEDFACTOR_DEFAULT_VALUE

        public static final float SPEEDFACTOR_DEFAULT_VALUE
        SFFloat field named speedFactor has default value 1.0f (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_BINDTIME

        public static final java.lang.String fromField_BINDTIME
        fromField ROUTE name for SFTime field named bindTime.
        See Also:
        Constant Field Values
      • fromField_CENTEROFROTATION

        public static final java.lang.String fromField_CENTEROFROTATION
        fromField ROUTE name for SFVec3d field named centerOfRotation.
        See Also:
        Constant Field Values
      • toField_CENTEROFROTATION

        public static final java.lang.String toField_CENTEROFROTATION
        toField ROUTE name for SFVec3d field named centerOfRotation.
        See Also:
        Constant Field Values
      • fromField_DESCRIPTION

        public static final java.lang.String fromField_DESCRIPTION
        fromField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • toField_DESCRIPTION

        public static final java.lang.String toField_DESCRIPTION
        toField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • fromField_FIELDOFVIEW

        public static final java.lang.String fromField_FIELDOFVIEW
        fromField ROUTE name for SFFloat field named fieldOfView.
        See Also:
        Constant Field Values
      • toField_FIELDOFVIEW

        public static final java.lang.String toField_FIELDOFVIEW
        toField ROUTE name for SFFloat field named fieldOfView.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_ISBOUND

        public static final java.lang.String fromField_ISBOUND
        fromField ROUTE name for SFBool field named isBound.
        See Also:
        Constant Field Values
      • fromField_JUMP

        public static final java.lang.String fromField_JUMP
        fromField ROUTE name for SFBool field named jump.
        See Also:
        Constant Field Values
      • toField_JUMP

        public static final java.lang.String toField_JUMP
        toField ROUTE name for SFBool field named jump.
        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
      • fromField_ORIENTATION

        public static final java.lang.String fromField_ORIENTATION
        fromField ROUTE name for SFRotation field named orientation.
        See Also:
        Constant Field Values
      • toField_ORIENTATION

        public static final java.lang.String toField_ORIENTATION
        toField ROUTE name for SFRotation field named orientation.
        See Also:
        Constant Field Values
      • fromField_POSITION

        public static final java.lang.String fromField_POSITION
        fromField ROUTE name for SFVec3d field named position.
        See Also:
        Constant Field Values
      • toField_POSITION

        public static final java.lang.String toField_POSITION
        toField ROUTE name for SFVec3d field named position.
        See Also:
        Constant Field Values
      • fromField_RETAINUSEROFFSETS

        public static final java.lang.String fromField_RETAINUSEROFFSETS
        fromField ROUTE name for SFBool field named retainUserOffsets.
        See Also:
        Constant Field Values
      • toField_RETAINUSEROFFSETS

        public static final java.lang.String toField_RETAINUSEROFFSETS
        toField ROUTE name for SFBool field named retainUserOffsets.
        See Also:
        Constant Field Values
      • toField_SET_BIND

        public static final java.lang.String toField_SET_BIND
        toField ROUTE name for SFBool field named set_bind.
        See Also:
        Constant Field Values
    • Constructor Detail

      • GeoViewpointObject

        public GeoViewpointObject()
        Constructor for GeoViewpointObject to initialize member variables with default values.
      • GeoViewpointObject

        public GeoViewpointObject​(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: GeoViewpoint
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the GeoViewpoint element: Geospatial
        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
      • initialize

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteNode
      • getBindTime

        public 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, instead only use it a source for ROUTE events.
        Specified by:
        getBindTime in interface GeoViewpoint
        Specified by:
        getBindTime in interface X3DBindableNode
        Specified by:
        getBindTime in interface X3DViewpointNode
        Returns:
        value of bindTime field
      • getCenterOfRotation

        public double[] getCenterOfRotation()
        Provide array of 3-tuple double results unit axis, angle (in radians) from inputOutput SFVec3d field named centerOfRotation.

        Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *
        Specified by:
        getCenterOfRotation in interface GeoViewpoint
        Returns:
        value of centerOfRotation field
      • setCenterOfRotation

        public GeoViewpointObject setCenterOfRotation​(double[] newValue)
        Accessor method to assign 3-tuple double array unit axis, angle (in radians) to inputOutput SFVec3d field named centerOfRotation.

        Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *
        Specified by:
        setCenterOfRotation in interface GeoViewpoint
        Parameters:
        newValue - is new value for the centerOfRotation field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setCenterOfRotation

        public GeoViewpointObject setCenterOfRotation​(SFVec3dObject newValue)
        Assign typed object value to SFVec3d centerOfRotation field, similar to setCenterOfRotation(double[]).
        Parameters:
        newValue - is new value for the centerOfRotation field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setCenterOfRotation

        public GeoViewpointObject setCenterOfRotation​(double x,
                                                      double y,
                                                      double z)
        Assign values to SFVec3d centerOfRotation field, similar to setCenterOfRotation(double[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getDescription

        public java.lang.String getDescription()
        Provide String value from inputOutput SFString field named description.

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
        • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
        Specified by:
        getDescription in interface GeoViewpoint
        Specified by:
        getDescription in interface X3DViewpointNode
        Returns:
        value of description field
      • setDescription

        public GeoViewpointObject setDescription​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named description.

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
        • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
        Specified by:
        setDescription in interface GeoViewpoint
        Specified by:
        setDescription in interface X3DViewpointNode
        Parameters:
        newValue - is new value for the description field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDescription

        public GeoViewpointObject setDescription​(SFStringObject newValue)
        Assign typed object value to SFString description field, similar to setDescription(String).
        Parameters:
        newValue - is new value for the description field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getFieldOfView

        public float getFieldOfView()
        Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.

        Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. *
        Specified by:
        getFieldOfView in interface GeoViewpoint
        Returns:
        value of fieldOfView field
      • setFieldOfView

        public GeoViewpointObject setFieldOfView​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.

        Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. *
        Specified by:
        setFieldOfView in interface GeoViewpoint
        Parameters:
        newValue - is new value for the fieldOfView field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFieldOfView

        public GeoViewpointObject setFieldOfView​(SFFloatObject newValue)
        Assign typed object value to SFFloat fieldOfView field, similar to setFieldOfView(float).
        Parameters:
        newValue - is new value for the fieldOfView field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFieldOfView

        public GeoViewpointObject setFieldOfView​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setFieldOfView(float).
        Parameters:
        newValue - is new value for field
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getGeoOrigin

        public GeoOrigin getGeoOrigin()
        Provide GeoOriginObject instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
        Specified by:
        getGeoOrigin in interface GeoViewpoint
        Returns:
        value of geoOrigin field
        See Also:
        getGeoOriginProtoInstance()
      • setGeoOrigin

        public GeoViewpointObject setGeoOrigin​(GeoOrigin newValue)
        Accessor method to assign GeoOriginObject instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
        Specified by:
        setGeoOrigin in interface GeoViewpoint
        Parameters:
        newValue - is new value for the geoOrigin field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setGeoOrigin(ProtoInstanceObject)
      • clearGeoOrigin

        public GeoViewpointObject clearGeoOrigin()
        Utility method to clear SFNode value of geoOrigin field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setGeoOrigin

        public GeoViewpointObject setGeoOrigin​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
        Parameters:
        newValue - is new value for the geoOrigin field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setGeoOrigin(GeoOrigin)
      • hasGeoOrigin

        public boolean hasGeoOrigin()
        Indicate whether an object is available for initializeOnly SFNode field geoOrigin.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getGeoOrigin(), getGeoOriginProtoInstance()
      • getGeoSystemList

        public java.util.ArrayList<java.lang.String> getGeoSystemList()
        Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().
        Returns:
        value of geoSystem field
      • setGeoSystem

        public GeoViewpointObject setGeoSystem​(MFStringObject newValue)
        Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]).
        Parameters:
        newValue - is new value for the geoSystem field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoSystem

        public GeoViewpointObject setGeoSystem​(SFStringObject newValue)
        Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
        Parameters:
        newValue - is new value for the geoSystem field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoSystem

        public GeoViewpointObject setGeoSystem​(java.lang.String newValue)
        Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).
        Parameters:
        newValue - is new value for the geoSystem field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoSystem

        public GeoViewpointObject setGeoSystem​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
        Parameters:
        newValue - is new value for the geoSystem field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearGeoSystem

        public GeoViewpointObject clearGeoSystem()
        Utility method to clear MFString value of geoSystem field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addGeoSystem

        public GeoViewpointObject addGeoSystem​(java.lang.String newValue)
        Add singleton String value to MFString geoSystem field.
        Parameters:
        newValue - is new value to add to the geoSystem field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • clearIS

        public GeoViewpointObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasIS

        public boolean hasIS()
        Indicate whether an object is available for inputOutput SFNode field IS.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getIS()
      • getIsBound

        public 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.
        • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
        Specified by:
        getIsBound in interface GeoViewpoint
        Specified by:
        getIsBound in interface X3DBindableNode
        Specified by:
        getIsBound in interface X3DViewpointNode
        Returns:
        value of isBound field
      • getJump

        public boolean getJump()
        Provide boolean value from inputOutput SFBool field named jump.

        Tooltip: Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint. *
        Specified by:
        getJump in interface GeoViewpoint
        Specified by:
        getJump in interface X3DViewpointNode
        Returns:
        value of jump field
      • setJump

        public GeoViewpointObject setJump​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named jump.

        Tooltip: Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint. *
        Specified by:
        setJump in interface GeoViewpoint
        Specified by:
        setJump in interface X3DViewpointNode
        Parameters:
        newValue - is new value for the jump field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setJump

        public GeoViewpointObject setJump​(SFBoolObject newValue)
        Assign typed object value to SFBool jump field, similar to setJump(boolean).
        Parameters:
        newValue - is new value for the jump field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearMetadata

        public GeoViewpointObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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
      • getOrientation

        public float[] getOrientation()
        Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.

        Tooltip: Rotation 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) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
        Specified by:
        getOrientation in interface GeoViewpoint
        Specified by:
        getOrientation in interface X3DViewpointNode
        Returns:
        value of orientation field
      • setOrientation

        public GeoViewpointObject setOrientation​(float[] newValue)
        Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.

        Tooltip: Rotation 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) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
        Specified by:
        setOrientation in interface GeoViewpoint
        Specified by:
        setOrientation in interface X3DViewpointNode
        Parameters:
        newValue - is new value for the orientation field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrientation

        public GeoViewpointObject setOrientation​(SFRotationObject newValue)
        Assign typed object value to SFRotation orientation field, similar to setOrientation(float[]).
        Parameters:
        newValue - is new value for the orientation field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrientation

        public GeoViewpointObject setOrientation​(float x,
                                                 float y,
                                                 float z,
                                                 float angleRadians)
        Assign values to SFRotation orientation field, similar to setOrientation(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:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrientation

        public GeoViewpointObject setOrientation​(double x,
                                                 double y,
                                                 double z,
                                                 double angleRadians)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOrientation(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        angleRadians - fourth component
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOrientation

        public GeoViewpointObject setOrientation​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOrientation(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getPosition

        public double[] getPosition()
        Provide array of 3-tuple double results from inputOutput SFVec3d field named position.

        Tooltip: position relative to local georeferenced coordinate system, in proper format. *
        Specified by:
        getPosition in interface GeoViewpoint
        Returns:
        value of position field
      • setPosition

        public GeoViewpointObject setPosition​(double[] newValue)
        Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named position.

        Tooltip: position relative to local georeferenced coordinate system, in proper format. *
        Specified by:
        setPosition in interface GeoViewpoint
        Parameters:
        newValue - is new value for the position field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPosition

        public GeoViewpointObject setPosition​(SFVec3dObject newValue)
        Assign typed object value to SFVec3d position field, similar to setPosition(double[]).
        Parameters:
        newValue - is new value for the position field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPosition

        public GeoViewpointObject setPosition​(double x,
                                              double y,
                                              double z)
        Assign values to SFVec3d position field, similar to setPosition(double[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getRetainUserOffsets

        public 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 GeoViewpoint
        Specified by:
        getRetainUserOffsets in interface X3DViewpointNode
        Returns:
        value of retainUserOffsets field
      • setRetainUserOffsets

        public GeoViewpointObject setRetainUserOffsets​(boolean newValue)
        Accessor method to 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 GeoViewpoint
        Specified by:
        setRetainUserOffsets in interface X3DViewpointNode
        Parameters:
        newValue - is new value for the retainUserOffsets field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRetainUserOffsets

        public GeoViewpointObject setRetainUserOffsets​(SFBoolObject newValue)
        Assign typed object value to SFBool retainUserOffsets field, similar to setRetainUserOffsets(boolean).
        Parameters:
        newValue - is new value for the retainUserOffsets field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getSpeedFactor

        public float getSpeedFactor()
        Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.

        Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser.
        • Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
        Specified by:
        getSpeedFactor in interface GeoViewpoint
        Returns:
        value of speedFactor field
      • setSpeedFactor

        public GeoViewpointObject setSpeedFactor​(float newValue)
        Accessor method to assign float value to initializeOnly SFFloat field named speedFactor.

        Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser.
        • Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
        Specified by:
        setSpeedFactor in interface GeoViewpoint
        Parameters:
        newValue - is new value for the speedFactor field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpeedFactor

        public GeoViewpointObject setSpeedFactor​(SFFloatObject newValue)
        Assign typed object value to SFFloat speedFactor field, similar to setSpeedFactor(float).
        Parameters:
        newValue - is new value for the speedFactor field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSpeedFactor

        public GeoViewpointObject setSpeedFactor​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSpeedFactor(float).
        Parameters:
        newValue - is new value for field
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public final GeoViewpointObject setDEF​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named DEF.

        Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

        Note that setting the DEF value clears the USE value.
        Specified by:
        setDEF in class X3DConcreteNode
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public GeoViewpointObject 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:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getUSE

        public java.lang.String getUSE()
        Provide String value from 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.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

        public final GeoViewpointObject setUSE​(java.lang.String newValue)
        Accessor method to 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 class X3DConcreteNode
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public GeoViewpointObject 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:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCssClass

        public java.lang.String getCssClass()
        Provide String value from 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
        Overrides:
        getCssClass in class X3DConcreteNode
        Returns:
        value of class field
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public final GeoViewpointObject setCssClass​(java.lang.String newValue)
        Accessor method to 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 class X3DConcreteNode
        Parameters:
        newValue - is new value for the class field.
        Returns:
        GeoViewpointObject - 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 GeoViewpointObject 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:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public GeoViewpointObject setUSE​(GeoViewpointObject 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:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public GeoViewpointObject addComments​(java.lang.String newComment)
        Add comment as String to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public GeoViewpointObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public GeoViewpointObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        GeoViewpointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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)
      • 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)