Class MFColor
java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.MFColor
This utility class provides a concrete implementation corresponding to MFColor X3D field type.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Note that SFColor 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, where each color value is an RGB triple of floating point numbers in range [0,1]. The default value of an uninitialized MFColor field is the empty list. Individual SFColor array values are optionally separated by commas in XML syntax.
Related field object:
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
Note that SFColor 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, where each color value is an RGB triple of floating point numbers in range [0,1]. The default value of an uninitialized MFColor field is the empty list. Individual SFColor array values are optionally separated by commas in XML syntax.
Related field object:
SFColor
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final float[]
Default value for this field type is an empty array.static final String
Default string value for this field type is "".static final String
String constant NAME provides name of this element: MFColorstatic final Pattern
Precompiled regular expression (regex) pattern for this field type using default REGEX value.static final String
Default regular expression (regex) pattern for this field type is \s*((([+-]?static final int
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
ConstructorsConstructorDescriptionMFColor()
Constructor for MFColor performs value initialization.MFColor
(double[] newValue) Utility constructor for MFColor using an alternatively typed Java double[] array as new initial value.MFColor
(float[] newValue) Constructor for MFColor using a corresponding Java primitive float[] array as new initial value.Constructor to copy an MFColor value as initial value for this new field object.Utility constructor for MFColor to assign a single SFColor as new initial value. -
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(float[] newValue) Places new value(s) at the end of the existing value array, increasing the field length accordingly.Appends a new MFColor to the end of the existing value array, increasing the field length accordingly.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.Complement all color values in RGB space (i.e. subtract each component from 1).boolean
Determine whether two objects contain equal values.void
get1Value
(int index, float[] destinationValue) Get an individual value from the existing field array.float[]
Provides current value of the field as a Java primitive type.void
getValue
(float[] valueDestination) Get the current value of this MFColor 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.final void
Initialization for MFColor 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 final boolean
isArray()
Whether or not this field type is an array (true)boolean
Determine whether current value matches DEFAULT_VALUEfinal boolean
matches()
Test PATTERN match via regular expression (regex) check of current object's toString() value.static final boolean
Test PATTERN match with regular expression (regex) of provided value.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.set1Value
(int index, int hexColorValue) Replace a single value at the appropriate location in the existing value array.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.Apply an MFColor value to this field.Assign a single-field SFColor as new array value.setValueByString
(String newValue) Utility accessor for MFColor 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[]
Provide float array for this field type.toString()
Provides current value as a String.static String
toString
(float[] value) Static utility method to provide String representation of a correctly typed input value.final String
validate()
Validate current value via get/set comparison testsfinal String
Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.Methods inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField
addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable
-
Field Details
-
NAME
String constant NAME provides name of this element: MFColor- See Also:
-
DEFAULT_VALUE
public static final float[] DEFAULT_VALUEDefault value for this field type is an empty array.- See Also:
-
DEFAULT_VALUE_STRING
Default string value for this field type is "".- See Also:
-
TUPLE_SIZE
public static final int TUPLE_SIZEDefault tuple size for this field type is 3 (i.e. number of component values making up a single-field SF object).- See Also:
-
REGEX
Default regular expression (regex) pattern for this field type is \s*((([+-]?((0(\.[0-9]*)?|\.[0-9]+)|1(\.0*)?)([Ee][+-]?[0-9]+)?)\s+){2}([+-]?((0(\.[0-9]*)?|\.[0-9]+)|1(\.0*)?)([Ee][+-]?[0-9]+)?)\s*,?\s*)*- See Also:
-
PATTERN
Precompiled regular expression (regex) pattern for this field type using default REGEX value.- See Also:
-
-
Constructor Details
-
MFColor
public MFColor()Constructor for MFColor performs value initialization. -
MFColor
Constructor to copy an MFColor value as initial value for this new field object.- Parameters:
newValue
- The newValue to apply
-
MFColor
public MFColor(float[] newValue) Constructor for MFColor 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)
-
MFColor
Utility constructor for MFColor to assign a single SFColor as new initial value.- Parameters:
newValue
- is new value to assign
-
MFColor
public MFColor(double[] newValue) Utility constructor for MFColor 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)- Returns:
- true if array type
-
initialize
public final void initialize()Initialization for MFColor applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.- Specified by:
initialize
in classX3DConcreteField
- See Also:
-
equals
Determine whether two objects contain equal values.- Parameters:
comparisonMFColor
- field type to compare- Returns:
- true if equivalent, false otherwise
-
validate
Validate current value via get/set comparison tests- Returns:
- empty string if get/set testing passes, warning otherwise
- See Also:
-
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:
-
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:
-
matches
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:
-
setValueByString
Utility accessor for MFColor 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:
MFMatrix4d
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).- Throws:
InvalidFieldValueException
- See Also:
-
set1Value
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 arrayhexColorValue
- HTML color value (such as 0xAA2288) to apply- Returns:
MFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- Throws:
ArrayIndexOutOfBoundsException
- See Also:
-
complementRGB
-
normalizeClip
-
toString
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:
-
getValue
-
getPrimitiveValue
public float[] getPrimitiveValue()Provides current value of the field as a Java primitive type.- Returns:
- current value
-
toString
-
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 interfaceMFColor
- Parameters:
index
- is position of selected value in current arraydestinationValue
- where to place result for selected value- Throws:
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. -
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:
-
setValue
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:
MFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setValue
-
set1Value
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 interfaceMFColor
- Parameters:
index
- is position of selected value in current arraynewValue
- provides new value to apply- Throws:
ArrayIndexOutOfBoundsException
- See Also:
-
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. -
append
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:
MFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
append
Appends a new MFColor 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:
MFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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 interfaceMFColor
- Parameters:
index
- The position for the inserted value in the current arraynewValue
- The newValue to insert- See Also:
-
size
-
clear
-
remove
-
getValue
public void getValue(float[][] valueDestination) Write out the current value of this field into the external valueDestination array.- Specified by:
getValue
in interfaceMFColor
- Parameters:
valueDestination
- The array to be filled in with current field values.- Throws:
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. -
toFloatArray
public float[] toFloatArray()Provide float array for this field type.- Returns:
- Array of floats in this field array.
-
setValue
-
isDefaultValue
public boolean isDefaultValue()Determine whether current value matches DEFAULT_VALUE- Returns:
- whether current value matches DEFAULT_VALUE
- See Also:
-