Class GeoOriginObject

  • All Implemented Interfaces:
    X3DNode, GeoOrigin

    public class GeoOriginObject
    extends X3DConcreteNode
    implements GeoOrigin
    GeoOrigin is deprecated and discouraged (but nevertheless allowed) in X3D v3.3. GeoOrigin is likely to be restored in X3D v4.0 for special use on devices with limited floating-point resolution.

    X3D node tooltip: [X3DNode] GeoOrigin specifies local geospatial coordinate system for parent node, enabling increased geographic precision during scene rendering (by mitigating potential floating-point roundoff errors). GeoOrigin can be contained by other Geospatial component nodes, typically via DEF/USE to ensure consistency.
    • Hint: only one geospatial coordinate system is allowed per scene, thus DEF-ing and later USE-ing only one GeoOrigin node per scene is recommended.
    • Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
    • Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
    • Warning: GeoOrigin is deprecated, discouraged and not legal in X3D v3.3. GeoOrigin can be ignored in X3D v3.2 and below.
    • Hint: GeoOrigin is likely to be restored in X3D v4.0 for special use on devices with limited floating-point resolution.

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

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the GeoOrigin 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
      • GEOCOORDS_DEFAULT_VALUE

        public static final double[] GEOCOORDS_DEFAULT_VALUE
        SFVec3d field named geoCoords has default value {0,0,0} (Java syntax) or 0 0 0 (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).
      • METADATA_DEFAULT_VALUE

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

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

        public static final java.lang.String fromField_GEOCOORDS
        fromField ROUTE name for SFVec3d field named geoCoords.
        See Also:
        Constant Field Values
      • toField_GEOCOORDS

        public static final java.lang.String toField_GEOCOORDS
        toField ROUTE name for SFVec3d field named geoCoords.
        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_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
    • Constructor Detail

      • GeoOriginObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the GeoOrigin 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
      • getGeoCoords

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

        Tooltip: Defines absolute geographic location (and implicit local coordinate frame).
        Specified by:
        getGeoCoords in interface GeoOrigin
        Returns:
        value of geoCoords field
      • setGeoCoords

        public GeoOriginObject setGeoCoords​(double[] newValue)
        Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.

        Tooltip: Defines absolute geographic location (and implicit local coordinate frame).
        Specified by:
        setGeoCoords in interface GeoOrigin
        Parameters:
        newValue - is new value for the geoCoords field.
        Returns:
        GeoOriginObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoCoords

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

        public GeoOriginObject setGeoCoords​(double x,
                                            double y,
                                            double z)
        Assign values to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        GeoOriginObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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 GeoOriginObject 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:
        GeoOriginObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoSystem

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

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

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

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

        public GeoOriginObject 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:
        GeoOriginObject - 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 GeoOriginObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        GeoOriginObject - 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()
      • clearMetadata

        public GeoOriginObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        GeoOriginObject - 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
      • getRotateYUp

        public boolean getRotateYUp()
        Provide boolean value from initializeOnly SFBool field named rotateYUp.

        Tooltip: Whether to rotate coordinates of nodes using this GeoOrigin so that local-up direction aligns with VRML Y axis rotateYUp false means local up-direction is relative to planet surface rotateYUp true allows proper operation of NavigationInfo modes FLY, WALK. *
        Specified by:
        getRotateYUp in interface GeoOrigin
        Returns:
        value of rotateYUp field
      • setRotateYUp

        public GeoOriginObject setRotateYUp​(boolean newValue)
        Accessor method to assign boolean value to initializeOnly SFBool field named rotateYUp.

        Tooltip: Whether to rotate coordinates of nodes using this GeoOrigin so that local-up direction aligns with VRML Y axis rotateYUp false means local up-direction is relative to planet surface rotateYUp true allows proper operation of NavigationInfo modes FLY, WALK. *
        Specified by:
        setRotateYUp in interface GeoOrigin
        Parameters:
        newValue - is new value for the rotateYUp field.
        Returns:
        GeoOriginObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRotateYUp

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

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

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

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

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

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

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

        public GeoOriginObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        GeoOriginObject - 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)