## org.apache.batik.anim
Class InterpolatingAnimation

    java.lang.Object
      org.apache.batik.anim.AbstractAnimation
          org.apache.batik.anim.InterpolatingAnimation

Direct Known Subclasses:
  MotionAnimation, SimpleAnimation

    public abstract class InterpolatingAnimation

extends AbstractAnimation

An abstract animation class for those animations that interpolate values. Specifically, this is for animations that have the 'calcMode', 'keyTimes', 'keySplines', 'additive' and 'cumulative' attributes.

Field Summary
`protected boolean` `additive` Whether this animation adds to ones below it in the animation sandwich or replaces them.
`protected int` `calcMode` The interpolation mode of this animator.
`protected boolean` `cumulative` Whether this animation accumulates from previous iterations.
`protected Cubic[]` `keySplineCubics` Cubics built from the bezier control points in `keySplines`.
`protected float[]` `keySplines` Bezier control points that control the pacing of the animation.
`protected float[]` `keyTimes` Time values to control the pacing of the animation.

Fields inherited from class org.apache.batik.anim.AbstractAnimation
`animatableElement, beginTime, CALC_MODE_DISCRETE, CALC_MODE_LINEAR, CALC_MODE_PACED, CALC_MODE_SPLINE, composedValue, higherAnimation, isActive, isDirty, isFrozen, lowerAnimation, timedElement, toAnimation, usesUnderlyingValue, value`

Constructor Summary
`InterpolatingAnimation(TimedElement timedElement, AnimatableElement animatableElement, int calcMode, float[] keyTimes, float[] keySplines, boolean additive, boolean cumulative)` Creates a new InterpolatingAnimation.

Method Summary
`protected void` `sampledAt(float simpleTime, float simpleDur, int repeatIteration)` Called when the element is sampled at the given time.
`protected abstract void` `sampledAtUnitTime(float unitTime, int repeatIteration)` Called when the element is sampled at the given unit time.
`protected void` `sampledLastValue(int repeatIteration)` Called when the element is sampled for its "last" value.
`protected boolean` `willReplace()` Returns whether this animation will replace values on animations lower in the sandwich.

Methods inherited from class org.apache.batik.anim.AbstractAnimation
`getComposedValue, getTimedElement, getValue, markDirty, toString, usesUnderlyingValue`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### calcMode

    protected int calcMode

  The interpolation mode of this animator. This should take one of the CALC_MODE_* constants defined in `AbstractAnimation`.

### keyTimes

    protected float[] keyTimes

  Time values to control the pacing of the animation.

### keySplines

    protected float[] keySplines

  Bezier control points that control the pacing of the animation.

### keySplineCubics

    protected Cubic[] keySplineCubics

  Cubics built from the bezier control points in `keySplines`.

### additive

    protected boolean additive

  Whether this animation adds to ones below it in the animation sandwich or replaces them.

### cumulative

    protected boolean cumulative

  Whether this animation accumulates from previous iterations.

Constructor Detail

### InterpolatingAnimation

    public InterpolatingAnimation(TimedElement timedElement,
                                  AnimatableElement animatableElement,
                                  int calcMode,
                                  float[] keyTimes,
                                  float[] keySplines,
                                  boolean additive,
                                  boolean cumulative)

  Creates a new InterpolatingAnimation.

Method Detail

### willReplace

    protected boolean willReplace()

  Returns whether this animation will replace values on animations lower in the sandwich.

  Overrides:
    `willReplace` in class `AbstractAnimation`

### sampledLastValue

    protected void sampledLastValue(int repeatIteration)

  Called when the element is sampled for its "last" value.

  Overrides:
    `sampledLastValue` in class `AbstractAnimation`

### sampledAt

    protected void sampledAt(float simpleTime,
                             float simpleDur,
                             int repeatIteration)

  Called when the element is sampled at the given time.

  Specified by:
    `sampledAt` in class `AbstractAnimation`

### sampledAtUnitTime

    protected abstract void sampledAtUnitTime(float unitTime,
                                              int repeatIteration)

  Called when the element is sampled at the given unit time. This updates the `AbstractAnimation.value` of the animation if active.

Copyright © 2008 Apache Software Foundation. All Rights Reserved.