Class OrthoViewpoint

All Implemented Interfaces:
X3DBindableNode, X3DChildNode, X3DNode, OrthoViewpoint, X3DViewpointNode

public class OrthoViewpoint 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.
  • Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
  • Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
  • Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch. Avoid this authoring pattern.
  • Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
  • 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 Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: OrthoViewpoint.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the OrthoViewpoint element: Navigation
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Navigation component level for this element: 3
      See Also:
    • CENTEROFROTATION_DEFAULT_VALUE

      public static final float[] CENTEROFROTATION_DEFAULT_VALUE
      SFVec3f field named centerOfRotation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:
    • FARDISTANCE_DEFAULT_VALUE

      public static final float FARDISTANCE_DEFAULT_VALUE
      SFFloat field named farDistance has default value -1f (Java syntax) or -1 (XML syntax).
      See Also:
    • FIELDOFVIEW_DEFAULT_VALUE

      public static final ArrayList<Float> FIELDOFVIEW_DEFAULT_VALUE
      MFFloat field named fieldOfView has default value {-1f,-1f,1f,1f} (Java syntax) or -1 -1 1 1 (XML syntax).
    • IS_DEFAULT_VALUE

      public static final IS 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_VALUE
      SFBool field named jump has default value true (Java syntax) or true (XML syntax).
      See Also:
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • NEARDISTANCE_DEFAULT_VALUE

      public static final float NEARDISTANCE_DEFAULT_VALUE
      SFFloat field named nearDistance has default value -1f (Java syntax) or -1 (XML syntax).
      See Also:
    • ORIENTATION_DEFAULT_VALUE

      public static final float[] ORIENTATION_DEFAULT_VALUE
      SFRotation 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_VALUE
      SFVec3f 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_VALUE
      SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).
      See Also:
    • VIEWALL_DEFAULT_VALUE

      public static final boolean VIEWALL_DEFAULT_VALUE
      SFBool field named viewAll has default value false (Java syntax) or false (XML syntax).
      See Also:
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      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.
      See Also:
    • fromField_BINDTIME

      public static final String fromField_BINDTIME
      fromField ROUTE name for SFTime field named bindTime.
      See Also:
    • fromField_CENTEROFROTATION

      public static final String fromField_CENTEROFROTATION
      fromField ROUTE name for SFVec3f field named centerOfRotation.
      See Also:
    • toField_CENTEROFROTATION

      public static final String toField_CENTEROFROTATION
      toField ROUTE name for SFVec3f field named centerOfRotation.
      See Also:
    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
    • fromField_FARDISTANCE

      public static final String fromField_FARDISTANCE
      fromField ROUTE name for SFFloat field named farDistance.
      See Also:
    • toField_FARDISTANCE

      public static final String toField_FARDISTANCE
      toField ROUTE name for SFFloat field named farDistance.
      See Also:
    • fromField_FIELDOFVIEW

      public static final String fromField_FIELDOFVIEW
      fromField ROUTE name for MFFloat field named fieldOfView.
      See Also:
    • toField_FIELDOFVIEW

      public static final String toField_FIELDOFVIEW
      toField ROUTE name for MFFloat field named fieldOfView.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_ISBOUND

      public static final String fromField_ISBOUND
      fromField ROUTE name for SFBool field named isBound.
      See Also:
    • fromField_JUMP

      public static final String fromField_JUMP
      fromField ROUTE name for SFBool field named jump.
      See Also:
    • toField_JUMP

      public static final String toField_JUMP
      toField ROUTE name for SFBool field named jump.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
    • fromField_NAVIGATIONINFO

      public static final String fromField_NAVIGATIONINFO
      fromField ROUTE name for SFNode field named navigationInfo.
      See Also:
    • toField_NAVIGATIONINFO

      public static final String toField_NAVIGATIONINFO
      toField ROUTE name for SFNode field named navigationInfo.
      See Also:
    • fromField_NEARDISTANCE

      public static final String fromField_NEARDISTANCE
      fromField ROUTE name for SFFloat field named nearDistance.
      See Also:
    • toField_NEARDISTANCE

      public static final String toField_NEARDISTANCE
      toField ROUTE name for SFFloat field named nearDistance.
      See Also:
    • fromField_ORIENTATION

      public static final String fromField_ORIENTATION
      fromField ROUTE name for SFRotation field named orientation.
      See Also:
    • toField_ORIENTATION

      public static final String toField_ORIENTATION
      toField ROUTE name for SFRotation field named orientation.
      See Also:
    • fromField_POSITION

      public static final String fromField_POSITION
      fromField ROUTE name for SFVec3f field named position.
      See Also:
    • toField_POSITION

      public static final String toField_POSITION
      toField ROUTE name for SFVec3f field named position.
      See Also:
    • fromField_RETAINUSEROFFSETS

      public static final String fromField_RETAINUSEROFFSETS
      fromField ROUTE name for SFBool field named retainUserOffsets.
      See Also:
    • toField_RETAINUSEROFFSETS

      public static final String toField_RETAINUSEROFFSETS
      toField ROUTE name for SFBool field named retainUserOffsets.
      See Also:
    • toField_SET_BIND

      public static final String toField_SET_BIND
      toField ROUTE name for SFBool field named set_bind.
      See Also:
    • fromField_VIEWALL

      public static final String fromField_VIEWALL
      fromField ROUTE name for SFBool field named viewAll.
      See Also:
    • toField_VIEWALL

      public static final String toField_VIEWALL
      toField ROUTE name for SFBool field named viewAll.
      See Also:
  • Constructor Details

    • OrthoViewpoint

      public OrthoViewpoint()
      Constructor for OrthoViewpoint to initialize member variables with default values.
    • OrthoViewpoint

      public OrthoViewpoint(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 String getElementName()
      Provides name of this element: OrthoViewpoint
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final String getComponent()
      Defines X3D component for the OrthoViewpoint element: Navigation
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 3
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      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

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      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

      public final 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 class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • 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 interface OrthoViewpoint
      Specified by:
      getBindTime in interface X3DBindableNode
      Specified by:
      getBindTime in interface X3DViewpointNode
      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 interface OrthoViewpoint
      Returns:
      value of centerOfRotation field
    • setCenterOfRotation

      public OrthoViewpoint setCenterOfRotation(float[] newValue)
      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 interface OrthoViewpoint
      Parameters:
      newValue - is new value for the centerOfRotation field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenterOfRotation

      public OrthoViewpoint setCenterOfRotation(SFVec3f newValue)
      Assign typed object value to SFVec3f centerOfRotation field, similar to setCenterOfRotation(float[]).
      Parameters:
      newValue - is new value for the centerOfRotation field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenterOfRotation

      public OrthoViewpoint setCenterOfRotation(float x, float y, float z)
      Assign values to SFVec3f centerOfRotation field, similar to setCenterOfRotation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenterOfRotation

      public OrthoViewpoint setCenterOfRotation(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenterOfRotation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenterOfRotation

      public OrthoViewpoint setCenterOfRotation(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenterOfRotation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDescription

      public 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface OrthoViewpoint
      Specified by:
      getDescription in interface X3DViewpointNode
      Returns:
      value of description field
    • setDescription

      public OrthoViewpoint setDescription(String newValue)
      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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface OrthoViewpoint
      Specified by:
      setDescription in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

      public OrthoViewpoint setDescription(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFarDistance

      public float getFarDistance()
      Provide float value from inputOutput SFFloat field named farDistance.

      Tooltip: or (0,+infinity) farDistance defines maximum clipping plane distance allowed for object display.
      Specified by:
      getFarDistance in interface OrthoViewpoint
      Specified by:
      getFarDistance in interface X3DViewpointNode
      Returns:
      value of farDistance field
    • setFarDistance

      public OrthoViewpoint setFarDistance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named farDistance.

      Tooltip: or (0,+infinity) farDistance defines maximum clipping plane distance allowed for object display.
      Specified by:
      setFarDistance in interface OrthoViewpoint
      Specified by:
      setFarDistance in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the farDistance field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFarDistance

      public OrthoViewpoint setFarDistance(SFFloat newValue)
      Assign typed object value to SFFloat farDistance field, similar to setFarDistance(float).
      Parameters:
      newValue - is new value for the farDistance field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFarDistance

      public OrthoViewpoint setFarDistance(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setFarDistance(float).
      Parameters:
      newValue - is new value for field
      Returns:
      OrthoViewpoint - 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 interface OrthoViewpoint
      Returns:
      value of fieldOfView field
    • getFieldOfViewList

      public ArrayList<Float> getFieldOfViewList()
      Utility method to get ArrayList value of MFFloat fieldOfView field, similar to getFieldOfView().
      Returns:
      value of fieldOfView field
    • getFieldOfViewString

      public String getFieldOfViewString()
      Utility method to get String value of MFFloat fieldOfView field, similar to getFieldOfView().
      Returns:
      value of fieldOfView field
    • setFieldOfView

      public OrthoViewpoint setFieldOfView(float[] newValue)
      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 interface OrthoViewpoint
      Parameters:
      newValue - is new value for the fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFieldOfView

      public OrthoViewpoint setFieldOfView(MFFloat newValue)
      Assign typed object value to MFFloat fieldOfView field, similar to setFieldOfView(float[]).
      Parameters:
      newValue - is new value for the fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFieldOfView

      public OrthoViewpoint setFieldOfView(ArrayList<Float> newValue)
      Assign ArrayList value of MFFloat fieldOfView field, similar to setFieldOfView(float[]).
      Parameters:
      newValue - is new value for the fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearFieldOfView

      public OrthoViewpoint clearFieldOfView()
      Utility method to clear MFFloat value of fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setFieldOfView

      public OrthoViewpoint setFieldOfView(int[] newValue)
      Assign floating-point array value of MFFloat fieldOfView field, similar to setFieldOfView(float[]).
      Parameters:
      newValue - is new value for the fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addFieldOfView

      public OrthoViewpoint addFieldOfView(float newValue)
      Add singleton float value to MFFloat fieldOfView field.
      Parameters:
      newValue - is new value to add to the fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addFieldOfView

      public OrthoViewpoint addFieldOfView(SFFloat newValue)
      Add singleton SFFloat value to MFFloat fieldOfView field.
      Parameters:
      newValue - is new value to add to the fieldOfView field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFieldOfView

      public OrthoViewpoint setFieldOfView(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setFieldOfView(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
    • setIS

      public OrthoViewpoint setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearIS

      public OrthoViewpoint clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      OrthoViewpoint - 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 interface OrthoViewpoint
      Specified by:
      getIsBound in interface X3DBindableNode
      Specified by:
      getIsBound in interface X3DViewpointNode
      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 interface OrthoViewpoint
      Specified by:
      getJump in interface X3DViewpointNode
      Returns:
      value of jump field
    • setJump

      public OrthoViewpoint setJump(boolean newValue)
      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 interface OrthoViewpoint
      Specified by:
      setJump in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the jump field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setJump

      public OrthoViewpoint setJump(SFBool newValue)
      Assign typed object value to SFBool jump field, similar to setJump(boolean).
      Parameters:
      newValue - is new value for the jump field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface OrthoViewpoint
      Specified by:
      getMetadata in interface X3DBindableNode
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DViewpointNode
      Returns:
      value of metadata field
      See Also:
    • setMetadata

      public OrthoViewpoint setMetadata(X3DMetadataObject newValue)
      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 interface OrthoViewpoint
      Specified by:
      setMetadata in interface X3DBindableNode
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DViewpointNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearMetadata

      public OrthoViewpoint clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public OrthoViewpoint setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      OrthoViewpoint - 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:
    • getNavigationInfo

      public NavigationInfo getNavigationInfo()
      Provide org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) from inputOutput SFNode field navigationInfo.
      Specified by:
      getNavigationInfo in interface OrthoViewpoint
      Specified by:
      getNavigationInfo in interface X3DViewpointNode
      Returns:
      value of navigationInfo field
      See Also:


      • Tooltip: [NavigationInfo] The navigationInfo field defines a dedicated NavigationInfo node for this X3DViewpointNode. The specified NavigationInfo node receives a set_bind TRUE event at the time when the parent node is bound and receives a set_bind FALSE at the time when the parent node is unbound.
        • Hint: allows simple integration of custom navigation associated with each Viewpoint according to user needs at that location.
    • setNavigationInfo

      public OrthoViewpoint setNavigationInfo(NavigationInfo newValue)
      Accessor method to assign org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) to inputOutput SFNode field navigationInfo.
      Specified by:
      setNavigationInfo in interface OrthoViewpoint
      Specified by:
      setNavigationInfo in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the navigationInfo field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearNavigationInfo

      public OrthoViewpoint clearNavigationInfo()
      Utility method to clear SFNode value of navigationInfo field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setNavigationInfo

      public OrthoViewpoint setNavigationInfo(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field navigationInfo.
      Parameters:
      newValue - is new value for the navigationInfo field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • hasNavigationInfo

      public boolean hasNavigationInfo()
      Indicate whether an object is available for inputOutput SFNode field navigationInfo.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
    • getNearDistance

      public float getNearDistance()
      Provide float value from inputOutput SFFloat field named nearDistance.

      Tooltip: or (0,+infinity) nearDistance defines minimum clipping plane distance necessary for object display.
      Specified by:
      getNearDistance in interface OrthoViewpoint
      Specified by:
      getNearDistance in interface X3DViewpointNode
      Returns:
      value of nearDistance field
    • setNearDistance

      public OrthoViewpoint setNearDistance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named nearDistance.

      Tooltip: or (0,+infinity) nearDistance defines minimum clipping plane distance necessary for object display.
      Specified by:
      setNearDistance in interface OrthoViewpoint
      Specified by:
      setNearDistance in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the nearDistance field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setNearDistance

      public OrthoViewpoint setNearDistance(SFFloat newValue)
      Assign typed object value to SFFloat nearDistance field, similar to setNearDistance(float).
      Parameters:
      newValue - is new value for the nearDistance field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setNearDistance

      public OrthoViewpoint setNearDistance(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setNearDistance(float).
      Parameters:
      newValue - is new value for field
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getOrientation

      public float[] getOrientation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.

      Tooltip: Rotation (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 interface OrthoViewpoint
      Specified by:
      getOrientation in interface X3DViewpointNode
      Returns:
      value of orientation field
    • setOrientation

      public OrthoViewpoint setOrientation(float[] newValue)
      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 interface OrthoViewpoint
      Specified by:
      setOrientation in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the orientation field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrientation

      public OrthoViewpoint setOrientation(SFRotation newValue)
      Assign typed object value to SFRotation orientation field, similar to setOrientation(float[]).
      Parameters:
      newValue - is new value for the orientation field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrientation

      public OrthoViewpoint setOrientation(float x, float y, float z, float angleRadians)
      Assign values to SFRotation orientation field, similar to setOrientation(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrientation

      public OrthoViewpoint setOrientation(double x, double y, double z, double angleRadians)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOrientation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      angleRadians - fourth component
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrientation

      public OrthoViewpoint setOrientation(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOrientation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      OrthoViewpoint - 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 interface OrthoViewpoint
      Returns:
      value of position field
    • setPosition

      public OrthoViewpoint setPosition(float[] newValue)
      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 interface OrthoViewpoint
      Parameters:
      newValue - is new value for the position field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPosition

      public OrthoViewpoint setPosition(SFVec3f newValue)
      Assign typed object value to SFVec3f position field, similar to setPosition(float[]).
      Parameters:
      newValue - is new value for the position field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPosition

      public OrthoViewpoint setPosition(float x, float y, float z)
      Assign values to SFVec3f position field, similar to setPosition(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPosition

      public OrthoViewpoint setPosition(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setPosition(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPosition

      public OrthoViewpoint setPosition(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      OrthoViewpoint - 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 interface OrthoViewpoint
      Specified by:
      getRetainUserOffsets in interface X3DViewpointNode
      Returns:
      value of retainUserOffsets field
    • setRetainUserOffsets

      public OrthoViewpoint setRetainUserOffsets(boolean newValue)
      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 interface OrthoViewpoint
      Specified by:
      setRetainUserOffsets in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRetainUserOffsets

      public OrthoViewpoint setRetainUserOffsets(SFBool newValue)
      Assign typed object value to SFBool retainUserOffsets field, similar to setRetainUserOffsets(boolean).
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getViewAll

      public boolean getViewAll()
      Provide boolean value from inputOutput SFBool field named viewAll.

      Tooltip: Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation is shifted to center of current bounding box and view is zoomed in or out until all visible objects are viewed.
      • Hint: no collision detection or proximity sensing occurs when zooming.
      • Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire scene.
      • Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in the current view occurs.
      Specified by:
      getViewAll in interface OrthoViewpoint
      Specified by:
      getViewAll in interface X3DViewpointNode
      Returns:
      value of viewAll field
    • setViewAll

      public OrthoViewpoint setViewAll(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named viewAll.

      Tooltip: Viewpoint is automatically adjusted to view all visible geometry. Typically centerOfRotation is shifted to center of current bounding box and view is zoomed in or out until all visible objects are viewed.
      • Hint: no collision detection or proximity sensing occurs when zooming.
      • Warning: if needed, near and far clipping planes shall be adjusted to allow viewing the entire scene.
      • Hint: when the value of the viewAll field is changed from TRUE to FALSE, no change in the current view occurs.
      Specified by:
      setViewAll in interface OrthoViewpoint
      Specified by:
      setViewAll in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the viewAll field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setViewAll

      public OrthoViewpoint setViewAll(SFBool newValue)
      Assign typed object value to SFBool viewAll field, similar to setViewAll(boolean).
      Parameters:
      newValue - is new value for the viewAll field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public 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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
    • setDEF

      public final OrthoViewpoint setDEF(String newValue)
      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.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public OrthoViewpoint setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public 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 class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
    • setUSE

      public final OrthoViewpoint setUSE(String newValue)
      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: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public OrthoViewpoint setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:
    • setCssClass

      public final OrthoViewpoint setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssClass

      public OrthoViewpoint setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:
    • setHtmlID

      public final OrthoViewpoint setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setHtmlID

      public OrthoViewpoint setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:
    • setCssStyle

      public final OrthoViewpoint setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssStyle

      public OrthoViewpoint setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public OrthoViewpoint setUSE(OrthoViewpoint DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() 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:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public OrthoViewpoint addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • addComments

      public OrthoViewpoint addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public OrthoViewpoint addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      OrthoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public 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 class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
    • findElementByNameValue

      public X3DConcreteElement 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. 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 class X3DConcreteElement
      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

      public X3DConcreteElement 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. 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 class X3DConcreteElement
      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

      public 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.
      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

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      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 class X3DConcreteElement
      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

      public boolean hasNodeByDEF(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:
    • validate

      public 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 class X3DConcreteElement
      Returns:
      validation results (if any)