public class SFColorObject extends X3DConcreteField implements SFColor
MFColorObject| Modifier and Type | Field and 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 java.lang.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 java.lang.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 java.util.regex.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 java.lang.String |
REGEX
Default regular expression (regex) pattern for this field type is (\s)*(([+]?
|
static float[] |
ROSYBROWN |
static float[] |
ROYALBLUE |
static float[] |
SADDLEBROWN |
static float[] |
SALMON |
static float[] |
SANDYBROWN |
static float[] |
SEAGREEN |
static float[] |
SEASHELL |
static float[] |
SIENNA |
static float[] |
SILVER |
static float[] |
SKYBLUE |
static float[] |
SLATEBLUE |
static float[] |
SLATEGRAY |
static float[] |
SLATEGREY |
static float[] |
SNOW |
static float[] |
SPRINGGREEN |
static float[] |
STEELBLUE |
static float[] |
TAN |
static float[] |
TEAL |
static float[] |
THISTLE |
static float[] |
TOMATO |
static int |
TUPLE_SIZE
Default tuple size for this field type is 3 (i.e. number of component values making up a single-field SF object).
|
static float[] |
TURQUOISE |
static float[] |
VIOLET |
static float[] |
WHEAT |
static float[] |
WHITE |
static float[] |
WHITESMOKE |
static float[] |
YELLOW |
static float[] |
YELLOWGREEN |
validationResult| Constructor and Description |
|---|
SFColorObject()
Constructor for SFColorObject performs value initialization.
|
SFColorObject(double[] newValue)
Constructor for MFVec3fObject using an alternatively typed Java double[] array as new initial value.
|
SFColorObject(double red,
double green,
double blue)
Constructor using individual double types as new initial value (which must pass validation checks).
|
SFColorObject(float[] newValue)
Constructor for SFColorObject using a corresponding Java primitive float[] array as new initial value.
|
SFColorObject(float red,
float green,
float blue)
Constructor using individual float types as new initial value (which must pass validation checks).
|
SFColorObject(int hexColorValue)
Constructor using single HTML-style 0xRRGGBB hex value as new initial value.
|
SFColorObject(SFColorObject newValue)
Constructor to copy an SFColorObject value as initial value for this new field object.
|
| Modifier and Type | Method and Description |
|---|---|
SFColorObject |
complementRGB()
Complement all color values in RGB space (i.e. subtract each component from 1).
|
float[] |
getPrimitiveValue()
Provides current value of the field as a Java primitive type.
|
void |
getValue(float[] valueDestination)
Get the current value of this SFColorObject by copying it into the valueDestination array, leaving the current object unchanged.
|
void |
initialize()
Initialization for SFColorObject applies default initial value.
|
boolean |
isDefaultValue()
Determine whether current value matches DEFAULT_VALUE
|
boolean |
matches()
Test PATTERN match via regular expression (regex) check of current object's toString() value.
|
static boolean |
matches(java.lang.String value)
Test PATTERN match with regular expression (regex) of provided value.
|
SFColorObject |
normalizeClip()
Ensure all component color values are within range [0-1] by clipping as necessary.
|
SFColorObject |
scaleRGB(float scaleFactor)
Scale all color values in RGB space.
|
void |
setValue(double[] newValue)
Assign a new value to this field.
|
SFColorObject |
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.
|
SFColorObject |
setValue(float red,
float green,
float blue)
Assign a new value to this field.
|
SFColorObject |
setValue(int hexColorValue)
Public utility accessor method setting single HTML-style 0xRRGGBB hex value as new value.
|
SFColorObject |
setValue(SFColorObject newValue)
Apply an SFColorObject value to this field.
|
SFColorObject |
setValueByString(java.lang.String newValue)
Utility accessor for SFColorObject 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.
|
java.lang.String |
toString()
Provides current value as a String.
|
static java.lang.String |
toString(float[] value)
Static utility method to provide String representation of a correctly typed input value.
|
java.lang.String |
toStringCSS()
Provide CSS color value for this object.
|
static java.lang.String |
toStringCSS(float[] colors)
Provide CSS color value foran RGB triplet.
|
static java.lang.String |
toStringCSS(float red,
float green,
float blue)
Provide CSS color value for RGB values.
|
java.lang.String |
toStringHTML()
Provide HTML color value for this object.
|
static java.lang.String |
toStringHTML(float[] colors)
Provide HTML color value for an RGB triplet.
|
static java.lang.String |
toStringHTML(float red,
float green,
float blue)
Provide HTML color value for RGB values.
|
java.lang.String |
validate()
Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.
|
addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritableclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListenerpublic static final java.lang.String NAME
public static final float[] DEFAULT_VALUE
public static final java.lang.String DEFAULT_VALUE_STRING
public static final int TUPLE_SIZE
public static final java.lang.String REGEX
public static final java.util.regex.Pattern PATTERN
REGEX,
matches(),
matches(String),
validate(),
java.util.regex.Patternpublic static float[] ALICEBLUE
public static float[] ANTIQUEWHITE
public static float[] AQUA
public static float[] AQUAMARINE
public static float[] AZURE
public static float[] BEIGE
public static float[] BISQUE
public static float[] BLACK
public static float[] BLANCHEDALMOND
public static float[] BLUE
public static float[] BLUEVIOLET
public static float[] BROWN
public static float[] BURLYWOOD
public static float[] CADETBLUE
public static float[] CHARTREUSE
public static float[] CHOCOLATE
public static float[] CORAL
public static float[] CORNFLOWERBLUE
public static float[] CORNSILK
public static float[] CRIMSON
public static float[] CYAN
public static float[] DARKBLUE
public static float[] DARKCYAN
public static float[] DARKGOLDENROD
public static float[] DARKGRAY
public static float[] DARKGREEN
public static float[] DARKGREY
public static float[] DARKKHAKI
public static float[] DARKMAGENTA
public static float[] DARKOLIVEGREEN
public static float[] DARKORANGE
public static float[] DARKORCHID
public static float[] DARKRED
public static float[] DARKSALMON
public static float[] DARKSEAGREEN
public static float[] DARKSLATEBLUE
public static float[] DARKSLATEGRAY
public static float[] DARKSLATEGREY
public static float[] DARKTURQUOISE
public static float[] DARKVIOLET
public static float[] DEEPPINK
public static float[] DEEPSKYBLUE
public static float[] DIMGRAY
public static float[] DIMGREY
public static float[] DODGERBLUE
public static float[] FIREBRICK
public static float[] FLORALWHITE
public static float[] FORESTGREEN
public static float[] FUCHSIA
public static float[] GAINSBORO
public static float[] GHOSTWHITE
public static float[] GOLD
public static float[] GOLDENROD
public static float[] GRAY
public static float[] GREEN
public static float[] GREENYELLOW
public static float[] GREY
public static float[] HONEYDEW
public static float[] HOTPINK
public static float[] INDIANRED
public static float[] INDIGO
public static float[] IVORY
public static float[] KHAKI
public static float[] LAVENDER
public static float[] LAVENDERBLUSH
public static float[] LAWNGREEN
public static float[] LEMONCHIFFON
public static float[] LIGHTBLUE
public static float[] LIGHTCORAL
public static float[] LIGHTCYAN
public static float[] LIGHTGOLDENRODYELLOW
public static float[] LIGHTGRAY
public static float[] LIGHTGREEN
public static float[] LIGHTGREY
public static float[] LIGHTPINK
public static float[] LIGHTSALMON
public static float[] LIGHTSEAGREEN
public static float[] LIGHTSKYBLUE
public static float[] LIGHTSLATEGRAY
public static float[] LIGHTSLATEGREY
public static float[] LIGHTSTEELBLUE
public static float[] LIGHTYELLOW
public static float[] LIME
public static float[] LIMEGREEN
public static float[] LINEN
public static float[] MAGENTA
public static float[] MAROON
public static float[] MEDIUMAQUAMARINE
public static float[] MEDIUMBLUE
public static float[] MEDIUMORCHID
public static float[] MEDIUMPURPLE
public static float[] MEDIUMSEAGREEN
public static float[] MEDIUMSLATEBLUE
public static float[] MEDIUMSPRINGGREEN
public static float[] MEDIUMTURQUOISE
public static float[] MEDIUMVIOLETRED
public static float[] MIDNIGHTBLUE
public static float[] MINTCREAM
public static float[] MISTYROSE
public static float[] MOCCASIN
public static float[] NAVAJOWHITE
public static float[] NAVY
public static float[] OLDLACE
public static float[] OLIVE
public static float[] OLIVEDRAB
public static float[] ORANGE
public static float[] ORANGERED
public static float[] ORCHID
public static float[] PALEGOLDENROD
public static float[] PALEGREEN
public static float[] PALETURQUOISE
public static float[] PALEVIOLETRED
public static float[] PAPAYAWHIP
public static float[] PEACHPUFF
public static float[] PERU
public static float[] PINK
public static float[] PLUM
public static float[] POWDERBLUE
public static float[] PURPLE
public static float[] RED
public static float[] ROSYBROWN
public static float[] ROYALBLUE
public static float[] SADDLEBROWN
public static float[] SALMON
public static float[] SANDYBROWN
public static float[] SEAGREEN
public static float[] SEASHELL
public static float[] SIENNA
public static float[] SILVER
public static float[] SKYBLUE
public static float[] SLATEBLUE
public static float[] SLATEGRAY
public static float[] SLATEGREY
public static float[] SNOW
public static float[] SPRINGGREEN
public static float[] STEELBLUE
public static float[] TAN
public static float[] TEAL
public static float[] THISTLE
public static float[] TOMATO
public static float[] TURQUOISE
public static float[] VIOLET
public static float[] WHEAT
public static float[] WHITE
public static float[] WHITESMOKE
public static float[] YELLOW
public static float[] YELLOWGREEN
public SFColorObject()
public SFColorObject(SFColorObject newValue)
newValue - The newValue to applypublic SFColorObject(float[] newValue)
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)public SFColorObject(float red,
float green,
float blue)
red - first componentgreen - second componentblue - third componentpublic SFColorObject(double red,
double green,
double blue)
red - first componentgreen - second componentblue - third componentpublic SFColorObject(int hexColorValue)
hexColorValue - HTML color value (such as 0xAA2288)public SFColorObject(double[] newValue)
newValue - is new value to assignpublic void initialize()
initialize in class X3DConcreteFieldDEFAULT_VALUEpublic final java.lang.String validate()
REGEX,
PATTERN,
matches(),
matches(String),
validate(),
java.util.regex.Patternpublic final boolean matches()
REGEX,
PATTERN,
matches(),
matches(String),
validate(),
java.util.regex.Patternpublic static final boolean matches(java.lang.String value)
value - String to check against regex pattern for successful matchREGEX,
PATTERN,
matches(),
matches(String),
validate(),
java.util.regex.Patternpublic SFColorObject setValueByString(java.lang.String newValue) throws InvalidFieldValueException
newValue - is new value to assign, if empty then assign DEFAULT_VALUEMFMatrix4dObject - namely this same object to allow sequential method pipelining (i.e. consecutive
method invocations on the same node object).InvalidFieldValueExceptionX3DLoaderObject.toX3dObjectTree(org.w3c.dom.Node)public static float[] toFloatArray(int hexColorValue)
hexColorValue - HTML color value (such as 0xAA2288)public SFColorObject setValue(int hexColorValue)
hexColorValue - HTML color value (such as 0xAA2288)SFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public SFColorObject complementRGB()
SFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public SFColorObject scaleRGB(float scaleFactor)
scaleFactor - nonnegative scaling factorSFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public SFColorObject normalizeClip()
SFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public java.lang.String toStringHTML()
public static java.lang.String toStringHTML(float red,
float green,
float blue)
red - red value [0..1]green - value value [0..1]blue - blue value [0..1]public static java.lang.String toStringHTML(float[] colors)
colors - RGB triplet with values [0..1]public java.lang.String toStringCSS()
public static java.lang.String toStringCSS(float red,
float green,
float blue)
red - red value [0..1]green - value value [0..1]blue - blue value [0..1]public static java.lang.String toStringCSS(float[] colors)
colors - RGB triplet with values [0..1]public void setValue(double[] newValue)
newValue - The replacement value to assign.X3DConcreteField.getTupleSize(String)public static java.lang.String toString(float[] value)
value - The value to convert to a StringSFFloatObject.stripTrailingZeroes(float)public void getValue(float[] valueDestination)
public float[] getPrimitiveValue()
public java.lang.String toString()
toString in class java.lang.ObjectSFFloatObject.stripTrailingZeroes(float)public void setValue(float[] newValue)
setValue in interface SFColornewValue - The replacement value to assign.X3DConcreteField.getTupleSize(String)public SFColorObject setValue(float red, float green, float blue)
red - first componentgreen - second componentblue - third componentSFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public SFColorObject setValue(double red, double green, double blue)
red - first componentgreen - second componentblue - third componentSFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public float[] toFloatArray()
public SFColorObject setValue(SFColorObject newValue)
newValue - The newValue to applySFColorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public boolean isDefaultValue()
DEFAULT_VALUECopyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.