Struct UIAttachmentBehavior

Source

pub struct UIAttachmentBehavior { /* private fields */ }

Available on crate features UIAttachmentBehavior and UIDynamicBehavior only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIAttachmentBehavior

Source

pub fn initWithItem_attachedToAnchor( this: Allocated<Self>, item: &ProtocolObject<dyn UIDynamicItem>, point: CGPoint, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Source

pub fn initWithItem_offsetFromCenter_attachedToAnchor( this: Allocated<Self>, item: &ProtocolObject<dyn UIDynamicItem>, offset: UIOffset, point: CGPoint, ) -> Retained<Self>

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

Source

pub fn initWithItem_attachedToItem( this: Allocated<Self>, item1: &ProtocolObject<dyn UIDynamicItem>, item2: &ProtocolObject<dyn UIDynamicItem>, ) -> Retained<Self>

Source

pub fn initWithItem_offsetFromCenter_attachedToItem_offsetFromCenter( this: Allocated<Self>, item1: &ProtocolObject<dyn UIDynamicItem>, offset1: UIOffset, item2: &ProtocolObject<dyn UIDynamicItem>, offset2: UIOffset, ) -> Retained<Self>

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

Source

pub fn slidingAttachmentWithItem_attachedToItem_attachmentAnchor_axisOfTranslation( item1: &ProtocolObject<dyn UIDynamicItem>, item2: &ProtocolObject<dyn UIDynamicItem>, point: CGPoint, axis: CGVector, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A sliding attachment allows for relative translation of two items along a specified axis with respect to the anchor point. A sliding attachment prevents all relative rotation of the dynamic items.

Parameter item1: The first of two dynamic items connected by the attachment behavior.

Parameter item2: The second of two dynamic items connected by the attachment behavior.

Parameter point: The point for which each item will be attached. The anchor point will be converted to each items local coordinate system.

Parameter axis: Axis of allowed relative translation between local anchor point. Must be a unit vector.

See: attachmentRange, Represents the slidable range of the attachment with respect to the anchor point along the specified axis, this range must include 0

Source

pub fn slidingAttachmentWithItem_attachmentAnchor_axisOfTranslation( item: &ProtocolObject<dyn UIDynamicItem>, point: CGPoint, axis: CGVector, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A sliding attachment allows for translation of the item along a specified axis with respect to the anchor point. A sliding attachment prevents all relative rotation of the dynamic items.

Parameter item1: The dynamic item connected by the attachment behavior.

Parameter point: The point for the item will be anchored by the attachment.

Parameter axis: Axis of allowed translation for the item. Must be a unit vector.

See: attachmentRange, Represents the slidable range of the attachment with respect to the anchor point along the specified axis, this range must include 0

Source

pub fn limitAttachmentWithItem_offsetFromCenter_attachedToItem_offsetFromCenter( item1: &ProtocolObject<dyn UIDynamicItem>, offset1: UIOffset, item2: &ProtocolObject<dyn UIDynamicItem>, offset2: UIOffset, ) -> Retained<Self>

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

A limit attachment imposes a maximum distance between two dynamic items, as if they were connected by a rope.

Parameter item1: The first of two dynamic items connected by the attachment behavior.

Parameter offset1: The point, within the dynamic item and described as an offset from its center point, for the attachment behavior.

Parameter item2: The second of two dynamic items connected by the attachment behavior.

Parameter offset2: The point, within the dynamic item and described as an offset from its center point, for the attachment behavior.

See: length

Source

pub fn fixedAttachmentWithItem_attachedToItem_attachmentAnchor( item1: &ProtocolObject<dyn UIDynamicItem>, item2: &ProtocolObject<dyn UIDynamicItem>, point: CGPoint, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A fixed attachment fuses two dynamic items together at a reference point. Fixed attachments are useful for creating complex shapes that can be broken apart later.

Parameter item1: The first of two dynamic items connected by the attachment behavior.

Parameter item2: The second of two dynamic items connected by the attachment behavior.

Parameter point: The point for which each item will be attached. The anchor point will be converted to each items local coordinate system.

Source

pub fn pinAttachmentWithItem_attachedToItem_attachmentAnchor( item1: &ProtocolObject<dyn UIDynamicItem>, item2: &ProtocolObject<dyn UIDynamicItem>, point: CGPoint, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A pin attachment allows two dynamic items to independently rotate around the anchor point as if pinned together. You can configure how far the two objects may rotate and the resistance to rotation

Parameter item1: The first of two dynamic items connected by the attachment behavior.

Parameter item2: The second of two dynamic items connected by the attachment behavior.

Parameter point: The point for which each item will be attached. The anchor point will be converted to each items local coordinate system

See: frictionTorque, resistance to rotation

Source

pub fn items(&self) -> Retained<NSArray<ProtocolObject<dyn UIDynamicItem>>>

Source

pub fn attachedBehaviorType(&self) -> UIAttachmentBehaviorType

Source

pub fn anchorPoint(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

Source

pub fn setAnchorPoint(&self, anchor_point: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for anchorPoint.

Source

pub fn length(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setLength(&self, length: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for length.

Source

pub fn damping(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setDamping(&self, damping: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for damping.

Source

pub fn frequency(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setFrequency(&self, frequency: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for frequency.

Source

pub fn frictionTorque(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setFrictionTorque(&self, friction_torque: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for frictionTorque.

Source

pub fn attachmentRange(&self) -> UIFloatRange

Available on crate feature objc2-core-foundation only.

Source

pub fn setAttachmentRange(&self, attachment_range: UIFloatRange)

Available on crate feature objc2-core-foundation only.

Setter for attachmentRange.

Source §

impl UIAttachmentBehavior

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