Package org.web3d.x3d.jsail.Navigation
Class NavigationInfo
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Navigation.NavigationInfo
- All Implemented Interfaces:
X3DBindableNode
,X3DChildNode
,X3DNode
,NavigationInfo
NavigationInfo describes the user's viewing model, user navigation-interaction modalities, and also dimensional characteristics of the user's (typically invisible) avatar.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
NavigationInfo node tooltip: [X3DBindableNode] NavigationInfo describes the user's viewing model, user navigation-interaction modalities, and also dimensional characteristics of the user's (typically invisible) avatar.
- Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY"
- 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: NavigationInfo types '"WALK" "FLY"' support camera-to-object collision detection.
- Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch. Avoid this authoring pattern.
- 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'/>
- Hint: X3D Scene Authoring Hints, Viewpoints https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionMFFloat field named avatarSize has default value {0.25f,1.6f,0.75f} (Java syntax) or 0.25 1.6 0.75 (XML syntax).static final String
String constant COMPONENT defines X3D component for the NavigationInfo element: Navigationstatic final String
containerField describes typical field relationship of a node to its parent.static final String
fromField ROUTE name for MFFloat field named avatarSize.static final String
fromField ROUTE name for SFTime field named bindTime.static final String
fromField ROUTE name for SFBool field named headlight.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFBool field named isBound.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFFloat field named speed.static final String
fromField ROUTE name for SFBool field named transitionComplete.static final String
fromField ROUTE name for SFTime field named transitionTime.static final String
fromField ROUTE name for MFString field named transitionType.static final String
fromField ROUTE name for MFString field named type.static final String
fromField ROUTE name for SFFloat field named visibilityLimit.static final boolean
SFBool field named headlight has default value true (Java syntax) or true (XML syntax).static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D Navigation component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: NavigationInfo.static final float
SFFloat field named speed has default value 1f (Java syntax) or 1 (XML syntax).static final String
toField ROUTE name for MFFloat field named avatarSize.static final String
toField ROUTE name for SFBool field named headlight.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFBool field named set_bind.static final String
toField ROUTE name for SFFloat field named speed.static final String
toField ROUTE name for SFTime field named transitionTime.static final String
toField ROUTE name for MFString field named transitionType.static final String
toField ROUTE name for MFString field named type.static final String
toField ROUTE name for SFFloat field named visibilityLimit.static final double
SFTime field named transitionTime has default value 1.0 (Java syntax) or 1.0 (XML syntax).static final String
Tooltip: rowser-specific transition.MFString field named transitionType has default quoted value new String[] {"LINEAR"} (Java syntax) or quoted value "LINEAR" (XML syntax).static final String
Tooltip: transition may proceed directly through intervening objects.static final String
Tooltip: immediate transition.static final String
Tooltip: browser can offer any type for user to choose.MFString field named type has default quoted value new String[] {"EXAMINE","ANY"} (Java syntax) or quoted value "EXAMINE" "ANY" (XML syntax).static final String
Tooltip: view an individual object by rotating view about center.static final String
Tooltip: consistent keystroke navigation for both geospatial and Cartesian modes.static final String
Tooltip: free navigation, collision detection.static final String
Tooltip: navigate to particular object.static final String
Tooltip: disables all navigation interfaces.static final String
Tooltip: free navigation, avatar remains on ground, collision detection.static final float
SFFloat field named visibilityLimit has default value 0f (Java syntax) or 0 (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for NavigationInfo to initialize member variables with default values.NavigationInfo
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddAvatarSize
(float newValue) Add singleton float value to MFFloat avatarSize field.addAvatarSize
(SFFloat newValue) Add singleton SFFloat value to MFFloat avatarSize field.addComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addTransitionType
(String newValue) Add singleton String value to MFString transitionType field.addTransitionType
(SFString newValue) Add singleton SFString value to MFString transitionType field.Add singleton String value to MFString type field.Add singleton SFString value to MFString type field.Utility method to clear MFFloat value of avatarSize field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear MFString value of transitionType field.Utility method to clear MFString value of type field.findElementByNameValue
(String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findElementByNameValue
(String nameValue, String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.float[]
Provide array of Float results within allowed range of [0,infinity) from inputOutput MFFloat field named avatarSize.Utility method to get ArrayList value of MFFloat avatarSize field, similar togetAvatarSize()
.Utility method to get String value of MFFloat avatarSize field, similar togetAvatarSize()
.double
Provide double value in seconds from outputOnly SFTime field named bindTime.final String
Defines X3D component for the NavigationInfo element: Navigationfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: NavigationInfogetFieldType
(String fieldName) Indicate type corresponding to given fieldName.boolean
Provide boolean value from inputOutput SFBool field named headlight.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.boolean
Provide boolean value from outputOnly SFBool field named isBound.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
getSpeed()
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.boolean
Provide boolean value from outputOnly SFBool field named transitionComplete.double
Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named transitionTime.String[]
Provide array of String enumeration results with quoted value(s) ["TELEPORT","LINEAR","ANIMATE",...] from inputOutput MFString field named transitionType.Utility method to get ArrayList value of MFString transitionType field, similar togetTransitionType()
.Utility method to get String value of MFString transitionType field, similar togetTransitionType()
.String[]
getType()
Provide array of String enumeration results with quoted value(s) ["ANY","WALK","EXAMINE","FLY","LOOKAT","NONE","EXPLORE",...] from inputOutput MFString field named type.Utility method to get ArrayList value of MFString type field, similar togetType()
.Utility method to get String value of MFString type field, similar togetType()
.getUSE()
Provide String value from inputOutput SFString field named USE.float
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityLimit.boolean
hasElementByNameValue
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setAvatarSize
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAvatarSize(float[])
.setAvatarSize
(float[] newValue) Accessor method to assign Float array to inputOutput MFFloat field named avatarSize.setAvatarSize
(int[] newValue) Assign floating-point array value of MFFloat avatarSize field, similar tosetAvatarSize(float[])
.setAvatarSize
(ArrayList<Float> newValue) Assign ArrayList value of MFFloat avatarSize field, similar tosetAvatarSize(float[])
.setAvatarSize
(MFFloat newValue) Assign typed object value to MFFloat avatarSize field, similar tosetAvatarSize(float[])
.final NavigationInfo
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final NavigationInfo
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final NavigationInfo
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setHeadlight
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named headlight.setHeadlight
(SFBool newValue) Assign typed object value to SFBool headlight field, similar tosetHeadlight(boolean)
.final NavigationInfo
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setSpeed
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeed(float)
.setSpeed
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named speed.Assign typed object value to SFFloat speed field, similar tosetSpeed(float)
.setTransitionTime
(double newValue) Accessor method to assign double value in seconds to inputOutput SFTime field named transitionTime.setTransitionTime
(SFTime newValue) Assign typed object value to SFTime transitionTime field, similar tosetTransitionTime(double)
.setTransitionType
(String newValue) Assign singleton String value to MFString transitionType field, similar tosetTransitionType(String[])
.setTransitionType
(String[] newValue) Accessor method to assign String enumeration array (""TELEPORT"" | ""LINEAR"" | ""ANIMATE"") to inputOutput MFString field named transitionType.setTransitionType
(ArrayList<String> newValue) Assign ArrayList value of MFString transitionType field, similar tosetTransitionType(String[])
.setTransitionType
(MFString newValue) Assign typed object value to MFString transitionType field, similar tosetTransitionType(String[])
.setTransitionType
(SFString newValue) Assign single SFString object value to MFString transitionType field, similar tosetTransitionType(String[])
.Assign singleton String value to MFString type field, similar tosetType(String[])
.Accessor method to assign String enumeration array (""ANY"" | ""WALK"" | ""EXAMINE"" | ""FLY"" | ""LOOKAT"" | ""NONE"" | ""EXPLORE"") to inputOutput MFString field named type.Assign ArrayList value of MFString type field, similar tosetType(String[])
.Assign typed object value to MFString type field, similar tosetType(String[])
.Assign single SFString object value to MFString type field, similar tosetType(String[])
.final NavigationInfo
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(NavigationInfo DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVisibilityLimit
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetVisibilityLimit(float)
.setVisibilityLimit
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named visibilityLimit.setVisibilityLimit
(SFFloat newValue) Assign typed object value to SFFloat visibilityLimit field, similar tosetVisibilityLimit(float)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
TRANSITIONTYPE_TELEPORT
Tooltip: immediate transition. MFString field named transitionType with X3DUOM simpleType navigationTransitionTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "TELEPORT" (Java syntax) or '"TELEPORT"' (XML syntax).- See Also:
-
TRANSITIONTYPE_LINEAR
Tooltip: transition may proceed directly through intervening objects. MFString field named transitionType with X3DUOM simpleType navigationTransitionTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "LINEAR" (Java syntax) or '"LINEAR"' (XML syntax).- See Also:
-
TRANSITIONTYPE_ANIMATE
Tooltip: rowser-specific transition. MFString field named transitionType with X3DUOM simpleType navigationTransitionTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ANIMATE" (Java syntax) or '"ANIMATE"' (XML syntax).- See Also:
-
TYPE_ANY
Tooltip: browser can offer any type for user to choose. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ANY" (Java syntax) or '"ANY"' (XML syntax).- See Also:
-
TYPE_WALK
Tooltip: free navigation, avatar remains on ground, collision detection. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "WALK" (Java syntax) or '"WALK"' (XML syntax).- See Also:
-
TYPE_EXAMINE
Tooltip: view an individual object by rotating view about center. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "EXAMINE" (Java syntax) or '"EXAMINE"' (XML syntax).- See Also:
-
TYPE_FLY
Tooltip: free navigation, collision detection. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "FLY" (Java syntax) or '"FLY"' (XML syntax).- See Also:
-
TYPE_LOOKAT
Tooltip: navigate to particular object. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "LOOKAT" (Java syntax) or '"LOOKAT"' (XML syntax).- See Also:
-
TYPE_NONE
Tooltip: disables all navigation interfaces. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).- See Also:
-
TYPE_EXPLORE
Tooltip: consistent keystroke navigation for both geospatial and Cartesian modes. MFString field named type with X3DUOM simpleType navigationTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "EXPLORE" (Java syntax) or '"EXPLORE"' (XML syntax).- See Also:
-
NAME
String constant NAME provides name of this element: NavigationInfo.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the NavigationInfo element: Navigation- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Navigation component level for this element: 1- See Also:
-
AVATARSIZE_DEFAULT_VALUE
-
HEADLIGHT_DEFAULT_VALUE
public static final boolean HEADLIGHT_DEFAULT_VALUESFBool field named headlight has default value true (Java syntax) or true (XML syntax).- See Also:
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
SPEED_DEFAULT_VALUE
public static final float SPEED_DEFAULT_VALUESFFloat field named speed has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
-
TRANSITIONTIME_DEFAULT_VALUE
public static final double TRANSITIONTIME_DEFAULT_VALUESFTime field named transitionTime has default value 1.0 (Java syntax) or 1.0 (XML syntax).- See Also:
-
TRANSITIONTYPE_DEFAULT_VALUE
-
TYPE_DEFAULT_VALUE
-
VISIBILITYLIMIT_DEFAULT_VALUE
public static final float VISIBILITYLIMIT_DEFAULT_VALUESFFloat field named visibilityLimit has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN- See Also:
-
fromField_AVATARSIZE
fromField ROUTE name for MFFloat field named avatarSize.- See Also:
-
toField_AVATARSIZE
toField ROUTE name for MFFloat field named avatarSize.- See Also:
-
fromField_BINDTIME
fromField ROUTE name for SFTime field named bindTime.- See Also:
-
fromField_HEADLIGHT
fromField ROUTE name for SFBool field named headlight.- See Also:
-
toField_HEADLIGHT
toField ROUTE name for SFBool field named headlight.- See Also:
-
fromField_IS
-
fromField_ISBOUND
fromField ROUTE name for SFBool field named isBound.- See Also:
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
toField_SET_BIND
toField ROUTE name for SFBool field named set_bind.- See Also:
-
fromField_SPEED
fromField ROUTE name for SFFloat field named speed.- See Also:
-
toField_SPEED
toField ROUTE name for SFFloat field named speed.- See Also:
-
fromField_TRANSITIONCOMPLETE
fromField ROUTE name for SFBool field named transitionComplete.- See Also:
-
fromField_TRANSITIONTIME
fromField ROUTE name for SFTime field named transitionTime.- See Also:
-
toField_TRANSITIONTIME
toField ROUTE name for SFTime field named transitionTime.- See Also:
-
fromField_TRANSITIONTYPE
fromField ROUTE name for MFString field named transitionType.- See Also:
-
toField_TRANSITIONTYPE
toField ROUTE name for MFString field named transitionType.- See Also:
-
fromField_TYPE
fromField ROUTE name for MFString field named type.- See Also:
-
toField_TYPE
-
fromField_VISIBILITYLIMIT
fromField ROUTE name for SFFloat field named visibilityLimit.- See Also:
-
toField_VISIBILITYLIMIT
toField ROUTE name for SFFloat field named visibilityLimit.- See Also:
-
-
Constructor Details
-
NavigationInfo
public NavigationInfo()Constructor for NavigationInfo to initialize member variables with default values. -
NavigationInfo
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
Provides name of this element: NavigationInfo- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the NavigationInfo element: Navigation- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getAvatarSize
public float[] getAvatarSize()Provide array of Float results within allowed range of [0,infinity) from inputOutput MFFloat field named avatarSize.
Tooltip: avatarSize triplet values define three separate parameters: (a) collisionDistance between user and geometry, i.e. near clipping plane of view frustrum, default 0.25m, (b) viewer height above terrain, default 1.6m, and (c) tallest height viewer can WALK over, default 0.75m.- Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
- Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Hint: transformation hierarchy of currently bound Viewpoint node scales avatarSize, but translations and rotations have no effect.
- Hint: content must be visible to be collidable and to be pickable.
- Warning: data type is MFFloat rather than SFVec3f, be sure that three values are provided in the array since validation tools are typically unable to detect erroneous data prior to run time.
- Specified by:
getAvatarSize
in interfaceNavigationInfo
- Returns:
- value of avatarSize field
-
getAvatarSizeList
Utility method to get ArrayList value of MFFloat avatarSize field, similar togetAvatarSize()
.- Returns:
- value of avatarSize field
-
getAvatarSizeString
Utility method to get String value of MFFloat avatarSize field, similar togetAvatarSize()
.- Returns:
- value of avatarSize field
-
setAvatarSize
Accessor method to assign Float array to inputOutput MFFloat field named avatarSize.
Tooltip: avatarSize triplet values define three separate parameters: (a) collisionDistance between user and geometry, i.e. near clipping plane of view frustrum, default 0.25m, (b) viewer height above terrain, default 1.6m, and (c) tallest height viewer can WALK over, default 0.75m.- Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
- Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Hint: transformation hierarchy of currently bound Viewpoint node scales avatarSize, but translations and rotations have no effect.
- Hint: content must be visible to be collidable and to be pickable.
- Warning: data type is MFFloat rather than SFVec3f, be sure that three values are provided in the array since validation tools are typically unable to detect erroneous data prior to run time.
- Specified by:
setAvatarSize
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the avatarSize field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAvatarSize
Assign typed object value to MFFloat avatarSize field, similar tosetAvatarSize(float[])
.- Parameters:
newValue
- is new value for the avatarSize field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAvatarSize
Assign ArrayList value of MFFloat avatarSize field, similar tosetAvatarSize(float[])
.- Parameters:
newValue
- is new value for the avatarSize field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearAvatarSize
Utility method to clear MFFloat value of avatarSize field. This method does not initialize withAVATARSIZE_DEFAULT_VALUE.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setAvatarSize
Assign floating-point array value of MFFloat avatarSize field, similar tosetAvatarSize(float[])
.- Parameters:
newValue
- is new value for the avatarSize field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addAvatarSize
Add singleton float value to MFFloat avatarSize field.- Parameters:
newValue
- is new value to add to the avatarSize field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addAvatarSize
Add singleton SFFloat value to MFFloat avatarSize field.- Parameters:
newValue
- is new value to add to the avatarSize field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAvatarSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAvatarSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 interfaceNavigationInfo
- Specified by:
getBindTime
in interfaceX3DBindableNode
- Returns:
- value of bindTime field
-
getHeadlight
public boolean getHeadlight()Provide boolean value from inputOutput SFBool field named headlight.
Tooltip: Enable/disable directional light that always points in the direction the user is looking. *- Specified by:
getHeadlight
in interfaceNavigationInfo
- Returns:
- value of headlight field
-
setHeadlight
Accessor method to assign boolean value to inputOutput SFBool field named headlight.
Tooltip: Enable/disable directional light that always points in the direction the user is looking. *- Specified by:
setHeadlight
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the headlight field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setHeadlight
Assign typed object value to SFBool headlight field, similar tosetHeadlight(boolean)
.- Parameters:
newValue
- is new value for the headlight field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
-
getIsBound
public boolean getIsBound()Provide boolean value from outputOnly SFBool field named isBound.
Tooltip: Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated.- Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
- 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 interfaceNavigationInfo
- Specified by:
getIsBound
in interfaceX3DBindableNode
- Returns:
- value of isBound field
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceNavigationInfo
- Specified by:
getMetadata
in interfaceX3DBindableNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceNavigationInfo
- Specified by:
setMetadata
in interfaceX3DBindableNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
NavigationInfo
- 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:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getSpeed
public float getSpeed()Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
Tooltip: [0,+infinity) Default rate at which viewer travels through scene, meters/second.- Warning: default 1 m/s usually seems slow for ordinary navigation. Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
getSpeed
in interfaceNavigationInfo
- Returns:
- value of speed field
-
setSpeed
Accessor method to assign float value to inputOutput SFFloat field named speed.
Tooltip: [0,+infinity) Default rate at which viewer travels through scene, meters/second.- Warning: default 1 m/s usually seems slow for ordinary navigation. Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
setSpeed
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the speed field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpeed
Assign typed object value to SFFloat speed field, similar tosetSpeed(float)
.- Parameters:
newValue
- is new value for the speed field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSpeed
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeed(float)
.- Parameters:
newValue
- is new value for field- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTransitionComplete
public boolean getTransitionComplete()Provide boolean value from outputOnly SFBool field named transitionComplete.
Tooltip: Event signaling viewpoint transition complete. Interchange profile- Hint: this field may be ignored.
- 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:
getTransitionComplete
in interfaceNavigationInfo
- Returns:
- value of transitionComplete field
-
getTransitionTime
public double getTransitionTime()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named transitionTime.
Tooltip: transitionTime defines the expected duration of viewpoint transition in seconds.- Hint: If transitionType is "ANIMATE", transitionTime provides browser-dependent animation parameters. Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
getTransitionTime
in interfaceNavigationInfo
- Returns:
- value of transitionTime field
-
setTransitionTime
Accessor method to assign double value in seconds to inputOutput SFTime field named transitionTime.
Tooltip: transitionTime defines the expected duration of viewpoint transition in seconds.- Hint: If transitionType is "ANIMATE", transitionTime provides browser-dependent animation parameters. Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
setTransitionTime
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the transitionTime field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransitionTime
Assign typed object value to SFTime transitionTime field, similar tosetTransitionTime(double)
.- Parameters:
newValue
- is new value for the transitionTime field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTransitionType
Provide array of String enumeration results with quoted value(s) ["TELEPORT","LINEAR","ANIMATE",...] from inputOutput MFString field named transitionType.
Tooltip: Camera transition between viewpoints. Enter one or more quoted SFString values: "ANIMATE" "TELEPORT" "LINEAR".- Hint: "ANIMATE" behavior is browser-specific, "TELEPORT" is immediate, and "LINEAR" may proceed directly through intervening objects.
Available enumeration values for string comparison:TELEPORT
,LINEAR
,ANIMATE
.- Specified by:
getTransitionType
in interfaceNavigationInfo
- Returns:
- value of transitionType field
-
getTransitionTypeList
Utility method to get ArrayList value of MFString transitionType field, similar togetTransitionType()
.- Returns:
- value of transitionType field
-
getTransitionTypeString
Utility method to get String value of MFString transitionType field, similar togetTransitionType()
.- Returns:
- value of transitionType field
-
setTransitionType
Accessor method to assign String enumeration array (""TELEPORT"" | ""LINEAR"" | ""ANIMATE"") to inputOutput MFString field named transitionType.
Hint: authors have option to choose from an extendible list of predefined enumeration values (TELEPORT
,LINEAR
,ANIMATE
).
Tooltip: Camera transition between viewpoints. Enter one or more quoted SFString values: "ANIMATE" "TELEPORT" "LINEAR".- Hint: "ANIMATE" behavior is browser-specific, "TELEPORT" is immediate, and "LINEAR" may proceed directly through intervening objects.
- Specified by:
setTransitionType
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransitionType
Assign typed object value to MFString transitionType field, similar tosetTransitionType(String[])
.- Parameters:
newValue
- is new value for the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransitionType
Assign single SFString object value to MFString transitionType field, similar tosetTransitionType(String[])
.- Parameters:
newValue
- is new value for the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setTransitionType
Assign singleton String value to MFString transitionType field, similar tosetTransitionType(String[])
.- Parameters:
newValue
- is new value for the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setTransitionType
Assign ArrayList value of MFString transitionType field, similar tosetTransitionType(String[])
.- Parameters:
newValue
- is new value for the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearTransitionType
Utility method to clear MFString value of transitionType field. This method does not initialize withTRANSITIONTYPE_DEFAULT_VALUE.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addTransitionType
Add singleton String value to MFString transitionType field.- Parameters:
newValue
- is new value to add to the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addTransitionType
Add singleton SFString value to MFString transitionType field.- Parameters:
newValue
- is new value to add to the transitionType field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getType
Provide array of String enumeration results with quoted value(s) ["ANY","WALK","EXAMINE","FLY","LOOKAT","NONE","EXPLORE",...] from inputOutput MFString field named type.
Tooltip: Enter one or more quoted SFString values: "EXAMINE" "WALK" "FLY" "LOOKAT" "EXPLORE" "ANY" "NONE".- Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY".
- Hint: types WALK and FLY force strict camera-to-object collision detection.
- Hint: see Collision node for further details on camera-to-object collision detection.
- Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc." ] Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
Available enumeration values for string comparison:ANY
,WALK
,EXAMINE
,FLY
,LOOKAT
,NONE
,EXPLORE
.- Specified by:
getType
in interfaceNavigationInfo
- Returns:
- value of type field
-
getTypeList
-
getTypeString
-
setType
Accessor method to assign String enumeration array (""ANY"" | ""WALK"" | ""EXAMINE"" | ""FLY"" | ""LOOKAT"" | ""NONE"" | ""EXPLORE"") to inputOutput MFString field named type.
Hint: authors have option to choose from an extendible list of predefined enumeration values (ANY
,WALK
,EXAMINE
,FLY
,LOOKAT
,NONE
,EXPLORE
).
Tooltip: Enter one or more quoted SFString values: "EXAMINE" "WALK" "FLY" "LOOKAT" "EXPLORE" "ANY" "NONE".- Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY".
- Hint: types WALK and FLY force strict camera-to-object collision detection.
- Hint: see Collision node for further details on camera-to-object collision detection.
- Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc." ] Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
setType
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setType
Assign typed object value to MFString type field, similar tosetType(String[])
.- Parameters:
newValue
- is new value for the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setType
Assign single SFString object value to MFString type field, similar tosetType(String[])
.- Parameters:
newValue
- is new value for the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setType
Assign singleton String value to MFString type field, similar tosetType(String[])
.- Parameters:
newValue
- is new value for the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setType
Assign ArrayList value of MFString type field, similar tosetType(String[])
.- Parameters:
newValue
- is new value for the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearType
Utility method to clear MFString value of type field. This method does not initialize withTYPE_DEFAULT_VALUE.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addType
Add singleton String value to MFString type field.- Parameters:
newValue
- is new value to add to the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addType
Add singleton SFString value to MFString type field.- Parameters:
newValue
- is new value to add to the type field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getVisibilityLimit
public float getVisibilityLimit()Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityLimit.
Tooltip: Geometry beyond the visibilityLimit may not be rendered (far clipping plane of the view frustrum).- Hint: visibilityLimit=0.0 indicates an infinite visibility limit (no far clipping plane).
- Hint: set visibilityLimit to appropriate positive value in meters to define far culling plane of view frustum.
- Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
- Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
getVisibilityLimit
in interfaceNavigationInfo
- Returns:
- value of visibilityLimit field
-
setVisibilityLimit
Accessor method to assign float value to inputOutput SFFloat field named visibilityLimit.
Tooltip: Geometry beyond the visibilityLimit may not be rendered (far clipping plane of the view frustrum).- Hint: visibilityLimit=0.0 indicates an infinite visibility limit (no far clipping plane).
- Hint: set visibilityLimit to appropriate positive value in meters to define far culling plane of view frustum.
- Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
- Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Specified by:
setVisibilityLimit
in interfaceNavigationInfo
- Parameters:
newValue
- is new value for the visibilityLimit field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisibilityLimit
Assign typed object value to SFFloat visibilityLimit field, similar tosetVisibilityLimit(float)
.- Parameters:
newValue
- is new value for the visibilityLimit field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisibilityLimit
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetVisibilityLimit(float)
.- Parameters:
newValue
- is new value for field- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
NavigationInfo
- 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:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
NavigationInfo
- 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:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
NavigationInfo
- 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:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
NavigationInfo
- 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:
NavigationInfo
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-