Struct SKTileDefinition

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

Available on crate feature SKTileDefinition only.

A tile definition contains the information needed to represent a single type of tile within a tile map.

See also Apple’s documentation

Implementations

impl SKTileDefinition

pub unsafe fn tileDefinitionWithTexture(texture: &SKTexture) -> Retained<Self>

Available on crate feature SKTexture only.

Create a tile definition with an SKTexture, and set its size to the SKTexture’s width/height.

Parameter texture: the texture to reference for size and content

pub unsafe fn tileDefinitionWithTexture_size( texture: &SKTexture, size: CGSize, ) -> Retained<Self>

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

Create a tile definition with an SKTexture and the specified size.

Parameter texture: the texture to reference for content

Parameter size: the size of the tile in points

pub unsafe fn tileDefinitionWithTexture_normalTexture_size( texture: &SKTexture, normal_texture: &SKTexture, size: CGSize, ) -> Retained<Self>

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

Create a tile definition with an SKTexture and the specified size.

Parameter texture: the texture to reference for content

Parameter normalTexture: the normal texture to use for generating normals for lighting

Parameter size: the size of the tile in points

pub unsafe fn tileDefinitionWithTextures_size_timePerFrame( textures: &NSArray<SKTexture>, size: CGSize, time_per_frame: CGFloat, ) -> Retained<Self>

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

Create an animated tile definition with an array of SKTextures, the specified size, and the length of time each texture should be displayed for in the animation.

Parameter textures: the textures to reference for animated content

Parameter size: the size of the tile in points

Parameter timePerFrame: the duration, in seconds, that each texture in the textures array is displayed before switching to the next texture in the sequence

pub unsafe fn tileDefinitionWithTextures_normalTextures_size_timePerFrame( textures: &NSArray<SKTexture>, normal_textures: &NSArray<SKTexture>, size: CGSize, time_per_frame: CGFloat, ) -> Retained<Self>

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

Create an animated tile definition with an array of SKTextures, the specified size, and the length of time each texture should be displayed for in the animation.

Parameter textures: the textures to reference for animated content

Parameter normalTextures: the normal textures to use for generating normals for lighting

Parameter size: the size of the tile in points

Parameter timePerFrame: the duration, in seconds, that each texture in the textures array is displayed before switching to the next texture in the sequence

pub unsafe fn initWithTexture( this: Allocated<Self>, texture: &SKTexture, ) -> Retained<Self>

Available on crate feature SKTexture only.

Initilize a tile definition with an SKTexture, and set its size to the SKTexture’s width/height.

Parameter texture: the texture to reference for size and content

pub unsafe fn initWithTexture_size( this: Allocated<Self>, texture: &SKTexture, size: CGSize, ) -> Retained<Self>

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

Initilize a tile definition with an SKTexture and the specified size.

Parameter texture: the texture to reference for content

Parameter size: the size of the tile in points

pub unsafe fn initWithTexture_normalTexture_size( this: Allocated<Self>, texture: &SKTexture, normal_texture: &SKTexture, size: CGSize, ) -> Retained<Self>

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

Initilize a tile definition with an SKTexture and the specified size.

Parameter texture: the texture to reference for content

Parameter normalTexture: the normal texture to use for generating normals for lighting

Parameter size: the size of the tile in points

pub unsafe fn initWithTextures_size_timePerFrame( this: Allocated<Self>, textures: &NSArray<SKTexture>, size: CGSize, time_per_frame: CGFloat, ) -> Retained<Self>

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

Initilize an animated tile definition with an array of SKTextures, the specified size, and the length of time each texture should be displayed for in the animation.

Parameter textures: the textures to reference for animated content

Parameter size: the size of the tile in points

Parameter timePerFrame: the duration, in seconds, that each texture in the textures array is displayed before switching to the next texture in the sequence

pub unsafe fn initWithTextures_normalTextures_size_timePerFrame( this: Allocated<Self>, textures: &NSArray<SKTexture>, normal_textures: &NSArray<SKTexture>, size: CGSize, time_per_frame: CGFloat, ) -> Retained<Self>

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

Initilize an animated tile definition with an array of SKTextures, the specified size, and the length of time each texture should be displayed for in the animation.

Parameter textures: the textures to reference for animated content

Parameter normalTextures: the normal textures to use for generating normals for lighting

Parameter size: the size of the tile in points

Parameter timePerFrame: the duration, in seconds, that each texture in the textures array is displayed before switching to the next texture in the sequence

pub unsafe fn textures(&self) -> Retained<NSArray<SKTexture>>

Available on crate feature SKTexture only.

The textures used to draw the tile. Non-animated tiles use only one texture. When more than one texture is present, the tile will swap through them in sequence, showing each for the duration specified in the timePerFrame property. After displaying the last texture in the array, the sequence is repeated from the first texture.

pub unsafe fn setTextures(&self, textures: &NSArray<SKTexture>)

Available on crate feature SKTexture only.

Setter for textures.

pub unsafe fn normalTextures(&self) -> Retained<NSArray<SKTexture>>

Available on crate feature SKTexture only.

The textures to use for generating normals that lights use to light this tile. These will only be used if the tile is lit by at least one light. Each normal texture corresponds to a texture in the textures property.

pub unsafe fn setNormalTextures(&self, normal_textures: &NSArray<SKTexture>)

Available on crate feature SKTexture only.

Setter for normalTextures.

pub unsafe fn userData(&self) -> Option<Retained<NSMutableDictionary>>

An optional dictionary that can be used to store your own data for each tile definition. Defaults to nil.

pub unsafe fn setUserData(&self, user_data: Option<&NSMutableDictionary>)

Setter for userData.

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

Client-assignable name for the tile definition. Defaults to nil.

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

Setter for name.

pub unsafe fn size(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The size of the tile in points.

pub unsafe fn setSize(&self, size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for size.

pub unsafe fn timePerFrame(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The duration, in seconds, that each texture in the textures array is displayed before switching to the next texture in the sequence. Only used when there is more than one texture available.

pub unsafe fn setTimePerFrame(&self, time_per_frame: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for timePerFrame.

pub unsafe fn placementWeight(&self) -> NSUInteger

This value is used to determine how likely this tile definition is to be chosen for placement when a SKTileGroupRule has mulitple tile definitions assigned to it. A higher value relative to the other definitions assigned to the rule make it more likely for this definition to be selected; lower values make it less likely. Defaults to 1. When set to 0, the definition will never be chosen as long as there is at least one other definition with a placementWeight above 0.

pub unsafe fn setPlacementWeight(&self, placement_weight: NSUInteger)

Setter for placementWeight.

pub unsafe fn rotation(&self) -> SKTileDefinitionRotation

The rotation of the tile definition’s images can be set in 90 degree increments. Defaults to SKTileDefinitionRotation0.

pub unsafe fn setRotation(&self, rotation: SKTileDefinitionRotation)

Setter for rotation.

pub unsafe fn flipVertically(&self) -> bool

When set to YES, the tile definition’s images will be flipped vertically (i.e., the top of the image becomes the bottom). Defaults to NO.

pub unsafe fn setFlipVertically(&self, flip_vertically: bool)

Setter for flipVertically.

pub unsafe fn flipHorizontally(&self) -> bool

When set to YES, the tile definition’s images will be flipped horizontally (i.e., the left of the image becomes the right). Defaults to NO.

pub unsafe fn setFlipHorizontally(&self, flip_horizontally: bool)

Setter for flipHorizontally.

impl SKTileDefinition

Methods declared on superclass NSObject.

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

pub unsafe 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.

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 SKTileDefinition

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SKTileDefinition

fn as_ref(&self) -> &NSObject

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

impl AsRef<SKTileDefinition> for SKTileDefinition

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SKTileDefinition

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SKTileDefinition

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SKTileDefinition

const NAME: &'static str = "SKTileDefinition"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SKTileDefinition 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 CopyingHelper for SKTileDefinition

type Result = SKTileDefinition

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

impl Debug for SKTileDefinition

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

Formats the value using the given formatter.

impl Deref for SKTileDefinition

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SKTileDefinition

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 SKTileDefinition

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SKTileDefinition

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate feature NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for SKTileDefinition

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 SKTileDefinition

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 SKTileDefinition

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SKTileDefinition

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 SKTileDefinition

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

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

impl DowncastTarget for SKTileDefinition

impl Eq for SKTileDefinition