com.openinventor.inventor.fields

Class SoSFColor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFColor

public class SoSFColor
extends SoSField

Field containing an RGB color. A single-value field containing an SbColor. Values may be set in either RGB (red, green, blue) or HSV (hue, saturation, value) color spaces.

SoSFColors are written to file as an RGB triple of floating point numbers in standard scientific notation, in the range 0.0 to 1.0.

See also:

SoField, SoSField, SoMFColor, SbColor

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField

SoField.FieldTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoSFColor() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFColor(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, SbColor defaultValue) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
SbColor	getValue() Returns this field's value.
long	getValueSize() Get size of the value.
void	setHSVValue(float[] hsv) Convenience method for setting the value.
void	setHSVValue(float h, float s, float v) Convenience method for setting the value.
void	setValue(float[] rgb) Convenience method for setting the value.
void	setValue(float r, float g, float b) Convenience method for setting the value.
void	setValue(SbColor newValue) Sets this field to newValue.
void	setValue(SbVec3f vec) Convenience method for setting the value.

Methods inherited from class com.openinventor.inventor.fields.SoField

appendConnection, appendConnection, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoSFColor

@Deprecated
public SoSFColor()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoSFColor

public SoSFColor(SoFieldContainer fieldContainer,
                 java.lang.String fieldName,
                 SoField.FieldTypes fieldType,
                 SbColor defaultValue)

Default constructor.

Method Detail

setValue

public void setValue(float r,
                     float g,
                     float b)

Convenience method for setting the value.

setHSVValue

public void setHSVValue(float h,
                        float s,
                        float v)

Convenience method for setting the value.

setValue

public void setValue(SbColor newValue)

Sets this field to newValue.

setValue

public void setValue(SbVec3f vec)

Convenience method for setting the value.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setHSVValue

public void setHSVValue(float[] hsv)

Convenience method for setting the value.

getValueSize

public long getValueSize()

Get size of the value.

setValue

public void setValue(float[] rgb)

Convenience method for setting the value.

getValue

public SbColor getValue()

Returns this field's value.