| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Behavior
javax.media.j3d.Interpolator
javax.media.j3d.ColorInterpolator
| ColorInterpolator | | public class ColorInterpolator extends Interpolator (Code) | | Color interpolation behavior. This class defines a behavior that
modifies the ambient, emissive, diffuse, or specular color of its
target material object by linearly interpolating between a pair of
specified colors, using the value generated by the specified Alpha
object.
The behavior modifies the color specified by the
Material's colorTarget attribute, one of: AMBIENT, EMISSIVE,
DIFFUSE, SPECULAR, or AMBIENT_AND_DIFFUSE.
The ALLOW_COMPONENT_READ bit must be set in the Material object in
order for the Material's colorTarget to be read.
If the Material object's ALLOW_COMPONENT_READ bit is not set, the
diffuse component will be modified.
See Also: Material |
| Constructor Summary | |
| | ColorInterpolator()
| | public | ColorInterpolator(Alpha alpha, Material target)
Constructs a trivial color interpolator with a specified target,
a starting color of black, and an ending color of white. | | public | ColorInterpolator(Alpha alpha, Material target, Color3f startColor, Color3f endColor)
Constructs a color interpolator with the specified target,
starting color, and ending color. |
| Method Summary | |
| public Node | cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. | | void | duplicateAttributes(Node originalNode, boolean forceDuplicate)
Copies all ColorInterpolator information from
originalNode into
the current node. | | public void | getEndColor(Color3f color)
This method retrieves this interpolator's endColor. | | public void | getStartColor(Color3f color)
This method retrieves this interpolator's startColor. | | public Material | getTarget()
This method retrieves this interpolator's target material
component object. | | public void | processStimulus(Enumeration criteria)
This method is invoked by the behavior scheduler every frame. | | public void | setEndColor(Color3f color)
This method sets the endColor for this interpolator. | | public void | setStartColor(Color3f color)
This method sets the startColor for this interpolator. | | public void | setTarget(Material target)
This method sets the target material component object for
this interpolator. | | public void | updateNodeReferences(NodeReferenceTable referenceTable)
Callback used to allow a node to check if any scene graph objects
referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. |
| endColor | | Color3f endColor(Code) | | |
| newColor | | Color3f newColor(Code) | | |
| startColor | | Color3f startColor(Code) | | |
| ColorInterpolator | | ColorInterpolator()(Code) | | |
| ColorInterpolator | | public ColorInterpolator(Alpha alpha, Material target)(Code) | | Constructs a trivial color interpolator with a specified target,
a starting color of black, and an ending color of white.
Parameters:
alpha - the alpha object for this interpolator
Parameters:
target - the material component object whosecolor is affected by this color interpolator |
| ColorInterpolator | | public ColorInterpolator(Alpha alpha, Material target, Color3f startColor, Color3f endColor)(Code) | | Constructs a color interpolator with the specified target,
starting color, and ending color.
Parameters:
alpha - the alpha object for this interpolator
Parameters:
target - the material component object whosecolor is affected by this color interpolator
Parameters:
startColor - the starting color
Parameters:
endColor - the ending color |
| cloneNode | | public Node cloneNode(boolean forceDuplicate)(Code) | | Used to create a new instance of the node. This routine is called
by cloneTree to duplicate the current node.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: Node.cloneNode
See Also: Node.duplicateNode
See Also: NodeComponent.setDuplicateOnCloneTree |
| duplicateAttributes | | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all ColorInterpolator information from
originalNode into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree method.
Parameters:
originalNode - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
exception:
RestrictedAccessException - if this object is part of a liveor compiled scenegraph.
See Also: Node.duplicateNode
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getEndColor | | public void getEndColor(Color3f color)(Code) | | This method retrieves this interpolator's endColor.
Parameters:
color - the vector that will receive the interpolator's end color |
| getStartColor | | public void getStartColor(Color3f color)(Code) | | This method retrieves this interpolator's startColor.
Parameters:
color - the vector that will receive the interpolator's start color |
| getTarget | | public Material getTarget()(Code) | | This method retrieves this interpolator's target material
component object.
the interpolator's target material component object |
| processStimulus | | public void processStimulus(Enumeration criteria)(Code) | | This method is invoked by the behavior scheduler every frame.
It maps the alpha value that corresponds to the current time
into a color value and updates the ambient, emissive, diffuse,
or specular color (or both the ambient and diffuse color) of
the specified target Material object with this new color value.
Parameters:
criteria - an enumeration of the criteria that caused thestimulus |
| setEndColor | | public void setEndColor(Color3f color)(Code) | | This method sets the endColor for this interpolator.
Parameters:
color - the new end color |
| setStartColor | | public void setStartColor(Color3f color)(Code) | | This method sets the startColor for this interpolator.
Parameters:
color - the new start color |
| setTarget | | public void setTarget(Material target)(Code) | | This method sets the target material component object for
this interpolator.
Parameters:
target - the material component object whosecolor is affected by this color interpolator |
| updateNodeReferences | | public void updateNodeReferences(NodeReferenceTable referenceTable)(Code) | | Callback used to allow a node to check if any scene graph objects
referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. The cloned Leaf node's method
will be called and the Leaf node can then look up any object references
by using the getNewObjectReference method found in the
NodeReferenceTable object. If a match is found, a
reference to the corresponding object in the newly cloned sub-graph
is returned. If no corresponding reference is found, either a
DanglingReferenceException is thrown or a reference to the original
object is returned depending on the value of the
allowDanglingReferences parameter passed in the
cloneTree call.
NOTE: Applications should not call this method directly.
It should only be called by the cloneTree method.
Parameters:
referenceTable - a NodeReferenceTableObject that contains thegetNewObjectReference method needed to search fornew object instances.
See Also: NodeReferenceTable
See Also: Node.cloneTree
See Also: DanglingReferenceException |
|
|