Package org.web3d.x3d.jsail.fields
Class SFColor
java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFColor
This utility class provides a concrete implementation corresponding to SFColor X3D field type.
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). SFColor specifies one RGB (red-green-blue) color triple, where each color value is an RGB triple of floating point numbers in range [0,1]. The default value of an uninitialized SFColor field is (0 0 0). Warning: comma characters within singleton values do not pass strict XML validation.
Related field object:
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). SFColor specifies one RGB (red-green-blue) color triple, where each color value is an RGB triple of floating point numbers in range [0,1]. The default value of an uninitialized SFColor field is (0 0 0). Warning: comma characters within singleton values do not pass strict XML validation.
Related field object:
MFColor
- See Also:
-
- X3D Tooltips: type SFColor
- 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 * @see CSS Color Module Level 3, 4.3. Extended color keywords
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static final float[]
Default value for this field type is 0 0 0.static final String
Default string value for this field type is "0 0 0".static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static final String
String constant NAME provides name of this element: SFColorstatic float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static final Pattern
Precompiled regular expression (regex) pattern for this field type using default REGEX value.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static final String
Default regular expression (regex) pattern for this field type is \s*(([+]?static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.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).static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.static float[]
Color value alias.Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField
validationResult
-
Constructor Summary
ConstructorsConstructorDescriptionSFColor()
Constructor for SFColor performs value initialization.SFColor
(double[] newValue) Utility constructor for SFColor using an alternatively typed Java double[] array as new initial value.SFColor
(double red, double green, double blue) Constructor using individual double types as new initial value (which must pass validation checks).SFColor
(float[] newValue) Constructor for SFColor using a corresponding Java primitive float[] array as new initial value.SFColor
(float red, float green, float blue) Constructor using individual float types as new initial value (which must pass validation checks).SFColor
(int hexColorValue) Constructor using single HTML-style 0xRRGGBB hex value as new initial value.Constructor to copy an SFColor value as initial value for this new field object. -
Method Summary
Modifier and TypeMethodDescriptionComplement all color values in RGB space (i.e. subtract each component from 1).boolean
Determine whether two objects contain equal values.float[]
Provides current value of the field as a Java primitive type.void
getValue
(float[] valueDestination) Get the current value of this SFColor by copying it into the valueDestination array, leaving the current object unchanged.final void
Initialization for SFColor applies default initial value.static final boolean
isArray()
Whether or not this field type is an array (false)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.scaleRGB
(float scaleFactor) Scale all color values in RGB space.setValue
(double[] newValue) Assign a new value to this field.setValue
(double red, double green, double blue) Assign a new value to this field.void
setValue
(float[] newValue) Assign a new value to this field.setValue
(float red, float green, float blue) Assign a new value to this field.setValue
(int hexColorValue) Public utility accessor method setting single HTML-style 0xRRGGBB hex value as new value.Apply an SFColor value to this field.setValueArray
(float[] newValue) Assign a new array value to this field, pipelined.setValueByString
(String newValue) Utility accessor for SFColor using String value (which must pass parsing validation checks).float[]
Provide float array for this field type.static float[]
toFloatArray
(int hexColorValue) Public utility method converting single HTML-style 0xRRGGBB hex value to three-tuple float array.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.Provide CSS color value for this object.static String
toStringCSS
(float[] colors) Provide CSS color value foran RGB triplet.static String
toStringCSS
(float red, float green, float blue) Provide CSS color value for RGB values.Provide HTML color value for this object.static String
toStringHTML
(float[] colors) Provide HTML color value for an RGB triplet.static String
toStringHTML
(float red, float green, float blue) Provide HTML color value for RGB values.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: SFColor- See Also:
-
DEFAULT_VALUE
public static final float[] DEFAULT_VALUEDefault value for this field type is 0 0 0.- See Also:
-
DEFAULT_VALUE_STRING
Default string value for this field type is "0 0 0".- 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* -
PATTERN
Precompiled regular expression (regex) pattern for this field type using default REGEX value. -
ALICEBLUE
public static float[] ALICEBLUEColor value alias. -
ANTIQUEWHITE
public static float[] ANTIQUEWHITEColor value alias. -
AQUA
public static float[] AQUAColor value alias. -
AQUAMARINE
public static float[] AQUAMARINEColor value alias. -
AZURE
public static float[] AZUREColor value alias. -
BEIGE
public static float[] BEIGEColor value alias. -
BISQUE
public static float[] BISQUEColor value alias. -
BLACK
public static float[] BLACKColor value alias. -
BLANCHEDALMOND
public static float[] BLANCHEDALMONDColor value alias. -
BLUE
public static float[] BLUEColor value alias. -
BLUEVIOLET
public static float[] BLUEVIOLETColor value alias. -
BROWN
public static float[] BROWNColor value alias. -
BURLYWOOD
public static float[] BURLYWOODColor value alias. -
CADETBLUE
public static float[] CADETBLUEColor value alias. -
CHARTREUSE
public static float[] CHARTREUSEColor value alias. -
CHOCOLATE
public static float[] CHOCOLATEColor value alias. -
CORAL
public static float[] CORALColor value alias. -
CORNFLOWERBLUE
public static float[] CORNFLOWERBLUEColor value alias. -
CORNSILK
public static float[] CORNSILKColor value alias. -
CRIMSON
public static float[] CRIMSONColor value alias. -
CYAN
public static float[] CYANColor value alias. -
DARKBLUE
public static float[] DARKBLUEColor value alias. -
DARKCYAN
public static float[] DARKCYANColor value alias. -
DARKGOLDENROD
public static float[] DARKGOLDENRODColor value alias. -
DARKGRAY
public static float[] DARKGRAYColor value alias. -
DARKGREEN
public static float[] DARKGREENColor value alias. -
DARKGREY
public static float[] DARKGREYColor value alias. -
DARKKHAKI
public static float[] DARKKHAKIColor value alias. -
DARKMAGENTA
public static float[] DARKMAGENTAColor value alias. -
DARKOLIVEGREEN
public static float[] DARKOLIVEGREENColor value alias. -
DARKORANGE
public static float[] DARKORANGEColor value alias. -
DARKORCHID
public static float[] DARKORCHIDColor value alias. -
DARKRED
public static float[] DARKREDColor value alias. -
DARKSALMON
public static float[] DARKSALMONColor value alias. -
DARKSEAGREEN
public static float[] DARKSEAGREENColor value alias. -
DARKSLATEBLUE
public static float[] DARKSLATEBLUEColor value alias. -
DARKSLATEGRAY
public static float[] DARKSLATEGRAYColor value alias. -
DARKSLATEGREY
public static float[] DARKSLATEGREYColor value alias. -
DARKTURQUOISE
public static float[] DARKTURQUOISEColor value alias. -
DARKVIOLET
public static float[] DARKVIOLETColor value alias. -
DEEPPINK
public static float[] DEEPPINKColor value alias. -
DEEPSKYBLUE
public static float[] DEEPSKYBLUEColor value alias. -
DIMGRAY
public static float[] DIMGRAYColor value alias. -
DIMGREY
public static float[] DIMGREYColor value alias. -
DODGERBLUE
public static float[] DODGERBLUEColor value alias. -
FIREBRICK
public static float[] FIREBRICKColor value alias. -
FLORALWHITE
public static float[] FLORALWHITEColor value alias. -
FORESTGREEN
public static float[] FORESTGREENColor value alias. -
FUCHSIA
public static float[] FUCHSIAColor value alias. -
GAINSBORO
public static float[] GAINSBOROColor value alias. -
GHOSTWHITE
public static float[] GHOSTWHITEColor value alias. -
GOLD
public static float[] GOLDColor value alias. -
GOLDENROD
public static float[] GOLDENRODColor value alias. -
GRAY
public static float[] GRAYColor value alias. -
GREEN
public static float[] GREENColor value alias. -
GREENYELLOW
public static float[] GREENYELLOWColor value alias. -
GREY
public static float[] GREYColor value alias. -
HONEYDEW
public static float[] HONEYDEWColor value alias. -
HOTPINK
public static float[] HOTPINKColor value alias. -
INDIANRED
public static float[] INDIANREDColor value alias. -
INDIGO
public static float[] INDIGOColor value alias. -
IVORY
public static float[] IVORYColor value alias. -
KHAKI
public static float[] KHAKIColor value alias. -
LAVENDER
public static float[] LAVENDERColor value alias. -
LAVENDERBLUSH
public static float[] LAVENDERBLUSHColor value alias. -
LAWNGREEN
public static float[] LAWNGREENColor value alias. -
LEMONCHIFFON
public static float[] LEMONCHIFFONColor value alias. -
LIGHTBLUE
public static float[] LIGHTBLUEColor value alias. -
LIGHTCORAL
public static float[] LIGHTCORALColor value alias. -
LIGHTCYAN
public static float[] LIGHTCYANColor value alias. -
LIGHTGOLDENRODYELLOW
public static float[] LIGHTGOLDENRODYELLOWColor value alias. -
LIGHTGRAY
public static float[] LIGHTGRAYColor value alias. -
LIGHTGREEN
public static float[] LIGHTGREENColor value alias. -
LIGHTGREY
public static float[] LIGHTGREYColor value alias. -
LIGHTPINK
public static float[] LIGHTPINKColor value alias. -
LIGHTSALMON
public static float[] LIGHTSALMONColor value alias. -
LIGHTSEAGREEN
public static float[] LIGHTSEAGREENColor value alias. -
LIGHTSKYBLUE
public static float[] LIGHTSKYBLUEColor value alias. -
LIGHTSLATEGRAY
public static float[] LIGHTSLATEGRAYColor value alias. -
LIGHTSLATEGREY
public static float[] LIGHTSLATEGREYColor value alias. -
LIGHTSTEELBLUE
public static float[] LIGHTSTEELBLUEColor value alias. -
LIGHTYELLOW
public static float[] LIGHTYELLOWColor value alias. -
LIME
public static float[] LIMEColor value alias. -
LIMEGREEN
public static float[] LIMEGREENColor value alias. -
LINEN
public static float[] LINENColor value alias. -
MAGENTA
public static float[] MAGENTAColor value alias. -
MAROON
public static float[] MAROONColor value alias. -
MEDIUMAQUAMARINE
public static float[] MEDIUMAQUAMARINEColor value alias. -
MEDIUMBLUE
public static float[] MEDIUMBLUEColor value alias. -
MEDIUMORCHID
public static float[] MEDIUMORCHIDColor value alias. -
MEDIUMPURPLE
public static float[] MEDIUMPURPLEColor value alias. -
MEDIUMSEAGREEN
public static float[] MEDIUMSEAGREENColor value alias. -
MEDIUMSLATEBLUE
public static float[] MEDIUMSLATEBLUEColor value alias. -
MEDIUMSPRINGGREEN
public static float[] MEDIUMSPRINGGREENColor value alias. -
MEDIUMTURQUOISE
public static float[] MEDIUMTURQUOISEColor value alias. -
MEDIUMVIOLETRED
public static float[] MEDIUMVIOLETREDColor value alias. -
MIDNIGHTBLUE
public static float[] MIDNIGHTBLUEColor value alias. -
MINTCREAM
public static float[] MINTCREAMColor value alias. -
MISTYROSE
public static float[] MISTYROSEColor value alias. -
MOCCASIN
public static float[] MOCCASINColor value alias. -
NAVAJOWHITE
public static float[] NAVAJOWHITEColor value alias. -
NAVY
public static float[] NAVYColor value alias. -
OLDLACE
public static float[] OLDLACEColor value alias. -
OLIVE
public static float[] OLIVEColor value alias. -
OLIVEDRAB
public static float[] OLIVEDRABColor value alias. -
ORANGE
public static float[] ORANGEColor value alias. -
ORANGERED
public static float[] ORANGEREDColor value alias. -
ORCHID
public static float[] ORCHIDColor value alias. -
PALEGOLDENROD
public static float[] PALEGOLDENRODColor value alias. -
PALEGREEN
public static float[] PALEGREENColor value alias. -
PALETURQUOISE
public static float[] PALETURQUOISEColor value alias. -
PALEVIOLETRED
public static float[] PALEVIOLETREDColor value alias. -
PAPAYAWHIP
public static float[] PAPAYAWHIPColor value alias. -
PEACHPUFF
public static float[] PEACHPUFFColor value alias. -
PERU
public static float[] PERUColor value alias. -
PINK
public static float[] PINKColor value alias. -
PLUM
public static float[] PLUMColor value alias. -
POWDERBLUE
public static float[] POWDERBLUEColor value alias. -
PURPLE
public static float[] PURPLEColor value alias. -
RED
public static float[] REDColor value alias. -
ROSYBROWN
public static float[] ROSYBROWNColor value alias. -
ROYALBLUE
public static float[] ROYALBLUEColor value alias. -
SADDLEBROWN
public static float[] SADDLEBROWNColor value alias. -
SALMON
public static float[] SALMONColor value alias. -
SANDYBROWN
public static float[] SANDYBROWNColor value alias. -
SEAGREEN
public static float[] SEAGREENColor value alias. -
SEASHELL
public static float[] SEASHELLColor value alias. -
SIENNA
public static float[] SIENNAColor value alias. -
SILVER
public static float[] SILVERColor value alias. -
SKYBLUE
public static float[] SKYBLUEColor value alias. -
SLATEBLUE
public static float[] SLATEBLUEColor value alias. -
SLATEGRAY
public static float[] SLATEGRAYColor value alias. -
SLATEGREY
public static float[] SLATEGREYColor value alias. -
SNOW
public static float[] SNOWColor value alias. -
SPRINGGREEN
public static float[] SPRINGGREENColor value alias. -
STEELBLUE
public static float[] STEELBLUEColor value alias. -
TAN
public static float[] TANColor value alias. -
TEAL
public static float[] TEALColor value alias. -
THISTLE
public static float[] THISTLEColor value alias. -
TOMATO
public static float[] TOMATOColor value alias. -
TURQUOISE
public static float[] TURQUOISEColor value alias. -
VIOLET
public static float[] VIOLETColor value alias. -
WHEAT
public static float[] WHEATColor value alias. -
WHITE
public static float[] WHITEColor value alias. -
WHITESMOKE
public static float[] WHITESMOKEColor value alias. -
YELLOW
public static float[] YELLOWColor value alias. -
YELLOWGREEN
public static float[] YELLOWGREENColor value alias.
-
-
Constructor Details
-
SFColor
public SFColor()Constructor for SFColor performs value initialization. -
SFColor
Constructor to copy an SFColor value as initial value for this new field object.- Parameters:
newValue
- The newValue to apply
-
SFColor
public SFColor(float[] newValue) Constructor for SFColor 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 SFColor tuple size of 3. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
-
SFColor
public SFColor(float red, float green, float blue) Constructor using individual float types as new initial value (which must pass validation checks).- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- See Also:
-
SFColor
public SFColor(double red, double green, double blue) Constructor using individual double types as new initial value (which must pass validation checks).- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- See Also:
-
SFColor
public SFColor(int hexColorValue) Constructor using single HTML-style 0xRRGGBB hex value as new initial value.- Parameters:
hexColorValue
- HTML color value (such as 0xAA2288)- See Also:
-
SFColor
public SFColor(double[] newValue) Utility constructor for SFColor 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 (false)- Returns:
- true if array type
-
initialize
public final void initialize()Initialization for SFColor 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:
comparisonSFColor
- 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 SFColor 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:
-
toFloatArray
public static float[] toFloatArray(int hexColorValue) Public utility method converting single HTML-style 0xRRGGBB hex value to three-tuple float array. TODO: also MFColor.- Parameters:
hexColorValue
- HTML color value (such as 0xAA2288)- Returns:
- float[3] array containing X3D RGB values, each ranging [0..1]
- See Also:
-
setValue
Public utility accessor method setting single HTML-style 0xRRGGBB hex value as new value.- Parameters:
hexColorValue
- HTML color value (such as 0xAA2288)- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
complementRGB
Complement all color values in RGB space (i.e. subtract each component from 1).- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
scaleRGB
Scale all color values in RGB space.- Parameters:
scaleFactor
- nonnegative scaling factor- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
normalizeClip
Ensure all component color values are within range [0-1] by clipping as necessary.- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
toStringHTML
Provide HTML color value for this object. -
toStringHTML
Provide HTML color value for RGB values.- Parameters:
red
- red value [0..1]green
- value value [0..1]blue
- blue value [0..1]- Returns:
- HTML color value
- See Also:
-
toStringHTML
Provide HTML color value for an RGB triplet.- Parameters:
colors
- RGB triplet with values [0..1]- Returns:
- HTML color value
- See Also:
-
toStringCSS
Provide CSS color value for this object. -
toStringCSS
Provide CSS color value for RGB values.- Parameters:
red
- red value [0..1]green
- value value [0..1]blue
- blue value [0..1]- Returns:
- CSS color value
- See Also:
-
toStringCSS
Provide CSS color value foran RGB triplet.- Parameters:
colors
- RGB triplet with values [0..1]- Returns:
- CSS color value
- See Also:
-
setValue
Assign a new value to this field. Warning: newValue array length must correspond to tuple size for base type SFColor tuple size of 3.- Parameters:
newValue
- The replacement value to assign.- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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
public void getValue(float[] valueDestination) Get the current value of this SFColor by copying it into the valueDestination array, leaving the current object unchanged. -
getPrimitiveValue
public float[] getPrimitiveValue()Provides current value of the field as a Java primitive type.- Returns:
- current value
-
toString
Provides current value as a String. -
setValue
public void setValue(float[] newValue) Assign a new value to this field. Warning: newValue array length must correspond to tuple size for base type SFColor tuple size of 3. -
setValueArray
Assign a new array value to this field, pipelined. This is an alternate utility method since primary method returns void and cannot be overridden. Warning: newValue array length must correspond to tuple size for base type SFColor tuple size of 3.- Parameters:
newValue
- The replacement value to assign.- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setValue
Assign a new value to this field.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setValue
Assign a new value to this field.- Parameters:
red
- first component [0..1]green
- second component [0..1]blue
- third component [0..1]- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
toFloatArray
public float[] toFloatArray()Provide float array for this field type.- Returns:
- Array of floats in this field array.
-
setValue
Apply an SFColor value to this field.- Parameters:
newValue
- The newValue to apply- Returns:
SFColor
- 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:
-