Package org.apache.batik.anim.values
Class AnimatableNumberOptionalNumberValue
java.lang.Object
org.apache.batik.anim.values.AnimatableValue
org.apache.batik.anim.values.AnimatableNumberOptionalNumberValue
A number-optional-number value in the animation system.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Whether the optional number is present.protected float
The first number.protected float
The optional number.Fields inherited from class org.apache.batik.anim.values.AnimatableValue
decimalFormat, hasChanged, target
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Creates a new, uninitialized AnimatableNumberOptionalNumberValue.AnimatableNumberOptionalNumberValue
(AnimationTarget target, float n) Creates a new AnimatableNumberOptionalNumberValue with one number.AnimatableNumberOptionalNumberValue
(AnimationTarget target, float n, float on) Creates a new AnimatableNumberOptionalNumberValue with two numbers. -
Method Summary
Modifier and TypeMethodDescriptionboolean
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.Returns the CSS text representation of the value.float
Returns the first number.float
Returns the optional number.Returns a zero value of this AnimatableValue's type.boolean
Returns whether the optional number is present.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
-
Field Details
-
number
protected float numberThe first number. -
hasOptionalNumber
protected boolean hasOptionalNumberWhether the optional number is present. -
optionalNumber
protected float optionalNumberThe optional number.
-
-
Constructor Details
-
AnimatableNumberOptionalNumberValue
Creates a new, uninitialized AnimatableNumberOptionalNumberValue. -
AnimatableNumberOptionalNumberValue
Creates a new AnimatableNumberOptionalNumberValue with one number. -
AnimatableNumberOptionalNumberValue
Creates a new AnimatableNumberOptionalNumberValue with two numbers.
-
-
Method Details
-
interpolate
public AnimatableValue interpolate(AnimatableValue result, AnimatableValue to, float interpolation, AnimatableValue accumulation, int multiplier) Performs interpolation to the given value. Number-optional-number values cannot be interpolated.- Specified by:
interpolate
in classAnimatableValue
- Parameters:
result
- the object in which to store the result of the interpolation, or null if a new object should be createdto
- the value this value should be interpolated towards, or null if no actual interpolation should be performedinterpolation
- the interpolation distance, 0 <= interpolation <= 1accumulation
- an accumulation to add to the interpolated valuemultiplier
- an amount the accumulation values should be multiplied by before being added to the interpolated value
-
getNumber
public float getNumber()Returns the first number. -
hasOptionalNumber
public boolean hasOptionalNumber()Returns whether the optional number is present. -
getOptionalNumber
public float getOptionalNumber()Returns the optional number. -
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 classAnimatableValue
-
distanceTo
Returns the absolute distance between this value and the specified other value.- Specified by:
distanceTo
in classAnimatableValue
-
getZeroValue
Returns a zero value of this AnimatableValue's type.- Specified by:
getZeroValue
in classAnimatableValue
-
getCssText
Returns the CSS text representation of the value.- Overrides:
getCssText
in classAnimatableValue
-