CABasicAnimation CABasicAnimation Class

Definition

Single keyframe based animations.

[Foundation.Register("CABasicAnimation", true)]
public class CABasicAnimation : CoreAnimation.CAPropertyAnimation
type CABasicAnimation = class
    inherit CAPropertyAnimation
Inheritance
Derived
Attributes

Remarks

The animation is created by calling the FromKeyPath(String) method and providing a keyPath that identifies the property on the target that will be animated. The animation is performed by using the values on the From, To and By properties applied to the keyPath.

The interpolation will depend on the values that you choose to set for From, To and By. The following table shows the effects of setting one or more of those properites on the property referenced by the key path:

SettingsResult
No values are setInterpolates between old value and new value in the presentation layer.
From is setInterpolation is done from the From value to the current value in the presentation layer.
To is setInterpolation is done from the current value in the presentation layer to the To value.
By is setInterpolation is done between the current value on the presentation layer to the current value plus the value in By.
From and To are setInterpolation is done between the From and To values.
From and By are setInterpolation is done between the value set in From to From plus By.
To and By are setInterpolation is done between To minus By and By.

The From, To and By properties all take NSObject parameters. If you need to specify other parameters, like a CGColor, you can use the methods that take INativeObject parameters (GetByAs, GetFromAs, GetToAs, SetBy, SetFrom, SetTo).

For example, the following will animate the "radius" property for three seconds, from its current value, to the value 120 and will repeat this ten times.


var radiusAnimation = CABasicAnimation.FromKeyPath ("radius");
radiusAnimation.Duration = 3;
radiusAnimation.To = NSNumber.FromDouble (120);
radiusAnimation.RepeatCount = 10;

The above works to set the “To” property to an NSObject, in this case the number 120. If you want to set this for other kinds of objects, you can use the SetTo method, for example, the following sets the target color to a CGColor:


var radiusAnimation = CABasicAnimation.FromKeyPath (“shadowColor");
radiusAnimation.Duration = 3;
radiusAnimation.SetTo (UIColor.Red.CGColor);
radiusAnimation.RepeatCount = 10;

Constructors

CABasicAnimation() CABasicAnimation()

Default constructor that initializes a new instance of this class with no parameters.

CABasicAnimation(IntPtr) CABasicAnimation(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

CABasicAnimation(NSCoder) CABasicAnimation(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

CABasicAnimation(NSObjectFlag) CABasicAnimation(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Additive Additive Inherited from CAPropertyAnimation
AnimationEvents AnimationEvents Inherited from CAAnimation
AutoReverses AutoReverses

When the animation completes, this determines if the animation will automatically reverse .

(Inherited from CAAnimation)
BeginTime BeginTime

The begin time of the animation, in seconds, relative to its parent (if applicable).

(Inherited from CAAnimation)
By By

Value to increment by.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

Cumulative Cumulative Inherited from CAPropertyAnimation
DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Delegate Delegate

An instance of the CoreAnimation.CAAnimationDelegate model class which acts as the class delegate.

(Inherited from CAAnimation)
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Duration Duration

Duration in seconds for this animation.

(Inherited from CAAnimation)
FadeInDuration FadeInDuration Inherited from CAAnimation
FadeOutDuration FadeOutDuration Inherited from CAAnimation
FillMode FillMode

The FillMode for this animation, use the CAFillMode constants as the values for this property.

(Inherited from CAAnimation)
From From

Initial value for the property to animate.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
KeyPath KeyPath Inherited from CAPropertyAnimation
RemovedOnCompletion RemovedOnCompletion

Whether the animation is removed from the layer on completion.

(Inherited from CAAnimation)
RepeatCount RepeatCount

Number of times to repeat the animation.

(Inherited from CAAnimation)
RepeatDuration RepeatDuration

The number of seconds that the animation will repeat for.

(Inherited from CAAnimation)
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
Speed Speed

The speed scale applied to this animation. A value of 2.0 will make animations run twice as fast as the parent animations.

(Inherited from CAAnimation)
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
TimeOffset TimeOffset

Extra time offset in the local time.

(Inherited from CAAnimation)
TimingFunction TimingFunction

The timing function used to compute the animation.

(Inherited from CAAnimation)
To To

Destination value for the property to animate.

UsesSceneTimeBase UsesSceneTimeBase Inherited from CAAnimation
ValueFunction ValueFunction Inherited from CAPropertyAnimation
WeakDelegate WeakDelegate

An object that can respond to the delegate protocol for this type

(Inherited from CAAnimation)
Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

(Inherited from CAAnimation)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
DidChangeValueForKey(String) DidChangeValueForKey(String)

As part of key-value observing, indicates that the value represented by key has changed.

(Inherited from CAAnimation)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

(Inherited from CAAnimation)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
FromKeyPath(String) FromKeyPath(String)

Creates an animation from the given key path.

GetByAs<T>() GetByAs<T>()

Returns the value to increment by, returned as an object of the specified type.

GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetFromAs<T>() GetFromAs<T>()

Returns the initial value for the property to animate, returned as an object of the specified type.

GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetToAs<T>() GetToAs<T>()

Returns the destination value for the property to animate, returned as an object of the specified type.

Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
MutableCopy(NSZone) MutableCopy(NSZone)

Performs a copy of the underlying Objective-C object.

(Inherited from CAAnimation)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
RunAction(String, NSObject, NSDictionary) RunAction(String, NSObject, NSDictionary) Inherited from CAAnimation
SetBy(INativeObject) SetBy(INativeObject)

Sets the value to increment by, by using a non-NSObject type.

SetFrom(INativeObject) SetFrom(INativeObject)

Sets the value for the initial value of the property to animate, by using a non-NSObject type.

SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetTo(INativeObject) SetTo(INativeObject)

Destination value for the property to animate (using INativeObject).

SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ShouldArchiveValueForKey(String) ShouldArchiveValueForKey(String)

Whether the value for the given key should be archived.

(Inherited from CAAnimation)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)
WillChangeValueForKey(String) WillChangeValueForKey(String)

With key-value observing, indicates that the value associated with key is about to change.

(Inherited from CAAnimation)

Events

AnimationStarted AnimationStarted

Event raised by the object.

(Inherited from CAAnimation)
AnimationStopped AnimationStopped

Event raised by the object.

(Inherited from CAAnimation)

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also