Package vrml.field

Class SFColor

java.lang.Object

vrml.Field

vrml.field.SFColor

All Implemented Interfaces:

Cloneable

public class SFColor
extends Field

VRML JSAI type class containing a color field

Version:

$Revision: 1.4 $

Author:

Alan Hudson, Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected float[]	data	The components of the field

Fields inherited from class vrml.Field

valueChanged

Constructor Summary

Constructors

Constructor	Description
SFColor()	Create a new default color with the fields set to 0 0 0
SFColor(float red, float green, float blue)	Create a new color based on the given values.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Create a cloned copy of this node.
float	getBlue()	Get the blue component of the color
float	getGreen()	Get the green component of the color
float	getRed()	Get the red component of the color
void	getValue(float[] colors)	Copy this angle into the user array
void	setValue(float[] colors)	Set the field to the new value based on the user data
void	setValue(float red, float green, float blue)	Set the field to the new components.
void	setValue(ConstSFColor color)	Set this field to the values from the passed in field
void	setValue(SFColor color)	Set this field to the values from the passed in field
String	toString()	Create a string representation of this field.

Methods inherited from class java.lang.Object

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

Field Details

data

protected float[] data

The components of the field

Constructor Details

SFColor

public SFColor()

Create a new default color with the fields set to 0 0 0

SFColor

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

Create a new color based on the given values.

Parameters:

red - The red component of the color

green - The green component of the color

blue - The blue component of the color

Method Details

getValue

public void getValue(float[] colors)

Copy this angle into the user array

Parameters:

colors - The target array to copy into

getRed

public float getRed()

Get the red component of the color

Returns:

The red value [0 - 1]

getGreen

public float getGreen()

Get the green component of the color

Returns:

The green value [0 - 1]

getBlue

public float getBlue()

Get the blue component of the color

Returns:

The blue value [0 - 1]

setValue

public void setValue(float[] colors)

Set the field to the new value based on the user data

Parameters:

colors - The new data to copy

setValue

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

Set the field to the new components.

Parameters:

red - The red component of the color

green - The green component of the color

blue - The blue component of the color

setValue

public void setValue(ConstSFColor color)

Set this field to the values from the passed in field

Parameters:

color - The field to copy the values from

setValue

public void setValue(SFColor color)

Set this field to the values from the passed in field

Parameters:

color - The field to copy the values from

toString

public String toString()

Create a string representation of this field.

Overrides:

toString in class Object

Returns:

A string representation of the color

clone

public Object clone()

Create a cloned copy of this node.

Specified by:

clone in class Field

Returns:

A complete copy of the node