Class ShapeObject

    • Field Detail

      • NAME

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

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

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

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

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

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

        public static final X3DGeometryNode GEOMETRY_DEFAULT_VALUE
        SFNode field named geometry has default value null (Java syntax) or NULL (XML syntax).
      • IS_DEFAULT_VALUE

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

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

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

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

        public static final java.lang.String toField_GEOMETRY
        toField ROUTE name for SFNode field named geometry.
        See Also:
        Constant Field Values
      • 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
    • Constructor Detail

      • ShapeObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the Shape element: Shape
        Specified by:
        getComponent in class X3DConcreteElement
        Returns:
        X3D component for this element
      • getComponentLevel

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

        public 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
      • getAppearance

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

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

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

        public boolean hasAppearance()
        Indicate whether an object is available for inputOutput SFNode field appearance.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getAppearance(), getAppearanceProtoInstance()
      • setBboxCenter

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public boolean hasGeometry()
        Indicate whether an object is available for inputOutput SFNode field geometry.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getGeometry(), getGeometryProtoInstance()
      • setIS

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

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

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

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

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

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

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

        public ShapeObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        ShapeObject - 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)