vmm.core
Interface Animateable

All Known Implementing Classes:

ComplexParamAnimateable, ComplexVariableParamAnimateable, RealParamAnimateable, VariableParamAnimateable

public interface Animateable

This interface is implemented by "Animateable" Parameters such as RealParamAnimateable. It includes the setFractionComplete method, which is used for morphing. It also includes several methods for getting and setting the start and end values for the animation; these methods are used in several dialogs, such as AnimationLimitsDialog. Note that an Animateable object could be used in other places besides in actual animations. For example, frames might be selected with a slider or with Prev and Next buttons, or fractionComplete might even be called directly. In general, however, this interface will not be used by ordinary programmers.

Method Summary

java.lang.String	getAnimationEndAsString() Returns a string representation of the end value for the animation.
java.lang.String	getAnimationStartAsString() Returns a string representation of the start value for the animation.
java.lang.String	getDefaultAnimationEndAsString() Returns a string representation of the default end value for the animation.
java.lang.String	getDefaultAnimationStartAsString() Returns a string representation of the default start value for the animation.
boolean	reallyAnimated() Check whether this Animateable will really change during an animation.
void	setAnimationEndFromString(java.lang.String endVal) Set the ending Animation value for this Animateable object from a string.
void	setAnimationStartFromString(java.lang.String startVal) Set the starting Animation value for this Animateable object from a string.
void	setDefaultAnimationEndFromString(java.lang.String endVal) Sets the default ending animation value for this Animateable object from a string representation of the value.
void	setDefaultAnimationStartFromString(java.lang.String startVal) Sets the default start animation value for this Animateable object from a string representation of the value.
void	setFractionComplete(double fractionComplete) Called during the course of a morphing animation so that the Animateable object can adjust itself to the current stage of the animation.

Method Detail

setFractionComplete

void setFractionComplete(double fractionComplete)

Called during the course of a morphing animation so that the Animateable object can adjust itself to the current stage of the animation. In fact, an Animateable Parameter could set its value to "startValue + fractionComplete * (endValue - startValue)" when this metod is called.

Parameters:

fractionComplete - A number in the range 0 to 1 that tells what stage the animation is at. The Animateable object adjusts itself accordingly.

See Also:

BasicAnimator

setAnimationStartFromString

void setAnimationStartFromString(java.lang.String startVal)

Set the starting Animation value for this Animateable object from a string. This method will probably only be used by Dialog boxes such as AnimationLimitsDialog.

Parameters:

startVal - The start value, as a string. This string will be parsed as a constant expression, and a NumberFormatException will be thrown if the string is not a legal expression.

setAnimationEndFromString

void setAnimationEndFromString(java.lang.String endVal)

Set the ending Animation value for this Animateable object from a string.

Parameters:

endVal - The end value, as a string. This string will be parsed as a constant expression, and a NumberFormatException will be thrown if the string is not a legal expression.

getAnimationStartAsString

java.lang.String getAnimationStartAsString()

Returns a string representation of the start value for the animation.

getAnimationEndAsString

java.lang.String getAnimationEndAsString()

Returns a string representation of the end value for the animation.

setDefaultAnimationStartFromString

void setDefaultAnimationStartFromString(java.lang.String startVal)

Sets the default start animation value for this Animateable object from a string representation of the value. The default values are used, for example, when the user clicks the "Defaults" button in AnimationLimitsDialog.

Parameters:

startVal - The default start value, as a string. This string will be parsed as a constant expression, and a NumberFormatException will be thrown if the string is not a legal expression.

setDefaultAnimationEndFromString

void setDefaultAnimationEndFromString(java.lang.String endVal)

Sets the default ending animation value for this Animateable object from a string representation of the value. The default values are used, for example, when the user clicks the "Defaults" button in AnimationLimitsDialog.

Parameters:

endVal - The default end value, as a string. This string will be parsed as a constant expression, and a NumberFormatException will be thrown if the string is not a legal expression.

getDefaultAnimationStartAsString

java.lang.String getDefaultAnimationStartAsString()

Returns a string representation of the default start value for the animation.

getDefaultAnimationEndAsString

java.lang.String getDefaultAnimationEndAsString()

Returns a string representation of the default end value for the animation.

reallyAnimated

boolean reallyAnimated()

Check whether this Animateable will really change during an animation. (If the start and end values are the same, then the return value will presumably be false.)