Package org.web3d.x3d.jsail.Navigation
Class OrthoViewpointObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Navigation.OrthoViewpointObject
- All Implemented Interfaces:
X3DBindableNode
,X3DChildNode
,X3DNode
,OrthoViewpoint
,X3DViewpointNode
public class OrthoViewpointObject extends X3DConcreteNode implements OrthoViewpoint
OrthoViewpoint provides an orthographic perspective-free view of a scene from a specific location and direction.
X3D node tooltip: [X3DViewpointNode] OrthoViewpoint provides an orthographic perspective-free view of a scene from a specific location and direction.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
X3D node tooltip: [X3DViewpointNode] OrthoViewpoint provides an orthographic perspective-free view of a scene from a specific location and direction.
- Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
- Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
- Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
- 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.
-
Field Summary
Fields Modifier and Type Field Description static float[]
CENTEROFROTATION_DEFAULT_VALUE
SFVec3f field named centerOfRotation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the OrthoViewpoint element: Navigationstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.static java.util.ArrayList<java.lang.Float>
FIELDOFVIEW_DEFAULT_VALUE
MFFloat field named fieldOfView has default value {-1f,-1f,1f,1f} (Java syntax) or -1 -1 1 1 (XML syntax).static java.lang.String
fromField_BINDTIME
fromField ROUTE name for SFTime field named bindTime.static java.lang.String
fromField_CENTEROFROTATION
fromField ROUTE name for SFVec3f field named centerOfRotation.static java.lang.String
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.static java.lang.String
fromField_FIELDOFVIEW
fromField ROUTE name for MFFloat field named fieldOfView.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISBOUND
fromField ROUTE name for SFBool field named isBound.static java.lang.String
fromField_JUMP
fromField ROUTE name for SFBool field named jump.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_ORIENTATION
fromField ROUTE name for SFRotation field named orientation.static java.lang.String
fromField_POSITION
fromField ROUTE name for SFVec3f field named position.static java.lang.String
fromField_RETAINUSEROFFSETS
fromField ROUTE name for SFBool field named retainUserOffsets.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static boolean
JUMP_DEFAULT_VALUE
SFBool field named jump has default value true (Java syntax) or true (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Navigation component level for this element: 3static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: OrthoViewpoint.static float[]
ORIENTATION_DEFAULT_VALUE
SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).static float[]
POSITION_DEFAULT_VALUE
SFVec3f field named position has default value {0f,0f,10f} (Java syntax) or 0 0 10 (XML syntax).static boolean
RETAINUSEROFFSETS_DEFAULT_VALUE
SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).static java.lang.String
toField_CENTEROFROTATION
toField ROUTE name for SFVec3f field named centerOfRotation.static java.lang.String
toField_DESCRIPTION
toField ROUTE name for SFString field named description.static java.lang.String
toField_FIELDOFVIEW
toField ROUTE name for MFFloat field named fieldOfView.static java.lang.String
toField_JUMP
toField ROUTE name for SFBool field named jump.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_ORIENTATION
toField ROUTE name for SFRotation field named orientation.static java.lang.String
toField_POSITION
toField ROUTE name for SFVec3f field named position.static java.lang.String
toField_RETAINUSEROFFSETS
toField ROUTE name for SFBool field named retainUserOffsets.static java.lang.String
toField_SET_BIND
toField ROUTE name for SFBool field named set_bind.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description OrthoViewpointObject()
Constructor for OrthoViewpointObject to initialize member variables with default values.OrthoViewpointObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description OrthoViewpointObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.OrthoViewpointObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.OrthoViewpointObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.OrthoViewpointObject
addFieldOfView(float newValue)
Add singleton float value to MFFloat fieldOfView field.OrthoViewpointObject
addFieldOfView(SFFloatObject newValue)
Add singleton SFFloatObject value to MFFloat fieldOfView field.OrthoViewpointObject
clearFieldOfView()
Utility method to clear MFFloat value of fieldOfView field.OrthoViewpointObject
clearIS()
Utility method to clear SFNode value of IS field.OrthoViewpointObject
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.double
getBindTime()
Provide double value in seconds from outputOnly SFTime field named bindTime.float[]
getCenterOfRotation()
Provide array of 3-tuple float results unit axis, angle (in radians) from inputOutput SFVec3f field named centerOfRotation.java.lang.String
getComponent()
Defines X3D component for the OrthoViewpoint element: Navigationint
getComponentLevel()
Provides default X3D component level for this element: 3java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.java.lang.String
getElementName()
Provides name of this element: OrthoViewpointfloat[]
getFieldOfView()
Provide array of Float results from inputOutput MFFloat field named fieldOfView.java.util.ArrayList<java.lang.Float>
getFieldOfViewList()
Utility method to get ArrayList value of MFFloat fieldOfView field, similar togetFieldOfView()
.java.lang.String
getFieldOfViewString()
Utility method to get String value of MFFloat fieldOfView field, similar togetFieldOfView()
.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.boolean
getIsBound()
Provide boolean value from outputOnly SFBool field named isBound.boolean
getJump()
Provide boolean value from inputOutput SFBool field named jump.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float[]
getOrientation()
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.float[]
getPosition()
Provide array of 3-tuple float results from inputOutput SFVec3f field named position.boolean
getRetainUserOffsets()
Provide boolean value from inputOutput SFBool field named retainUserOffsets.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.OrthoViewpointObject
setCenterOfRotation(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetCenterOfRotation(float[])
.OrthoViewpointObject
setCenterOfRotation(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetCenterOfRotation(float[])
.OrthoViewpointObject
setCenterOfRotation(float[] newValue)
Accessor method to assign 3-tuple float array unit axis, angle (in radians) to inputOutput SFVec3f field named centerOfRotation.OrthoViewpointObject
setCenterOfRotation(float x, float y, float z)
Assign values to SFVec3f centerOfRotation field, similar tosetCenterOfRotation(float[])
.OrthoViewpointObject
setCenterOfRotation(SFVec3fObject newValue)
Assign typed object value to SFVec3f centerOfRotation field, similar tosetCenterOfRotation(float[])
.OrthoViewpointObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.OrthoViewpointObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.OrthoViewpointObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.OrthoViewpointObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.OrthoViewpointObject
setDescription(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named description.OrthoViewpointObject
setDescription(SFStringObject newValue)
Assign typed object value to SFString description field, similar tosetDescription(String)
.OrthoViewpointObject
setFieldOfView(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetFieldOfView(float[])
.OrthoViewpointObject
setFieldOfView(float[] newValue)
Accessor method to assign Float array to inputOutput MFFloat field named fieldOfView.OrthoViewpointObject
setFieldOfView(int[] newValue)
Assign floating-point array value of MFFloat fieldOfView field, similar tosetFieldOfView(float[])
.OrthoViewpointObject
setFieldOfView(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat fieldOfView field, similar tosetFieldOfView(float[])
.OrthoViewpointObject
setFieldOfView(MFFloatObject newValue)
Assign typed object value to MFFloat fieldOfView field, similar tosetFieldOfView(float[])
.OrthoViewpointObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.OrthoViewpointObject
setJump(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named jump.OrthoViewpointObject
setJump(SFBoolObject newValue)
Assign typed object value to SFBool jump field, similar tosetJump(boolean)
.OrthoViewpointObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.OrthoViewpointObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.OrthoViewpointObject
setOrientation(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOrientation(float[])
.OrthoViewpointObject
setOrientation(double x, double y, double z, double angleRadians)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetOrientation(float[])
.OrthoViewpointObject
setOrientation(float[] newValue)
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.OrthoViewpointObject
setOrientation(float x, float y, float z, float angleRadians)
Assign values to SFRotation orientation field, similar tosetOrientation(float[])
.OrthoViewpointObject
setOrientation(SFRotationObject newValue)
Assign typed object value to SFRotation orientation field, similar tosetOrientation(float[])
.OrthoViewpointObject
setPosition(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetPosition(float[])
.OrthoViewpointObject
setPosition(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetPosition(float[])
.OrthoViewpointObject
setPosition(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.OrthoViewpointObject
setPosition(float x, float y, float z)
Assign values to SFVec3f position field, similar tosetPosition(float[])
.OrthoViewpointObject
setPosition(SFVec3fObject newValue)
Assign typed object value to SFVec3f position field, similar tosetPosition(float[])
.OrthoViewpointObject
setRetainUserOffsets(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.OrthoViewpointObject
setRetainUserOffsets(SFBoolObject newValue)
Assign typed object value to SFBool retainUserOffsets field, similar tosetRetainUserOffsets(boolean)
.OrthoViewpointObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.OrthoViewpointObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.OrthoViewpointObject
setUSE(OrthoViewpointObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: OrthoViewpoint.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the OrthoViewpoint element: Navigation- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Navigation component level for this element: 3- See Also:
- Constant Field Values
-
CENTEROFROTATION_DEFAULT_VALUE
public static final float[] CENTEROFROTATION_DEFAULT_VALUESFVec3f field named centerOfRotation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
DESCRIPTION_DEFAULT_VALUE
public static final java.lang.String DESCRIPTION_DEFAULT_VALUESFString field named description has default value equal to an empty string.- See Also:
- Constant Field Values
-
FIELDOFVIEW_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> FIELDOFVIEW_DEFAULT_VALUEMFFloat field named fieldOfView has default value {-1f,-1f,1f,1f} (Java syntax) or -1 -1 1 1 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
JUMP_DEFAULT_VALUE
public static final boolean JUMP_DEFAULT_VALUESFBool field named jump has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
ORIENTATION_DEFAULT_VALUE
public static final float[] ORIENTATION_DEFAULT_VALUESFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax). -
POSITION_DEFAULT_VALUE
public static final float[] POSITION_DEFAULT_VALUESFVec3f field named position has default value {0f,0f,10f} (Java syntax) or 0 0 10 (XML syntax). -
RETAINUSEROFFSETS_DEFAULT_VALUE
public static final boolean RETAINUSEROFFSETS_DEFAULT_VALUESFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_BINDTIME
public static final java.lang.String fromField_BINDTIMEfromField ROUTE name for SFTime field named bindTime.- See Also:
- Constant Field Values
-
fromField_CENTEROFROTATION
public static final java.lang.String fromField_CENTEROFROTATIONfromField ROUTE name for SFVec3f field named centerOfRotation.- See Also:
- Constant Field Values
-
toField_CENTEROFROTATION
public static final java.lang.String toField_CENTEROFROTATIONtoField ROUTE name for SFVec3f field named centerOfRotation.- See Also:
- Constant Field Values
-
fromField_DESCRIPTION
public static final java.lang.String fromField_DESCRIPTIONfromField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
toField_DESCRIPTION
public static final java.lang.String toField_DESCRIPTIONtoField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
fromField_FIELDOFVIEW
public static final java.lang.String fromField_FIELDOFVIEWfromField ROUTE name for MFFloat field named fieldOfView.- See Also:
- Constant Field Values
-
toField_FIELDOFVIEW
public static final java.lang.String toField_FIELDOFVIEWtoField ROUTE name for MFFloat field named fieldOfView.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISBOUND
public static final java.lang.String fromField_ISBOUNDfromField ROUTE name for SFBool field named isBound.- See Also:
- Constant Field Values
-
fromField_JUMP
public static final java.lang.String fromField_JUMPfromField ROUTE name for SFBool field named jump.- See Also:
- Constant Field Values
-
toField_JUMP
public static final java.lang.String toField_JUMPtoField ROUTE name for SFBool field named jump.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_ORIENTATION
public static final java.lang.String fromField_ORIENTATIONfromField ROUTE name for SFRotation field named orientation.- See Also:
- Constant Field Values
-
toField_ORIENTATION
public static final java.lang.String toField_ORIENTATIONtoField ROUTE name for SFRotation field named orientation.- See Also:
- Constant Field Values
-
fromField_POSITION
public static final java.lang.String fromField_POSITIONfromField ROUTE name for SFVec3f field named position.- See Also:
- Constant Field Values
-
toField_POSITION
public static final java.lang.String toField_POSITIONtoField ROUTE name for SFVec3f field named position.- See Also:
- Constant Field Values
-
fromField_RETAINUSEROFFSETS
public static final java.lang.String fromField_RETAINUSEROFFSETSfromField ROUTE name for SFBool field named retainUserOffsets.- See Also:
- Constant Field Values
-
toField_RETAINUSEROFFSETS
public static final java.lang.String toField_RETAINUSEROFFSETStoField ROUTE name for SFBool field named retainUserOffsets.- See Also:
- Constant Field Values
-
toField_SET_BIND
public static final java.lang.String toField_SET_BINDtoField ROUTE name for SFBool field named set_bind.- See Also:
- Constant Field Values
-
-
Constructor Details
-
OrthoViewpointObject
public OrthoViewpointObject()Constructor for OrthoViewpointObject to initialize member variables with default values. -
OrthoViewpointObject
public OrthoViewpointObject(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: OrthoViewpoint- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the OrthoViewpoint 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: 3- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getBindTime
public double getBindTime()Provide double value in seconds from outputOnly SFTime field named bindTime.
Tooltip: Event sent reporting timestamp when node becomes active/inactive.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getBindTime
in interfaceOrthoViewpoint
- Specified by:
getBindTime
in interfaceX3DBindableNode
- Specified by:
getBindTime
in interfaceX3DViewpointNode
- Returns:
- value of bindTime field
-
getCenterOfRotation
public float[] getCenterOfRotation()Provide array of 3-tuple float results unit axis, angle (in radians) from inputOutput SFVec3f field named centerOfRotation.
Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *- Specified by:
getCenterOfRotation
in interfaceOrthoViewpoint
- Returns:
- value of centerOfRotation field
-
setCenterOfRotation
Accessor method to assign 3-tuple float array unit axis, angle (in radians) to inputOutput SFVec3f field named centerOfRotation.
Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *- Specified by:
setCenterOfRotation
in interfaceOrthoViewpoint
- Parameters:
newValue
- is new value for the centerOfRotation field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenterOfRotation
Assign typed object value to SFVec3f centerOfRotation field, similar tosetCenterOfRotation(float[])
.- Parameters:
newValue
- is new value for the centerOfRotation field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenterOfRotation
Assign values to SFVec3f centerOfRotation field, similar tosetCenterOfRotation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenterOfRotation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetCenterOfRotation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenterOfRotation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetCenterOfRotation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDescription
public java.lang.String getDescription()Provide String value from inputOutput SFString field named description.
Tooltip: Text description or navigation hint to describe the significance of this model Viewpoint.- Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided tour of a model.
- Hint: the currently bound NavigationInfo node has a major effect on how a user might change viewing position and orientation after reaching this Viewpoint.
- Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections between corresponding isBound/set_bind fields.
- Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
- Warning: without description, this OrthoViewpoint is unlikely to appear on browser Viewpoint menus.
- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfaceOrthoViewpoint
- Specified by:
getDescription
in interfaceX3DViewpointNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Text description or navigation hint to describe the significance of this model Viewpoint.- Hint: a sequence of good Viewpoints with understandable descriptions can provide a guided tour of a model.
- Hint: the currently bound NavigationInfo node has a major effect on how a user might change viewing position and orientation after reaching this Viewpoint.
- Hint: consider paired Viewpoint/NavigationInfo node combinations by defining ROUTE connections between corresponding isBound/set_bind fields.
- Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
- Warning: without description, this OrthoViewpoint is unlikely to appear on browser Viewpoint menus.
- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfaceOrthoViewpoint
- Specified by:
setDescription
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the description field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDescription
Assign typed object value to SFString description field, similar tosetDescription(String)
.- Parameters:
newValue
- is new value for the description field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getFieldOfView
public float[] getFieldOfView()Provide array of Float results from inputOutput MFFloat field named fieldOfView.
Tooltip: Minimum and maximum extents of view in units of local coordinate system. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.- Warning: minimum corner must remain less than maximum corner.
- Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
- Specified by:
getFieldOfView
in interfaceOrthoViewpoint
- Returns:
- value of fieldOfView field
-
getFieldOfViewList
public java.util.ArrayList<java.lang.Float> getFieldOfViewList()Utility method to get ArrayList value of MFFloat fieldOfView field, similar togetFieldOfView()
.- Returns:
- value of fieldOfView field
-
getFieldOfViewString
public java.lang.String getFieldOfViewString()Utility method to get String value of MFFloat fieldOfView field, similar togetFieldOfView()
.- Returns:
- value of fieldOfView field
-
setFieldOfView
Accessor method to assign Float array to inputOutput MFFloat field named fieldOfView.
Tooltip: Minimum and maximum extents of view in units of local coordinate system. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.- Warning: minimum corner must remain less than maximum corner.
- Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
- Specified by:
setFieldOfView
in interfaceOrthoViewpoint
- Parameters:
newValue
- is new value for the fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFieldOfView
Assign typed object value to MFFloat fieldOfView field, similar tosetFieldOfView(float[])
.- Parameters:
newValue
- is new value for the fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFieldOfView
Assign ArrayList value of MFFloat fieldOfView field, similar tosetFieldOfView(float[])
.- Parameters:
newValue
- is new value for the fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearFieldOfView
Utility method to clear MFFloat value of fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setFieldOfView
Assign floating-point array value of MFFloat fieldOfView field, similar tosetFieldOfView(float[])
.- Parameters:
newValue
- is new value for the fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addFieldOfView
Add singleton float value to MFFloat fieldOfView field.- Parameters:
newValue
- is new value to add to the fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addFieldOfView
Add singleton SFFloatObject value to MFFloat fieldOfView field.- Parameters:
newValue
- is new value to add to the fieldOfView field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFieldOfView
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetFieldOfView(float[])
.- Parameters:
newArray
- is new value for field- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getIsBound
public boolean getIsBound()Provide boolean value from outputOnly SFBool field named isBound.
Tooltip: Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated.- 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 interfaceOrthoViewpoint
- Specified by:
getIsBound
in interfaceX3DBindableNode
- Specified by:
getIsBound
in interfaceX3DViewpointNode
- Returns:
- value of isBound field
-
getJump
public boolean getJump()Provide boolean value from inputOutput SFBool field named jump.
Tooltip: Transition instantly by jumping, otherwise smoothly adjust offsets in place when changing to this Viewpoint.- Hint: see NavigationInfo.transitionType for the manner in which animated Viewpoint transistions occur.
- Hint: set jump=true for instantaneous camera motion when going to this viewpoint.
- Warning: for VR/AR/MAR users wearing head-mounted displays, animating transitions between viewpoints may induce motion sickness.
- Specified by:
getJump
in interfaceOrthoViewpoint
- Specified by:
getJump
in interfaceX3DViewpointNode
- Returns:
- value of jump field
-
setJump
Accessor method to assign boolean value to inputOutput SFBool field named jump.
Tooltip: Transition instantly by jumping, otherwise smoothly adjust offsets in place when changing to this Viewpoint.- Hint: see NavigationInfo.transitionType for the manner in which animated Viewpoint transistions occur.
- Hint: set jump=true for instantaneous camera motion when going to this viewpoint.
- Warning: for VR/AR/MAR users wearing head-mounted displays, animating transitions between viewpoints may induce motion sickness.
- Specified by:
setJump
in interfaceOrthoViewpoint
- Specified by:
setJump
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the jump field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJump
Assign typed object value to SFBool jump field, similar tosetJump(boolean)
.- Parameters:
newValue
- is new value for the jump field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceOrthoViewpoint
- Specified by:
getMetadata
in interfaceX3DBindableNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DViewpointNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceOrthoViewpoint
- Specified by:
setMetadata
in interfaceX3DBindableNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DViewpointNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getOrientation
public float[] getOrientation()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
Tooltip: Rotation (axis, angle in radians) of Viewpoint, relative to default -Z axis direction in local coordinate system.- Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
- Hint: this is orientation _change_ from default direction (0 0 -1).
- Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
- Specified by:
getOrientation
in interfaceOrthoViewpoint
- Specified by:
getOrientation
in interfaceX3DViewpointNode
- Returns:
- value of orientation field
-
setOrientation
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
Tooltip: Rotation (axis, angle in radians) of Viewpoint, relative to default -Z axis direction in local coordinate system.- Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
- Hint: this is orientation _change_ from default direction (0 0 -1).
- Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
- Specified by:
setOrientation
in interfaceOrthoViewpoint
- Specified by:
setOrientation
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the orientation field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Assign typed object value to SFRotation orientation field, similar tosetOrientation(float[])
.- Parameters:
newValue
- is new value for the orientation field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Assign values to SFRotation orientation field, similar tosetOrientation(float[])
.- Parameters:
x
- first component of axisy
- second component of axisz
- third component of axisangleRadians
- fourth component of rotation around axis- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetOrientation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third componentangleRadians
- fourth component- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setOrientation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetOrientation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getPosition
public float[] getPosition()Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
Tooltip: position (x, y, z in meters) relative to local coordinate system. *- Specified by:
getPosition
in interfaceOrthoViewpoint
- Returns:
- value of position field
-
setPosition
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
Tooltip: position (x, y, z in meters) relative to local coordinate system. *- Specified by:
setPosition
in interfaceOrthoViewpoint
- Parameters:
newValue
- is new value for the position field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPosition
Assign typed object value to SFVec3f position field, similar tosetPosition(float[])
.- Parameters:
newValue
- is new value for the position field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPosition
Assign values to SFVec3f position field, similar tosetPosition(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPosition
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetPosition(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPosition
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetPosition(float[])
.- Parameters:
newArray
- is new value for field- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRetainUserOffsets
public boolean getRetainUserOffsets()Provide boolean value from inputOutput SFBool field named retainUserOffsets.
Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *- Specified by:
getRetainUserOffsets
in interfaceOrthoViewpoint
- Specified by:
getRetainUserOffsets
in interfaceX3DViewpointNode
- Returns:
- value of retainUserOffsets field
-
setRetainUserOffsets
Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.
Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *- Specified by:
setRetainUserOffsets
in interfaceOrthoViewpoint
- Specified by:
setRetainUserOffsets
in interfaceX3DViewpointNode
- Parameters:
newValue
- is new value for the retainUserOffsets field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRetainUserOffsets
Assign typed object value to SFBool retainUserOffsets field, similar tosetRetainUserOffsets(boolean)
.- Parameters:
newValue
- is new value for the retainUserOffsets field.- Returns:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
OrthoViewpointObject
- 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:
OrthoViewpointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-