Class FillPropertiesObject

  • All Implemented Interfaces:
    X3DNode, FillProperties, X3DAppearanceChildNode

    public class FillPropertiesObject
    extends X3DConcreteNode
    implements FillProperties
    X3D node tooltip: [X3DAppearanceChildNode] FillProperties indicates whether appearance is filled or hatched for associated geometry nodes inside the same Shape. Hatches are applied on top of the already rendered appearance of the node, and are not affected by lighting.
    • Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
    • Warning: requires X3D profile='Full' or else include <component name='Shape' level='3'/>

    Note that SFColorObject provides a variety of color constants.

    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: FillProperties, X3D Tooltips: FillProperties, X3D Scene Authoring Hints
    • Field Detail

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the FillProperties 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: 3
        See Also:
        Constant Field Values
      • FILLED_DEFAULT_VALUE

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

        public static final float[] HATCHCOLOR_DEFAULT_VALUE
        SFColor field named hatchColor has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
      • HATCHED_DEFAULT_VALUE

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

        public static final int HATCHSTYLE_DEFAULT_VALUE
        SFInt32 field named hatchStyle has default value 1 (Java syntax) or 1 (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).
      • fromField_FILLED

        public static final java.lang.String fromField_FILLED
        fromField ROUTE name for SFBool field named filled.
        See Also:
        Constant Field Values
      • toField_FILLED

        public static final java.lang.String toField_FILLED
        toField ROUTE name for SFBool field named filled.
        See Also:
        Constant Field Values
      • fromField_HATCHCOLOR

        public static final java.lang.String fromField_HATCHCOLOR
        fromField ROUTE name for SFColor field named hatchColor.
        See Also:
        Constant Field Values
      • toField_HATCHCOLOR

        public static final java.lang.String toField_HATCHCOLOR
        toField ROUTE name for SFColor field named hatchColor.
        See Also:
        Constant Field Values
      • fromField_HATCHED

        public static final java.lang.String fromField_HATCHED
        fromField ROUTE name for SFBool field named hatched.
        See Also:
        Constant Field Values
      • toField_HATCHED

        public static final java.lang.String toField_HATCHED
        toField ROUTE name for SFBool field named hatched.
        See Also:
        Constant Field Values
      • fromField_HATCHSTYLE

        public static final java.lang.String fromField_HATCHSTYLE
        fromField ROUTE name for SFInt32 field named hatchStyle.
        See Also:
        Constant Field Values
      • toField_HATCHSTYLE

        public static final java.lang.String toField_HATCHSTYLE
        toField ROUTE name for SFInt32 field named hatchStyle.
        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

      • FillPropertiesObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the FillProperties 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: 3
        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
      • getFilled

        public boolean getFilled()
        Provide boolean value from inputOutput SFBool field named filled.

        Tooltip: Whether or not associated geometry is filled. *
        Specified by:
        getFilled in interface FillProperties
        Returns:
        value of filled field
      • setFilled

        public FillPropertiesObject setFilled​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named filled.

        Tooltip: Whether or not associated geometry is filled. *
        Specified by:
        setFilled in interface FillProperties
        Parameters:
        newValue - is new value for the filled field.
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFilled

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

        public float[] getHatchColor()
        Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named hatchColor.

        Tooltip: [0,1] Color of the hatch pattern. *
        Specified by:
        getHatchColor in interface FillProperties
        Returns:
        value of hatchColor field
      • setHatchColor

        public FillPropertiesObject setHatchColor​(float[] newValue)
        Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named hatchColor.

        Tooltip: [0,1] Color of the hatch pattern. *
        Specified by:
        setHatchColor in interface FillProperties
        Parameters:
        newValue - is new value for the hatchColor field.
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHatchColor

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

        public FillPropertiesObject setHatchColor​(float red,
                                                  float green,
                                                  float blue)
        Assign values to SFColor hatchColor field, similar to setHatchColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHatchColor

        public FillPropertiesObject setHatchColor​(double red,
                                                  double green,
                                                  double blue)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setHatchColor(float[]).
        Parameters:
        red - first component [0..1]
        green - second component [0..1]
        blue - third component [0..1]
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHatchColor

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

        public boolean getHatched()
        Provide boolean value from inputOutput SFBool field named hatched.

        Tooltip: Whether or not associated geometry is hatched. *
        Specified by:
        getHatched in interface FillProperties
        Returns:
        value of hatched field
      • setHatched

        public FillPropertiesObject setHatched​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named hatched.

        Tooltip: Whether or not associated geometry is hatched. *
        Specified by:
        setHatched in interface FillProperties
        Parameters:
        newValue - is new value for the hatched field.
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHatched

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

        public int getHatchStyle()
        Provide int value from inputOutput SFInt32 field named hatchStyle.

        Tooltip: hatchStyle selects a hatch pattern from International Register of Graphical Items. 1=Horizontal equally spaced parallel lines. 2=Vertical equally spaced parallel lines. 3=Positive slope equally spaced parallel lines. 4=Negative slope equally spaced parallel lines. 5=Horizontal/vertical crosshatch. 6=Positive slope/negative slope crosshatch. 7=(cast iron or malleable iron and general use for all materials). 8=(steel). 9=(bronze, brass, copper, and compositions). 10=(white metal, zinc, lead, babbit, and alloys). 11=(magnesium, aluminum, and aluminum alloys). 12=(rubber, plastic, and electrical insulation). 13=(cork, felt, fabric, leather, and fibre). 14=(thermal insulation). 15=(titanium and refi-actory material). 16=(marble, slate, porcelain, glass, etc.). 17=(earth). 18=(sand). 19=(repeating dot).
        Specified by:
        getHatchStyle in interface FillProperties
        Returns:
        value of hatchStyle field
      • setHatchStyle

        public FillPropertiesObject setHatchStyle​(int newValue)
        Accessor method to assign int value to inputOutput SFInt32 field named hatchStyle.

        Tooltip: hatchStyle selects a hatch pattern from International Register of Graphical Items. 1=Horizontal equally spaced parallel lines. 2=Vertical equally spaced parallel lines. 3=Positive slope equally spaced parallel lines. 4=Negative slope equally spaced parallel lines. 5=Horizontal/vertical crosshatch. 6=Positive slope/negative slope crosshatch. 7=(cast iron or malleable iron and general use for all materials). 8=(steel). 9=(bronze, brass, copper, and compositions). 10=(white metal, zinc, lead, babbit, and alloys). 11=(magnesium, aluminum, and aluminum alloys). 12=(rubber, plastic, and electrical insulation). 13=(cork, felt, fabric, leather, and fibre). 14=(thermal insulation). 15=(titanium and refi-actory material). 16=(marble, slate, porcelain, glass, etc.). 17=(earth). 18=(sand). 19=(repeating dot).
        Specified by:
        setHatchStyle in interface FillProperties
        Parameters:
        newValue - is new value for the hatchStyle field.
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHatchStyle

        public FillPropertiesObject setHatchStyle​(SFInt32Object newValue)
        Assign typed object value to SFInt32 hatchStyle field, similar to setHatchStyle(int).
        Parameters:
        newValue - is new value for the hatchStyle field.
        Returns:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

        public FillPropertiesObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        FillPropertiesObject - 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 FillPropertiesObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        FillPropertiesObject - 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 FillPropertiesObject 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:
        FillPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

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

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

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

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

        public FillPropertiesObject 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:
        FillPropertiesObject - 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)