ValueAnimator Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This class provides a simple timing engine for running animations which calculate animated values and set them on target objects.
[Android.Runtime.Register("android/animation/ValueAnimator", DoNotGenerateAcw=true)]
public class ValueAnimator : Android.Animation.Animator
[<Android.Runtime.Register("android/animation/ValueAnimator", DoNotGenerateAcw=true)>]
type ValueAnimator = class
inherit Animator
- Inheritance
- Derived
- Attributes
Remarks
This class provides a simple timing engine for running animations which calculate animated values and set them on target objects.
There is a single timing pulse that all animations use. It runs in a custom handler to ensure that property changes happen on the UI thread.
By default, ValueAnimator uses non-linear time interpolation, via the AccelerateDecelerateInterpolator
class, which accelerates into and decelerates out of an animation. This behavior can be changed by calling ValueAnimator#setInterpolator(TimeInterpolator)
.
Animators can be created from either code or resource files. Here is an example of a ValueAnimator resource file:
{
Java documentation for android.animation.ValueAnimator
.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
ValueAnimator() |
Creates a new ValueAnimator object. |
ValueAnimator(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
Fields
DurationInfinite |
The value used to indicate infinite duration (e. (Inherited from Animator) |
Infinite |
This value used used with the |
Restart |
Obsolete.
When the animation reaches the end and |
Properties
AnimatedFraction |
Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation. |
AnimatedValue |
The most recent value calculated by this |
Class |
Returns the runtime class of this |
CurrentPlayTime |
Gets the current position of the animation in time, which is equal to the current time minus the time that the animation started. -or- Sets the position of the animation to the specified point in time. |
Duration |
Gets the length of the animation. |
DurationScale |
Returns the system-wide scaling factor for Animator-based animations. |
FrameDelay |
The amount of time, in milliseconds, between each frame of the animation. -or- The amount of time, in milliseconds, between each frame of the animation. |
Handle |
The handle to the underlying Android instance. (Inherited from Object) |
Interpolator |
Returns the timing interpolator that this animation uses. (Inherited from Animator) |
IsPaused |
Returns whether this animator is currently in a paused state. (Inherited from Animator) |
IsRunning |
Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended). |
IsStarted |
Returns whether this Animator has been started and not yet ended. (Inherited from Animator) |
JniIdentityHashCode | (Inherited from Object) |
JniPeerMembers | |
Listeners |
Gets the set of |
PeerReference | (Inherited from Object) |
RepeatCount |
Defines how many times the animation should repeat. -or- Sets how many times the animation should be repeated. |
RepeatMode |
Defines what this animation should do when it reaches the end. -or- Defines what this animation should do when it reaches the end. |
StartDelay |
The amount of time, in milliseconds, to delay starting the animation after
|
ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
TotalDuration |
Gets the total duration of the animation, accounting for animation sequences, start delay, and repeating. (Inherited from Animator) |
Methods
AddListener(Animator+IAnimatorListener) |
Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end. (Inherited from Animator) |
AddPauseListener(Animator+IAnimatorPauseListener) |
Adds a pause listener to this animator. (Inherited from Animator) |
AddUpdateListener(ValueAnimator+IAnimatorUpdateListener) |
Adds a listener to the set of listeners that are sent update events through the life of an animation. |
AreAnimatorsEnabled() |
Returns whether animators are currently enabled, system-wide. |
Cancel() |
Cancels the animation. (Inherited from Animator) |
Clone() |
Creates and returns a copy of this |
Dispose() | (Inherited from Object) |
Dispose(Boolean) | (Inherited from Object) |
End() |
Ends the animation. (Inherited from Animator) |
Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
GetAnimatedValue(String) |
The most recent value calculated by this |
GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
GetValues() |
Returns the values that this ValueAnimator animates between. |
JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
OfArgb(Int32[]) |
Constructs and returns a ValueAnimator that animates between color values. |
OfFloat(Single[]) |
Constructs and returns a ValueAnimator that animates between float values. |
OfInt(Int32[]) |
Constructs and returns a ValueAnimator that animates between int values. |
OfObject(ITypeEvaluator, Object[]) |
Constructs and returns a ValueAnimator that animates between Object values. |
OfPropertyValuesHolder(PropertyValuesHolder[]) |
Constructs and returns a ValueAnimator that animates between the values specified in the PropertyValuesHolder objects. |
Pause() |
Pauses a running animation. (Inherited from Animator) |
RegisterDurationScaleChangeListener(ValueAnimator+IDurationScaleChangeListener) | |
RemoveAllListeners() |
Removes all |
RemoveAllUpdateListeners() |
Removes all listeners from the set listening to frame updates for this animation. |
RemoveListener(Animator+IAnimatorListener) |
Removes a listener from the set listening to this animation. (Inherited from Animator) |
RemovePauseListener(Animator+IAnimatorPauseListener) |
Removes a pause listener from the set listening to this animation. (Inherited from Animator) |
RemoveUpdateListener(ValueAnimator+IAnimatorUpdateListener) |
Removes a listener from the set listening to frame updates for this animation. |
Resume() |
Resumes a paused animation, causing the animator to pick up where it left off when it was paused. (Inherited from Animator) |
Reverse() |
Plays the ValueAnimator in reverse. |
SetCurrentFraction(Single) |
Sets the position of the animation to the specified fraction. |
SetDuration(Int64) |
Sets the length of the animation. |
SetEvaluator(ITypeEvaluator) |
The type evaluator to be used when calculating the animated values of this animation. |
SetFloatValues(Single[]) |
Sets float values that will be animated between. |
SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
SetInterpolator(ITimeInterpolator) |
The time interpolator used in calculating the elapsed fraction of this animation. |
SetIntValues(Int32[]) |
Sets int values that will be animated between. |
SetObjectValues(Object[]) |
Sets the values to animate between for this animation. |
SetTarget(Object) |
Sets the target object whose property will be animated by this animation. (Inherited from Animator) |
SetupEndValues() |
This method tells the object to use appropriate information to extract ending values for the animation. (Inherited from Animator) |
SetupStartValues() |
This method tells the object to use appropriate information to extract starting values for the animation. (Inherited from Animator) |
SetValues(PropertyValuesHolder[]) |
Sets the values, per property, being animated between. |
Start() |
Starts this animation. (Inherited from Animator) |
ToArray<T>() | (Inherited from Object) |
ToString() |
Returns a string representation of the object. (Inherited from Object) |
UnregisterDurationScaleChangeListener(ValueAnimator+IDurationScaleChangeListener) | |
UnregisterFromRuntime() | (Inherited from Object) |
Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Events
AnimationCancel | (Inherited from Animator) |
AnimationEnd | (Inherited from Animator) |
AnimationPause | (Inherited from Animator) |
AnimationRepeat | (Inherited from Animator) |
AnimationResume | (Inherited from Animator) |
AnimationStart | (Inherited from Animator) |
Update |
Explicit Interface Implementations
IJavaPeerable.Disposed() | (Inherited from Object) |
IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
IJavaPeerable.Finalized() | (Inherited from Object) |
IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
JavaCast<TResult>(IJavaObject) | |
GetJniTypeName(IJavaPeerable) |