Struct UIDynamicItemBehavior

Source

pub struct UIDynamicItemBehavior { /* private fields */ }

Available on crate features UIDynamicBehavior and UIDynamicItemBehavior only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIDynamicItemBehavior

Source

pub fn initWithItems( this: Allocated<Self>, items: &NSArray<ProtocolObject<dyn UIDynamicItem>>, ) -> Retained<Self>

Source

pub fn elasticity(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setElasticity(&self, elasticity: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for elasticity.

Source

pub fn friction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setFriction(&self, friction: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for friction.

Source

pub fn density(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setDensity(&self, density: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for density.

Source

pub fn resistance(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setResistance(&self, resistance: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for resistance.

Source

pub fn angularResistance(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setAngularResistance(&self, angular_resistance: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for angularResistance.

Source

pub fn charge(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the charge associated with the item behavior. Charge determines the degree to which a dynamic item is affected by electric and magnetic fields. Note that this is a unitless quantity, it is up to the developer to set charge and field strength appropriately. Defaults to 0.0

Source

pub fn setCharge(&self, charge: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for charge.

Source

pub fn isAnchored(&self) -> bool

If an item is anchored, it can participate in collisions, but will not exhibit any dynamic response. i.e. The item will behave more like a collision boundary. The default is NO

Source

pub fn setAnchored(&self, anchored: bool)

Setter for isAnchored.

Source

pub fn allowsRotation(&self) -> bool

Source

pub fn setAllowsRotation(&self, allows_rotation: bool)

Setter for allowsRotation.

Source

pub fn addLinearVelocity_forItem( &self, velocity: CGPoint, item: &ProtocolObject<dyn UIDynamicItem>, )

Available on crate feature objc2-core-foundation only.

Source

pub fn linearVelocityForItem( &self, item: &ProtocolObject<dyn UIDynamicItem>, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

Source

pub fn addAngularVelocity_forItem( &self, velocity: CGFloat, item: &ProtocolObject<dyn UIDynamicItem>, )

Available on crate feature objc2-core-foundation only.

Source

pub fn angularVelocityForItem( &self, item: &ProtocolObject<dyn UIDynamicItem>, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source §

impl UIDynamicItemBehavior

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = UIDynamicBehavior>§

Source

pub fn addChildBehavior(&self, behavior: &UIDynamicBehavior)

Source

pub fn removeChildBehavior(&self, behavior: &UIDynamicBehavior)

Source

pub fn childBehaviors(&self) -> Retained<NSArray<UIDynamicBehavior>>

Source

pub fn action(&self) -> *mut DynBlock<dyn Fn()>

Available on crate feature block2 only.

Source

pub fn setAction(&self, action: Option<&DynBlock<dyn Fn()>>)

Available on crate feature block2 only.

Setter for action.

This is copied when set.

Source

pub fn willMoveToAnimator(&self, dynamic_animator: Option<&UIDynamicAnimator>)

Available on crate feature UIDynamicAnimator only.

Source

pub fn dynamicAnimator(&self) -> Option<Retained<UIDynamicAnimator>>

Available on crate feature UIDynamicAnimator only.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}