Class MFColorObject

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

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


Note that SFColorObject provides a variety of color constants.

Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFColor specifies zero or more SFColor RGB triples. Each color value is an RGB triple of floating point numbers in the range 0.0 to 1.0. The default value of an uninitialized MFColor field is the empty list. Individual SFColor array values are optionally separated by commas.

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

    Fields 
    Modifier and Type Field Description
    static float[] 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: MFColor
    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 3 (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
    MFColorObject()
    Constructor for MFColorObject performs value initialization.
    MFColorObject​(double[] newValue)
    Utility constructor for MFColorObject using an alternatively typed Java double[] array as new initial value.
    MFColorObject​(float[] newValue)
    Constructor for MFColorObject using a corresponding Java primitive float[] array as new initial value.
    MFColorObject​(MFColorObject newValue)
    Constructor to copy an MFColorObject value as initial value for this new field object.
    MFColorObject​(SFColorObject newValue)
    Utility constructor for MFColorObject to assign a single SFColorObject as new initial value.
  • Method Summary

    Modifier and Type Method Description
    void append​(float[] newValue)
    Places new value(s) at the end of the existing value array, increasing the field length accordingly.
    MFColorObject append​(MFColorObject newValue)
    Appends a new MFColorObject to the end of the existing value array, increasing the field length accordingly.
    MFColorObject append​(SFColorObject newValue)
    Appends a new singleton typed 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.
    MFColorObject complementRGB()
    Complement all color values in RGB space (i.e. subtract each component from 1).
    boolean equals​(MFColorObject comparisonMFColorObject)
    Determine whether two objects contain equal values.
    void get1Value​(int index, float[] destinationValue)
    Get an individual value from the existing field array.
    float[] getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    void getValue​(float[] valueDestination)
    Get the current value of this MFColorObject by copying it into the valueDestination array, leaving the current object unchanged.
    void getValue​(float[][] valueDestination)
    Write out the current value of this field into the external valueDestination array.
    void initialize()
    Initialization for MFColorObject applies default initial value.
    void insertValue​(int index, float[] newValue)
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    static boolean isArray()
    Whether or not this field type is an array (true)
    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.
    MFColorObject normalizeClip()
    Ensure all component color values are within range [0-1] by clipping as necessary.
    void remove​(int index)
    Remove one SFColor element of the field array at index position, if found.
    void set1Value​(int index, float[] newValue)
    Replace a single value at the appropriate location in the existing value array.
    MFColorObject set1Value​(int index, int hexColorValue)
    Replace a single value at the appropriate location in the existing value array.
    MFColorObject setValue​(double[] newValue)
    Assign a double-precision array value to this single-precision field.
    void setValue​(float[] newValue)
    Assign a new float[] value to this field.
    void setValue​(int size, float[] newValue)
    Assign an array subset to this field.
    void setValue​(int size, float[][] newValue)
    Assign an array subset to this field.
    MFColorObject setValue​(MFColorObject newValue)
    Apply an MFColorObject value to this field.
    MFColorObject setValue​(SFColorObject newValue)
    Assign a single-field SFColorObject as new array value.
    MFColorObject setValueByString​(java.lang.String newValue)
    Utility accessor for MFColorObject using String value (which must pass parsing validation checks).
    int size()
    Get the size of the underlying data array, meaning the number of simple SFColor elements for the given data type.
    float[] toFloatArray()
    Provide float array for this field type.
    java.lang.String toString()
    Provides current value as a String.
    static java.lang.String toString​(float[] value)
    Static utility method to provide String representation of a correctly typed input value.
    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

    • MFColorObject

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

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

      public MFColorObject​(float[] newValue)
      Constructor for MFColorObject using a corresponding Java primitive float[] array as new initial value.
      Parameters:
      newValue - is new value to assign Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
    • MFColorObject

      public MFColorObject​(SFColorObject newValue)
      Utility constructor for MFColorObject to assign a single SFColorObject as new initial value.
      Parameters:
      newValue - is new value to assign
    • MFColorObject

      public MFColorObject​(double[] newValue)
      Utility constructor for MFColorObject using an alternatively typed Java double[] array as new initial value.
      Parameters:
      newValue - is new value to assign
  • Method Details

    • isArray

      public static final boolean isArray()
      Whether or not this field type is an array (true)
    • initialize

      public final void initialize()
      Initialization for MFColorObject 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​(MFColorObject comparisonMFColorObject)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonMFColorObject - 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 MFColorObject setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for MFColorObject 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)
    • set1Value

      public MFColorObject set1Value​(int index, int hexColorValue) throws java.lang.ArrayIndexOutOfBoundsException
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Parameters:
      index - is position of selected value in current array
      hexColorValue - HTML color value (such as 0xAA2288) to apply
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      Throws:
      java.lang.ArrayIndexOutOfBoundsException
      See Also:
      X3DConcreteField.getTupleSize(String), X3D Scene Authoring Hints: Color
    • complementRGB

      public MFColorObject complementRGB()
      Complement all color values in RGB space (i.e. subtract each component from 1).
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Wikipedia: Negative (photography), Wikipedia: Complementary colors, X3D Scene Authoring Hints: Color
    • normalizeClip

      public MFColorObject normalizeClip()
      Ensure all component color values are within range [0-1] by clipping as necessary.
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Color
    • toString

      public static java.lang.String toString​(float[] 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, with trailing zeroes and decimal points omitted.
      See Also:
      X3D Tooltips: type, SFFloatObject.stripTrailingZeroes(float)
    • getValue

      public void getValue​(float[] valueDestination)
      Get the current value of this MFColorObject by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface MFColor
      Parameters:
      valueDestination - The array to be filled in with current field values.
    • getPrimitiveValue

      public float[] 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 trailing zeroes and decimal points omitted.
      See Also:
      X3D Tooltips: type MFColor, SFFloatObject.stripTrailingZeroes(float)
    • get1Value

      public void get1Value​(int index, float[] destinationValue)

      Get an individual value from the existing field array.

      If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

      Specified by:
      get1Value in interface MFColor
      Parameters:
      index - is position of selected value in current array
      destinationValue - where to place result for selected value
      Throws:
      java.lang.ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.
    • setValue

      public void setValue​(int size, float[] newValue)
      Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Specified by:
      setValue in interface MFColor
      Parameters:
      size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
      newValue - The replacement value array to (potentially) slice and then assign.
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public void setValue​(float[] newValue)
      Assign a new float[] value to this field. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Parameters:
      newValue - is replacement value array to assign
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public MFColorObject setValue​(double[] newValue)
      Assign a double-precision array value to this single-precision field.

      Warning: this method casts type of input values from higher precision to lower precision.

      Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Parameters:
      newValue - is replacement value array to assign
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public MFColorObject setValue​(SFColorObject newValue)
      Assign a single-field SFColorObject as new array value.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    • set1Value

      public void set1Value​(int index, float[] newValue) throws java.lang.ArrayIndexOutOfBoundsException
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Specified by:
      set1Value in interface MFColor
      Parameters:
      index - is position of selected value in current array
      newValue - provides new value to apply
      Throws:
      java.lang.ArrayIndexOutOfBoundsException
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public void append​(float[] newValue)
      Places new value(s) at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Specified by:
      append in interface MFColor
      Parameters:
      newValue - The newValue to append
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public MFColorObject append​(SFColorObject newValue)
      Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.
      Parameters:
      newValue - The newValue to append
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • append

      public MFColorObject append​(MFColorObject newValue)
      Appends a new MFColorObject to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.
      Parameters:
      newValue - The newValue to append
      Returns:
      MFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • insertValue

      public void insertValue​(int index, float[] newValue)
      Insert a new value prior to the index location in the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Specified by:
      insertValue in interface MFColor
      Parameters:
      index - The position for the inserted value in the current array
      newValue - The newValue to insert
      See Also:
      X3DConcreteField.getTupleSize(String)
    • size

      public int size()
      Get the size of the underlying data array, meaning the number of simple SFColor elements for the given data type.
      Specified by:
      size in interface MField
      Returns:
      The number of SFColor elements in this field array.
    • clear

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

      public void remove​(int index)
      Remove one SFColor 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
    • getValue

      public void getValue​(float[][] valueDestination)
      Write out the current value of this field into the external valueDestination array.
      Specified by:
      getValue in interface MFColor
      Parameters:
      valueDestination - The array to be filled in with current field values.
      Throws:
      java.lang.ArrayIndexOutOfBoundsException - The provided valueDestination array was too small.
    • setValue

      public void setValue​(int size, float[][] newValue)
      Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFColor tuple size of 3.
      Specified by:
      setValue in interface MFColor
      Parameters:
      size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
      newValue - The replacement value array to (potentially) slice and then assign.
      See Also:
      X3DConcreteField.getTupleSize(String)
    • toFloatArray

      public float[] toFloatArray()
      Provide float array for this field type.
      Returns:
      Array of floats in this field array.
    • setValue

      public MFColorObject setValue​(MFColorObject newValue)
      Apply an MFColorObject value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      MFColorObject - 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