Struct UIPercentDrivenInteractiveTransition

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

Available on crate feature UIViewControllerTransitioning only.

Apple’s documentation

Implementations

impl UIPercentDrivenInteractiveTransition

pub unsafe fn duration(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

This is the non-interactive duration that was returned when the animators transitionDuration: method was called when the transition started.

pub unsafe fn percentComplete(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The last percentComplete value specified by updateInteractiveTransition:

pub unsafe fn completionSpeed(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

completionSpeed defaults to 1.0 which corresponds to a completion duration of (1 - percentComplete)*duration. It must be greater than 0.0. The actual completion is inversely proportional to the completionSpeed. This can be set before cancelInteractiveTransition or finishInteractiveTransition is called in order to speed up or slow down the non interactive part of the transition.

pub unsafe fn setCompletionSpeed(&self, completion_speed: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for completionSpeed.

pub unsafe fn completionCurve(&self) -> UIViewAnimationCurve

Available on crate feature UIView only.

When the interactive part of the transition has completed, this property can be set to indicate a different animation curve. It defaults to UIViewAnimationCurveEaseInOut. Note that during the interactive portion of the animation the timing curve is linear.

pub unsafe fn setCompletionCurve(&self, completion_curve: UIViewAnimationCurve)

Available on crate feature UIView only.

Setter for completionCurve.

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

Available on crate feature UITimingCurveProvider only.

For an interruptible animator, one can specify a different timing curve provider to use when the transition is continued. This property is ignored if the animated transitioning object does not vend an interruptible animator.

pub unsafe fn setTimingCurve( &self, timing_curve: Option<&ProtocolObject<dyn UITimingCurveProvider>>, )

Available on crate feature UITimingCurveProvider only.

Setter for timingCurve.

pub unsafe fn wantsInteractiveStart(&self) -> bool

Set this to NO in order to start an interruptible transition non interactively. By default this is YES, which is consistent with the behavior before 10.0.

pub unsafe fn setWantsInteractiveStart(&self, wants_interactive_start: bool)

Setter for wantsInteractiveStart.

pub unsafe fn pauseInteractiveTransition(&self)

Use this method to pause a running interruptible animator. This will ensure that all blocks provided by a transition coordinator’s notifyWhenInteractionChangesUsingBlock: method are executed when a transition moves in and out of an interactive mode.

pub unsafe fn updateInteractiveTransition(&self, percent_complete: CGFloat)

Available on crate feature objc2-core-foundation only.

pub unsafe fn cancelInteractiveTransition(&self)

pub unsafe fn finishInteractiveTransition(&self)

impl UIPercentDrivenInteractiveTransition

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.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

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 UIPercentDrivenInteractiveTransition

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIPercentDrivenInteractiveTransition

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIPercentDrivenInteractiveTransition> for UIPercentDrivenInteractiveTransition

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIPercentDrivenInteractiveTransition

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIPercentDrivenInteractiveTransition

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIPercentDrivenInteractiveTransition

const NAME: &'static str = "UIPercentDrivenInteractiveTransition"

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 Debug for UIPercentDrivenInteractiveTransition

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

Formats the value using the given formatter.

impl Deref for UIPercentDrivenInteractiveTransition

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIPercentDrivenInteractiveTransition

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 UIPercentDrivenInteractiveTransition

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UIPercentDrivenInteractiveTransition

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 UIPercentDrivenInteractiveTransition

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 UIPercentDrivenInteractiveTransition

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

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

impl UIViewControllerInteractiveTransitioning for UIPercentDrivenInteractiveTransition

unsafe fn startInteractiveTransition( &self, transition_context: &ProtocolObject<dyn UIViewControllerContextTransitioning>, )

where Self: Sized + Message,

unsafe fn completionSpeed(&self) -> CGFloat

where Self: Sized + Message,

Available on crate feature objc2-core-foundation only.

unsafe fn completionCurve(&self) -> UIViewAnimationCurve

where Self: Sized + Message,

Available on crate feature UIView only.

unsafe fn wantsInteractiveStart(&self) -> bool

where Self: Sized + Message,

In 10.0, if an object conforming to UIViewControllerAnimatedTransitioning is known to be interruptible, it is possible to start it as if it was not interactive and then interrupt the transition and interact with it. In this case, implement this method and return NO. If an interactor does not implement this method, YES is assumed.

impl DowncastTarget for UIPercentDrivenInteractiveTransition

impl Eq for UIPercentDrivenInteractiveTransition