Class MFImageObject

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.MFImageObject
All Implemented Interfaces:
MField, MFImage, X3DField

public class MFImageObject
extends X3DConcreteField
implements MFImage
This utility class provides a concrete implementation corresponding to MFImage X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFImage is an array of SFImage values.

Related field object: SFImageObject
See Also:
X3D Tooltips: type MFImage, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFImageAndMFImage, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int[] DEFAULT_VALUE
    Default value for this field type is an empty array.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "".
    static java.lang.String NAME
    String constant NAME provides name of this element: MFImage
    static java.util.regex.Pattern PATTERN
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static java.lang.String REGEX
    Default regular expression (regex) pattern for this field type is \s*(([+]?
    static int TUPLE_SIZE
    Default tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).

    Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    MFImageObject()
    Constructor for MFImageObject performs value initialization.
    MFImageObject​(int[] newValue)
    Constructor for MFImageObject using a corresponding Java primitive int[] array as new initial value.
    MFImageObject​(MFImageObject newValue)
    Constructor to copy an MFImageObject value as initial value for this new field object.
    MFImageObject​(SFImageObject newValue)
    Utility constructor for MFImageObject to assign a single SFImageObject as new initial value.
  • Method Summary

    Modifier and Type Method Description
    void append​(java.awt.image.RenderedImage[] newValue)
    Places a new SFImage value at the end of the existing value array, increasing the field length accordingly.
    void clear()
    Removes all values in the field array, changing the array size to zero.
    boolean equals​(MFImageObject comparisonMFImageObject)
    Determine whether two objects contain equal values.
    int getComponents​(int imageIndex)
    Get the number of color components in the image.
    int getHeight​(int imageIndex)
    Get the height of the image array.
    java.awt.image.WritableRenderedImage getImage​(int imageIndex)
    Fetch the Java representation of the underlying image from these pixels.
    void getPixels​(int imageIndex, int[] pixels)
    Get the image pixel value in the given eventOut.
    int[] getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    int getWidth​(int imageIndex)
    Get the width of the image array.
    void initialize()
    Initialization for MFImageObject applies default initial value.
    void insertValue​(int index, java.awt.image.RenderedImage newValue)
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    boolean isDefaultValue()
    Determine whether current value matches DEFAULT_VALUE
    boolean matches()
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static boolean matches​(java.lang.String value)
    Test PATTERN match with regular expression (regex) of provided value.
    void remove​(int index)
    Remove one SFImage element of the field array at index position, if found.
    void set1Value​(int imageIndex, int newValue)
    Replace a single value at the appropriate location in the existing value array.
    void set1Value​(int imageIndex, int width, int height, int components, int[] pixels)  
    void setImage​(int imageIndex, java.awt.image.RenderedImage image)
    Set the image value in the given writable field to the new image defined by a set of pixels.
    void setImage​(java.awt.image.RenderedImage[] image)  
    void setSubImage​(int imageIndex, java.awt.image.RenderedImage image, int sourceWidth, int sourceHeight, int sourceXOffset, int sourceYOffset, int destinationXOffset, int destinationYOffset)
    Copy a region of the argument RenderedImage to replace a portion of the current SFimage.
    void setValue​(int[] newValue)
    Assign a new value array; can be an SFImage primive array containing width, height, and components count, followed by array of pixels.
    MFImageObject setValue​(MFImageObject newValue)
    Apply an MFImageObject value to this field.
    void setValue​(SFImageObject newValue)
    Assign a new value array; can be an SFImage primive array containing width, height, and components count, followed by array of pixels.
    MFImageObject setValueByString​(java.lang.String newValue)
    Utility accessor for MFImageObject using String value (which must pass parsing validation checks).
    int size()
    Get the size of the underlying data array.
    java.lang.String toString()
    Provides current value as a String.
    static java.lang.String toString​(int[] value)
    Static utility method to provide String representation of a correctly typed input value.
    java.lang.String toStringDecimal()
    Provide pixel values in decimal format.
    java.lang.String toStringHexadecimal()
    Provide pixel values in hexadecimal format.
    java.lang.String validate()
    Validate current value via get/set comparison tests
    java.lang.String validateRegex()
    Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.web3d.x3d.sai.X3DField

    addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener
  • Field Details

  • Constructor Details

    • MFImageObject

      public MFImageObject()
      Constructor for MFImageObject performs value initialization.
    • MFImageObject

      public MFImageObject​(MFImageObject newValue)
      Constructor to copy an MFImageObject value as initial value for this new field object.
      Parameters:
      newValue - The newValue to apply
    • MFImageObject

      public MFImageObject​(int[] newValue)
      Constructor for MFImageObject using a corresponding Java primitive int[] array as new initial value.
      Parameters:
      newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
    • MFImageObject

      public MFImageObject​(SFImageObject newValue)
      Utility constructor for MFImageObject to assign a single SFImageObject as new initial value.
      Parameters:
      newValue - is new value to assign
  • Method Details

    • initialize

      public void initialize()
      Initialization for MFImageObject applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.
      Specified by:
      initialize in class X3DConcreteField
      See Also:
      Stack Overflow: How to check if a given Regex is valid?, DEFAULT_VALUE
    • equals

      public boolean equals​(MFImageObject comparisonMFImageObject)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonMFImageObject - field type to compare
      Returns:
      true if equivalent, false otherwise
    • validate

      public final java.lang.String validate()
      Validate current value via get/set comparison tests
      Returns:
      empty string if get/set testing passes, warning otherwise
      See Also:
      validate(), validateRegex()
    • validateRegex

      public final java.lang.String validateRegex()
      Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.
      Returns:
      empty string if PATTERN matches, warning otherwise
      See Also:
      REGEX, PATTERN, matches(), matches(String), validate(), validate(), java.util.regex.Pattern
    • matches

      public final boolean matches()
      Test PATTERN match via regular expression (regex) check of current object's toString() value.
      Returns:
      true if PATTERN matches, false otherwise
      See Also:
      REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
    • matches

      public static final boolean matches​(java.lang.String value)
      Test PATTERN match with regular expression (regex) of provided value.
      Parameters:
      value - String to check against regex pattern for successful match
      Returns:
      true if PATTERN matches, false otherwise
      See Also:
      REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
    • setValueByString

      public MFImageObject setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for MFImageObject using String value (which must pass parsing validation checks).

      Warning: this method is not type safe at compile time! Best practice for X3DJSAIL programmers is to use strongly typed methods instead, in order to avoid potential for run-time errors.
      Parameters:
      newValue - is new value to assign, if empty then assign DEFAULT_VALUE
      Returns:
      MFMatrix4dObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
      Throws:
      InvalidFieldValueException
      See Also:
      X3DLoaderDOM.toX3dObjectTree(org.w3c.dom.Node)
    • toString

      public static java.lang.String toString​(int[] value)
      Static utility method to provide String representation of a correctly typed input value.
      Parameters:
      value - The value to convert to a String
      Returns:
      String version of the provided value
      See Also:
      X3D Tooltips: type
    • getPrimitiveValue

      public int[] getPrimitiveValue()
      Provides current value of the field as a Java primitive type.
      Returns:
      current value
    • toString

      public java.lang.String toString()
      Provides current value as a String.
      Overrides:
      toString in class java.lang.Object
      Returns:
      String version of the provided value, with pixels in hexadecimal or decimal format.
      See Also:
      X3D Tooltips: type MFImage, toStringHexadecimal(), toStringDecimal(), ConfigurationProperties.SFImagePixelOutputHexadecimal_DEFAULT, ConfigurationProperties.isSFImagePixelOutputHexadecimal(), ConfigurationProperties.setSFImagePixelOutputHexadecimal(boolean)
    • toStringDecimal

      public java.lang.String toStringDecimal()
      Provide pixel values in decimal format.
      Returns:
      String version of the provided value in decimal format
      See Also:
      toStringHexadecimal(), ConfigurationProperties.SFImagePixelOutputHexadecimal_DEFAULT, ConfigurationProperties.isSFImagePixelOutputHexadecimal(), ConfigurationProperties.setSFImagePixelOutputHexadecimal(boolean), X3D Tooltips: type MFImage
    • toStringHexadecimal

      public java.lang.String toStringHexadecimal()
      Provide pixel values in hexadecimal format.
      Returns:
      String version of the provided value in hexadecimal format
      See Also:
      toStringDecimal(), ConfigurationProperties.SFImagePixelOutputHexadecimal_DEFAULT, ConfigurationProperties.isSFImagePixelOutputHexadecimal(), ConfigurationProperties.setSFImagePixelOutputHexadecimal(boolean), X3D Tooltips: type MFImage
    • getWidth

      public int getWidth​(int imageIndex)
      Get the width of the image array.
      Specified by:
      getWidth in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      Returns:
      The width of the image in pixels
    • getHeight

      public int getHeight​(int imageIndex)
      Get the height of the image array.
      Specified by:
      getHeight in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      Returns:
      The height of the image in pixels
    • getComponents

      public int getComponents​(int imageIndex)
      Get the number of color components in the image. The value will always be between 1 and 4 indicating the number of components of the color specification to be read from the image pixel data.
      Specified by:
      getComponents in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      Returns:
      The number of components
    • getPixels

      public void getPixels​(int imageIndex, int[] pixels)
      Get the image pixel value in the given eventOut.

      The number of items in the pixels array will be width * height. If there are less items than this an ArrayIndexOutOfBoundsException will be generated. The integer values are represented according to the number of components.

      1 Component Images
      The integer has the intensity value stored in the lowest byte and can be obtained:

          intensity = (pixel[i]     ) &0xFF;
        

      2 Component Images
      The integer has the transparency value stored in the lowest byte and the intensity in the next byte:

          intensity = (pixel[i] >> 8) &0xFF;
          alpha     = (pixel[i]     ) &0xFF;
        

      3 Component Images
      The three color components are stored in the integer array as follows:

          red   = (pixel[i] >> 16) &0xFF;
          green = (pixel[i] >>  8) &0xFF;
          blue  = (pixel[i]      ) &0xFF;
        

      4 Component Images
      The integer has the value stored in the array as follows:

          red   = (pixel[i] >> 24) &0xFF;
          green = (pixel[i] >> 16) &0xFF;
          blue  = (pixel[i] >>  8) &0xFF;
          alpha = (pixel[i]      ) &0xFF;
        

      The width and height values must be greater than or equal to zero. The number of components is between 1 and 4. Any value outside of these bounds will generate an IllegalArgumentException.

      Specified by:
      getPixels in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      pixels - The array to copy pixel values into
    • getImage

      public java.awt.image.WritableRenderedImage getImage​(int imageIndex)
      Fetch the Java representation of the underlying image from these pixels. This is the same copy that the browser uses to generate texture information from.
      Specified by:
      getImage in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      Returns:
      The image reference representing the current state
    • setImage

      public void setImage​(int imageIndex, java.awt.image.RenderedImage image)
      Set the image value in the given writable field to the new image defined by a set of pixels.
      Specified by:
      setImage in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      image - The new image to use as the source
    • setSubImage

      public void setSubImage​(int imageIndex, java.awt.image.RenderedImage image, int sourceWidth, int sourceHeight, int sourceXOffset, int sourceYOffset, int destinationXOffset, int destinationYOffset)
      Copy a region of the argument RenderedImage to replace a portion of the current SFimage.

      The sub image set shall not resize the base image representation and therefore performs an intersection clip of the provided image. The user provided image shall be of the same format (pixel depth, pixel representation) as the original image obtained through the getImage() method.

      RenderedImages are row order from top to bottom. A 4x8 RenderImage is indexed as follows:

      
       X >01234567
         ----------
       0 |********|
       1 |********|
       2 |********|
       3 |********|
       ^ ----------
       Y
      
        
      SFImages are row order from bottom to top. A 4x8 RenderImage is indexed as follows:
      
       X >01234567
         ----------
       3 |********|
       2 |********|
       1 |********|
       0 |********|
       ^ ----------
       Y
      
        

      Note: The parameter srcYOffset is referenced to the RenderedImage object (indexed top to bottom).
      The parameter destYOffset is referenced to the SFImage object (indexed bottom to top).

      Specified by:
      setSubImage in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      image - The new image to use as the source
      sourceWidth - The width of the argument sub-image region to copy
      sourceHeight - The height of the argument sub-image region to copy
      sourceXOffset - The initial x dimension (width) offset into the argument sub-image that begins the region to copy
      sourceYOffset - The initial y dimension (height) offset into the argument sub-image that begins the region to copy
      destinationXOffset - The initial x dimension (width) offset in the SFimage object that begins the region to receive the copy
      destinationYOffset - The initial y dimension (height) offset in the SFimage object that begins the region to receive the copy
    • set1Value

      public void set1Value​(int imageIndex, int newValue)
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.
      Specified by:
      set1Value in interface MFImage
      Parameters:
      imageIndex - the index of the selected image
      newValue - provides new value to apply
    • set1Value

      public void set1Value​(int imageIndex, int width, int height, int components, int[] pixels)
      Specified by:
      set1Value in interface MFImage
    • setValue

      public void setValue​(int[] newValue)
      Assign a new value array; can be an SFImage primive array containing width, height, and components count, followed by array of pixels.
      Specified by:
      setValue in interface MFImage
      Parameters:
      newValue - the newValue to set
    • setValue

      public void setValue​(SFImageObject newValue)
      Assign a new value array; can be an SFImage primive array containing width, height, and components count, followed by array of pixels.
      Parameters:
      newValue - the newValue to set
    • setImage

      public void setImage​(java.awt.image.RenderedImage[] image)
      Specified by:
      setImage in interface MFImage
    • append

      public void append​(java.awt.image.RenderedImage[] newValue)
      Places a new SFImage value at the end of the existing value array, increasing the field length accordingly.
      Specified by:
      append in interface MFImage
      Parameters:
      newValue - The newValue to append
    • insertValue

      public void insertValue​(int index, java.awt.image.RenderedImage newValue)
      Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
      Specified by:
      insertValue in interface MFImage
      Parameters:
      index - The position for the inserted value in the current array
      newValue - The newValue to insert
    • remove

      public void remove​(int index)
      Remove one SFImage element of the field array at index position, if found. Initial element is at index 0.
      Specified by:
      remove in interface MField
      Parameters:
      index - position of element in field array that gets removed
    • clear

      public void clear()
      Removes all values in the field array, changing the array size to zero.
      Specified by:
      clear in interface MField
    • size

      public int size()
      Get the size of the underlying data array. The size is the number of elements for that data type. So for an MFFloat the size would be the number of float values, but for an MFVec3f, it is the number of vectors in the returned array (where a vector is 3 consecutive array indexes in a flat array).
      Specified by:
      size in interface MField
      Returns:
      The number of elements in this field array.
    • setValue

      public MFImageObject setValue​(MFImageObject newValue)
      Apply an MFImageObject value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      MFImageObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • isDefaultValue

      public boolean isDefaultValue()
      Determine whether current value matches DEFAULT_VALUE
      Returns:
      whether current value matches DEFAULT_VALUE
      See Also:
      DEFAULT_VALUE