Struct UIViewPropertyAnimator

#[repr(C)]
pub struct UIViewPropertyAnimator { /* private fields */ }

Available on crate feature UIViewPropertyAnimator only.

Apple’s documentation

Implementations

impl UIViewPropertyAnimator

pub unsafe fn timingParameters( &self, ) -> Option<Retained<ProtocolObject<dyn UITimingCurveProvider>>>

Available on crate feature UITimingCurveProvider only.

pub unsafe fn duration(&self) -> NSTimeInterval

pub unsafe fn delay(&self) -> NSTimeInterval

Defaults to 0. This property is set when calling -[UIView startAnimationAfterDelay:].

pub unsafe fn isUserInteractionEnabled(&self) -> bool

Defaults to YES. Raises if set on an active animator.

pub unsafe fn setUserInteractionEnabled(&self, user_interaction_enabled: bool)

Setter for isUserInteractionEnabled.

pub unsafe fn isManualHitTestingEnabled(&self) -> bool

Defaults to NO. Set if you need to manage the the hit-testing of animating view hierarchies

pub unsafe fn setManualHitTestingEnabled( &self, manual_hit_testing_enabled: bool, )

Setter for isManualHitTestingEnabled.

pub unsafe fn isInterruptible(&self) -> bool

Defaults to YES. Raises if set on an active animator.

pub unsafe fn setInterruptible(&self, interruptible: bool)

Setter for isInterruptible.

pub unsafe fn scrubsLinearly(&self) -> bool

Defaults to YES. Provides the ability for an animator to pause and scrub either linearly or using the animator’s current timing.

pub unsafe fn setScrubsLinearly(&self, scrubs_linearly: bool)

Setter for scrubsLinearly.

pub unsafe fn pausesOnCompletion(&self) -> bool

Defaults to NO. Provides the ability for an animator to pause on completion instead of transitioning to the .inactive state.

pub unsafe fn setPausesOnCompletion(&self, pauses_on_completion: bool)

Setter for pausesOnCompletion.

pub unsafe fn initWithDuration_timingParameters( this: Allocated<Self>, duration: NSTimeInterval, parameters: &ProtocolObject<dyn UITimingCurveProvider>, ) -> Retained<Self>

Available on crate feature UITimingCurveProvider only.

pub unsafe fn initWithDuration_curve_animations( this: Allocated<Self>, duration: NSTimeInterval, curve: UIViewAnimationCurve, animations: Option<&Block<dyn Fn()>>, ) -> Retained<Self>

Available on crate features UIView and block2 only.

All convenience initializers return an animator which is not running.

pub unsafe fn initWithDuration_controlPoint1_controlPoint2_animations( this: Allocated<Self>, duration: NSTimeInterval, point1: CGPoint, point2: CGPoint, animations: Option<&Block<dyn Fn()>>, ) -> Retained<Self>

Available on crate features block2 and objc2-core-foundation only.

pub unsafe fn initWithDuration_dampingRatio_animations( this: Allocated<Self>, duration: NSTimeInterval, ratio: CGFloat, animations: Option<&Block<dyn Fn()>>, ) -> Retained<Self>

Available on crate features block2 and objc2-core-foundation only.

pub unsafe fn runningPropertyAnimatorWithDuration_delay_options_animations_completion( duration: NSTimeInterval, delay: NSTimeInterval, options: UIViewAnimationOptions, animations: &Block<dyn Fn()>, completion: Option<&Block<dyn Fn(UIViewAnimatingPosition)>>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate features UIView and UIViewAnimating and block2 only.

This method provides compatibility with the old style [UIView animationWithDuration:…] method. It is also useful for controlling how animations options are inherited.

Creates a UIViewPropertyAnimator, sets the duration, options, etc. And starts the animation with the associated animation and completion blocks. The animator returned is interruptible only if it is not called from within the execution block of another animation (animator or legacy). Note that if it is called within the execution block of another animation it will inherit the duration and other characteristics of that animation UNLESS the appropriate override options have been specified. Also note that if is called within the execution block of another propertyAnimator that is interruptible, the implicit animations defined by this call will be tracked by the outer propertyAnimator.

pub unsafe fn addAnimations_delayFactor( &self, animation: &Block<dyn Fn()>, delay_factor: CGFloat, )

Available on crate features block2 and objc2-core-foundation only.

Animatable view properties that are set by the animation block will be animated to their new values. The animations will commence at delayFactor * animator.duration seconds into the animation. The duration of the animation will be (1 - delayFactor) * animator.duration seconds.

pub unsafe fn addAnimations(&self, animation: &Block<dyn Fn()>)

Available on crate feature block2 only.

Animatable view properties that are set by the animation block will be animated to their new values. Starting an animator that does not contain any animation blocks will start the animator in a transient paused state. While in this state, submitting an animation block will automatically start animating any animatable view properties set therein. When the animator is stopped, either naturally completing or explicitly, any animation blocks and completion handlers are invalidated. Immediately calling startAnimation again on the animator, since there are no animation blocks, will start the animator in a transient paused state.

pub unsafe fn addCompletion( &self, completion: &Block<dyn Fn(UIViewAnimatingPosition)>, )

Available on crate features UIViewAnimating and block2 only.

pub unsafe fn continueAnimationWithTimingParameters_durationFactor( &self, parameters: Option<&ProtocolObject<dyn UITimingCurveProvider>>, duration_factor: CGFloat, )

Available on crate features UITimingCurveProvider and objc2-core-foundation only.

Provides a means to continue an animation in either the forward or reversed directions with new timing parameters and duration. The durationFactor is in terms of a unit duration defined by the originally specified duration of the animator. It is used to specify the remaining time for the animation. When called, it behaves as if the animation was started from its current position with a new duration and timing parameters.

impl UIViewPropertyAnimator

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Available on crate feature UIIndirectScribbleInteraction only.

Dynamically find the class of this object.

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature UIIndirectScribbleInteraction only.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Available on crate feature UIIndirectScribbleInteraction only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for UIViewPropertyAnimator

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for UIViewPropertyAnimator

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UIViewPropertyAnimator> for UIViewPropertyAnimator

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for UIViewPropertyAnimator

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIViewPropertyAnimator

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIViewPropertyAnimator

const NAME: &'static str = "UIViewPropertyAnimator"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for UIViewPropertyAnimator

type Result = UIViewPropertyAnimator

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for UIViewPropertyAnimator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for UIViewPropertyAnimator

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for UIViewPropertyAnimator

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for UIViewPropertyAnimator

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for UIViewPropertyAnimator

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for UIViewPropertyAnimator

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for UIViewPropertyAnimator

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for UIViewPropertyAnimator

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl UIViewAnimating for UIViewPropertyAnimator

Available on crate feature UIViewAnimating only.

unsafe fn state(&self) -> UIViewAnimatingState

where Self: Sized + Message,

unsafe fn isRunning(&self) -> bool

where Self: Sized + Message,

unsafe fn isReversed(&self) -> bool

where Self: Sized + Message,

unsafe fn setReversed(&self, reversed: bool)

where Self: Sized + Message,

Setter for isReversed.

unsafe fn fractionComplete(&self) -> CGFloat

where Self: Sized + Message,

Available on crate feature objc2-core-foundation only.

unsafe fn setFractionComplete(&self, fraction_complete: CGFloat)

where Self: Sized + Message,

Available on crate feature objc2-core-foundation only.

Setter for fractionComplete.

unsafe fn startAnimation(&self)

where Self: Sized + Message,

unsafe fn startAnimationAfterDelay(&self, delay: NSTimeInterval)

where Self: Sized + Message,

unsafe fn pauseAnimation(&self)

where Self: Sized + Message,

unsafe fn stopAnimation(&self, without_finishing: bool)

where Self: Sized + Message,

unsafe fn finishAnimationAtPosition( &self, final_position: UIViewAnimatingPosition, )

where Self: Sized + Message,

impl UIViewImplicitlyAnimating for UIViewPropertyAnimator

Available on crate feature UIViewAnimating only.

unsafe fn addAnimations_delayFactor( &self, animation: &Block<dyn Fn()>, delay_factor: CGFloat, )

where Self: Sized + Message,

Available on crate features block2 and objc2-core-foundation only.

unsafe fn addAnimations(&self, animation: &Block<dyn Fn()>)

where Self: Sized + Message,

Available on crate feature block2 only.

unsafe fn addCompletion( &self, completion: &Block<dyn Fn(UIViewAnimatingPosition)>, )

where Self: Sized + Message,

Available on crate feature block2 only.

unsafe fn continueAnimationWithTimingParameters_durationFactor( &self, parameters: Option<&ProtocolObject<dyn UITimingCurveProvider>>, duration_factor: CGFloat, )

where Self: Sized + Message,

Available on crate features UITimingCurveProvider and objc2-core-foundation only.

impl DowncastTarget for UIViewPropertyAnimator

impl Eq for UIViewPropertyAnimator