Class Shape

All Implemented Interfaces:
X3DChildNode, X3DNode, X3DBoundedObject, Shape, X3DShapeNode

public class Shape extends X3DConcreteNode implements Shape
Shape can appear under any grouping node.

X3D node tooltip: [X3DShapeNode,X3DVisibleObject] Shape can appear under any grouping node. Shape can contain an Appearance node and a geometry node (for example one of the primitives Box Cone Cylinder Sphere Text, one of ElevationGrid Extrusion IndexedFaceSet IndexedLineSet LineSet PointSet, or one of the other geometry nodes).
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: Shape, X3D Tooltips: Shape, X3D Scene Authoring Hints
  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: Shape.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the Shape element: Shape
      See Also:
      Constant Field Values
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Shape component level for this element: 1
      See Also:
      Constant Field Values
    • APPEARANCE_DEFAULT_VALUE

      public static final X3DAppearanceNode APPEARANCE_DEFAULT_VALUE
      SFNode field named appearance has default value null (Java syntax) or NULL (XML syntax).
    • BBOXCENTER_DEFAULT_VALUE

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

      public static final boolean BBOXDISPLAY_DEFAULT_VALUE
      SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
      See Also:
      Constant Field Values
    • BBOXSIZE_DEFAULT_VALUE

      public static final float[] BBOXSIZE_DEFAULT_VALUE
      SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
    • CASTSHADOW_DEFAULT_VALUE

      public static final boolean CASTSHADOW_DEFAULT_VALUE
      SFBool field named castShadow has default value true (Java syntax) or true (XML syntax).
      See Also:
      Constant Field Values
    • GEOMETRY_DEFAULT_VALUE

      public static final X3DGeometryNode GEOMETRY_DEFAULT_VALUE
      SFNode field named geometry has default value null (Java syntax) or NULL (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).
    • METADATA_DEFAULT_VALUE

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

      public static final boolean VISIBLE_DEFAULT_VALUE
      SFBool field named visible has default value true (Java syntax) or true (XML syntax).
      See Also:
      Constant Field Values
    • 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:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_APPEARANCE

      public static final String fromField_APPEARANCE
      fromField ROUTE name for SFNode field named appearance.
      See Also:
      Constant Field Values
    • toField_APPEARANCE

      public static final String toField_APPEARANCE
      toField ROUTE name for SFNode field named appearance.
      See Also:
      Constant Field Values
    • fromField_BBOXDISPLAY

      public static final String fromField_BBOXDISPLAY
      fromField ROUTE name for SFBool field named bboxDisplay.
      See Also:
      Constant Field Values
    • toField_BBOXDISPLAY

      public static final String toField_BBOXDISPLAY
      toField ROUTE name for SFBool field named bboxDisplay.
      See Also:
      Constant Field Values
    • fromField_CASTSHADOW

      public static final String fromField_CASTSHADOW
      fromField ROUTE name for SFBool field named castShadow.
      See Also:
      Constant Field Values
    • toField_CASTSHADOW

      public static final String toField_CASTSHADOW
      toField ROUTE name for SFBool field named castShadow.
      See Also:
      Constant Field Values
    • fromField_GEOMETRY

      public static final String fromField_GEOMETRY
      fromField ROUTE name for SFNode field named geometry.
      See Also:
      Constant Field Values
    • toField_GEOMETRY

      public static final String toField_GEOMETRY
      toField ROUTE name for SFNode field named geometry.
      See Also:
      Constant Field Values
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_METADATA

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

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • fromField_VISIBLE

      public static final String fromField_VISIBLE
      fromField ROUTE name for SFBool field named visible.
      See Also:
      Constant Field Values
    • toField_VISIBLE

      public static final String toField_VISIBLE
      toField ROUTE name for SFBool field named visible.
      See Also:
      Constant Field Values
  • Constructor Details

    • Shape

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

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

      public final String getComponent()
      Defines X3D component for the Shape element: Shape
      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: 1
      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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • 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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • 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:
      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
    • getAppearance

      public X3DAppearanceNode getAppearance()
      Provide org.web3d.x3d.sai.Shape.X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
      Specified by:
      getAppearance in interface Shape
      Specified by:
      getAppearance in interface X3DShapeNode
      Returns:
      value of appearance field
      See Also:
      Tooltip: [X3DAppearanceNode] Single contained Appearance node that specifies visual attributes (such as material, texture, fillProperties and lineProperties) applied to corresponding geometry. *
    • setAppearance

      public Shape setAppearance(X3DAppearanceNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
      Specified by:
      setAppearance in interface Shape
      Specified by:
      setAppearance in interface X3DShapeNode
      Parameters:
      newValue - is new value for the appearance field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DAppearanceNode] Single contained Appearance node that specifies visual attributes (such as material, texture, fillProperties and lineProperties) applied to corresponding geometry. *
    • clearAppearance

      public Shape clearAppearance()
      Utility method to clear SFNode value of appearance field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setAppearance

      public Shape setAppearance(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field appearance.
      Parameters:
      newValue - is new value for the appearance field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setAppearance( org.web3d.x3d.sai.Shape.X3DAppearanceNode)
    • hasAppearance

      public boolean hasAppearance()
      Indicate whether an object is available for inputOutput SFNode field appearance.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getAppearance(), getAppearanceProtoInstance()
    • 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 Shape
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DShapeNode
      Returns:
      value of bboxCenter field
    • setBboxCenter

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

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

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

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

      public Shape 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:
      Shape - 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 Shape
      Specified by:
      getBboxDisplay in interface X3DBoundedObject
      Specified by:
      getBboxDisplay in interface X3DShapeNode
      Returns:
      value of bboxDisplay field
    • setBboxDisplay

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

      public Shape 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:
      Shape - 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: or [0,+infinity) 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 Shape
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DShapeNode
      Returns:
      value of bboxSize field
    • setBboxSize

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

      Tooltip: or [0,+infinity) 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 Shape
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DShapeNode
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

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

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

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

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

      public boolean getCastShadow()
      Provide boolean value from inputOutput SFBool field named castShadow.
      Specified by:
      getCastShadow in interface Shape
      Specified by:
      getCastShadow in interface X3DShapeNode
      Returns:
      value of castShadow field
    • setCastShadow

      public Shape setCastShadow(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named castShadow.
      Specified by:
      setCastShadow in interface Shape
      Specified by:
      setCastShadow in interface X3DShapeNode
      Parameters:
      newValue - is new value for the castShadow field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCastShadow

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

      public X3DGeometryNode getGeometry()
      Provide org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
      Specified by:
      getGeometry in interface Shape
      Specified by:
      getGeometry in interface X3DShapeNode
      Returns:
      value of geometry field
      See Also:
      Tooltip: [X3DGeometryNode] Single contained geometry node that is rendered according to corresponding appearance. *
    • setGeometry

      public Shape setGeometry(X3DGeometryNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
      Specified by:
      setGeometry in interface Shape
      Specified by:
      setGeometry in interface X3DShapeNode
      Parameters:
      newValue - is new value for the geometry field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DGeometryNode] Single contained geometry node that is rendered according to corresponding appearance. *
    • clearGeometry

      public Shape clearGeometry()
      Utility method to clear SFNode value of geometry field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setGeometry

      public Shape setGeometry(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field geometry.
      Parameters:
      newValue - is new value for the geometry field.
      Returns:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setGeometry( org.web3d.x3d.sai.Rendering.X3DGeometryNode)
    • hasGeometry

      public boolean hasGeometry()
      Indicate whether an object is available for inputOutput SFNode field geometry.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getGeometry(), getGeometryProtoInstance()
    • 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 Shape 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:
      Shape - 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 Shape clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      Shape - 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()
    • 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 Shape
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DShapeNode
      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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public Shape 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 Shape
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DShapeNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Shape - 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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public Shape 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:
      Shape - 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
    • 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 Shape
      Specified by:
      getVisible in interface X3DBoundedObject
      Specified by:
      getVisible in interface X3DShapeNode
      Returns:
      value of visible field
    • setVisible

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

      public Shape 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:
      Shape - 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:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

      public Shape 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:
      Shape - 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:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

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

      public Shape 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:
      Shape - 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 X3DConcreteNode
      Returns:
      value of class field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public final Shape 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:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public Shape 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:
      Shape - 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 X3DConcreteNode
      Returns:
      value of id field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setHtmlID

      public final Shape 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:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, L.3.1 Content definition and page presentation, HTML 5.2 W3C Recommendation, Document Object Model (DOM) Technical Reports, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setHtmlID

      public Shape 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:
      Shape - 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 X3DConcreteNode
      Returns:
      value of style field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

      public final Shape 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:
      Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

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

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

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

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

      public Shape addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      Shape - 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:
      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 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 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(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(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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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:
      findElementByNameValue(String, String)
    • 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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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:
      findNodeByDEF(String)
    • 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)