org.apache.batik.anim.values

Class AnimatableLengthOrIdentValue

java.lang.Object

org.apache.batik.anim.values.AnimatableValue

org.apache.batik.anim.values.AnimatableLengthValue

org.apache.batik.anim.values.AnimatableLengthOrIdentValue

public class AnimatableLengthOrIdentValue
extends AnimatableLengthValue

An SVG length-or-identifier value in the animation system.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ident The identifier.
protected boolean	isIdent Whether this value is an identifier.

Fields inherited from class org.apache.batik.anim.values.AnimatableLengthValue

lengthType, lengthValue, percentageInterpretation, UNITS

Fields inherited from class org.apache.batik.anim.values.AnimatableValue

decimalFormat, hasChanged, target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnimatableLengthOrIdentValue(AnimationTarget target) Creates a new, uninitialized AnimatableLengthOrIdentValue.
	AnimatableLengthOrIdentValue(AnimationTarget target, short type, float v, short pcInterp) Creates a new AnimatableLengthOrIdentValue for a length value.
	AnimatableLengthOrIdentValue(AnimationTarget target, java.lang.String ident) Creates a new AnimatableLengthOrIdentValue for an identifier value.

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getCssText() Returns the CSS text representation of the value.
java.lang.String	getIdent() Returns the identifier.
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.
boolean	isIdent() Returns whether this value is an identifier or a length.

Methods inherited from class org.apache.batik.anim.values.AnimatableLengthValue

compatibleTypes, getLengthType, getLengthValue

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

isIdent

protected boolean isIdent

Whether this value is an identifier.

ident

protected java.lang.String ident

The identifier.

Constructor Detail

AnimatableLengthOrIdentValue

protected AnimatableLengthOrIdentValue(AnimationTarget target)

Creates a new, uninitialized AnimatableLengthOrIdentValue.

AnimatableLengthOrIdentValue

public AnimatableLengthOrIdentValue(AnimationTarget target,
                                    short type,
                                    float v,
                                    short pcInterp)

Creates a new AnimatableLengthOrIdentValue for a length value.

AnimatableLengthOrIdentValue

public AnimatableLengthOrIdentValue(AnimationTarget target,
                                    java.lang.String ident)

Creates a new AnimatableLengthOrIdentValue for an identifier value.

Method Detail

isIdent

public boolean isIdent()

Returns whether this value is an identifier or a length.

getIdent

public java.lang.String getIdent()

Returns the identifier.

canPace

public boolean canPace()

Returns whether two values of this type can have their distance computed, as needed by paced animation.

Overrides:

canPace in class AnimatableLengthValue

distanceTo

public float distanceTo(AnimatableValue other)

Returns the absolute distance between this value and the specified other value.

Overrides:

distanceTo in class AnimatableLengthValue

getZeroValue

public AnimatableValue getZeroValue()

Returns a zero value of this AnimatableValue's type.

Overrides:

getZeroValue in class AnimatableLengthValue

getCssText

public java.lang.String getCssText()

Returns the CSS text representation of the value.

Overrides:

getCssText in class AnimatableLengthValue

interpolate

public AnimatableValue interpolate(AnimatableValue result,
                                   AnimatableValue to,
                                   float interpolation,
                                   AnimatableValue accumulation,
                                   int multiplier)

Performs interpolation to the given value.

Overrides:

interpolate in class AnimatableLengthValue

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