Package org.web3d.x3d.sai.Followers
Interface ColorChaser
- All Superinterfaces:
X3DChaserNode
,X3DChildNode
,X3DFollowerNode
,X3DNode
- All Known Implementing Classes:
ColorChaser
ColorChaser generates a series of SFColor values that progressively change from initial value to destination value.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
ColorChaser 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 https://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:
-
Method Summary
Modifier and TypeMethodDescriptiondouble
Provide double value in seconds within allowed range of [0,infinity) from initializeOnly SFTime field named duration.float[]
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialDestination.float[]
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialValue.boolean
Provide boolean value from outputOnly SFBool field named isActive.Provide org.web3d.x3d.sai.Core.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.setDuration
(double newValue) Accessor method to assign double value in seconds to initializeOnly SFTime field named duration.setInitialDestination
(float[] newValue) Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialDestination.setInitialValue
(float[] newValue) Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialValue.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
-
Method Details
-
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 interfaceX3DChaserNode
- Returns:
- value of duration field
-
setDuration
Accessor method to assign double value in seconds 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 interfaceX3DChaserNode
- 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
Accessor method to assign 3-tuple float array 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
Accessor method to assign 3-tuple float array 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, instead only use it a source for ROUTE events.
- Specified by:
getIsActive
in interfaceX3DChaserNode
- Specified by:
getIsActive
in interfaceX3DFollowerNode
- Returns:
- value of isActive field
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DChaserNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DFollowerNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DChaserNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DFollowerNode
- Specified by:
setMetadata
in interfaceX3DNode
- 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:
-
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, instead only use it a source for ROUTE events.
- Returns:
- value of value_changed field
-