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	Color value alias.
static float[]	ANTIQUEWHITE	Color value alias.
static float[]	AQUA	Color value alias.
static float[]	AQUAMARINE	Color value alias.
static float[]	AZURE	Color value alias.
static float[]	BEIGE	Color value alias.
static float[]	BISQUE	Color value alias.
static float[]	BLACK	Color value alias.
static float[]	BLANCHEDALMOND	Color value alias.
static float[]	BLUE	Color value alias.
static float[]	BLUEVIOLET	Color value alias.
static float[]	BROWN	Color value alias.
static float[]	BURLYWOOD	Color value alias.
static float[]	CADETBLUE	Color value alias.
static float[]	CHARTREUSE	Color value alias.
static float[]	CHOCOLATE	Color value alias.
static float[]	CORAL	Color value alias.
static float[]	CORNFLOWERBLUE	Color value alias.
static float[]	CORNSILK	Color value alias.
static float[]	CRIMSON	Color value alias.
static float[]	CYAN	Color value alias.
static float[]	DARKBLUE	Color value alias.
static float[]	DARKCYAN	Color value alias.
static float[]	DARKGOLDENROD	Color value alias.
static float[]	DARKGRAY	Color value alias.
static float[]	DARKGREEN	Color value alias.
static float[]	DARKGREY	Color value alias.
static float[]	DARKKHAKI	Color value alias.
static float[]	DARKMAGENTA	Color value alias.
static float[]	DARKOLIVEGREEN	Color value alias.
static float[]	DARKORANGE	Color value alias.
static float[]	DARKORCHID	Color value alias.
static float[]	DARKRED	Color value alias.
static float[]	DARKSALMON	Color value alias.
static float[]	DARKSEAGREEN	Color value alias.
static float[]	DARKSLATEBLUE	Color value alias.
static float[]	DARKSLATEGRAY	Color value alias.
static float[]	DARKSLATEGREY	Color value alias.
static float[]	DARKTURQUOISE	Color value alias.
static float[]	DARKVIOLET	Color value alias.
static float[]	DEEPPINK	Color value alias.
static float[]	DEEPSKYBLUE	Color value alias.
static final float[]	DEFAULT_VALUE	Default value for this field type is 0 0 0.
static final String	DEFAULT_VALUE_STRING	Default string value for this field type is "0 0 0".
static float[]	DIMGRAY	Color value alias.
static float[]	DIMGREY	Color value alias.
static float[]	DODGERBLUE	Color value alias.
static float[]	FIREBRICK	Color value alias.
static float[]	FLORALWHITE	Color value alias.
static float[]	FORESTGREEN	Color value alias.
static DecimalFormat	formatPrecision	DecimalFormat matching local number of significant digits for floating-point and double-precision String output
static float[]	FUCHSIA	Color value alias.
static float[]	GAINSBORO	Color value alias.
static float[]	GHOSTWHITE	Color value alias.
static float[]	GOLD	Color value alias.
static float[]	GOLDENROD	Color value alias.
static float[]	GRAY	Color value alias.
static float[]	GREEN	Color value alias.
static float[]	GREENYELLOW	Color value alias.
static float[]	GREY	Color value alias.
static float[]	HONEYDEW	Color value alias.
static float[]	HOTPINK	Color value alias.
static float[]	INDIANRED	Color value alias.
static float[]	INDIGO	Color value alias.
static float[]	IVORY	Color value alias.
static float[]	KHAKI	Color value alias.
static float[]	LAVENDER	Color value alias.
static float[]	LAVENDERBLUSH	Color value alias.
static float[]	LAWNGREEN	Color value alias.
static float[]	LEMONCHIFFON	Color value alias.
static float[]	LIGHTBLUE	Color value alias.
static float[]	LIGHTCORAL	Color value alias.
static float[]	LIGHTCYAN	Color value alias.
static float[]	LIGHTGOLDENRODYELLOW	Color value alias.
static float[]	LIGHTGRAY	Color value alias.
static float[]	LIGHTGREEN	Color value alias.
static float[]	LIGHTGREY	Color value alias.
static float[]	LIGHTPINK	Color value alias.
static float[]	LIGHTSALMON	Color value alias.
static float[]	LIGHTSEAGREEN	Color value alias.
static float[]	LIGHTSKYBLUE	Color value alias.
static float[]	LIGHTSLATEGRAY	Color value alias.
static float[]	LIGHTSLATEGREY	Color value alias.
static float[]	LIGHTSTEELBLUE	Color value alias.
static float[]	LIGHTYELLOW	Color value alias.
static float[]	LIME	Color value alias.
static float[]	LIMEGREEN	Color value alias.
static float[]	LINEN	Color value alias.
static float[]	MAGENTA	Color value alias.
static float[]	MAROON	Color value alias.
static float[]	MEDIUMAQUAMARINE	Color value alias.
static float[]	MEDIUMBLUE	Color value alias.
static float[]	MEDIUMORCHID	Color value alias.
static float[]	MEDIUMPURPLE	Color value alias.
static float[]	MEDIUMSEAGREEN	Color value alias.
static float[]	MEDIUMSLATEBLUE	Color value alias.
static float[]	MEDIUMSPRINGGREEN	Color value alias.
static float[]	MEDIUMTURQUOISE	Color value alias.
static float[]	MEDIUMVIOLETRED	Color value alias.
static float[]	MIDNIGHTBLUE	Color value alias.
static float[]	MINTCREAM	Color value alias.
static float[]	MISTYROSE	Color value alias.
static float[]	MOCCASIN	Color value alias.
static final String	NAME	String constant NAME provides name of this field type: SFColor
static float[]	NAVAJOWHITE	Color value alias.
static float[]	NAVY	Color value alias.
static float[]	OLDLACE	Color value alias.
static float[]	OLIVE	Color value alias.
static float[]	OLIVEDRAB	Color value alias.
static float[]	ORANGE	Color value alias.
static float[]	ORANGERED	Color value alias.
static float[]	ORCHID	Color value alias.
static float[]	PALEGOLDENROD	Color value alias.
static float[]	PALEGREEN	Color value alias.
static float[]	PALETURQUOISE	Color value alias.
static float[]	PALEVIOLETRED	Color value alias.
static float[]	PAPAYAWHIP	Color value alias.
static final Pattern	PATTERN	Precompiled regular expression (regex) pattern for this field type using default REGEX value.
static float[]	PEACHPUFF	Color value alias.
static float[]	PERU	Color value alias.
static float[]	PINK	Color value alias.
static float[]	PLUM	Color value alias.
static float[]	POWDERBLUE	Color value alias.
static float[]	PURPLE	Color value alias.
static float[]	RED	Color value alias.
static final String	REGEX	Default regular expression (regex) pattern for this field type is \s*(([+]?
static float[]	ROSYBROWN	Color value alias.
static float[]	ROYALBLUE	Color value alias.
static float[]	SADDLEBROWN	Color value alias.
static float[]	SALMON	Color value alias.
static float[]	SANDYBROWN	Color value alias.
static float[]	SEAGREEN	Color value alias.
static float[]	SEASHELL	Color value alias.
static float[]	SIENNA	Color value alias.
static float[]	SILVER	Color value alias.
static float[]	SKYBLUE	Color value alias.
static float[]	SLATEBLUE	Color value alias.
static float[]	SLATEGRAY	Color value alias.
static float[]	SLATEGREY	Color value alias.
static float[]	SNOW	Color value alias.
static float[]	SPRINGGREEN	Color value alias.
static float[]	STEELBLUE	Color value alias.
static float[]	TAN	Color value alias.
static float[]	TEAL	Color value alias.
static float[]	THISTLE	Color value alias.
static float[]	TOMATO	Color value alias.
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).
static float[]	TURQUOISE	Color value alias.
static float[]	VIOLET	Color value alias.
static float[]	WHEAT	Color value alias.
static float[]	WHITE	Color value alias.
static float[]	WHITESMOKE	Color value alias.
static float[]	YELLOW	Color value alias.
static float[]	YELLOWGREEN	Color value alias.

Fields inherited from class X3DConcreteField

validationResult

Modifier and Type	Field	Description
protected static StringBuilder	validationResult	Results log of local validation.

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(float[] comparisonValue)	Determine whether current SFColor object and float array contain equal values.
boolean	equals(SFColor comparisonSFColor)	Determine whether current object and another SFColor object contain equal values.
float	getEpsilon()	Current error bound for numerical comparison of values for equality
float[]	getPrimitiveValue()	Provides current value of the field as a Java primitive type.
int	getSignificantDigits()	Current significant digits for floating-point and double-precision String output
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	initialize()	Initialization for SFColor applies default initial value.
static final boolean	isArray()	Whether or not this field type is an array (false)
boolean	isDefaultValue()	Determine whether current value matches DEFAULT_VALUE
final boolean	matches()	Test PATTERN match via regular expression (regex) check of current object's toString() value.
static final 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.
void	setEpsilon(float newEpsilon)	Set revised error bound for numerical comparison of values for equality
void	setSignificantDigits(int newSignificantDigits)	Set revised number of significant digits for floating-point and double-precision String output
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.
final String	validate()	Validate current value via get/set comparison tests
final 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 X3DConcreteField

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

Modifier and Type	Method	Description
void	addX3DEventListener(X3DFieldEventListener newListener)	WARNING not tested
X3DConcreteFieldDefinition	getDefinition()	WARNING not implemented
static int	getTupleSize(String fieldType)	Compute tuple size for given type (for example, SFVec3f and MFVec3f have tupleSize of 3).
String	getValidationResult()	Get output of results from prior validation, if any
boolean	isReadable()	Check whether field is readable, default /true/
boolean	isWritable()	Check whether field is writable, default /true/
void	removeX3DEventListener(X3DFieldEventListener oldListener)	WARNING not tested
void	setReadable(boolean newValue)	Set whether field is readable
void	setWritable(boolean newValue)	Set whether field is writable

Methods inherited from class 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 field type: 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

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

ANTIQUEWHITE

public static float[] ANTIQUEWHITE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

AQUA

public static float[] AQUA

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

AQUAMARINE

public static float[] AQUAMARINE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

AZURE

public static float[] AZURE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BEIGE

public static float[] BEIGE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BISQUE

public static float[] BISQUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BLACK

public static float[] BLACK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BLANCHEDALMOND

public static float[] BLANCHEDALMOND

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BLUE

public static float[] BLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BLUEVIOLET

public static float[] BLUEVIOLET

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BROWN

public static float[] BROWN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

BURLYWOOD

public static float[] BURLYWOOD

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CADETBLUE

public static float[] CADETBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CHARTREUSE

public static float[] CHARTREUSE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CHOCOLATE

public static float[] CHOCOLATE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CORAL

public static float[] CORAL

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CORNFLOWERBLUE

public static float[] CORNFLOWERBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CORNSILK

public static float[] CORNSILK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CRIMSON

public static float[] CRIMSON

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

CYAN

public static float[] CYAN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKBLUE

public static float[] DARKBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKCYAN

public static float[] DARKCYAN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKGOLDENROD

public static float[] DARKGOLDENROD

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKGRAY

public static float[] DARKGRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKGREEN

public static float[] DARKGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKGREY

public static float[] DARKGREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKKHAKI

public static float[] DARKKHAKI

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKMAGENTA

public static float[] DARKMAGENTA

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKOLIVEGREEN

public static float[] DARKOLIVEGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKORANGE

public static float[] DARKORANGE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKORCHID

public static float[] DARKORCHID

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKRED

public static float[] DARKRED

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKSALMON

public static float[] DARKSALMON

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKSEAGREEN

public static float[] DARKSEAGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKSLATEBLUE

public static float[] DARKSLATEBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKSLATEGRAY

public static float[] DARKSLATEGRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKSLATEGREY

public static float[] DARKSLATEGREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKTURQUOISE

public static float[] DARKTURQUOISE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DARKVIOLET

public static float[] DARKVIOLET

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DEEPPINK

public static float[] DEEPPINK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DEEPSKYBLUE

public static float[] DEEPSKYBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DIMGRAY

public static float[] DIMGRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DIMGREY

public static float[] DIMGREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

DODGERBLUE

public static float[] DODGERBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

FIREBRICK

public static float[] FIREBRICK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

FLORALWHITE

public static float[] FLORALWHITE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

FORESTGREEN

public static float[] FORESTGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

FUCHSIA

public static float[] FUCHSIA

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GAINSBORO

public static float[] GAINSBORO

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GHOSTWHITE

public static float[] GHOSTWHITE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GOLD

public static float[] GOLD

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GOLDENROD

public static float[] GOLDENROD

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GRAY

public static float[] GRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GREEN

public static float[] GREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GREENYELLOW

public static float[] GREENYELLOW

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

GREY

public static float[] GREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

HONEYDEW

public static float[] HONEYDEW

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

HOTPINK

public static float[] HOTPINK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

INDIANRED

public static float[] INDIANRED

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

INDIGO

public static float[] INDIGO

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

IVORY

public static float[] IVORY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

KHAKI

public static float[] KHAKI

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LAVENDER

public static float[] LAVENDER

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LAVENDERBLUSH

public static float[] LAVENDERBLUSH

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LAWNGREEN

public static float[] LAWNGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LEMONCHIFFON

public static float[] LEMONCHIFFON

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTBLUE

public static float[] LIGHTBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTCORAL

public static float[] LIGHTCORAL

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTCYAN

public static float[] LIGHTCYAN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGOLDENRODYELLOW

public static float[] LIGHTGOLDENRODYELLOW

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGRAY

public static float[] LIGHTGRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGREEN

public static float[] LIGHTGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTGREY

public static float[] LIGHTGREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTPINK

public static float[] LIGHTPINK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSALMON

public static float[] LIGHTSALMON

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSEAGREEN

public static float[] LIGHTSEAGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSKYBLUE

public static float[] LIGHTSKYBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSLATEGRAY

public static float[] LIGHTSLATEGRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSLATEGREY

public static float[] LIGHTSLATEGREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTSTEELBLUE

public static float[] LIGHTSTEELBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIGHTYELLOW

public static float[] LIGHTYELLOW

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIME

public static float[] LIME

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LIMEGREEN

public static float[] LIMEGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

LINEN

public static float[] LINEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MAGENTA

public static float[] MAGENTA

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MAROON

public static float[] MAROON

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMAQUAMARINE

public static float[] MEDIUMAQUAMARINE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMBLUE

public static float[] MEDIUMBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMORCHID

public static float[] MEDIUMORCHID

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMPURPLE

public static float[] MEDIUMPURPLE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMSEAGREEN

public static float[] MEDIUMSEAGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMSLATEBLUE

public static float[] MEDIUMSLATEBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMSPRINGGREEN

public static float[] MEDIUMSPRINGGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMTURQUOISE

public static float[] MEDIUMTURQUOISE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MEDIUMVIOLETRED

public static float[] MEDIUMVIOLETRED

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MIDNIGHTBLUE

public static float[] MIDNIGHTBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MINTCREAM

public static float[] MINTCREAM

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MISTYROSE

public static float[] MISTYROSE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

MOCCASIN

public static float[] MOCCASIN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

NAVAJOWHITE

public static float[] NAVAJOWHITE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

NAVY

public static float[] NAVY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

OLDLACE

public static float[] OLDLACE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

OLIVE

public static float[] OLIVE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

OLIVEDRAB

public static float[] OLIVEDRAB

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

ORANGE

public static float[] ORANGE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

ORANGERED

public static float[] ORANGERED

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

ORCHID

public static float[] ORCHID

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PALEGOLDENROD

public static float[] PALEGOLDENROD

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PALEGREEN

public static float[] PALEGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PALETURQUOISE

public static float[] PALETURQUOISE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PALEVIOLETRED

public static float[] PALEVIOLETRED

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PAPAYAWHIP

public static float[] PAPAYAWHIP

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PEACHPUFF

public static float[] PEACHPUFF

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PERU

public static float[] PERU

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PINK

public static float[] PINK

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PLUM

public static float[] PLUM

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

POWDERBLUE

public static float[] POWDERBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

PURPLE

public static float[] PURPLE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

RED

public static float[] RED

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

ROSYBROWN

public static float[] ROSYBROWN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

ROYALBLUE

public static float[] ROYALBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SADDLEBROWN

public static float[] SADDLEBROWN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SALMON

public static float[] SALMON

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SANDYBROWN

public static float[] SANDYBROWN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SEAGREEN

public static float[] SEAGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SEASHELL

public static float[] SEASHELL

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SIENNA

public static float[] SIENNA

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SILVER

public static float[] SILVER

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SKYBLUE

public static float[] SKYBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SLATEBLUE

public static float[] SLATEBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SLATEGRAY

public static float[] SLATEGRAY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SLATEGREY

public static float[] SLATEGREY

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SNOW

public static float[] SNOW

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

SPRINGGREEN

public static float[] SPRINGGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

STEELBLUE

public static float[] STEELBLUE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

TAN

public static float[] TAN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

TEAL

public static float[] TEAL

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

THISTLE

public static float[] THISTLE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

TOMATO

public static float[] TOMATO

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

TURQUOISE

public static float[] TURQUOISE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

VIOLET

public static float[] VIOLET

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

WHEAT

public static float[] WHEAT

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

WHITE

public static float[] WHITE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

WHITESMOKE

public static float[] WHITESMOKE

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

YELLOW

public static float[] YELLOW

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

YELLOWGREEN

public static float[] YELLOWGREEN

Color value alias.

See Also:

• CSS Color Module Level 3, 4.3. Extended color keywords

formatPrecision

public static DecimalFormat formatPrecision

DecimalFormat matching local number of significant digits for floating-point and double-precision String output

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 current object and another SFColor object contain equal values.

Parameters:

comparisonSFColor - field type to compare

Returns:

true if equivalent, false otherwise

setEpsilon

public void setEpsilon(float newEpsilon)

Set revised error bound for numerical comparison of values for equality

Parameters:

newEpsilon - new value for epsilon, must be positive

getEpsilon

public float getEpsilon()

Current error bound for numerical comparison of values for equality

setSignificantDigits

public void setSignificantDigits(int newSignificantDigits)

Set revised number of significant digits for floating-point and double-precision String output

Parameters:

newSignificantDigits - new value for significantDigits, must be non-negative

getSignificantDigits

public int getSignificantDigits()

Current significant digits for floating-point and double-precision String output

equals

public boolean equals(float[] comparisonValue)

Determine whether current SFColor object and float array contain equal values.

Parameters:

comparisonValue - float[] array to compare

Returns:

true if equal, 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