com.openinventor.inventor.fields

Class SoSFColorRGBA

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFColorRGBA

public class SoSFColorRGBA
extends SoSField

Field containing an RGBA color. A single-value field containing an SbColorRGBA. Values are set in RGBA (red, green, blue, alpha) color space.

SoSFColorRGBAs are written to file as an RGBA quadruple of floating point numbers in standard scientific notation, in the range 0.0 to 1.0.

See also:

SoField, SoSField, SoMFColorRGBA, SbColorRGBA

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
SoSFColorRGBA() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFColorRGBA(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, SbColorRGBA defaultValue) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
SbColorRGBA	getValue() Returns this field's value.
long	getValueSize() Get size of the value.
void	setHSVAValue(float[] hsva) Convenience method for setting the value.
void	setHSVAValue(float h, float s, float v, float a) Convenience method for setting the value.
void	setValue(float[] rgba) Convenience method for setting the value.
void	setValue(float r, float g, float b, float a) Convenience method for setting the value.
void	setValue(SbColorRGBA newValue) Sets this field to newValue.
void	setValue(SbVec4f 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

SoSFColorRGBA

@Deprecated
public SoSFColorRGBA()

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

SoSFColorRGBA

public SoSFColorRGBA(SoFieldContainer fieldContainer,
                     java.lang.String fieldName,
                     SoField.FieldTypes fieldType,
                     SbColorRGBA defaultValue)

Default constructor.

Method Detail

setValue

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

Convenience method for setting the value.

setValue

public void setValue(float[] rgba)

Convenience method for setting the value.

setValue

public void setValue(SbColorRGBA newValue)

Sets this field to newValue.

setValue

public void setValue(SbVec4f vec)

Convenience method for setting the value.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setHSVAValue

public void setHSVAValue(float[] hsva)

Convenience method for setting the value.

getValueSize

public long getValueSize()

Get size of the value.

setHSVAValue

public void setHSVAValue(float h,
                         float s,
                         float v,
                         float a)

Convenience method for setting the value.

getValue

public SbColorRGBA getValue()

Returns this field's value.