Package org.web3d.x3d.jsail.Geospatial
Class GeoViewpoint
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geospatial.GeoViewpoint
- All Implemented Interfaces:
X3DBindableNode
,X3DChildNode
,X3DNode
,GeoViewpoint
,X3DViewpointNode
GeoViewpoint specifies viewpoints using geographic coordinates.
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
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.
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.
GeoViewpoint 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: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch. Avoid this authoring pattern.
- 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 https://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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final double[]
SFVec3d field named centerOfRotation has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).static final String
String constant COMPONENT defines X3D component for the GeoViewpoint element: Geospatialstatic final String
containerField describes typical field relationship of a node to its parent.static final String
SFString field named description has default value equal to an empty string.static final float
SFFloat field named farDistance has default value -1f (Java syntax) or -1 (XML syntax).static final float
SFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).static final String
fromField ROUTE name for SFTime field named bindTime.static final String
fromField ROUTE name for SFVec3d field named centerOfRotation.static final String
fromField ROUTE name for SFString field named description.static final String
fromField ROUTE name for SFFloat field named farDistance.static final String
fromField ROUTE name for SFFloat field named fieldOfView.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFBool field named isBound.static final String
fromField ROUTE name for SFBool field named jump.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFNode field named navigationInfo.static final String
fromField ROUTE name for SFFloat field named nearDistance.static final String
fromField ROUTE name for SFRotation field named orientation.static final String
fromField ROUTE name for SFVec3d field named position.static final String
fromField ROUTE name for SFBool field named retainUserOffsets.static final String
fromField ROUTE name for SFBool field named viewAll.static final GeoOrigin
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final boolean
SFBool field named jump has default value true (Java syntax) or true (XML syntax).static final int
Integer constant LEVEL provides default X3D Geospatial component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: GeoViewpoint.static final NavigationInfo
SFNode field named navigationInfo has default value null (Java syntax) or NULL (XML syntax).static final float
SFFloat field named nearDistance has default value -1f (Java syntax) or -1 (XML syntax).static final float[]
SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).static final double[]
SFVec3d field named position has default value {0,0,100000} (Java syntax) or 0 0 100000 (XML syntax).static final boolean
SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).static final float
SFFloat field named speedFactor has default value 1.0f (Java syntax) or 1.0 (XML syntax).static final String
toField ROUTE name for SFVec3d field named centerOfRotation.static final String
toField ROUTE name for SFString field named description.static final String
toField ROUTE name for SFFloat field named farDistance.static final String
toField ROUTE name for SFFloat field named fieldOfView.static final String
toField ROUTE name for SFBool field named jump.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFNode field named navigationInfo.static final String
toField ROUTE name for SFFloat field named nearDistance.static final String
toField ROUTE name for SFRotation field named orientation.static final String
toField ROUTE name for SFVec3d field named position.static final String
toField ROUTE name for SFBool field named retainUserOffsets.static final String
toField ROUTE name for SFBool field named set_bind.static final String
toField ROUTE name for SFBool field named viewAll.static final boolean
SFBool field named viewAll has default value false (Java syntax) or false (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for GeoViewpoint to initialize member variables with default values.GeoViewpoint
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addGeoSystem
(String newValue) Add singleton String value to MFString geoSystem field.addGeoSystem
(SFString newValue) Add singleton SFString value to MFString geoSystem field.Utility method to clear SFNode value of geoOrigin field.Utility method to clear MFString value of geoSystem field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear SFNode value of navigationInfo field.findElementByNameValue
(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.findElementByNameValue
(String nameValue, 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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.double
Provide double value in seconds from outputOnly SFTime field named bindTime.double[]
Provide array of 3-tuple double results unit axis, angle (in radians) from inputOutput SFVec3d field named centerOfRotation.final String
Defines X3D component for the GeoViewpoint element: Geospatialfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.Provide String value from inputOutput SFString field named description.final String
Provides name of this element: GeoViewpointfloat
Provide float value from inputOutput SFFloat field named farDistance.float
Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.getFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.String[]
Provide array of String results from initializeOnly MFString field named geoSystem.Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.boolean
Provide boolean value from outputOnly SFBool field named isBound.boolean
getJump()
Provide boolean value from inputOutput SFBool field named jump.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.Provide org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) from inputOutput SFNode field navigationInfo.float
Provide float value from inputOutput SFFloat field named nearDistance.float[]
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.double[]
Provide array of 3-tuple double results from inputOutput SFVec3d field named position.boolean
Provide boolean value from inputOutput SFBool field named retainUserOffsets.float
Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.getUSE()
Provide String value from inputOutput SFString field named USE.boolean
Provide boolean value from inputOutput SFBool field named viewAll.boolean
hasElementByNameValue
(String nameValue, 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.boolean
Indicate whether an object is available for initializeOnly SFNode field geoOrigin.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
Indicate whether an object is available for inputOutput SFNode field navigationInfo.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setCenterOfRotation
(double[] newValue) Accessor method to assign 3-tuple double array unit axis, angle (in radians) to inputOutput SFVec3d field named centerOfRotation.setCenterOfRotation
(double x, double y, double z) Assign values to SFVec3d centerOfRotation field, similar tosetCenterOfRotation(double[])
.setCenterOfRotation
(SFVec3d newValue) Assign typed object value to SFVec3d centerOfRotation field, similar tosetCenterOfRotation(double[])
.final GeoViewpoint
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final GeoViewpoint
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final GeoViewpoint
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setDescription
(SFString newValue) Assign typed object value to SFString description field, similar tosetDescription(String)
.setFarDistance
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetFarDistance(float)
.setFarDistance
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named farDistance.setFarDistance
(SFFloat newValue) Assign typed object value to SFFloat farDistance field, similar tosetFarDistance(float)
.setFieldOfView
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetFieldOfView(float)
.setFieldOfView
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.setFieldOfView
(SFFloat newValue) Assign typed object value to SFFloat fieldOfView field, similar tosetFieldOfView(float)
.setGeoOrigin
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.setGeoOrigin
(GeoOrigin newValue) Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.setGeoSystem
(String newValue) Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.setGeoSystem
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named geoSystem.setGeoSystem
(ArrayList<String> newValue) Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.setGeoSystem
(MFString newValue) Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.setGeoSystem
(SFString newValue) Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.final GeoViewpoint
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setJump
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named jump.Assign typed object value to SFBool jump field, similar tosetJump(boolean)
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setNavigationInfo
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field navigationInfo.setNavigationInfo
(NavigationInfo newValue) Accessor method to assign org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) to inputOutput SFNode field navigationInfo.setNearDistance
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetNearDistance(float)
.setNearDistance
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named nearDistance.setNearDistance
(SFFloat newValue) Assign typed object value to SFFloat nearDistance field, similar tosetNearDistance(float)
.setOrientation
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOrientation(float[])
.setOrientation
(double x, double y, double z, double angleRadians) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetOrientation(float[])
.setOrientation
(float[] newValue) Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.setOrientation
(float x, float y, float z, float angleRadians) Assign values to SFRotation orientation field, similar tosetOrientation(float[])
.setOrientation
(SFRotation newValue) Assign typed object value to SFRotation orientation field, similar tosetOrientation(float[])
.setPosition
(double[] newValue) Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named position.setPosition
(double x, double y, double z) Assign values to SFVec3d position field, similar tosetPosition(double[])
.setPosition
(SFVec3d newValue) Assign typed object value to SFVec3d position field, similar tosetPosition(double[])
.setRetainUserOffsets
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.setRetainUserOffsets
(SFBool newValue) Assign typed object value to SFBool retainUserOffsets field, similar tosetRetainUserOffsets(boolean)
.setSpeedFactor
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeedFactor(float)
.setSpeedFactor
(float newValue) Accessor method to assign float value to initializeOnly SFFloat field named speedFactor.setSpeedFactor
(SFFloat newValue) Assign typed object value to SFFloat speedFactor field, similar tosetSpeedFactor(float)
.final GeoViewpoint
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(GeoViewpoint DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setViewAll
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named viewAll.setViewAll
(SFBool newValue) Assign typed object value to SFBool viewAll field, similar tosetViewAll(boolean)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: GeoViewpoint.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the GeoViewpoint element: Geospatial- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Geospatial component level for this element: 1- See Also:
-
CENTEROFROTATION_DEFAULT_VALUE
public static final double[] CENTEROFROTATION_DEFAULT_VALUESFVec3d field named centerOfRotation has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax). -
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.- See Also:
-
FARDISTANCE_DEFAULT_VALUE
public static final float FARDISTANCE_DEFAULT_VALUESFFloat field named farDistance has default value -1f (Java syntax) or -1 (XML syntax).- See Also:
-
FIELDOFVIEW_DEFAULT_VALUE
public static final float FIELDOFVIEW_DEFAULT_VALUESFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).- See Also:
-
GEOORIGIN_DEFAULT_VALUE
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax). -
GEOSYSTEM_DEFAULT_VALUE
-
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_VALUESFBool field named jump has default value true (Java syntax) or true (XML syntax).- See Also:
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
NAVIGATIONINFO_DEFAULT_VALUE
SFNode field named navigationInfo has default value null (Java syntax) or NULL (XML syntax). -
NEARDISTANCE_DEFAULT_VALUE
public static final float NEARDISTANCE_DEFAULT_VALUESFFloat field named nearDistance has default value -1f (Java syntax) or -1 (XML syntax).- See Also:
-
ORIENTATION_DEFAULT_VALUE
public static final float[] ORIENTATION_DEFAULT_VALUESFRotation 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_VALUESFVec3d 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_VALUESFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).- See Also:
-
SPEEDFACTOR_DEFAULT_VALUE
public static final float SPEEDFACTOR_DEFAULT_VALUESFFloat field named speedFactor has default value 1.0f (Java syntax) or 1.0 (XML syntax).- See Also:
-
VIEWALL_DEFAULT_VALUE
public static final boolean VIEWALL_DEFAULT_VALUESFBool field named viewAll has default value false (Java syntax) or false (XML syntax).- See Also:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN- See Also:
-
fromField_BINDTIME
fromField ROUTE name for SFTime field named bindTime.- See Also:
-
fromField_CENTEROFROTATION
fromField ROUTE name for SFVec3d field named centerOfRotation.- See Also:
-
toField_CENTEROFROTATION
toField ROUTE name for SFVec3d field named centerOfRotation.- See Also:
-
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.- See Also:
-
toField_DESCRIPTION
toField ROUTE name for SFString field named description.- See Also:
-
fromField_FARDISTANCE
fromField ROUTE name for SFFloat field named farDistance.- See Also:
-
toField_FARDISTANCE
toField ROUTE name for SFFloat field named farDistance.- See Also:
-
fromField_FIELDOFVIEW
fromField ROUTE name for SFFloat field named fieldOfView.- See Also:
-
toField_FIELDOFVIEW
toField ROUTE name for SFFloat field named fieldOfView.- See Also:
-
fromField_IS
-
fromField_ISBOUND
fromField ROUTE name for SFBool field named isBound.- See Also:
-
fromField_JUMP
fromField ROUTE name for SFBool field named jump.- See Also:
-
toField_JUMP
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_NAVIGATIONINFO
fromField ROUTE name for SFNode field named navigationInfo.- See Also:
-
toField_NAVIGATIONINFO
toField ROUTE name for SFNode field named navigationInfo.- See Also:
-
fromField_NEARDISTANCE
fromField ROUTE name for SFFloat field named nearDistance.- See Also:
-
toField_NEARDISTANCE
toField ROUTE name for SFFloat field named nearDistance.- See Also:
-
fromField_ORIENTATION
fromField ROUTE name for SFRotation field named orientation.- See Also:
-
toField_ORIENTATION
toField ROUTE name for SFRotation field named orientation.- See Also:
-
fromField_POSITION
fromField ROUTE name for SFVec3d field named position.- See Also:
-
toField_POSITION
toField ROUTE name for SFVec3d field named position.- See Also:
-
fromField_RETAINUSEROFFSETS
fromField ROUTE name for SFBool field named retainUserOffsets.- See Also:
-
toField_RETAINUSEROFFSETS
toField ROUTE name for SFBool field named retainUserOffsets.- See Also:
-
toField_SET_BIND
toField ROUTE name for SFBool field named set_bind.- See Also:
-
fromField_VIEWALL
fromField ROUTE name for SFBool field named viewAll.- See Also:
-
toField_VIEWALL
toField ROUTE name for SFBool field named viewAll.- See Also:
-
-
Constructor Details
-
GeoViewpoint
public GeoViewpoint()Constructor for GeoViewpoint to initialize member variables with default values. -
GeoViewpoint
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
Provides name of this element: GeoViewpoint- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the GeoViewpoint element: Geospatial- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- 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:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
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 interfaceGeoViewpoint
- Specified by:
getBindTime
in interfaceX3DBindableNode
- Specified by:
getBindTime
in interfaceX3DViewpointNode
- 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 interfaceGeoViewpoint
- Returns:
- value of centerOfRotation field
-
setCenterOfRotation
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 interfaceGeoViewpoint
- Parameters:
newValue
- is new value for the centerOfRotation field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenterOfRotation
Assign typed object value to SFVec3d centerOfRotation field, similar tosetCenterOfRotation(double[])
.- Parameters:
newValue
- is new value for the centerOfRotation field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenterOfRotation
Assign values to SFVec3d centerOfRotation field, similar tosetCenterOfRotation(double[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDescription
Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose 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 & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfaceGeoViewpoint
- Specified by:
getDescription
in interfaceX3DViewpointNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose 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 & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfaceGeoViewpoint
- Specified by:
setDescription
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the description field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDescription
Assign typed object value to SFString description field, similar tosetDescription(String)
.- Parameters:
newValue
- is new value for the description field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getFarDistance
public float getFarDistance()Provide float value from inputOutput SFFloat field named farDistance.
Tooltip: or (0,+infinity) farDistance defines maximum clipping plane distance allowed for object display.- Hint: overrides bound NavigationInfo visibilityLimit value, if any.
- Hint: default value -1 means no effect on currently defined view frustum boundaries.
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
- Warning: nearDistance must be less than farDistance.
- Specified by:
getFarDistance
in interfaceGeoViewpoint
- Specified by:
getFarDistance
in interfaceX3DViewpointNode
- Returns:
- value of farDistance field
-
setFarDistance
Accessor method to assign float value to inputOutput SFFloat field named farDistance.
Tooltip: or (0,+infinity) farDistance defines maximum clipping plane distance allowed for object display.- Hint: overrides bound NavigationInfo visibilityLimit value, if any.
- Hint: default value -1 means no effect on currently defined view frustum boundaries.
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
- Warning: nearDistance must be less than farDistance.
- Specified by:
setFarDistance
in interfaceGeoViewpoint
- Specified by:
setFarDistance
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the farDistance field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFarDistance
Assign typed object value to SFFloat farDistance field, similar tosetFarDistance(float)
.- Parameters:
newValue
- is new value for the farDistance field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFarDistance
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetFarDistance(float)
.- Parameters:
newValue
- is new value for field- Returns:
GeoViewpoint
- 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 interfaceGeoViewpoint
- Returns:
- value of fieldOfView field
-
setFieldOfView
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 interfaceGeoViewpoint
- Parameters:
newValue
- is new value for the fieldOfView field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFieldOfView
Assign typed object value to SFFloat fieldOfView field, similar tosetFieldOfView(float)
.- Parameters:
newValue
- is new value for the fieldOfView field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFieldOfView
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetFieldOfView(float)
.- Parameters:
newValue
- is new value for field- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeoOrigin
Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.- Specified by:
getGeoOrigin
in interfaceGeoViewpoint
- Returns:
- value of geoOrigin field
- See Also:
-
setGeoOrigin
Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.- Specified by:
setGeoOrigin
in interfaceGeoViewpoint
- Parameters:
newValue
- is new value for the geoOrigin field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearGeoOrigin
Utility method to clear SFNode value of geoOrigin field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setGeoOrigin
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.- Parameters:
newValue
- is new value for the geoOrigin field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getGeoSystem
Provide array of String results from initializeOnly MFString field named geoSystem.
Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.- Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Specifyinggeospatialcoords
- Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
- Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).
- Specified by:
getGeoSystem
in interfaceGeoViewpoint
- Returns:
- value of geoSystem field
-
getGeoSystemList
Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
getGeoSystemString
Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
setGeoSystem
Accessor method to assign String array to initializeOnly MFString field named geoSystem.
Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.- Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Specifyinggeospatialcoords
- Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
- Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).
- Specified by:
setGeoSystem
in interfaceGeoViewpoint
- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearGeoSystem
Utility method to clear MFString value of geoSystem field. This method does not initialize withGEOSYSTEM_DEFAULT_VALUE.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addGeoSystem
Add singleton String value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addGeoSystem
Add singleton SFString value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
GeoViewpoint
- 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:
-
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 interfaceGeoViewpoint
- Specified by:
getIsBound
in interfaceX3DBindableNode
- Specified by:
getIsBound
in interfaceX3DViewpointNode
- 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 interfaceGeoViewpoint
- Specified by:
getJump
in interfaceX3DViewpointNode
- Returns:
- value of jump field
-
setJump
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 interfaceGeoViewpoint
- Specified by:
setJump
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the jump field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJump
Assign typed object value to SFBool jump field, similar tosetJump(boolean)
.- Parameters:
newValue
- is new value for the jump field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceGeoViewpoint
- Specified by:
getMetadata
in interfaceX3DBindableNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DViewpointNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceGeoViewpoint
- Specified by:
setMetadata
in interfaceX3DBindableNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DViewpointNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getNearDistance
public float getNearDistance()Provide float value from inputOutput SFFloat field named nearDistance.
Tooltip: or (0,+infinity) nearDistance defines minimum clipping plane distance necessary for object display.- Hint: overrides bound NavigationInfo avatarSize value, if any.
- Hint: default value -1 means no effect on currently defined view frustum boundaries.
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
- Warning: nearDistance must be less than farDistance.
- Specified by:
getNearDistance
in interfaceGeoViewpoint
- Specified by:
getNearDistance
in interfaceX3DViewpointNode
- Returns:
- value of nearDistance field
-
setNearDistance
Accessor method to assign float value to inputOutput SFFloat field named nearDistance.
Tooltip: or (0,+infinity) nearDistance defines minimum clipping plane distance necessary for object display.- Hint: overrides bound NavigationInfo avatarSize value, if any.
- Hint: default value -1 means no effect on currently defined view frustum boundaries.
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
- Warning: nearDistance must be less than farDistance.
- Specified by:
setNearDistance
in interfaceGeoViewpoint
- Specified by:
setNearDistance
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the nearDistance field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setNearDistance
Assign typed object value to SFFloat nearDistance field, similar tosetNearDistance(float)
.- Parameters:
newValue
- is new value for the nearDistance field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setNearDistance
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetNearDistance(float)
.- Parameters:
newValue
- is new value for field- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 interfaceGeoViewpoint
- Specified by:
getOrientation
in interfaceX3DViewpointNode
- Returns:
- value of orientation field
-
setOrientation
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 interfaceGeoViewpoint
- Specified by:
setOrientation
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the orientation field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Assign typed object value to SFRotation orientation field, similar tosetOrientation(float[])
.- Parameters:
newValue
- is new value for the orientation field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Assign values to SFRotation orientation field, similar tosetOrientation(float[])
.- Parameters:
x
- first component of axisy
- second component of axisz
- third component of axisangleRadians
- fourth component of rotation around axis- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetOrientation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third componentangleRadians
- fourth component- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOrientation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
GeoViewpoint
- 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 interfaceGeoViewpoint
- Returns:
- value of position field
-
setPosition
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 interfaceGeoViewpoint
- Parameters:
newValue
- is new value for the position field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPosition
Assign typed object value to SFVec3d position field, similar tosetPosition(double[])
.- Parameters:
newValue
- is new value for the position field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPosition
Assign values to SFVec3d position field, similar tosetPosition(double[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoViewpoint
- 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 interfaceGeoViewpoint
- Specified by:
getRetainUserOffsets
in interfaceX3DViewpointNode
- Returns:
- value of retainUserOffsets field
-
setRetainUserOffsets
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 interfaceGeoViewpoint
- Specified by:
setRetainUserOffsets
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the retainUserOffsets field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRetainUserOffsets
Assign typed object value to SFBool retainUserOffsets field, similar tosetRetainUserOffsets(boolean)
.- Parameters:
newValue
- is new value for the retainUserOffsets field.- Returns:
GeoViewpoint
- 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 interfaceGeoViewpoint
- Returns:
- value of speedFactor field
-
setSpeedFactor
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 interfaceGeoViewpoint
- Parameters:
newValue
- is new value for the speedFactor field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpeedFactor
Assign typed object value to SFFloat speedFactor field, similar tosetSpeedFactor(float)
.- Parameters:
newValue
- is new value for the speedFactor field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpeedFactor
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeedFactor(float)
.- Parameters:
newValue
- is new value for field- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getViewAll
public boolean getViewAll()Provide boolean value from inputOutput SFBool field named viewAll.
Tooltip: Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation is shifted to center of current bounding box and view is zoomed in or out until all visible objects are viewed.- Hint: no collision detection or proximity sensing occurs when zooming.
- Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire scene.
- Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in the current view occurs.
- Specified by:
getViewAll
in interfaceGeoViewpoint
- Specified by:
getViewAll
in interfaceX3DViewpointNode
- Returns:
- value of viewAll field
-
setViewAll
Accessor method to assign boolean value to inputOutput SFBool field named viewAll.
Tooltip: Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation is shifted to center of current bounding box and view is zoomed in or out until all visible objects are viewed.- Hint: no collision detection or proximity sensing occurs when zooming.
- Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire scene.
- Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in the current view occurs.
- Specified by:
setViewAll
in interfaceGeoViewpoint
- Specified by:
setViewAll
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the viewAll field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setViewAll
Assign typed object value to SFBool viewAll field, similar tosetViewAll(boolean)
.- Parameters:
newValue
- is new value for the viewAll field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
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.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
GeoViewpoint
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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 classX3DConcreteElement
- 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:
-
findElementByNameValue
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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 classX3DConcreteElement
- 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:
-
hasElementByNameValue
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:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
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:
-
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. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-