Class ExtrusionObject

  • All Implemented Interfaces:
    X3DNode, Extrusion, X3DGeometryNode

    public class ExtrusionObject
    extends X3DConcreteNode
    implements Extrusion
    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 Detail

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the Extrusion element: Geometry3D
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Geometry3D component level for this element: 4
        See Also:
        Constant Field Values
      • BEGINCAP_DEFAULT_VALUE

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

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

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

        public static final float CREASEANGLE_DEFAULT_VALUE
        SFFloat field named creaseAngle has default value 0.0f (Java syntax) or 0.0 (XML syntax).
        See Also:
        Constant Field Values
      • CROSSSECTION_DEFAULT_VALUE

        public static final float[] CROSSSECTION_DEFAULT_VALUE
        MFVec2f field named crossSection has default value {1f,1f,1f,-1f,-1f,-1f,-1f,1f,1f,1f} (Java syntax) or 1 1 1 -1 -1 -1 -1 1 1 1 (XML syntax).
      • ENDCAP_DEFAULT_VALUE

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

        public static final ISObject 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).
      • ORIENTATION_DEFAULT_VALUE

        public static final float[] ORIENTATION_DEFAULT_VALUE
        MFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
      • SCALE_DEFAULT_VALUE

        public static final float[] SCALE_DEFAULT_VALUE
        MFVec2f field named scale has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).
      • SOLID_DEFAULT_VALUE

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

        public static final float[] SPINE_DEFAULT_VALUE
        MFVec3f field named spine has default value {0f,0f,0f,0f,1f,0f} (Java syntax) or 0 0 0 0 1 0 (XML syntax).
      • fromField_IS

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

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

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

        public static final java.lang.String fromField_ORIENTATION
        fromField ROUTE name for MFRotation field named orientation.
        See Also:
        Constant Field Values
      • toField_ORIENTATION

        public static final java.lang.String toField_ORIENTATION
        toField ROUTE name for MFRotation field named orientation.
        See Also:
        Constant Field Values
      • fromField_SCALE

        public static final java.lang.String fromField_SCALE
        fromField ROUTE name for MFVec2f field named scale.
        See Also:
        Constant Field Values
      • toField_SCALE

        public static final java.lang.String toField_SCALE
        toField ROUTE name for MFVec2f field named scale.
        See Also:
        Constant Field Values
      • toField_SET_CROSSSECTION

        public static final java.lang.String toField_SET_CROSSSECTION
        toField ROUTE name for MFVec2f field named set_crossSection.
        See Also:
        Constant Field Values
      • toField_SET_ORIENTATION

        public static final java.lang.String toField_SET_ORIENTATION
        toField ROUTE name for MFRotation field named set_orientation.
        See Also:
        Constant Field Values
      • toField_SET_SCALE

        public static final java.lang.String toField_SET_SCALE
        toField ROUTE name for MFVec2f field named set_scale.
        See Also:
        Constant Field Values
      • toField_SET_SPINE

        public static final java.lang.String toField_SET_SPINE
        toField ROUTE name for MFVec3f field named set_spine.
        See Also:
        Constant Field Values
    • Constructor Detail

      • 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 Detail

      • 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
      • 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: 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: 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: ccw = counterclockwise: ordering of vertex-coordinates orientation.
        • Hint: ccw false can reverse solid (backface culling) and normal-vector orientation. Note that consistency of left-handed or right-handed point sequences is important throughout.
        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: ccw = counterclockwise: ordering of vertex-coordinates orientation.
        • Hint: ccw false can reverse solid (backface culling) and normal-vector orientation. Note that consistency of left-handed or right-handed point sequences is important throughout.
        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: 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.
        • Warning: concave or inverted geometry may be invisible when using default value convex=true.
        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: 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.
        • Warning: concave or inverted geometry may be invisible when using default value convex=true.
        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: match clockwise/counterclockwise, otherwise 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. , particularly 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: match clockwise/counterclockwise, otherwise 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. , particularly 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: 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: 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).
      • 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()
      • 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).
      • 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).
        • 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).
        • 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: take care if creating loops or spirals, otherwise self-intersecting, impossible or inverted geometry can result!.
        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: take care if creating loops or spirals, otherwise self-intersecting, impossible or inverted geometry can result!.
        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).
      • 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).
      • 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)
      • 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