Package org.web3d.x3d.jsail.Geospatial
Class GeoPositionInterpolatorObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geospatial.GeoPositionInterpolatorObject
- All Implemented Interfaces:
X3DChildNode,X3DNode,GeoPositionInterpolator,X3DInterpolatorNode
public class GeoPositionInterpolatorObject extends X3DConcreteNode implements GeoPositionInterpolator
GeoPositionInterpolator animates objects within a geographic coordinate system.
X3D node tooltip: [X3DInterpolatorNode] GeoPositionInterpolator animates objects within a geographic coordinate system. GeoPositionInterpolator can contain a GeoOrigin node.
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: [X3DInterpolatorNode] GeoPositionInterpolator animates objects within a geographic coordinate system. GeoPositionInterpolator can contain a GeoOrigin node.
- Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
- Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
- Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
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 java.lang.StringCOMPONENTString constant COMPONENT defines X3D component for the GeoPositionInterpolator element: Geospatialstatic java.lang.StringcontainerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent.static java.lang.StringfromField_GEOVALUE_CHANGEDfromField ROUTE name for SFVec3d field named geovalue_changed.static java.lang.StringfromField_ISfromField ROUTE name for SFNode field named IS.static java.lang.StringfromField_KEYfromField ROUTE name for MFFloat field named key.static java.lang.StringfromField_KEYVALUEfromField ROUTE name for MFVec3d field named keyValue.static java.lang.StringfromField_METADATAfromField ROUTE name for SFNode field named metadata.static java.lang.StringfromField_VALUE_CHANGEDfromField ROUTE name for SFVec3f field named value_changed.static GeoOriginObjectGEOORIGIN_DEFAULT_VALUESFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).static 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).static ISObjectIS_DEFAULT_VALUESFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static java.util.ArrayList<java.lang.Float>KEY_DEFAULT_VALUEMFFloat field named key has default value equal to an empty list.static double[]KEYVALUE_DEFAULT_VALUEMFVec3d field named keyValue has default value equal to an empty list.static intLEVELInteger constant LEVEL provides default X3D Geospatial component level for this element: 1static X3DMetadataObjectMETADATA_DEFAULT_VALUESFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringNAMEString constant NAME provides name of this element: GeoPositionInterpolator.static java.lang.StringtoField_KEYtoField ROUTE name for MFFloat field named key.static java.lang.StringtoField_KEYVALUEtoField ROUTE name for MFVec3d field named keyValue.static java.lang.StringtoField_METADATAtoField ROUTE name for SFNode field named metadata.static java.lang.StringtoField_SET_FRACTIONtoField ROUTE name for SFFloat field named set_fraction.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 GeoPositionInterpolatorObject()Constructor for GeoPositionInterpolatorObject to initialize member variables with default values.GeoPositionInterpolatorObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description GeoPositionInterpolatorObjectaddComments(java.lang.String newComment)Add comment as String to contained commentsList.GeoPositionInterpolatorObjectaddComments(java.lang.String[] newComments)Add comments as String[] array to contained commentsList.GeoPositionInterpolatorObjectaddComments(CommentsBlock newCommentsBlock)Add CommentsBlock to contained commentsList.GeoPositionInterpolatorObjectaddGeoSystem(java.lang.String newValue)Add singleton String value to MFString geoSystem field.GeoPositionInterpolatorObjectaddGeoSystem(SFStringObject newValue)Add singleton SFStringObject value to MFString geoSystem field.GeoPositionInterpolatorObjectaddKey(float newValue)Add singleton float value to MFFloat key field.GeoPositionInterpolatorObjectaddKey(SFFloatObject newValue)Add singleton SFFloatObject value to MFFloat key field.GeoPositionInterpolatorObjectaddKeyValue(SFVec3dObject newValue)Add singleton SFVec3dObject value to MFVec3d keyValue field.GeoPositionInterpolatorObjectclearGeoOrigin()Utility method to clear SFNode value of geoOrigin field.GeoPositionInterpolatorObjectclearGeoSystem()Utility method to clear MFString value of geoSystem field.GeoPositionInterpolatorObjectclearIS()Utility method to clear SFNode value of IS field.GeoPositionInterpolatorObjectclearKey()Utility method to clear MFFloat value of key field.GeoPositionInterpolatorObjectclearMetadata()Utility method to clear SFNode value of metadata field.X3DConcreteElementfindElementByNameValue(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.X3DConcreteElementfindElementByNameValue(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.X3DConcreteNodefindNodeByDEF(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.StringgetAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.java.lang.StringgetComponent()Defines X3D component for the GeoPositionInterpolator element: GeospatialintgetComponentLevel()Provides default X3D component level for this element: 1java.lang.StringgetContainerFieldDefault()containerField describes typical field relationship of a node to its parent.java.lang.StringgetCssClass()Provide String value from inputOutput SFString field named class.java.lang.StringgetDEF()Provide String value from inputOutput SFString field named DEF.java.lang.StringgetElementName()Provides name of this element: GeoPositionInterpolatorjava.lang.StringgetFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.GeoOrigingetGeoOrigin()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.StringgetGeoSystemString()Utility method to get String value of MFString geoSystem field, similar togetGeoSystem().double[]getGeovalue()Provide array of 3-tuple double results from outputOnly SFVec3d field named geovalue_changed.ISObjectgetIS()Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.float[]getKey()Provide array of Float results from inputOutput MFFloat field named key.java.util.ArrayList<java.lang.Float>getKeyList()Utility method to get ArrayList value of MFFloat key field, similar togetKey().java.lang.StringgetKeyString()Utility method to get String value of MFFloat key field, similar togetKey().double[]getKeyValue()Provide array of 3-tuple double results from inputOutput MFVec3d field named keyValue.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.java.lang.StringgetUSE()Provide String value from inputOutput SFString field named USE.float[]getValue()Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.booleanhasElementByNameValue(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.booleanhasGeoOrigin()Indicate whether an object is available for initializeOnly SFNode field geoOrigin.booleanhasIS()Indicate whether an object is available for inputOutput SFNode field IS.booleanhasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.booleanhasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.voidinitialize()Initialize all member variables to default values.GeoPositionInterpolatorObjectsetCssClass(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named class.GeoPositionInterpolatorObjectsetCssClass(SFStringObject newValue)Assign typed object value to SFString cssClass field, similar tosetCssClass(String).GeoPositionInterpolatorObjectsetDEF(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named DEF.GeoPositionInterpolatorObjectsetDEF(SFStringObject newValue)Assign typed object value to SFString DEF field, similar tosetDEF(String).GeoPositionInterpolatorObjectsetGeoOrigin(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.GeoPositionInterpolatorObjectsetGeoOrigin(GeoOrigin newValue)Accessor method to assign GeoOriginObject instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.GeoPositionInterpolatorObjectsetGeoSystem(java.lang.String newValue)Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[]).GeoPositionInterpolatorObjectsetGeoSystem(java.lang.String[] newValue)Accessor method to assign String array to initializeOnly MFString field named geoSystem.GeoPositionInterpolatorObjectsetGeoSystem(java.util.ArrayList<java.lang.String> newValue)Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[]).GeoPositionInterpolatorObjectsetGeoSystem(MFStringObject newValue)Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[]).GeoPositionInterpolatorObjectsetGeoSystem(SFStringObject newValue)Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[]).GeoPositionInterpolatorObjectsetIS(ISObject newValue)Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.GeoPositionInterpolatorObjectsetKey(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKey(float[]).GeoPositionInterpolatorObjectsetKey(float[] newValue)Accessor method to assign Float array to inputOutput MFFloat field named key.GeoPositionInterpolatorObjectsetKey(int[] newValue)Assign floating-point array value of MFFloat key field, similar tosetKey(float[]).GeoPositionInterpolatorObjectsetKey(java.util.ArrayList<java.lang.Float> newValue)Assign ArrayList value of MFFloat key field, similar tosetKey(float[]).GeoPositionInterpolatorObjectsetKey(MFFloatObject newValue)Assign typed object value to MFFloat key field, similar tosetKey(float[]).GeoPositionInterpolatorObjectsetKeyValue(double[] newValue)Accessor method to assign 3-tuple double array to inputOutput MFVec3d field named keyValue.GeoPositionInterpolatorObjectsetKeyValue(MFVec3dObject newValue)Assign typed object value to MFVec3d keyValue field, similar tosetKeyValue(double[]).GeoPositionInterpolatorObjectsetMetadata(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.GeoPositionInterpolatorObjectsetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.GeoPositionInterpolatorObjectsetUSE(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named USE.GeoPositionInterpolatorObjectsetUSE(SFStringObject newValue)Assign typed object value to SFString USE field, similar tosetUSE(String).GeoPositionInterpolatorObjectsetUSE(GeoPositionInterpolatorObject DEFnode)Assign a USE reference to another DEF node of same node type, similar tosetUSE(String).java.lang.StringtoStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.java.lang.StringtoStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.java.lang.StringtoStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.Stringvalidate()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, setContainerFieldOverrideMethods 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: GeoPositionInterpolator.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the GeoPositionInterpolator 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
-
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). -
KEY_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> KEY_DEFAULT_VALUEMFFloat field named key has default value equal to an empty list. -
KEYVALUE_DEFAULT_VALUE
public static final double[] KEYVALUE_DEFAULT_VALUEMFVec3d field named keyValue has default value equal to an empty list. -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
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_GEOVALUE_CHANGED
public static final java.lang.String fromField_GEOVALUE_CHANGEDfromField ROUTE name for SFVec3d field named geovalue_changed.- 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_KEY
public static final java.lang.String fromField_KEYfromField ROUTE name for MFFloat field named key.- See Also:
- Constant Field Values
-
toField_KEY
public static final java.lang.String toField_KEYtoField ROUTE name for MFFloat field named key.- See Also:
- Constant Field Values
-
fromField_KEYVALUE
public static final java.lang.String fromField_KEYVALUEfromField ROUTE name for MFVec3d field named keyValue.- See Also:
- Constant Field Values
-
toField_KEYVALUE
public static final java.lang.String toField_KEYVALUEtoField ROUTE name for MFVec3d field named keyValue.- 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
-
toField_SET_FRACTION
public static final java.lang.String toField_SET_FRACTIONtoField ROUTE name for SFFloat field named set_fraction.- See Also:
- Constant Field Values
-
fromField_VALUE_CHANGED
public static final java.lang.String fromField_VALUE_CHANGEDfromField ROUTE name for SFVec3f field named value_changed.- See Also:
- Constant Field Values
-
-
Constructor Details
-
GeoPositionInterpolatorObject
public GeoPositionInterpolatorObject()Constructor for GeoPositionInterpolatorObject to initialize member variables with default values. -
GeoPositionInterpolatorObject
public GeoPositionInterpolatorObject(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: GeoPositionInterpolator- Specified by:
getElementNamein classX3DConcreteElement- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the GeoPositionInterpolator element: Geospatial- Specified by:
getComponentin classX3DConcreteElement- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevelin 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:
getFieldTypein 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:
getAccessTypein 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:
getContainerFieldDefaultin 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:
initializein classX3DConcreteNode
-
getGeoOrigin
Provide GeoOriginObject instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.- Specified by:
getGeoOriginin interfaceGeoPositionInterpolator- 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:
setGeoOriginin interfaceGeoPositionInterpolator- Parameters:
newValue- is new value for the geoOrigin field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
getGeoSystemin interfaceGeoPositionInterpolator- 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:
setGeoSystemin interfaceGeoPositionInterpolator- Parameters:
newValue- is new value for the geoSystem field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getGeovalue
public double[] getGeovalue()Provide array of 3-tuple double results from outputOnly SFVec3d field named geovalue_changed.
Tooltip: interpolated coordinate in the geographic coordinate system specified by geoSystem- Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Warning: 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:
getGeovaluein interfaceGeoPositionInterpolator- Returns:
- value of geovalue_changed field
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getISin 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:
setISin classX3DConcreteNode- Parameters:
newValue- is new value for the IS field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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()
-
getKey
public float[] getKey()Provide array of Float results from inputOutput MFFloat field named key.
Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array.- Warning: number of keys must match number of keyValues!
- Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
- Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
- Specified by:
getKeyin interfaceGeoPositionInterpolator- Specified by:
getKeyin interfaceX3DInterpolatorNode- Returns:
- value of key field
-
getKeyList
public java.util.ArrayList<java.lang.Float> getKeyList()Utility method to get ArrayList value of MFFloat key field, similar togetKey().- Returns:
- value of key field
-
getKeyString
public java.lang.String getKeyString()Utility method to get String value of MFFloat key field, similar togetKey().- Returns:
- value of key field
-
setKey
Accessor method to assign Float array to inputOutput MFFloat field named key.
Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array.- Warning: number of keys must match number of keyValues!
- Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
- Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
- Specified by:
setKeyin interfaceGeoPositionInterpolator- Specified by:
setKeyin interfaceX3DInterpolatorNode- Parameters:
newValue- is new value for the key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKey
Assign typed object value to MFFloat key field, similar tosetKey(float[]).- Parameters:
newValue- is new value for the key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKey
Assign ArrayList value of MFFloat key field, similar tosetKey(float[]).- Parameters:
newValue- is new value for the key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearKey
Utility method to clear MFFloat value of key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setKey
Assign floating-point array value of MFFloat key field, similar tosetKey(float[]).- Parameters:
newValue- is new value for the key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKey
Add singleton float value to MFFloat key field.- Parameters:
newValue- is new value to add to the key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKey
Add singleton SFFloatObject value to MFFloat key field.- Parameters:
newValue- is new value to add to the key field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKey
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetKey(float[]).- Parameters:
newArray- is new value for field- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getKeyValue
public double[] getKeyValue()Provide array of 3-tuple double results from inputOutput MFVec3d field named keyValue.
Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array.- Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
- Warning: number of keys must match number of keyValues!
- Specified by:
getKeyValuein interfaceGeoPositionInterpolator- Returns:
- value of keyValue field
-
setKeyValue
Accessor method to assign 3-tuple double array to inputOutput MFVec3d field named keyValue.
Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array.- Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
- Warning: number of keys must match number of keyValues!
- Specified by:
setKeyValuein interfaceGeoPositionInterpolator- Parameters:
newValue- is new value for the keyValue field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setKeyValue
Assign typed object value to MFVec3d keyValue field, similar tosetKeyValue(double[]).- Parameters:
newValue- is new value for the keyValue field.- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addKeyValue
Add singleton SFVec3dObject value to MFVec3d keyValue field.- Parameters:
newValue- is new value to add to the keyValue field.- Returns:
GeoPositionInterpolatorObject- 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:
getMetadatain interfaceGeoPositionInterpolator- Specified by:
getMetadatain interfaceX3DChildNode- Specified by:
getMetadatain interfaceX3DInterpolatorNode- Specified by:
getMetadatain interfaceX3DNode- 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:
setMetadatain interfaceGeoPositionInterpolator- Specified by:
setMetadatain interfaceX3DChildNode- Specified by:
setMetadatain interfaceX3DInterpolatorNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
GeoPositionInterpolatorObject- 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
-
getValue
public float[] getValue()Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.
Tooltip: Linearly interpolated output value determined by current key time and corresponding keyValue pair.- Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect.
- 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:
getValuein interfaceGeoPositionInterpolator- Returns:
- value of value_changed field
-
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:
getDEFin 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:
setDEFin classX3DConcreteNode- Parameters:
newValue- is new value for the DEF field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
getUSEin 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: eachUSEnode is still an independent object, with theUSEvalue matching theDEFvalue 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:
setUSEin classX3DConcreteNode- Parameters:
newValue- is new value for the USE field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
getCssClassin 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:
setCssClassin classX3DConcreteNode- Parameters:
newValue- is new value for the class field.- Returns:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
GeoPositionInterpolatorObject- 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:
addCommentsin classX3DConcreteElement- Parameters:
newComment- initial value- Returns:
GeoPositionInterpolatorObject- 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:
addCommentsin classX3DConcreteElement- Parameters:
newComments- array of comments- Returns:
GeoPositionInterpolatorObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newCommentsBlock- block of comments to add- Returns:
GeoPositionInterpolatorObject- 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:
toStringX3Din 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:
toStringClassicVRMLin 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:
toStringVRML97in 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:
findElementByNameValuein 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:
findElementByNameValuein 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:
findNodeByDEFin 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:
validatein classX3DConcreteElement- Returns:
- validation results (if any)
-