Struct CAEmitterCell 

pub struct CAEmitterCell { /* private fields */ }

Available on crate feature CAEmitterCell only.

Apple’s documentation

Implementations

impl CAEmitterCell

pub fn emitterCell() -> Retained<Self>

pub fn defaultValueForKey(key: &NSString) -> Option<Retained<AnyObject>>

pub fn shouldArchiveValueForKey(&self, key: &NSString) -> bool

pub fn name(&self) -> Option<Retained<NSString>>

pub fn setName(&self, name: Option<&NSString>)

Setter for name.

This is copied when set.

pub fn isEnabled(&self) -> bool

pub fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub fn birthRate(&self) -> c_float

pub fn setBirthRate(&self, birth_rate: c_float)

Setter for birthRate.

pub fn lifetime(&self) -> c_float

pub fn setLifetime(&self, lifetime: c_float)

Setter for lifetime.

pub fn lifetimeRange(&self) -> c_float

pub fn setLifetimeRange(&self, lifetime_range: c_float)

Setter for lifetimeRange.

pub fn emissionLatitude(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setEmissionLatitude(&self, emission_latitude: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for emissionLatitude.

pub fn emissionLongitude(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setEmissionLongitude(&self, emission_longitude: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for emissionLongitude.

pub fn emissionRange(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setEmissionRange(&self, emission_range: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for emissionRange.

pub fn velocity(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setVelocity(&self, velocity: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for velocity.

pub fn velocityRange(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setVelocityRange(&self, velocity_range: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for velocityRange.

pub fn xAcceleration(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setXAcceleration(&self, x_acceleration: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for xAcceleration.

pub fn yAcceleration(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setYAcceleration(&self, y_acceleration: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for yAcceleration.

pub fn zAcceleration(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setZAcceleration(&self, z_acceleration: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for zAcceleration.

pub fn scale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setScale(&self, scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for scale.

pub fn scaleRange(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setScaleRange(&self, scale_range: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for scaleRange.

pub fn scaleSpeed(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setScaleSpeed(&self, scale_speed: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for scaleSpeed.

pub fn spin(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setSpin(&self, spin: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for spin.

pub fn spinRange(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setSpinRange(&self, spin_range: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for spinRange.

pub fn color(&self) -> Option<Retained<CGColor>>

Available on crate feature objc2-core-graphics only.

pub fn setColor(&self, color: Option<&CGColor>)

Available on crate feature objc2-core-graphics only.

Setter for color.

pub fn redRange(&self) -> c_float

pub fn setRedRange(&self, red_range: c_float)

Setter for redRange.

pub fn greenRange(&self) -> c_float

pub fn setGreenRange(&self, green_range: c_float)

Setter for greenRange.

pub fn blueRange(&self) -> c_float

pub fn setBlueRange(&self, blue_range: c_float)

Setter for blueRange.

pub fn alphaRange(&self) -> c_float

pub fn setAlphaRange(&self, alpha_range: c_float)

Setter for alphaRange.

pub fn redSpeed(&self) -> c_float

pub fn setRedSpeed(&self, red_speed: c_float)

Setter for redSpeed.

pub fn greenSpeed(&self) -> c_float

pub fn setGreenSpeed(&self, green_speed: c_float)

Setter for greenSpeed.

pub fn blueSpeed(&self) -> c_float

pub fn setBlueSpeed(&self, blue_speed: c_float)

Setter for blueSpeed.

pub fn alphaSpeed(&self) -> c_float

pub fn setAlphaSpeed(&self, alpha_speed: c_float)

Setter for alphaSpeed.

pub fn contents(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setContents(&self, contents: Option<&AnyObject>)

Setter for contents.

Safety

contents should be of the correct type.

pub fn contentsRect(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub fn setContentsRect(&self, contents_rect: CGRect)

Available on crate feature objc2-core-foundation only.

Setter for contentsRect.

pub fn contentsScale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setContentsScale(&self, contents_scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for contentsScale.

pub fn minificationFilter(&self) -> Retained<NSString>

pub fn setMinificationFilter(&self, minification_filter: &NSString)

Setter for minificationFilter.

This is copied when set.

pub fn magnificationFilter(&self) -> Retained<NSString>

pub fn setMagnificationFilter(&self, magnification_filter: &NSString)

Setter for magnificationFilter.

This is copied when set.

pub fn minificationFilterBias(&self) -> c_float

pub fn setMinificationFilterBias(&self, minification_filter_bias: c_float)

Setter for minificationFilterBias.

pub fn emitterCells(&self) -> Option<Retained<NSArray<CAEmitterCell>>>

pub fn setEmitterCells(&self, emitter_cells: Option<&NSArray<CAEmitterCell>>)

Setter for emitterCells.

This is copied when set.

pub fn style(&self) -> Option<Retained<NSDictionary>>

pub unsafe fn setStyle(&self, style: Option<&NSDictionary>)

Setter for style.

This is copied when set.

Safety

style generic should be of the correct type.

impl CAEmitterCell

Methods declared on superclass NSObject.

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

pub fn new() -> 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

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.

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,

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 CAEmitterCell

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CAEmitterCell> for CAEmitterCell

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CAEmitterCell

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CAEmitterCell

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CAEmitterCell

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl CAMediaTiming for CAEmitterCell

fn beginTime(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setBeginTime(&self, begin_time: CFTimeInterval)

where Self: Sized + Message,

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

Setter for beginTime.

fn duration(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setDuration(&self, duration: CFTimeInterval)

where Self: Sized + Message,

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

Setter for duration.

fn speed(&self) -> c_float

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setSpeed(&self, speed: c_float)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for speed.

fn timeOffset(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setTimeOffset(&self, time_offset: CFTimeInterval)

where Self: Sized + Message,

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

Setter for timeOffset.

fn repeatCount(&self) -> c_float

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setRepeatCount(&self, repeat_count: c_float)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for repeatCount.

fn repeatDuration(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setRepeatDuration(&self, repeat_duration: CFTimeInterval)

where Self: Sized + Message,

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

Setter for repeatDuration.

fn autoreverses(&self) -> bool

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setAutoreverses(&self, autoreverses: bool)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for autoreverses.

fn fillMode(&self) -> Retained<CAMediaTimingFillMode>

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setFillMode(&self, fill_mode: &CAMediaTimingFillMode)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for fillMode.

impl ClassType for CAEmitterCell

const NAME: &'static str = "CAEmitterCell"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CAEmitterCell as ClassType>::Super as ClassType>::ThreadKind

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 CAEmitterCell

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

Formats the value using the given formatter.

impl DefaultRetained for CAEmitterCell

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for CAEmitterCell

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CAEmitterCell

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 CAEmitterCell

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CAEmitterCell

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 NSSecureCoding for CAEmitterCell

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CAEmitterCell

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 CAEmitterCell

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

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

impl DowncastTarget for CAEmitterCell

impl Eq for CAEmitterCell

impl NSCoding for CAEmitterCell