ColorChaser (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChaserNode, X3DChildNode, X3DFollowerNode, X3DNode

All Known Implementing Classes:

ColorChaserObject
```
public interface ColorChaser
extends X3DChaserNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.3 or later) [X3DChaserNode] ColorChaser generates a series of SFColor values that progressively change from initial value to destination value.
- Hint: ROUTE value_changed output events to one of a <Material> node's color fields, for example.
- 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: ColorChaser, X3D Tooltips: ColorChaser, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getDuration()` Provide double value in seconds within allowed range of [0,infinity) from initializeOnly SFTime field named duration.
`float[]`	`getInitialDestination()` Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialDestination.
`float[]`	`getInitialValue()` Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialValue.
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getValue()` Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from outputOnly SFColor field named value_changed.
`ColorChaser`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ColorChaser`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ColorChaser`	`setDuration(double newValue)` Assign double value in seconds within allowed range of [0,infinity) to initializeOnly SFTime field named duration.
`ColorChaser`	`setInitialDestination(float[] newValue)` Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to initializeOnly SFColor field named initialDestination.
`ColorChaser`	`setInitialValue(float[] newValue)` Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to initializeOnly SFColor field named initialValue.
`ColorChaser`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ColorChaser`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getDuration
```
double getDuration()
```
    Provide double value in seconds within allowed range of [0,infinity) from initializeOnly SFTime field named duration.
    
    Tooltip: [0,+infinity) duration is the time interval for filter response in seconds.
    - Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
    Specified by:
    
    getDuration in interface X3DChaserNode
    
    Returns:
    
    value of duration field
  - setDuration
```
ColorChaser setDuration(double newValue)
```
    Assign double value in seconds within allowed range of [0,infinity) to initializeOnly SFTime field named duration.
    
    Tooltip: [0,+infinity) duration is the time interval for filter response in seconds. Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
    
    Specified by:
    
    setDuration in interface X3DChaserNode
    
    Parameters:
    
    newValue - is new value for the duration field.
    
    Returns:
    
    ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getInitialDestination
```
float[] getInitialDestination()
```
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialDestination.
    
    Tooltip: Initial destination value for this node. *
    
    Returns:
    
    value of initialDestination field
  - setInitialDestination
```
ColorChaser setInitialDestination(float[] newValue)
```
    Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to initializeOnly SFColor field named initialDestination.
    
    Tooltip: Initial destination value for this node.
    
    Parameters:
    
    newValue - is new value for the initialDestination field.
    
    Returns:
    
    ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getInitialValue
```
float[] getInitialValue()
```
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialValue.
    
    Tooltip: Initial starting value for this node. *
    
    Returns:
    
    value of initialValue field
  - setInitialValue
```
ColorChaser setInitialValue(float[] newValue)
```
    Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to initializeOnly SFColor field named initialValue.
    
    Tooltip: Initial starting value for this node.
    
    Parameters:
    
    newValue - is new value for the initialValue field.
    
    Returns:
    
    ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsActive
```
boolean getIsActive()
```
    Provide boolean value from outputOnly SFBool field named isActive.
    
    Tooltip: isActive true/false events are sent when follower-node computation starts/stops.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsActive in interface X3DChaserNode
    
    Specified by:
    
    getIsActive in interface X3DFollowerNode
    
    Returns:
    
    value of isActive field
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChaserNode
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DFollowerNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
ColorChaser setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChaserNode
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DFollowerNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ColorChaser - 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
  - getValue
```
float[] getValue()
```
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from outputOnly SFColor field named value_changed.
    
    Tooltip: Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of value_changed field
  - setDEF
```
ColorChaser 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 X3DChaserNode
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DFollowerNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ColorChaser 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 X3DChaserNode
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DFollowerNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ColorChaser 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 X3DChaserNode
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DFollowerNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ColorChaser - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ColorChaser

Method Summary

Method Detail

getDuration

setDuration

getInitialDestination

setInitialDestination

getInitialValue

setInitialValue

getIsActive

getMetadata

setMetadata

getValue

setDEF

setUSE

setCssClass