Class LOD

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DBoundedObject, X3DGroupingNode, LOD

public class LOD
extends X3DConcreteNode
implements LOD
LOD (Level Of Detail) uses camera-to-object distance to switch among contained child levels.

X3D node tooltip: [X3DGroupingNode,X3DVisibleObject] LOD (Level Of Detail) uses camera-to-object distance to switch among contained child levels. (Contained nodes are now called 'children' rather than 'level', for consistent naming among all GroupingNodeType nodes.) LOD range values go from near to far (as child geometry gets simpler for better performance). For n range values, you must have n+1 children levels! Only currently selected children level is rendered, but all levels continue to send/receive events.
  • Hint: can add <WorldInfo info='null node'/> as a nonrendering, invisible final (or initial or intermediate) child node that also documents the LOD switch-over rationale.
  • Hint: insert a Shape node before adding geometry or Appearance.
  • Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
  • Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
  • Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch.
  • Hint: security mechanisms such as encryption and authentication can be applied to high levels of detail, allowing authors to protect intellectual property at high resolution for authorized users while still rendering simple unrestricted models for other users.
  • Warning: nested LOD (and/or GeoLOD) nodes with overlapping range intervals can lead to unexpected or undefined behavior.
  • Hint: contained nodes must have type X3DChildNode, such as Group or Transform or Shape.
  • Warning: LOD is not allowed as a direct parent of Appearance, Material, Color, Coordinate, Normal or Texture nodes, instead ensure that a Shape is present.
  • Hint: apply containerField='shape' if parent node is CADFace.
  • Hint: ConformanceNist X3D Examples Archive https://www.web3d.org/x3d/content/examples/ConformanceNist/SpecialGroups/LOD

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:
X3D Abstract Specification: LOD, X3D Tooltips: LOD, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static float[] BBOXCENTER_DEFAULT_VALUE
    SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
    static boolean BBOXDISPLAY_DEFAULT_VALUE
    SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
    static float[] BBOXSIZE_DEFAULT_VALUE
    SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
    static float[] CENTER_DEFAULT_VALUE
    SFVec3f field named center 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 LOD element: Navigation
    static java.lang.String containerField_DEFAULT_VALUE
    containerField describes typical field relationship of a node to its parent.
    static boolean FORCETRANSITIONS_DEFAULT_VALUE
    SFBool field named forceTransitions has default value false (Java syntax) or false (XML syntax).
    static java.lang.String fromField_BBOXDISPLAY
    fromField ROUTE name for SFBool field named bboxDisplay.
    static java.lang.String fromField_CHILDREN
    fromField ROUTE name for MFNode field named children.
    static java.lang.String fromField_IS
    fromField ROUTE name for SFNode field named IS.
    static java.lang.String fromField_LEVEL_CHANGED
    fromField ROUTE name for SFInt32 field named level_changed.
    static java.lang.String fromField_METADATA
    fromField ROUTE name for SFNode field named metadata.
    static java.lang.String fromField_VISIBLE
    fromField ROUTE name for SFBool field named visible.
    static IS IS_DEFAULT_VALUE
    SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    static int LEVEL
    Integer constant LEVEL provides default X3D Navigation component level for this element: 2
    static 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: LOD.
    static java.util.ArrayList<java.lang.Float> RANGE_DEFAULT_VALUE
    MFFloat field named range has default value equal to an empty list.
    static java.lang.String toField_ADDCHILDREN
    toField ROUTE name for MFNode field named addChildren.
    static java.lang.String toField_BBOXDISPLAY
    toField ROUTE name for SFBool field named bboxDisplay.
    static java.lang.String toField_CHILDREN
    toField ROUTE name for MFNode field named children.
    static java.lang.String toField_METADATA
    toField ROUTE name for SFNode field named metadata.
    static java.lang.String toField_REMOVECHILDREN
    toField ROUTE name for MFNode field named removeChildren.
    static java.lang.String toField_VISIBLE
    toField ROUTE name for SFBool field named visible.
    static boolean VISIBLE_DEFAULT_VALUE
    SFBool field named visible has default value true (Java syntax) or true (XML syntax).

    Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    LOD()
    Constructor for LOD to initialize member variables with default values.
    LOD​(java.lang.String DEFlabel)
    Utility constructor that assigns DEF label after initializing member variables with default values.
  • Method Summary

    Modifier and Type Method Description
    LOD addChild​(X3DChildNode newValue)
    Utility method to add single child element to contained list of existing children nodes (if any).
    LOD addChildren​(ProtoInstance newValue)
    Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.
    void addChildren​(X3DNode newValue)
    Add single node to existing array of children nodes (if any).
    void addChildren​(X3DNode[] newValue)
    Add array of children nodes to array of existing nodes (if any).
    LOD addComments​(java.lang.String newComment)
    Add comment as CommentsBlock to children field
    LOD addComments​(java.lang.String[] newComments)
    Add comments as String[] array to children field
    LOD addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to children field
    LOD addRange​(float newValue)
    Add singleton float value to MFFloat range field.
    LOD addRange​(SFFloat newValue)
    Add singleton SFFloat value to MFFloat range field.
    LOD clearChildren()
    Utility method to clear MFNode value of children field.
    LOD clearIS()
    Utility method to clear SFNode value of IS field.
    LOD clearMetadata()
    Utility method to clear SFNode value of metadata field.
    LOD clearRange()
    Utility method to clear MFFloat value of range 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.
    float[] getBboxCenter()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
    boolean getBboxDisplay()
    Provide boolean value from inputOutput SFBool field named bboxDisplay.
    float[] getBboxSize()
    Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
    float[] getCenter()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named center.
    X3DNode[] getChildren()
    Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
    java.util.ArrayList<X3DNode> getChildrenList()
    Utility method to get ArrayList value of MFNode children field, similar to getChildren().
    java.lang.String getComponent()
    Defines X3D component for the LOD element: Navigation
    int getComponentLevel()
    Provides default X3D component level for this element: 2
    java.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 getElementName()
    Provides name of this element: LOD
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    boolean getForceTransitions()
    Provide boolean value from initializeOnly SFBool field named forceTransitions.
    IS getIS()
    Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
    int getLevel()
    Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named level_changed.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getRange()
    Provide array of Float results from initializeOnly MFFloat field named range.
    java.util.ArrayList<java.lang.Float> getRangeList()
    Utility method to get ArrayList value of MFFloat range field, similar to getRange().
    java.lang.String getRangeString()
    Utility method to get String value of MFFloat range field, similar to getRange().
    java.lang.String getUSE()
    Provide String value from inputOutput SFString field named USE.
    boolean getVisible()
    Provide boolean value from inputOutput SFBool field named visible.
    boolean hasChildren()
    Indicate whether an object is available for inputOutput MFNode field children.
    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.
    LOD setBboxCenter​(double[] newArray)
    Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
    LOD setBboxCenter​(double x, double y, double z)
    Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
    LOD setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    LOD setBboxCenter​(float x, float y, float z)
    Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    LOD setBboxCenter​(SFVec3f newValue)
    Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    LOD setBboxDisplay​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
    LOD setBboxDisplay​(SFBool newValue)
    Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
    LOD setBboxSize​(double[] newArray)
    Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
    LOD setBboxSize​(double x, double y, double z)
    Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
    LOD setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    LOD setBboxSize​(float x, float y, float z)
    Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    LOD setBboxSize​(SFVec3f newValue)
    Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    LOD setCenter​(double[] newArray)
    Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).
    LOD setCenter​(double x, double y, double z)
    Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).
    LOD setCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named center.
    LOD setCenter​(float x, float y, float z)
    Assign values to SFVec3f center field, similar to setCenter(float[]).
    LOD setCenter​(SFVec3f newValue)
    Assign typed object value to SFVec3f center field, similar to setCenter(float[]).
    LOD setChildren​(java.util.ArrayList<X3DChildNode> newValue)
    Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
    void setChildren​(X3DNode newValue)
    Set single children node, replacing prior array of existing nodes (if any).
    LOD setChildren​(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
    LOD setCssClass​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named class.
    LOD setCssClass​(SFString newValue)
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    LOD setDEF​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named DEF.
    LOD setDEF​(SFString newValue)
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    LOD setForceTransitions​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named forceTransitions.
    LOD setForceTransitions​(SFBool newValue)
    Assign typed object value to SFBool forceTransitions field, similar to setForceTransitions(boolean).
    LOD setIS​(IS newValue)
    Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
    LOD setMetadata​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    LOD setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    LOD setRange​(double[] newArray)
    Utility method: double-precision set-array accessor for X3D floating-point type, similar to setRange(float[]).
    LOD setRange​(float[] newValue)
    Accessor method to assign Float array to initializeOnly MFFloat field named range.
    LOD setRange​(int[] newValue)
    Assign floating-point array value of MFFloat range field, similar to setRange(float[]).
    LOD setRange​(java.util.ArrayList<java.lang.Float> newValue)
    Assign ArrayList value of MFFloat range field, similar to setRange(float[]).
    LOD setRange​(MFFloat newValue)
    Assign typed object value to MFFloat range field, similar to setRange(float[]).
    LOD setUSE​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named USE.
    LOD setUSE​(SFString newValue)
    Assign typed object value to SFString USE field, similar to setUSE(String).
    LOD setUSE​(LOD DEFnode)
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    LOD setVisible​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named visible.
    LOD setVisible​(SFBool newValue)
    Assign typed object value to SFBool visible field, similar to setVisible(boolean).
    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 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • LOD

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

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

      public final java.lang.String getComponent()
      Defines X3D component for the LOD 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: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      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 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:
      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 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:
      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 class X3DConcreteNode
      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 class X3DConcreteNode
    • getBboxCenter

      public float[] getBboxCenter()
      Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      getBboxCenter in interface LOD
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DGroupingNode
      Returns:
      value of bboxCenter field
    • setBboxCenter

      public LOD setBboxCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      setBboxCenter in interface LOD
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Specified by:
      setBboxCenter in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

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

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

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

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

      public boolean getBboxDisplay()
      Provide boolean value from inputOutput SFBool field named bboxDisplay.

      Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
      • Hint: the bounding box is displayed regardless of whether contained content is visible.
      Specified by:
      getBboxDisplay in interface LOD
      Specified by:
      getBboxDisplay in interface X3DBoundedObject
      Specified by:
      getBboxDisplay in interface X3DGroupingNode
      Returns:
      value of bboxDisplay field
    • setBboxDisplay

      public LOD setBboxDisplay​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

      Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
      • Hint: the bounding box is displayed regardless of whether contained content is visible.
      Specified by:
      setBboxDisplay in interface LOD
      Specified by:
      setBboxDisplay in interface X3DBoundedObject
      Specified by:
      setBboxDisplay in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxDisplay field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxDisplay

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

      public float[] getBboxSize()
      Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

      Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
      Specified by:
      getBboxSize in interface LOD
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DGroupingNode
      Returns:
      value of bboxSize field
    • setBboxSize

      public LOD setBboxSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

      Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
      Specified by:
      setBboxSize in interface LOD
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

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

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

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

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

      public float[] getCenter()
      Provide array of 3-tuple float results from initializeOnly SFVec3f field named center.

      Tooltip: Viewpoint distance-measurement offset from origin of local coordinate system, used for LOD node distance calculations. *
      Specified by:
      getCenter in interface LOD
      Returns:
      value of center field
    • setCenter

      public LOD setCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named center.

      Tooltip: Viewpoint distance-measurement offset from origin of local coordinate system, used for LOD node distance calculations. *
      Specified by:
      setCenter in interface LOD
      Parameters:
      newValue - is new value for the center field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

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

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

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

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

      public X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

      Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
      • Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
      • Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
      • Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
      • Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
      Specified by:
      getChildren in interface LOD
      Specified by:
      getChildren in interface X3DGroupingNode
      Returns:
      value of children field
      See Also:
      X3DChildNode
    • getChildrenList

      public java.util.ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field
    • setChildren

      public LOD setChildren​(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

      Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
      • Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
      • Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
      • Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
      • Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
      Specified by:
      setChildren in interface LOD
      Specified by:
      setChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the children field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChildren

      public LOD setChildren​(java.util.ArrayList<X3DChildNode> newValue)
      Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
      Parameters:
      newValue - is new value for the children field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChildren

      public void addChildren​(X3DNode newValue)
      Add single node to existing array of children nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the children field.
    • addChildren

      public LOD addChildren​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChild

      public LOD addChild​(X3DChildNode newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      Parameters:
      newValue - is new node value to be appended the children field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChildren

      public void addChildren​(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
      Specified by:
      addChildren in interface LOD
      Specified by:
      addChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new value array to be appended the children field.
    • setChildren

      public void setChildren​(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.
      Specified by:
      setChildren in interface LOD
      Specified by:
      setChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new node for the children field (restricted to X3DChildNode)
    • clearChildren

      public LOD clearChildren()
      Utility method to clear MFNode value of children field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasChildren

      public boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getChildren()
    • addComments

      public LOD addComments​(java.lang.String newComment)
      Add comment as CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

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

      public LOD addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getForceTransitions

      public boolean getForceTransitions()
      Provide boolean value from initializeOnly SFBool field named forceTransitions.

      Tooltip: Whether to perform every range-based transition, regardless of browser optimizations that might otherwise occur. *
      Specified by:
      getForceTransitions in interface LOD
      Returns:
      value of forceTransitions field
    • setForceTransitions

      public LOD setForceTransitions​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named forceTransitions.

      Tooltip: Whether to perform every range-based transition, regardless of browser optimizations that might otherwise occur. *
      Specified by:
      setForceTransitions in interface LOD
      Parameters:
      newValue - is new value for the forceTransitions field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setForceTransitions

      public LOD setForceTransitions​(SFBool newValue)
      Assign typed object value to SFBool forceTransitions field, similar to setForceTransitions(boolean).
      Parameters:
      newValue - is new value for the forceTransitions field.
      Returns:
      LOD - 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:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public LOD 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:
      LOD - 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

      public LOD clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      LOD - 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()
    • getLevel

      public int getLevel()
      Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named level_changed.

      Tooltip: Output event that reports current level of LOD children whenever switching occurs.
      • Hint: LOD level index counting starts at zero. Thus level_changed value of -1 means no choice, 0 means initial child, 1 means second child, etc.
      • 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:
      getLevel in interface LOD
      Returns:
      value of level_changed field
    • 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 LOD
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DGroupingNode
      Specified by:
      getMetadata in interface X3DNode
      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

      public LOD 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 LOD
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DGroupingNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      LOD - 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

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

      public LOD 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:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.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
    • getRange

      public float[] getRange()
      Provide array of Float results from initializeOnly MFFloat field named range.

      Tooltip: (0,+infinity) Specifies ideal distances at which to switch between levels. The range field is a floating-point array of camera-to-object distance transitions for each child level, where range values go from near to far. For n range values, you must have n+1 child levels!
      • Hint: can add &lt;WorldInfo info='null node'/&gt; as a nonrendering, invisible final (or initial or intermediate) child node that also documents the LOD switch-over rationale.
      • Hint: not setting range values indicates that level switching can be optimized automatically based on performance.
      Specified by:
      getRange in interface LOD
      Returns:
      value of range field
    • getRangeList

      public java.util.ArrayList<java.lang.Float> getRangeList()
      Utility method to get ArrayList value of MFFloat range field, similar to getRange().
      Returns:
      value of range field
    • getRangeString

      public java.lang.String getRangeString()
      Utility method to get String value of MFFloat range field, similar to getRange().
      Returns:
      value of range field
    • setRange

      public LOD setRange​(float[] newValue)
      Accessor method to assign Float array to initializeOnly MFFloat field named range.

      Tooltip: (0,+infinity) Specifies ideal distances at which to switch between levels. The range field is a floating-point array of camera-to-object distance transitions for each child level, where range values go from near to far. For n range values, you must have n+1 child levels!
      • Hint: can add &lt;WorldInfo info='null node'/&gt; as a nonrendering, invisible final (or initial or intermediate) child node that also documents the LOD switch-over rationale.
      • Hint: not setting range values indicates that level switching can be optimized automatically based on performance.
      Specified by:
      setRange in interface LOD
      Parameters:
      newValue - is new value for the range field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRange

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

      public LOD setRange​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat range field, similar to setRange(float[]).
      Parameters:
      newValue - is new value for the range field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearRange

      public LOD clearRange()
      Utility method to clear MFFloat value of range field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setRange

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

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

      public LOD addRange​(SFFloat newValue)
      Add singleton SFFloat value to MFFloat range field.
      Parameters:
      newValue - is new value to add to the range field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRange

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

      public boolean getVisible()
      Provide boolean value from inputOutput SFBool field named visible.

      Tooltip: Whether or not renderable content within this node is visually displayed.
      • Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
      • Hint: content must be visible to be collidable and to be pickable.
      Specified by:
      getVisible in interface LOD
      Specified by:
      getVisible in interface X3DBoundedObject
      Specified by:
      getVisible in interface X3DGroupingNode
      Returns:
      value of visible field
    • setVisible

      public LOD setVisible​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named visible.

      Tooltip: Whether or not renderable content within this node is visually displayed.
      • Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
      • Hint: content must be visible to be collidable and to be pickable.
      Specified by:
      setVisible in interface LOD
      Specified by:
      setVisible in interface X3DBoundedObject
      Specified by:
      setVisible in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setVisible

      public LOD setVisible​(SFBool newValue)
      Assign typed object value to SFBool visible field, similar to setVisible(boolean).
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      LOD - 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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final LOD setDEF​(java.lang.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:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public LOD 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:
      LOD - 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 class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final LOD setUSE​(java.lang.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:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public LOD 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:
      LOD - 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 class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final LOD setCssClass​(java.lang.String newValue)
      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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      LOD - 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

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

      public LOD setUSE​(LOD 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:
      LOD - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.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 class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.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 class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public 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. 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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

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

      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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 class X3DConcreteElement
      Returns:
      validation results (if any)