Package org.web3d.x3d.jsail.Texturing

Class PixelTextureObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing.PixelTextureObject
All Implemented Interfaces:
X3DNode, X3DAppearanceChildNode, PixelTexture, X3DTexture2DNode, X3DTextureNode
public class PixelTextureObject
extends X3DConcreteNode
implements PixelTexture
PixelTexture creates a 2D-image texture map using a numeric array of pixel values.

X3D node tooltip: [X3DTexture2DNode] PixelTexture creates a 2D-image texture map using a numeric array of pixel values. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
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: PixelTexture, X3D Tooltips: PixelTexture, X3D Scene Authoring Hints: Images

  • Field Details

  • Constructor Details

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

    • 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

    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getImage

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

      Tooltip: Defines image: width, height, number_of_components per each pixel value, and list of pixel_values. Note that width and height are pixel count, and allowed values for RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity).
      • Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different. 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]
      • Hint: it is easier to understand hexadecimal values for each pixel, but integer values are also allowed.
      • Hint: the array of pixel values has length = (width*height).
      • Hint: the full list of integers in this field has length = (width*height + 3).
      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

    • getImageString

      public java.lang.String getImageString()
      Utility method to get String 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 per each pixel value, and list of pixel_values. Note that width and height are pixel count, and allowed values for RGBA number_of_components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (red green blue), 4 (red green blue alpha-opacity).
      • Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different. 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]
      • Hint: it is easier to understand hexadecimal values for each pixel, but integer values are also allowed.
      • Hint: the array of pixel values has length = (width*height).
      • Hint: the full list of integers in this field has length = (width*height + 3).
      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).

    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • setIS

      public PixelTextureObject 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:
      PixelTextureObject - 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 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()

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface PixelTexture
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DTexture2DNode
      Specified by:
      getMetadata in interface X3DTextureNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public PixelTextureObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface PixelTexture
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTexture2DNode
      Specified by:
      setMetadata in interface X3DTextureNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • clearMetadata

      public 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).

    • setMetadata

      public PixelTextureObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PixelTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)

    • hasMetadata

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

    • 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).

    • getTextureProperties

      public TextureProperties getTextureProperties()
      Provide TexturePropertiesObject instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
      Specified by:
      getTextureProperties in interface PixelTexture
      Specified by:
      getTextureProperties in interface X3DTexture2DNode
      Returns:
      value of textureProperties field
      See Also:
      getTexturePropertiesProtoInstance()

    • setTextureProperties

      public PixelTextureObject setTextureProperties​(TextureProperties newValue)
      Accessor method to assign TexturePropertiesObject instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
      Specified by:
      setTextureProperties in interface PixelTexture
      Specified by:
      setTextureProperties in interface X3DTexture2DNode
      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(ProtoInstanceObject)

    • 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()

    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setDEF

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

    • toStringX3D

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

    • toStringClassicVRML

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

    • toStringVRML97

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

    • findElementByNameValue

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

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

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • findElementByNameValue

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

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

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasElementByNameValue

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

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

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

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasNodeByDEF

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

    • validate

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

    • getExpectedLength

      public int getExpectedLength()
      Compute expected length of integer array based on width and height values. Note that each integer pixel value must represent the full set of components for this SFImage.
      Returns:
      number of pixel values expected in image integer array
      See Also:
      getWidth(), getHeight()

    • getWidth

      public int getWidth()
      Utility method to determine width of texture from initial element in value array.
      Returns:
      width parameter of value field

    • getHeight

      public int getHeight()
      Utility method to determine height of texture from second element in value array.
      Returns:
      height parameter of value field

    • getNumberComponents

      public int getNumberComponents()
      Utility method to determine number of components of texture (1..4 components) from third element in value array.
      Returns:
      number of components for each element in value field

    • getPixels

      public int[] getPixels()
      Utility method to provide pixels (following parameters) in value array.
      Returns:
      pixels in image field

    • getPixelsString

      public java.lang.String getPixelsString()
      Utility method to get String value of SFImage image field only, without size parameters.
      Returns:
      string value of pixels (only, no size parameters)