Class PixelTextureObject

    • Field Detail

      • NAME

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

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

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

        public static final java.util.ArrayList<java.lang.Integer> IMAGE_DEFAULT_VALUE
        SFImage field named image has default value {0,0,0} (Java syntax) or 0 0 0 (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).
      • REPEATS_DEFAULT_VALUE

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

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

        public static final TexturePropertiesObject TEXTUREPROPERTIES_DEFAULT_VALUE
        SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).
      • fromField_IMAGE

        public static final java.lang.String fromField_IMAGE
        fromField ROUTE name for SFImage field named image.
        See Also:
        Constant Field Values
      • toField_IMAGE

        public static final java.lang.String toField_IMAGE
        toField ROUTE name for SFImage field named image.
        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

      • PixelTextureObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the PixelTexture element: Texturing
        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
      • getImage

        public int[] getImage()
        Provide array of Integer results from inputOutput SFImage field named image.

        Tooltip: Defines image: width height number_of_components pixel_values. width and height are pixel count, number_of_components = 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity). Example: intensity [1 2 1 0xFF 0x00] Example: intensity-alpha [2 2 1 0 255 255 0] Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00] Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]. *
        Specified by:
        getImage in interface PixelTexture
        Returns:
        value of image field
      • getImageList

        public java.util.ArrayList<java.lang.Integer> getImageList()
        Utility method to get ArrayList value of SFImage image field, similar to getImage().
        Returns:
        value of image field
      • setImage

        public PixelTextureObject setImage​(int[] newValue)
        Accessor method to assign Integer array to inputOutput SFImage field named image.

        Tooltip: Defines image: width height number_of_components pixel_values. width and height are pixel count, number_of_components = 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity). Example: intensity [1 2 1 0xFF 0x00] Example: intensity-alpha [2 2 1 0 255 255 0] Example: red-green-blue [2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00] Example: red-green-blue-alpha [2 2 4 0xFFFFFFAA 0xFFFF00AA 0x11111111AA 0x787800AA]. *
        Specified by:
        setImage in interface PixelTexture
        Parameters:
        newValue - is new value for the image field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setImage

        public PixelTextureObject setImage​(SFImageObject newValue)
        Assign typed object value to SFImage image field, similar to setImage(int[]).
        Parameters:
        newValue - is new value for the image field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setImage

        public PixelTextureObject setImage​(java.util.ArrayList<java.lang.Integer> newValue)
        Assign ArrayList value of SFImage image field, similar to setImage(int[]).
        Parameters:
        newValue - is new value for the image field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearImage

        public PixelTextureObject clearImage()
        Utility method to clear SFImage value of image field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • clearIS

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

        public boolean getRepeatS()
        Provide boolean value from initializeOnly SFBool field named repeatS.

        Tooltip: Whether to horizontally repeat texture along S axis. *
        Specified by:
        getRepeatS in interface PixelTexture
        Specified by:
        getRepeatS in interface X3DTexture2DNode
        Returns:
        value of repeatS field
      • setRepeatS

        public PixelTextureObject setRepeatS​(boolean newValue)
        Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.

        Tooltip: Whether to horizontally repeat texture along S axis. *
        Specified by:
        setRepeatS in interface PixelTexture
        Specified by:
        setRepeatS in interface X3DTexture2DNode
        Parameters:
        newValue - is new value for the repeatS field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRepeatS

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

        public boolean getRepeatT()
        Provide boolean value from initializeOnly SFBool field named repeatT.

        Tooltip: Whether to vertically repeat texture along T axis. *
        Specified by:
        getRepeatT in interface PixelTexture
        Specified by:
        getRepeatT in interface X3DTexture2DNode
        Returns:
        value of repeatT field
      • setRepeatT

        public PixelTextureObject setRepeatT​(boolean newValue)
        Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.

        Tooltip: Whether to vertically repeat texture along T axis. *
        Specified by:
        setRepeatT in interface PixelTexture
        Specified by:
        setRepeatT in interface X3DTexture2DNode
        Parameters:
        newValue - is new value for the repeatT field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRepeatT

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

        public PixelTextureObject clearTextureProperties()
        Utility method to clear SFNode value of textureProperties field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setTextureProperties

        public PixelTextureObject setTextureProperties​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.
        Parameters:
        newValue - is new value for the textureProperties field.
        Returns:
        PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setTextureProperties(TextureProperties)
      • hasTextureProperties

        public boolean hasTextureProperties()
        Indicate whether an object is available for initializeOnly SFNode field textureProperties.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getTextureProperties(), getTexturePropertiesProtoInstance()
      • setDEF

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

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

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

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

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

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

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