Package org.web3d.x3d.jsail.fields

Class SFColor

java.lang.Object

org.web3d.x3d.jsail.fields.X3DConcreteField

org.web3d.x3d.jsail.fields.SFColor

All Implemented Interfaces:

SFColor, X3DField

public class SFColor
extends X3DConcreteField
implements 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: 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

Fields

Modifier and Type	Field	Description
static float[]	ALICEBLUE
static float[]	ANTIQUEWHITE
static float[]	AQUA
static float[]	AQUAMARINE
static float[]	AZURE
static float[]	BEIGE
static float[]	BISQUE
static float[]	BLACK
static float[]	BLANCHEDALMOND
static float[]	BLUE
static float[]	BLUEVIOLET
static float[]	BROWN
static float[]	BURLYWOOD
static float[]	CADETBLUE
static float[]	CHARTREUSE
static float[]	CHOCOLATE
static float[]	CORAL
static float[]	CORNFLOWERBLUE
static float[]	CORNSILK
static float[]	CRIMSON
static float[]	CYAN
static float[]	DARKBLUE
static float[]	DARKCYAN
static float[]	DARKGOLDENROD
static float[]	DARKGRAY
static float[]	DARKGREEN
static float[]	DARKGREY
static float[]	DARKKHAKI
static float[]	DARKMAGENTA
static float[]	DARKOLIVEGREEN
static float[]	DARKORANGE
static float[]	DARKORCHID
static float[]	DARKRED
static float[]	DARKSALMON
static float[]	DARKSEAGREEN
static float[]	DARKSLATEBLUE
static float[]	DARKSLATEGRAY
static float[]	DARKSLATEGREY
static float[]	DARKTURQUOISE
static float[]	DARKVIOLET
static float[]	DEEPPINK
static float[]	DEEPSKYBLUE
static float[]	DEFAULT_VALUE	Default value for this field type is 0 0 0.
static String	DEFAULT_VALUE_STRING	Default string value for this field type is "0 0 0".
static float[]	DIMGRAY
static float[]	DIMGREY
static float[]	DODGERBLUE
static float[]	FIREBRICK
static float[]	FLORALWHITE
static float[]	FORESTGREEN
static float[]	FUCHSIA
static float[]	GAINSBORO
static float[]	GHOSTWHITE
static float[]	GOLD
static float[]	GOLDENROD
static float[]	GRAY
static float[]	GREEN
static float[]	GREENYELLOW
static float[]	GREY
static float[]	HONEYDEW
static float[]	HOTPINK
static float[]	INDIANRED
static float[]	INDIGO
static float[]	IVORY
static float[]	KHAKI
static float[]	LAVENDER
static float[]	LAVENDERBLUSH
static float[]	LAWNGREEN
static float[]	LEMONCHIFFON
static float[]	LIGHTBLUE
static float[]	LIGHTCORAL
static float[]	LIGHTCYAN
static float[]	LIGHTGOLDENRODYELLOW
static float[]	LIGHTGRAY
static float[]	LIGHTGREEN
static float[]	LIGHTGREY
static float[]	LIGHTPINK
static float[]	LIGHTSALMON
static float[]	LIGHTSEAGREEN
static float[]	LIGHTSKYBLUE
static float[]	LIGHTSLATEGRAY
static float[]	LIGHTSLATEGREY
static float[]	LIGHTSTEELBLUE
static float[]	LIGHTYELLOW
static float[]	LIME
static float[]	LIMEGREEN
static float[]	LINEN
static float[]	MAGENTA
static float[]	MAROON
static float[]	MEDIUMAQUAMARINE
static float[]	MEDIUMBLUE
static float[]	MEDIUMORCHID
static float[]	MEDIUMPURPLE
static float[]	MEDIUMSEAGREEN
static float[]	MEDIUMSLATEBLUE
static float[]	MEDIUMSPRINGGREEN
static float[]	MEDIUMTURQUOISE
static float[]	MEDIUMVIOLETRED
static float[]	MIDNIGHTBLUE
static float[]	MINTCREAM
static float[]	MISTYROSE
static float[]	MOCCASIN
static String	NAME	String constant NAME provides name of this element: SFColor
static float[]	NAVAJOWHITE
static float[]	NAVY
static float[]	OLDLACE
static float[]	OLIVE
static float[]	OLIVEDRAB
static float[]	ORANGE
static float[]	ORANGERED
static float[]	ORCHID
static float[]	PALEGOLDENROD
static float[]	PALEGREEN
static float[]	PALETURQUOISE
static float[]	PALEVIOLETRED
static float[]	PAPAYAWHIP
static Pattern	PATTERN	Precompiled regular expression (regex) pattern for this field type using default REGEX value.
static float[]	PEACHPUFF
static float[]	PERU
static float[]	PINK
static float[]	PLUM
static float[]	POWDERBLUE
static float[]	PURPLE
static float[]	RED
static String	REGEX	Default regular expression (regex) pattern for this field type is (\s)*(([+]?

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

validationResult

Constructor Summary

Constructors

Constructor	Description
SFColor()	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.
SFColor(SFColor newValue)	Constructor to copy an SFColor value as initial value for this new field object.

Method Summary

Modifier and Type	Method	Description
SFColor	complementRGB()	Complement all color values in RGB space (i.e. subtract each component from 1).
boolean	equals(SFColor comparisonSFColor)	Determine whether two objects contain equal values.
float[]	getPrimitiveValue()	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.
void	initialize()	Initialization for SFColor applies default initial value.
static boolean	isArray()	Whether or not this field type is an array (false)
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(String value)	Test PATTERN match with regular expression (regex) of provided value.
SFColor	normalizeClip()	Ensure all component color values are within range [0-1] by clipping as necessary.
SFColor	scaleRGB(float scaleFactor)	Scale all color values in RGB space.
SFColor	setValue(double[] newValue)	Assign a new value to this field.
SFColor	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.
SFColor	setValue(float red, float green, float blue)	Assign a new value to this field.
SFColor	setValue(int hexColorValue)	Public utility accessor method setting single HTML-style 0xRRGGBB hex value as new value.
SFColor	setValue(SFColor newValue)	Apply an SFColor value to this field.
SFColor	setValueArray(float[] newValue)	Assign a new array value to this field, pipelined.
SFColor	setValueByString(String newValue)	Utility accessor for SFColor using String value (which must pass parsing validation checks).
float[]	toFloatArray()	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.
String	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.
String	toStringCSS()	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.
String	toStringHTML()	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.
String	validate()	Validate current value via get/set comparison tests
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 org.web3d.x3d.jsail.fields.X3DConcreteField

addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: SFColor

See Also:

Constant Field Values

DEFAULT_VALUE

public static final float[] DEFAULT_VALUE

Default value for this field type is 0 0 0.

See Also:

Java Tutorials: Primitive Data Types

DEFAULT_VALUE_STRING

public static final String DEFAULT_VALUE_STRING

Default string value for this field type is "0 0 0".

See Also:

Constant Field Values

TUPLE_SIZE

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

See Also:

Constant Field Values

REGEX

public static final String 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)*

See Also:

PATTERN, matches(), matches(String), validate(), X3D Regular Expressions: SFColor, Constant Field Values

PATTERN

public static final Pattern PATTERN

Precompiled regular expression (regex) pattern for this field type using default REGEX value.

See Also:

REGEX, matches(), matches(String), validate(), java.util.regex.Pattern

ALICEBLUE

public static float[] ALICEBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

ANTIQUEWHITE

public static float[] ANTIQUEWHITE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

AQUA

public static float[] AQUA

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

AQUAMARINE

public static float[] AQUAMARINE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

AZURE

public static float[] AZURE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BEIGE

public static float[] BEIGE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BISQUE

public static float[] BISQUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BLACK

public static float[] BLACK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BLANCHEDALMOND

public static float[] BLANCHEDALMOND

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BLUE

public static float[] BLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BLUEVIOLET

public static float[] BLUEVIOLET

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BROWN

public static float[] BROWN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

BURLYWOOD

public static float[] BURLYWOOD

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CADETBLUE

public static float[] CADETBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CHARTREUSE

public static float[] CHARTREUSE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CHOCOLATE

public static float[] CHOCOLATE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CORAL

public static float[] CORAL

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CORNFLOWERBLUE

public static float[] CORNFLOWERBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CORNSILK

public static float[] CORNSILK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CRIMSON

public static float[] CRIMSON

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

CYAN

public static float[] CYAN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKBLUE

public static float[] DARKBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKCYAN

public static float[] DARKCYAN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKGOLDENROD

public static float[] DARKGOLDENROD

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKGRAY

public static float[] DARKGRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKGREEN

public static float[] DARKGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKGREY

public static float[] DARKGREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKKHAKI

public static float[] DARKKHAKI

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKMAGENTA

public static float[] DARKMAGENTA

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKOLIVEGREEN

public static float[] DARKOLIVEGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKORANGE

public static float[] DARKORANGE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKORCHID

public static float[] DARKORCHID

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKRED

public static float[] DARKRED

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKSALMON

public static float[] DARKSALMON

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKSEAGREEN

public static float[] DARKSEAGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKSLATEBLUE

public static float[] DARKSLATEBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKSLATEGRAY

public static float[] DARKSLATEGRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKSLATEGREY

public static float[] DARKSLATEGREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKTURQUOISE

public static float[] DARKTURQUOISE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DARKVIOLET

public static float[] DARKVIOLET

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DEEPPINK

public static float[] DEEPPINK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DEEPSKYBLUE

public static float[] DEEPSKYBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DIMGRAY

public static float[] DIMGRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DIMGREY

public static float[] DIMGREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

DODGERBLUE

public static float[] DODGERBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

FIREBRICK

public static float[] FIREBRICK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

FLORALWHITE

public static float[] FLORALWHITE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

FORESTGREEN

public static float[] FORESTGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

FUCHSIA

public static float[] FUCHSIA

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GAINSBORO

public static float[] GAINSBORO

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GHOSTWHITE

public static float[] GHOSTWHITE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GOLD

public static float[] GOLD

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GOLDENROD

public static float[] GOLDENROD

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GRAY

public static float[] GRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GREEN

public static float[] GREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GREENYELLOW

public static float[] GREENYELLOW

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

GREY

public static float[] GREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

HONEYDEW

public static float[] HONEYDEW

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

HOTPINK

public static float[] HOTPINK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

INDIANRED

public static float[] INDIANRED

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

INDIGO

public static float[] INDIGO

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

IVORY

public static float[] IVORY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

KHAKI

public static float[] KHAKI

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LAVENDER

public static float[] LAVENDER

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LAVENDERBLUSH

public static float[] LAVENDERBLUSH

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LAWNGREEN

public static float[] LAWNGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LEMONCHIFFON

public static float[] LEMONCHIFFON

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTBLUE

public static float[] LIGHTBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTCORAL

public static float[] LIGHTCORAL

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTCYAN

public static float[] LIGHTCYAN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGOLDENRODYELLOW

public static float[] LIGHTGOLDENRODYELLOW

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGRAY

public static float[] LIGHTGRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGREEN

public static float[] LIGHTGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGREY

public static float[] LIGHTGREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTPINK

public static float[] LIGHTPINK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSALMON

public static float[] LIGHTSALMON

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSEAGREEN

public static float[] LIGHTSEAGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSKYBLUE

public static float[] LIGHTSKYBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSLATEGRAY

public static float[] LIGHTSLATEGRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSLATEGREY

public static float[] LIGHTSLATEGREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSTEELBLUE

public static float[] LIGHTSTEELBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTYELLOW

public static float[] LIGHTYELLOW

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIME

public static float[] LIME

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LIMEGREEN

public static float[] LIMEGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

LINEN

public static float[] LINEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MAGENTA

public static float[] MAGENTA

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MAROON

public static float[] MAROON

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMAQUAMARINE

public static float[] MEDIUMAQUAMARINE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMBLUE

public static float[] MEDIUMBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMORCHID

public static float[] MEDIUMORCHID

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMPURPLE

public static float[] MEDIUMPURPLE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMSEAGREEN

public static float[] MEDIUMSEAGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMSLATEBLUE

public static float[] MEDIUMSLATEBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMSPRINGGREEN

public static float[] MEDIUMSPRINGGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMTURQUOISE

public static float[] MEDIUMTURQUOISE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMVIOLETRED

public static float[] MEDIUMVIOLETRED

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MIDNIGHTBLUE

public static float[] MIDNIGHTBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MINTCREAM

public static float[] MINTCREAM

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MISTYROSE

public static float[] MISTYROSE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

MOCCASIN

public static float[] MOCCASIN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

NAVAJOWHITE

public static float[] NAVAJOWHITE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

NAVY

public static float[] NAVY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

OLDLACE

public static float[] OLDLACE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

OLIVE

public static float[] OLIVE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

OLIVEDRAB

public static float[] OLIVEDRAB

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

ORANGE

public static float[] ORANGE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

ORANGERED

public static float[] ORANGERED

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

ORCHID

public static float[] ORCHID

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PALEGOLDENROD

public static float[] PALEGOLDENROD

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PALEGREEN

public static float[] PALEGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PALETURQUOISE

public static float[] PALETURQUOISE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PALEVIOLETRED

public static float[] PALEVIOLETRED

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PAPAYAWHIP

public static float[] PAPAYAWHIP

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PEACHPUFF

public static float[] PEACHPUFF

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PERU

public static float[] PERU

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PINK

public static float[] PINK

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PLUM

public static float[] PLUM

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

POWDERBLUE

public static float[] POWDERBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

PURPLE

public static float[] PURPLE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

RED

public static float[] RED

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

ROSYBROWN

public static float[] ROSYBROWN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

ROYALBLUE

public static float[] ROYALBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SADDLEBROWN

public static float[] SADDLEBROWN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SALMON

public static float[] SALMON

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SANDYBROWN

public static float[] SANDYBROWN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SEAGREEN

public static float[] SEAGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SEASHELL

public static float[] SEASHELL

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SIENNA

public static float[] SIENNA

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SILVER

public static float[] SILVER

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SKYBLUE

public static float[] SKYBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SLATEBLUE

public static float[] SLATEBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SLATEGRAY

public static float[] SLATEGRAY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SLATEGREY

public static float[] SLATEGREY

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SNOW

public static float[] SNOW

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

SPRINGGREEN

public static float[] SPRINGGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

STEELBLUE

public static float[] STEELBLUE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

TAN

public static float[] TAN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

TEAL

public static float[] TEAL

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

THISTLE

public static float[] THISTLE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

TOMATO

public static float[] TOMATO

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

TURQUOISE

public static float[] TURQUOISE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

VIOLET

public static float[] VIOLET

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

WHEAT

public static float[] WHEAT

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

WHITE

public static float[] WHITE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

WHITESMOKE

public static float[] WHITESMOKE

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

YELLOW

public static float[] YELLOW

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

YELLOWGREEN

public static float[] YELLOWGREEN

See Also:

CSS Color Module Level 3, 4.3. Extended color keywords

Constructor Details

SFColor

public SFColor()

Constructor for SFColor performs value initialization.

SFColor

public SFColor(SFColor newValue)

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:

X3D Scene Authoring Hints: Color

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:

X3D Scene Authoring Hints: Color

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:

X3D Scene Authoring Hints: Color

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 class X3DConcreteField

See Also:

Stack Overflow: How to check if a given Regex is valid?, DEFAULT_VALUE

equals

public boolean equals(SFColor comparisonSFColor)

Determine whether two objects contain equal values.

Parameters:

comparisonSFColor - field type to compare

Returns:

true if equivalent, false otherwise

validate

public final 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 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(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 SFColor setValueByString(String newValue)
                         throws InvalidFieldValueException

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:

X3DLoaderDOM.toX3dModelInstance(org.w3c.dom.Node)

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:

X3D Scene Authoring Hints: Color

setValue

public SFColor setValue(int hexColorValue)

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:

X3D Scene Authoring Hints: Color

complementRGB

public SFColor 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:

Wikipedia: Negative (photography), Wikipedia: Complementary colors, X3D Scene Authoring Hints: Color

scaleRGB

public SFColor scaleRGB(float scaleFactor)

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:

X3D Scene Authoring Hints: Color

normalizeClip

public SFColor 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:

X3D Scene Authoring Hints: Color

toStringHTML

public String toStringHTML()

Provide HTML color value for this object.

Returns:

HTML color value

See Also:

X3D Scene Authoring Hints: Color, HyperText Markup Language (HTML) 5.2, section 2.4.6 Colors, Cascading Style Sheets (CSS) Color Module Level 3, Java Tutorials: Formatting Numeric Print Output, stackoverflow: Integer to two digits hex in Java

toStringHTML

public static String toStringHTML(float red,
 float green,
 float blue)

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:

X3D Scene Authoring Hints: Color, HyperText Markup Language (HTML) 5.2, section 2.4.6 Colors, Cascading Style Sheets (CSS) Color Module Level 3, Java Tutorials: Formatting Numeric Print Output, stackoverflow: Integer to two digits hex in Java

toStringHTML

public static String toStringHTML(float[] colors)

Provide HTML color value for an RGB triplet.

Parameters:

colors - RGB triplet with values [0..1]

Returns:

HTML color value

See Also:

X3D Scene Authoring Hints: Color, HyperText Markup Language (HTML) 5.2, section 2.4.6 Colors, Cascading Style Sheets (CSS) Color Module Level 3, Java Tutorials: Formatting Numeric Print Output, stackoverflow: Integer to two digits hex in Java

toStringCSS

public String toStringCSS()

Provide CSS color value for this object.

Returns:

CSS color value

See Also:

X3D Scene Authoring Hints: Color, HyperText Markup Language (HTML) 5.2, section 2.4.6 Colors, Cascading Style Sheets (CSS) Color Module Level 3: section 4.2.1. RGB color values

toStringCSS

public static String toStringCSS(float red,
 float green,
 float blue)

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:

X3D Scene Authoring Hints: Color, HyperText Markup Language (HTML) 5.2, section 2.4.6 Colors, Cascading Style Sheets (CSS) Color Module Level 3: section 4.2.1. RGB color values

toStringCSS

public static String toStringCSS(float[] colors)

Provide CSS color value foran RGB triplet.

Parameters:

colors - RGB triplet with values [0..1]

Returns:

CSS color value

See Also:

X3D Scene Authoring Hints: Color, HyperText Markup Language (HTML) 5.2, section 2.4.6 Colors, Cascading Style Sheets (CSS) Color Module Level 3

setValue

public SFColor setValue(double[] 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.

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:

X3DConcreteField.getTupleSize(String)

toString

public static 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, SFFloat.stripTrailingZeroes(float)

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.

Specified by:

getValue in interface SFColor

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 String toString()

Provides current value as a String.

Overrides:

toString in class Object

Returns:

String version of the provided value, with trailing zeroes and decimal points omitted.

See Also:

X3D Tooltips: type SFColor, SFFloat.stripTrailingZeroes(float)

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.

Specified by:

setValue in interface SFColor

Parameters:

newValue - The replacement value to assign.

See Also:

X3DConcreteField.getTupleSize(String)

setValueArray

public SFColor setValueArray(float[] newValue)

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:

X3DConcreteField.getTupleSize(String)

setValue

public SFColor setValue(float red,
 float green,
 float blue)

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

public SFColor setValue(double red,
 double green,
 double blue)

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

public SFColor setValue(SFColor newValue)

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:

DEFAULT_VALUE