org.web3d.x3d.sai.Rendering

Interface ColorRGBA

All Superinterfaces:

X3DColorNode, X3DGeometricPropertyNode, X3DNode

All Known Implementing Classes:

ColorRGBAObject

public interface ColorRGBA
extends X3DColorNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DColorNode] ColorRGBA node defines a set of RGBA color values that apply either to a sibling Coordinate|CoordinateDouble node, or else to a parent ElevationGrid node. ColorRGBA is only used by ElevationGrid, IndexedFaceSet, IndexedLineSet, LineSet, PointSet, Triangle* and IndexedTriangle* nodes.

• Hint: colors are often controlled by Material instead.
• Hint: alpha channel may be ignored under Interchange profile.
• Warning: ColorRGBA requires Rendering component level 3 (alpha fully supported), Rendering component level 1 (alpha optional), otherwise Full profile.
• Hint: X3D Scene Authoring Hints, Color
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: ColorRGBA, X3D Tooltips: ColorRGBA, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
float[]	getColor() Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput MFColorRGBA field named color.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
ColorRGBA	setColor(float[] newValue) Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput MFColorRGBA field named color.
ColorRGBA	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
ColorRGBA	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
ColorRGBA	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ColorRGBA	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getColor

float[] getColor()

Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput MFColorRGBA field named color.

Tooltip: [0,1] The color field defines an array of 4-tuple RGBA colors.

• Warning: ColorRGBA requires Rendering component level 3 (alpha fully supported), Rendering component level 1 (alpha optional), otherwise Full profile.

Returns:

value of color field

setColor

ColorRGBA setColor(float[] newValue)

Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput MFColorRGBA field named color.

Tooltip: [0,1] The color field defines an array of 4-tuple RGBA colors. Warning: ColorRGBA requires Rendering component level 3 (alpha fully supported), Rendering component level 1 (alpha optional), otherwise Full profile.

Parameters:

newValue - is new value for the color field.

Returns:

ColorRGBA - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DColorNode

Specified by:

getMetadata in interface X3DGeometricPropertyNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

ColorRGBA setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DColorNode

Specified by:

setMetadata in interface X3DGeometricPropertyNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

ColorRGBA - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setDEF

ColorRGBA setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DColorNode

Specified by:

setDEF in interface X3DGeometricPropertyNode

Specified by:

setDEF in interface X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

ColorRGBA - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

ColorRGBA setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DColorNode

Specified by:

setUSE in interface X3DGeometricPropertyNode

Specified by:

setUSE in interface X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

ColorRGBA - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

ColorRGBA setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DColorNode

Specified by:

setCssClass in interface X3DGeometricPropertyNode

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

ColorRGBA - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).