Package org.web3d.x3d.jsail.Geospatial
Class GeoViewpointObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geospatial.GeoViewpointObject
- All Implemented Interfaces:
X3DBindableNode
,X3DChildNode
,X3DNode
,GeoViewpoint
,X3DViewpointNode
public class GeoViewpointObject extends X3DConcreteNode implements GeoViewpoint
GeoViewpoint specifies viewpoints using geographic coordinates.
X3D node tooltip: [X3DViewpointNode] GeoViewpoint specifies viewpoints using geographic coordinates. GeoViewpoint can contain a GeoOrigin node. Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system, it includes both Viewpoint and NavigationInfo attributes.
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.
X3D node tooltip: [X3DViewpointNode] GeoViewpoint specifies viewpoints using geographic coordinates. GeoViewpoint can contain a GeoOrigin node. Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system, it includes both Viewpoint and NavigationInfo attributes.
- Hint: alternatively can use GeoLocation or GeoTransform as parent of a Viewpoint node to orient geospatial views.
- Hint: include <component name='Geospatial' level='1'/>
- Hint: when a GeoViewpoint node is bound, it also overrides the currently bound NavigationInfo node in the scene and controls user navigation for smoother geospatial interaction.
- Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
- Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
- Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
- Warning: GeoViewpoint navType and headlight fields were removed as part of X3D version 3.3, authors can instead use a NavigationInfo node for those fields in prior X3D versions 3.0, 3.1 or 3.2. Upgrading such legacy scenes to version 3.3 or greater is preferred and recommended.
- Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation between user's view and defined position/orientation is stored for later use when un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
- Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView' fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
- Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoViewpoint, since multiple geospatial transformations then occur with unpredictable results.
- Hint: X3D Scene Authoring Hints, Viewpoints 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.
-
Field Summary
Fields Modifier and Type Field Description static double[]
CENTEROFROTATION_DEFAULT_VALUE
SFVec3d field named centerOfRotation has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the GeoViewpoint element: Geospatialstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.static float
FIELDOFVIEW_DEFAULT_VALUE
SFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).static java.lang.String
fromField_BINDTIME
fromField ROUTE name for SFTime field named bindTime.static java.lang.String
fromField_CENTEROFROTATION
fromField ROUTE name for SFVec3d field named centerOfRotation.static java.lang.String
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.static java.lang.String
fromField_FIELDOFVIEW
fromField ROUTE name for SFFloat field named fieldOfView.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISBOUND
fromField ROUTE name for SFBool field named isBound.static java.lang.String
fromField_JUMP
fromField ROUTE name for SFBool field named jump.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_ORIENTATION
fromField ROUTE name for SFRotation field named orientation.static java.lang.String
fromField_POSITION
fromField ROUTE name for SFVec3d field named position.static java.lang.String
fromField_RETAINUSEROFFSETS
fromField ROUTE name for SFBool field named retainUserOffsets.static GeoOriginObject
GEOORIGIN_DEFAULT_VALUE
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).static 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).static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static boolean
JUMP_DEFAULT_VALUE
SFBool field named jump has default value true (Java syntax) or true (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Geospatial component level for this element: 1static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: GeoViewpoint.static float[]
ORIENTATION_DEFAULT_VALUE
SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).static double[]
POSITION_DEFAULT_VALUE
SFVec3d field named position has default value {0,0,100000} (Java syntax) or 0 0 100000 (XML syntax).static boolean
RETAINUSEROFFSETS_DEFAULT_VALUE
SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).static float
SPEEDFACTOR_DEFAULT_VALUE
SFFloat field named speedFactor has default value 1.0f (Java syntax) or 1.0 (XML syntax).static java.lang.String
toField_CENTEROFROTATION
toField ROUTE name for SFVec3d field named centerOfRotation.static java.lang.String
toField_DESCRIPTION
toField ROUTE name for SFString field named description.static java.lang.String
toField_FIELDOFVIEW
toField ROUTE name for SFFloat field named fieldOfView.static java.lang.String
toField_JUMP
toField ROUTE name for SFBool field named jump.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_ORIENTATION
toField ROUTE name for SFRotation field named orientation.static java.lang.String
toField_POSITION
toField ROUTE name for SFVec3d field named position.static java.lang.String
toField_RETAINUSEROFFSETS
toField ROUTE name for SFBool field named retainUserOffsets.static java.lang.String
toField_SET_BIND
toField ROUTE name for SFBool field named set_bind.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description GeoViewpointObject()
Constructor for GeoViewpointObject to initialize member variables with default values.GeoViewpointObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description GeoViewpointObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.GeoViewpointObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.GeoViewpointObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.GeoViewpointObject
addGeoSystem(java.lang.String newValue)
Add singleton String value to MFString geoSystem field.GeoViewpointObject
addGeoSystem(SFStringObject newValue)
Add singleton SFStringObject value to MFString geoSystem field.GeoViewpointObject
clearGeoOrigin()
Utility method to clear SFNode value of geoOrigin field.GeoViewpointObject
clearGeoSystem()
Utility method to clear MFString value of geoSystem field.GeoViewpointObject
clearIS()
Utility method to clear SFNode value of IS field.GeoViewpointObject
clearMetadata()
Utility method to clear SFNode value of metadata field.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.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.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.double
getBindTime()
Provide double value in seconds from outputOnly SFTime field named bindTime.double[]
getCenterOfRotation()
Provide array of 3-tuple double results unit axis, angle (in radians) from inputOutput SFVec3d field named centerOfRotation.java.lang.String
getComponent()
Defines X3D component for the GeoViewpoint element: Geospatialint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.java.lang.String
getElementName()
Provides name of this element: GeoViewpointfloat
getFieldOfView()
Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.GeoOrigin
getGeoOrigin()
Provide GeoOriginObject instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.java.lang.String[]
getGeoSystem()
Provide array of String results from initializeOnly MFString field named geoSystem.java.util.ArrayList<java.lang.String>
getGeoSystemList()
Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.java.lang.String
getGeoSystemString()
Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.boolean
getIsBound()
Provide boolean value from outputOnly SFBool field named isBound.boolean
getJump()
Provide boolean value from inputOutput SFBool field named jump.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float[]
getOrientation()
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.double[]
getPosition()
Provide array of 3-tuple double results from inputOutput SFVec3d field named position.boolean
getRetainUserOffsets()
Provide boolean value from inputOutput SFBool field named retainUserOffsets.float
getSpeedFactor()
Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.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.boolean
hasGeoOrigin()
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
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.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.void
initialize()
Initialize all member variables to default values.GeoViewpointObject
setCenterOfRotation(double[] newValue)
Accessor method to assign 3-tuple double array unit axis, angle (in radians) to inputOutput SFVec3d field named centerOfRotation.GeoViewpointObject
setCenterOfRotation(double x, double y, double z)
Assign values to SFVec3d centerOfRotation field, similar tosetCenterOfRotation(double[])
.GeoViewpointObject
setCenterOfRotation(SFVec3dObject newValue)
Assign typed object value to SFVec3d centerOfRotation field, similar tosetCenterOfRotation(double[])
.GeoViewpointObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.GeoViewpointObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.GeoViewpointObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.GeoViewpointObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.GeoViewpointObject
setDescription(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named description.GeoViewpointObject
setDescription(SFStringObject newValue)
Assign typed object value to SFString description field, similar tosetDescription(String)
.GeoViewpointObject
setFieldOfView(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetFieldOfView(float)
.GeoViewpointObject
setFieldOfView(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.GeoViewpointObject
setFieldOfView(SFFloatObject newValue)
Assign typed object value to SFFloat fieldOfView field, similar tosetFieldOfView(float)
.GeoViewpointObject
setGeoOrigin(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.GeoViewpointObject
setGeoOrigin(GeoOrigin newValue)
Accessor method to assign GeoOriginObject instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.GeoViewpointObject
setGeoSystem(java.lang.String newValue)
Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoViewpointObject
setGeoSystem(java.lang.String[] newValue)
Accessor method to assign String array to initializeOnly MFString field named geoSystem.GeoViewpointObject
setGeoSystem(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoViewpointObject
setGeoSystem(MFStringObject newValue)
Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoViewpointObject
setGeoSystem(SFStringObject newValue)
Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoViewpointObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.GeoViewpointObject
setJump(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named jump.GeoViewpointObject
setJump(SFBoolObject newValue)
Assign typed object value to SFBool jump field, similar tosetJump(boolean)
.GeoViewpointObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.GeoViewpointObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.GeoViewpointObject
setOrientation(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOrientation(float[])
.GeoViewpointObject
setOrientation(double x, double y, double z, double angleRadians)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetOrientation(float[])
.GeoViewpointObject
setOrientation(float[] newValue)
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.GeoViewpointObject
setOrientation(float x, float y, float z, float angleRadians)
Assign values to SFRotation orientation field, similar tosetOrientation(float[])
.GeoViewpointObject
setOrientation(SFRotationObject newValue)
Assign typed object value to SFRotation orientation field, similar tosetOrientation(float[])
.GeoViewpointObject
setPosition(double[] newValue)
Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named position.GeoViewpointObject
setPosition(double x, double y, double z)
Assign values to SFVec3d position field, similar tosetPosition(double[])
.GeoViewpointObject
setPosition(SFVec3dObject newValue)
Assign typed object value to SFVec3d position field, similar tosetPosition(double[])
.GeoViewpointObject
setRetainUserOffsets(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.GeoViewpointObject
setRetainUserOffsets(SFBoolObject newValue)
Assign typed object value to SFBool retainUserOffsets field, similar tosetRetainUserOffsets(boolean)
.GeoViewpointObject
setSpeedFactor(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeedFactor(float)
.GeoViewpointObject
setSpeedFactor(float newValue)
Accessor method to assign float value to initializeOnly SFFloat field named speedFactor.GeoViewpointObject
setSpeedFactor(SFFloatObject newValue)
Assign typed object value to SFFloat speedFactor field, similar tosetSpeedFactor(float)
.GeoViewpointObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.GeoViewpointObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.GeoViewpointObject
setUSE(GeoViewpointObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: GeoViewpoint.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the GeoViewpoint element: Geospatial- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Geospatial component level for this element: 1- See Also:
- Constant Field Values
-
CENTEROFROTATION_DEFAULT_VALUE
public static final double[] CENTEROFROTATION_DEFAULT_VALUESFVec3d field named centerOfRotation has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax). -
DESCRIPTION_DEFAULT_VALUE
public static final java.lang.String DESCRIPTION_DEFAULT_VALUESFString field named description has default value equal to an empty string.- See Also:
- Constant Field Values
-
FIELDOFVIEW_DEFAULT_VALUE
public static final float FIELDOFVIEW_DEFAULT_VALUESFFloat field named fieldOfView has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).- See Also:
- Constant Field Values
-
GEOORIGIN_DEFAULT_VALUE
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax). -
GEOSYSTEM_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> GEOSYSTEM_DEFAULT_VALUEMFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax). -
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:
- Constant Field Values
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
ORIENTATION_DEFAULT_VALUE
public static final float[] ORIENTATION_DEFAULT_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:
- Constant Field Values
-
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:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_BINDTIME
public static final java.lang.String fromField_BINDTIMEfromField ROUTE name for SFTime field named bindTime.- See Also:
- Constant Field Values
-
fromField_CENTEROFROTATION
public static final java.lang.String fromField_CENTEROFROTATIONfromField ROUTE name for SFVec3d field named centerOfRotation.- See Also:
- Constant Field Values
-
toField_CENTEROFROTATION
public static final java.lang.String toField_CENTEROFROTATIONtoField ROUTE name for SFVec3d field named centerOfRotation.- See Also:
- Constant Field Values
-
fromField_DESCRIPTION
public static final java.lang.String fromField_DESCRIPTIONfromField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
toField_DESCRIPTION
public static final java.lang.String toField_DESCRIPTIONtoField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
fromField_FIELDOFVIEW
public static final java.lang.String fromField_FIELDOFVIEWfromField ROUTE name for SFFloat field named fieldOfView.- See Also:
- Constant Field Values
-
toField_FIELDOFVIEW
public static final java.lang.String toField_FIELDOFVIEWtoField ROUTE name for SFFloat field named fieldOfView.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISBOUND
public static final java.lang.String fromField_ISBOUNDfromField ROUTE name for SFBool field named isBound.- See Also:
- Constant Field Values
-
fromField_JUMP
public static final java.lang.String fromField_JUMPfromField ROUTE name for SFBool field named jump.- See Also:
- Constant Field Values
-
toField_JUMP
public static final java.lang.String toField_JUMPtoField ROUTE name for SFBool field named jump.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_ORIENTATION
public static final java.lang.String fromField_ORIENTATIONfromField ROUTE name for SFRotation field named orientation.- See Also:
- Constant Field Values
-
toField_ORIENTATION
public static final java.lang.String toField_ORIENTATIONtoField ROUTE name for SFRotation field named orientation.- See Also:
- Constant Field Values
-
fromField_POSITION
public static final java.lang.String fromField_POSITIONfromField ROUTE name for SFVec3d field named position.- See Also:
- Constant Field Values
-
toField_POSITION
public static final java.lang.String toField_POSITIONtoField ROUTE name for SFVec3d field named position.- See Also:
- Constant Field Values
-
fromField_RETAINUSEROFFSETS
public static final java.lang.String fromField_RETAINUSEROFFSETSfromField ROUTE name for SFBool field named retainUserOffsets.- See Also:
- Constant Field Values
-
toField_RETAINUSEROFFSETS
public static final java.lang.String toField_RETAINUSEROFFSETStoField ROUTE name for SFBool field named retainUserOffsets.- See Also:
- Constant Field Values
-
toField_SET_BIND
public static final java.lang.String toField_SET_BINDtoField ROUTE name for SFBool field named set_bind.- See Also:
- Constant Field Values
-
-
Constructor Details
-
GeoViewpointObject
public GeoViewpointObject()Constructor for GeoViewpointObject to initialize member variables with default values. -
GeoViewpointObject
public GeoViewpointObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: GeoViewpoint- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String 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
public java.lang.String getFieldType(java.lang.String fieldName)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:
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 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:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDescription
public java.lang.String getDescription()Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getFieldOfView
public float getFieldOfView()Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.
Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. *- Specified by:
getFieldOfView
in 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeoOrigin
Provide GeoOriginObject 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:
Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
-
setGeoOrigin
Accessor method to assign GeoOriginObject 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
-
clearGeoOrigin
Utility method to clear SFNode value of geoOrigin field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setGeoOrigin
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.- Parameters:
newValue
- is new value for the geoOrigin field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setGeoOrigin(GeoOrigin)
-
hasGeoOrigin
public boolean hasGeoOrigin()Indicate whether an object is available for initializeOnly SFNode field geoOrigin.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getGeoOrigin()
,getGeoOriginProtoInstance()
-
getGeoSystem
public java.lang.String[] 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/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.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
public java.util.ArrayList<java.lang.String> getGeoSystemList()Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
getGeoSystemString
public java.lang.String 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/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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.- Returns:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addGeoSystem
Add singleton SFStringObject value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getIsBound
public boolean getIsBound()Provide boolean value from outputOnly SFBool field named isBound.
Tooltip: Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getIsBound
in 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide 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:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getOrientation
public float[] getOrientation()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
Tooltip: Rotation of Viewpoint, relative to default -Z axis direction in local coordinate system.- Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
- Hint: this is orientation _change_ from default direction (0 0 -1) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
- Specified by:
getOrientation
in 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getPosition
public double[] getPosition()Provide array of 3-tuple double results from inputOutput SFVec3d field named position.
Tooltip: position relative to local georeferenced coordinate system, in proper format. *- Specified by:
getPosition
in 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRetainUserOffsets
public boolean getRetainUserOffsets()Provide boolean value from inputOutput SFBool field named retainUserOffsets.
Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *- Specified by:
getRetainUserOffsets
in 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSpeedFactor
public float getSpeedFactor()Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.
Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser.- Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
- Specified by:
getSpeedFactor
in 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.String 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:
- X3D Scene Authoring Hints: Naming Conventions
-
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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
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:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
GeoViewpointObject
- 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:
GeoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)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:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)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:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)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:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
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 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 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:
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 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:
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)
-
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 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 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:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
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 classX3DConcreteElement
- Returns:
- validation results (if any)
-