org.apache.batik.anim.values
Class AnimatableColorValue

java.lang.Object
  extended by org.apache.batik.anim.values.AnimatableValue
      extended by org.apache.batik.anim.values.AnimatableColorValue
Direct Known Subclasses:
AnimatablePaintValue

public class AnimatableColorValue
extends AnimatableValue

An SVG color value in the animation system.


Field Summary
protected  float blue
          The blue component.
protected  float green
          The green component.
protected  float red
          The red component.
 
Fields inherited from class org.apache.batik.anim.values.AnimatableValue
decimalFormat, hasChanged, target
 
Constructor Summary
protected AnimatableColorValue(AnimationTarget target)
          Creates a new AnimatableColorValue.
  AnimatableColorValue(AnimationTarget target, float r, float g, float b)
          Creates a new AnimatableColorValue.
 
Method Summary
 boolean canPace()
          Returns whether two values of this type can have their distance computed, as needed by paced animation.
 float distanceTo(AnimatableValue other)
          Returns the absolute distance between this value and the specified other value.
 String getCssText()
          Returns the CSS text representation of the value.
 AnimatableValue getZeroValue()
          Returns a zero value of this AnimatableValue's type.
 AnimatableValue interpolate(AnimatableValue result, AnimatableValue to, float interpolation, AnimatableValue accumulation, int multiplier)
          Performs interpolation to the given value.
 
Methods inherited from class org.apache.batik.anim.values.AnimatableValue
formatNumber, hasChanged, toString, toStringRep
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

red

protected float red
The red component.


green

protected float green
The green component.


blue

protected float blue
The blue component.

Constructor Detail

AnimatableColorValue

protected AnimatableColorValue(AnimationTarget target)
Creates a new AnimatableColorValue.


AnimatableColorValue

public AnimatableColorValue(AnimationTarget target,
                            float r,
                            float g,
                            float b)
Creates a new AnimatableColorValue.

Method Detail

interpolate

public AnimatableValue interpolate(AnimatableValue result,
                                   AnimatableValue to,
                                   float interpolation,
                                   AnimatableValue accumulation,
                                   int multiplier)
Performs interpolation to the given value.

Specified by:
interpolate in class AnimatableValue
Parameters:
result - the object in which to store the result of the interpolation, or null if a new object should be created
to - the value this value should be interpolated towards, or null if no actual interpolation should be performed
interpolation - the interpolation distance, 0 <= interpolation <= 1
accumulation - an accumulation to add to the interpolated value
multiplier - an amount the accumulation values should be multiplied by before being added to the interpolated value

canPace

public boolean canPace()
Returns whether two values of this type can have their distance computed, as needed by paced animation.

Specified by:
canPace in class AnimatableValue

distanceTo

public float distanceTo(AnimatableValue other)
Returns the absolute distance between this value and the specified other value.

Specified by:
distanceTo in class AnimatableValue

getZeroValue

public AnimatableValue getZeroValue()
Returns a zero value of this AnimatableValue's type.

Specified by:
getZeroValue in class AnimatableValue

getCssText

public String getCssText()
Returns the CSS text representation of the value.

Overrides:
getCssText in class AnimatableValue


Copyright © 2008 Apache Software Foundation. All Rights Reserved.