Package org.web3d.x3d.jsail.Geometry3D

Class ExtrusionObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geometry3D.ExtrusionObject
All Implemented Interfaces:
X3DNode, Extrusion, X3DGeometryNode
public class ExtrusionObject
extends X3DConcreteNode
implements Extrusion
Extrusion is a geometry node that sequentially stretches a 2D cross section along a 3D-spine path in the local coordinate system, creating an outer hull.

X3D node tooltip: [X3DGeometryNode] Extrusion is a geometry node that sequentially stretches a 2D cross section along a 3D-spine path in the local coordinate system, creating an outer hull. Scaling and rotating the crossSection 2D outline at each control point can modify the outer hull of the Extrusion to produce a wide variety of interesting shapes.
  • Warning: take care to avoid defining parameter combinations that create self-intersecting, impossible or inverted geometry.
  • Hint: Extrusion https://en.wikipedia.org/wiki/Extrusion
  • Hint: insert a Shape node before adding geometry or Appearance.

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: Extrusion, X3D Tooltips: Extrusion, X3D Scene Authoring Hints

  • Field Details

  • Constructor Details

    • ExtrusionObject

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

    • ExtrusionObject

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

    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the Extrusion element: Geometry3D
      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: 4
      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

    • getBeginCap

      public boolean getBeginCap()
      Provide boolean value from initializeOnly SFBool field named beginCap.

      Tooltip: Whether beginning cap is drawn (similar to Cylinder top cap).
      • Warning: since this field has accessType initializeOnly, the value cannot be changed after initial creation.
      Specified by:
      getBeginCap in interface Extrusion
      Returns:
      value of beginCap field

    • setBeginCap

      public ExtrusionObject setBeginCap​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named beginCap.

      Tooltip: Whether beginning cap is drawn (similar to Cylinder top cap).
      • Warning: since this field has accessType initializeOnly, the value cannot be changed after initial creation.
      Specified by:
      setBeginCap in interface Extrusion
      Parameters:
      newValue - is new value for the beginCap field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setBeginCap

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

    • getCcw

      public boolean getCcw()
      Provide boolean value from initializeOnly SFBool field named ccw.

      Tooltip: The ccw field indicates counterclockwise ordering of vertex-coordinates orientation.
      • Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
      • Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
      • Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
      Specified by:
      getCcw in interface Extrusion
      Returns:
      value of ccw field

    • setCcw

      public ExtrusionObject setCcw​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named ccw.

      Tooltip: The ccw field indicates counterclockwise ordering of vertex-coordinates orientation.
      • Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
      • Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
      • Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
      Specified by:
      setCcw in interface Extrusion
      Parameters:
      newValue - is new value for the ccw field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCcw

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

    • getConvex

      public boolean getConvex()
      Provide boolean value from initializeOnly SFBool field named convex.

      Tooltip: The convex field is a hint to renderers whether all polygons in a shape are convex (true), or possibly concave (false). A convex polygon is planar, does not intersect itself, and has all interior angles < 180 degrees.
      • Hint: concave is the opposite of convex.
      • Warning: concave or inverted geometry may be invisible when using default value convex=true, since some renderers use more-efficient algorithms to perform tessellation that may inadvertently fail on concave geometry.
      • Hint: select convex=false (i.e. concave) and solid=false (i.e. two-sided display) for greatest visibility of geometry.
      • Hint: convex polygon https://en.wikipedia.org/wiki/Convex_polygon
      • Hint: tessellation https://en.wikipedia.org/wiki/Tessellation
      Specified by:
      getConvex in interface Extrusion
      Returns:
      value of convex field

    • setConvex

      public ExtrusionObject setConvex​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named convex.

      Tooltip: The convex field is a hint to renderers whether all polygons in a shape are convex (true), or possibly concave (false). A convex polygon is planar, does not intersect itself, and has all interior angles < 180 degrees.
      • Hint: concave is the opposite of convex.
      • Warning: concave or inverted geometry may be invisible when using default value convex=true, since some renderers use more-efficient algorithms to perform tessellation that may inadvertently fail on concave geometry.
      • Hint: select convex=false (i.e. concave) and solid=false (i.e. two-sided display) for greatest visibility of geometry.
      • Hint: convex polygon https://en.wikipedia.org/wiki/Convex_polygon
      • Hint: tessellation https://en.wikipedia.org/wiki/Tessellation
      Specified by:
      setConvex in interface Extrusion
      Parameters:
      newValue - is new value for the convex field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setConvex

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

    • getCreaseAngle

      public float getCreaseAngle()
      Provide float value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFFloat field named creaseAngle.

      Tooltip: [0,+infinity) creaseAngle defines angle (in radians) where adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment.
      Specified by:
      getCreaseAngle in interface Extrusion
      Returns:
      value of creaseAngle field

    • setCreaseAngle

      public ExtrusionObject setCreaseAngle​(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named creaseAngle.

      Tooltip: [0,+infinity) creaseAngle defines angle (in radians) where adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment.
      Specified by:
      setCreaseAngle in interface Extrusion
      Parameters:
      newValue - is new value for the creaseAngle field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCreaseAngle

      public ExtrusionObject setCreaseAngle​(SFFloatObject newValue)
      Assign typed object value to SFFloat creaseAngle field, similar to setCreaseAngle(float).
      Parameters:
      newValue - is new value for the creaseAngle field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCreaseAngle

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

    • getCrossSection

      public float[] getCrossSection()
      Provide array of 2-tuple float results from initializeOnly MFVec2f field named crossSection.

      Tooltip: The crossSection array defines a silhouette outline of the outer Extrusion surface. crossSection is an ordered set of 2D points that draw a piecewise-linear curve which is extruded to form a series of connected vertices.
      • Hint: the crossSection array can be open or closed (closed means that endpoints are coincident).
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      • Warning: if the order of crossSection point definition does not match clockwise/counterclockwise setting of ccw field, then self-intersecting, impossible or inverted geometry can result!
      • Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular and rendering results are undefined (especially for end caps).
      Specified by:
      getCrossSection in interface Extrusion
      Returns:
      value of crossSection field

    • setCrossSection

      public ExtrusionObject setCrossSection​(float[] newValue)
      Accessor method to assign 2-tuple float array to initializeOnly MFVec2f field named crossSection.

      Tooltip: The crossSection array defines a silhouette outline of the outer Extrusion surface. crossSection is an ordered set of 2D points that draw a piecewise-linear curve which is extruded to form a series of connected vertices.
      • Hint: the crossSection array can be open or closed (closed means that endpoints are coincident).
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      • Warning: if the order of crossSection point definition does not match clockwise/counterclockwise setting of ccw field, then self-intersecting, impossible or inverted geometry can result!
      • Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular and rendering results are undefined (especially for end caps).
      Specified by:
      setCrossSection in interface Extrusion
      Parameters:
      newValue - is new value for the crossSection field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCrossSection

      public ExtrusionObject setCrossSection​(MFVec2fObject newValue)
      Assign typed object value to MFVec2f crossSection field, similar to setCrossSection(float[]).
      Parameters:
      newValue - is new value for the crossSection field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addCrossSection

      public ExtrusionObject addCrossSection​(SFVec2fObject newValue)
      Add singleton SFVec2fObject value to MFVec2f crossSection field.
      Parameters:
      newValue - is new value to add to the crossSection field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCrossSection

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

    • getEndCap

      public boolean getEndCap()
      Provide boolean value from initializeOnly SFBool field named endCap.

      Tooltip: Whether end cap is drawn (similar to Cylinder bottom cap).
      • Warning: since this field has accessType initializeOnly, the value cannot be changed after initial creation.
      Specified by:
      getEndCap in interface Extrusion
      Returns:
      value of endCap field

    • setEndCap

      public ExtrusionObject setEndCap​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named endCap.

      Tooltip: Whether end cap is drawn (similar to Cylinder bottom cap).
      • Warning: since this field has accessType initializeOnly, the value cannot be changed after initial creation.
      Specified by:
      setEndCap in interface Extrusion
      Parameters:
      newValue - is new value for the endCap field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setEndCap

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

    • getIS

      public ISObject getIS()
      Provide ISObject 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 ExtrusionObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      ExtrusionObject - 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 ExtrusionObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ExtrusionObject - 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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface Extrusion
      Specified by:
      getMetadata in interface X3DGeometryNode
      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 ExtrusionObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface Extrusion
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ExtrusionObject - 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 ExtrusionObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public ExtrusionObject setMetadata​(ProtoInstanceObject 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:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

    • getOrientation

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

      Tooltip: The orientation array is a list of axis-angle 4-tuple values applied at each spine-aligned cross-section plane.
      • Hint: if the orientation array contains a single 4-tuple value, it is applied at all spine-aligned crossSection planes.
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      Specified by:
      getOrientation in interface Extrusion
      Returns:
      value of orientation field

    • setOrientation

      public ExtrusionObject setOrientation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput MFRotation field named orientation.

      Tooltip: The orientation array is a list of axis-angle 4-tuple values applied at each spine-aligned cross-section plane.
      • Hint: if the orientation array contains a single 4-tuple value, it is applied at all spine-aligned crossSection planes.
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      Specified by:
      setOrientation in interface Extrusion
      Parameters:
      newValue - is new value for the orientation field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setOrientation

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

    • addOrientation

      public ExtrusionObject addOrientation​(SFRotationObject newValue)
      Add singleton SFRotationObject value to MFRotation orientation field.
      Parameters:
      newValue - is new value to add to the orientation field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getScale

      public float[] getScale()
      Provide array of 2-tuple float results from inputOutput MFVec2f field named scale.

      Tooltip: (0,+infinity) scale is a list of 2D-scale parameters applied at each spine-aligned cross-section plane.
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      • Hint: if the scale array contains one value, it is applied at all spine-aligned crossSection planes.
      • Warning: zero or negative scale values not allowed.
      Specified by:
      getScale in interface Extrusion
      Returns:
      value of scale field

    • setScale

      public ExtrusionObject setScale​(float[] newValue)
      Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named scale.

      Tooltip: (0,+infinity) scale is a list of 2D-scale parameters applied at each spine-aligned cross-section plane.
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      • Hint: if the scale array contains one value, it is applied at all spine-aligned crossSection planes.
      • Warning: zero or negative scale values not allowed.
      Specified by:
      setScale in interface Extrusion
      Parameters:
      newValue - is new value for the scale field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setScale

      public ExtrusionObject setScale​(MFVec2fObject newValue)
      Assign typed object value to MFVec2f scale field, similar to setScale(float[]).
      Parameters:
      newValue - is new value for the scale field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addScale

      public ExtrusionObject addScale​(SFVec2fObject newValue)
      Add singleton SFVec2fObject value to MFVec2f scale field.
      Parameters:
      newValue - is new value to add to the scale field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setScale

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

    • getSolid

      public boolean getSolid()
      Provide boolean value from initializeOnly SFBool field named solid.

      Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
      • Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      Specified by:
      getSolid in interface Extrusion
      Returns:
      value of solid field

    • setSolid

      public ExtrusionObject setSolid​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named solid.

      Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
      • Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      Specified by:
      setSolid in interface Extrusion
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSolid

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

    • getSpine

      public float[] getSpine()
      Provide array of 3-tuple float results from initializeOnly MFVec3f field named spine.

      Tooltip: The spine array defines a center-line sequence of 3D points that define a piecewise-linear curve forming a series of connected vertices. The spine is set of points along which a 2D crossSection is extruded, scaled and oriented.
      • Hint: the spine array can be open or closed (closed means that endpoints are coincident).
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      • Warning: special care is needed if creating loops or spirals since self-intersecting, impossible or inverted geometry can result!
      • Warning: ensure that spine segments have non-zero length and are not coincident with each other.
      • Hint: if a spine is closed (or nearly closed) then the inner diameter usually needs to be greater than the corresponding crossSection width.
      Specified by:
      getSpine in interface Extrusion
      Returns:
      value of spine field

    • setSpine

      public ExtrusionObject setSpine​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly MFVec3f field named spine.

      Tooltip: The spine array defines a center-line sequence of 3D points that define a piecewise-linear curve forming a series of connected vertices. The spine is set of points along which a 2D crossSection is extruded, scaled and oriented.
      • Hint: the spine array can be open or closed (closed means that endpoints are coincident).
      • Hint: number of values must all match for 3-tuple spine points, 2-tuple scale values, and 4-tuple orientation values.
      • Warning: special care is needed if creating loops or spirals since self-intersecting, impossible or inverted geometry can result!
      • Warning: ensure that spine segments have non-zero length and are not coincident with each other.
      • Hint: if a spine is closed (or nearly closed) then the inner diameter usually needs to be greater than the corresponding crossSection width.
      Specified by:
      setSpine in interface Extrusion
      Parameters:
      newValue - is new value for the spine field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSpine

      public ExtrusionObject setSpine​(MFVec3fObject newValue)
      Assign typed object value to MFVec3f spine field, similar to setSpine(float[]).
      Parameters:
      newValue - is new value for the spine field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addSpine

      public ExtrusionObject addSpine​(SFVec3fObject newValue)
      Add singleton SFVec3fObject value to MFVec3f spine field.
      Parameters:
      newValue - is new value to add to the spine field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSpine

      public ExtrusionObject setSpine​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSpine(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ExtrusionObject - 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 ExtrusionObject 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:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public ExtrusionObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ExtrusionObject - 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 ExtrusionObject 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:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ExtrusionObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ExtrusionObject - 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 ExtrusionObject 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:
      ExtrusionObject - 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 ExtrusionObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ExtrusionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • addComments

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

    • addComments

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

    • addComments

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

    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool

    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

    • findElementByNameValue

      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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)

    • findNodeByDEF

      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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)

    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)

    • isCrossSectionClosed

      public boolean isCrossSectionClosed()
      Whether crossSection array is open or closed (closed means that endpoints are coincident).
      Returns:
      whether crossSection is closed, i.e. first and last points identical
      See Also:
      X3D Tooltips: Extrusion

    • isSpineClosed

      public boolean isSpineClosed()
      Whether spine array is open or closed (closed means that endpoints are coincident).
      Returns:
      whether spine is closed, i.e. first and last points identical

    • toFileSvgCrossSection

      public java.io.File toFileSvgCrossSection​(java.lang.String fileName)
      Create SVG output file (with same base name) for Extrusion crossSection, if found.
      Parameters:
      fileName - name of file to create and save, can include local directory path, must end with .svg
      Returns:
      File containing result (if operation succeeds), null otherwise
      See Also:
      X3DObject.FILE_EXTENSION_SVG, ConfigurationProperties.STYLESHEET_ExtrusionCrossSectionSVG, X3DObject.toFileStylesheetConversion(String,String)