Struct SKTileMapNode

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

Available on crate feature SKNode and crate feature SKTileMapNode and crate feature objc2-app-kit and macOS only.

A SpriteKit node used to render a 2D array of textured sprites. Uses SKTileSet to determine what textures it can use to render. Separate tile map nodes can be layered on top of one another to achieve various effects, such as parallax scrolling.

See also Apple’s documentation

Implementations

impl SKTileMapNode

pub unsafe fn tileMapNodeWithTileSet_columns_rows_tileSize( tile_set: &SKTileSet, columns: NSUInteger, rows: NSUInteger, tile_size: CGSize, mtm: MainThreadMarker, ) -> Retained<Self>

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

Create a tile map node with the specified tile set and dimensions. The tiles of the map will be empty, equivalent to the nil tile definition/group.

Parameter tileSet: the tile set that is used to render the tiles

Parameter columns: the number of columns in the map that can hold tiles

Parameter rows: the number of rows in the map that can hold tiles

Parameter tileSize: the size of each tile in points

pub unsafe fn tileMapNodeWithTileSet_columns_rows_tileSize_fillWithTileGroup( tile_set: &SKTileSet, columns: NSUInteger, rows: NSUInteger, tile_size: CGSize, tile_group: &SKTileGroup, mtm: MainThreadMarker, ) -> Retained<Self>

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

Create a tile map node with the specified tile set and dimensions, and fill it with the specified tile group.

Parameter tileSet: the tile set that is used to render the tiles

Parameter columns: the number of columns in the map that can hold tiles

Parameter rows: the number of rows in the map that can hold tiles

Parameter tileSize: the size of each tile in points

Parameter tileGroup: the tile group we wish to fill the tile map with

pub unsafe fn tileMapNodeWithTileSet_columns_rows_tileSize_tileGroupLayout( tile_set: &SKTileSet, columns: NSUInteger, rows: NSUInteger, tile_size: CGSize, tile_group_layout: &NSArray<SKTileGroup>, mtm: MainThreadMarker, ) -> Retained<Self>

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

Create a tile map node with the specified tile set and dimensions, and fill it with a specific layout of tile groups that belong to the provided tile set. The tileGroupLayout array should match the dimensions of the tile map (i.e., the number of elements should be equal to columns * rows). Index 0 of the array maps to column 0, row 0 of the tile map. Index 1 is column 1, row 0, and so on, wrapping around to the next row once the index passes the number of columns in the tile map. If the array has fewer elements than the number of tiles in the map, the remaining tiles are initialized with the nil tile group. If the array has more elements than the number of tiles in the map, the extra tile groups are ignored.

Parameter tileSet: the tile set that is used to render the tiles

Parameter columns: the number of columns in the map that can hold tiles

Parameter rows: the number of rows in the map that can hold tiles

Parameter tileSize: the size of each tile in points

Parameter tileGroupLayout: an array of tile groups that we want to use to fill the tile map

pub unsafe fn initWithTileSet_columns_rows_tileSize( this: Allocated<Self>, tile_set: &SKTileSet, columns: NSUInteger, rows: NSUInteger, tile_size: CGSize, ) -> Retained<Self>

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

Initialize a tile map node with the specified tile set and dimensions. The tiles of the map will be empty, equivalent to the nil tile definition/group.

Parameter tileSet: the tile set that is used to render the tiles

Parameter columns: the number of columns in the map that can hold tiles

Parameter rows: the number of rows in the map that can hold tiles

Parameter tileSize: the size of each tile in points

pub unsafe fn initWithTileSet_columns_rows_tileSize_fillWithTileGroup( this: Allocated<Self>, tile_set: &SKTileSet, columns: NSUInteger, rows: NSUInteger, tile_size: CGSize, tile_group: &SKTileGroup, ) -> Retained<Self>

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

Initialize a tile map node with the specified tile set and dimensions, and fill it with the specified tile group.

Parameter tileSet: the tile set that is used to render the tiles

Parameter columns: the number of columns in the map that can hold tiles

Parameter rows: the number of rows in the map that can hold tiles

Parameter tileSize: the size of each tile in points

Parameter tileGroup: the tile group we wish to fill the tile map with

pub unsafe fn initWithTileSet_columns_rows_tileSize_tileGroupLayout( this: Allocated<Self>, tile_set: &SKTileSet, columns: NSUInteger, rows: NSUInteger, tile_size: CGSize, tile_group_layout: &NSArray<SKTileGroup>, ) -> Retained<Self>

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

Initialize a tile map node with the specified tile set and dimensions, and fill it with a specific layout of tile groups that belong to the provided tile set. The tileGroupLayout array should match the dimensions of the tile map (i.e., the number of elements should be equal to columns * rows). Index 0 of the array maps to column 0, row 0 of the tile map. Index 1 is column 1, row 0, and so on, wrapping around to the next row once the index passes the number of columns in the tile map. If the array has fewer elements than the number of tiles in the map, the remaining tiles are initialized with the nil tile group. If the array has more elements than the number of tiles in the map, the extra tile groups are ignored.

Parameter tileSet: the tile set that is used to render the tiles

Parameter columns: the number of columns in the map that can hold tiles

Parameter rows: the number of rows in the map that can hold tiles

Parameter tileSize: the size of each tile in points

Parameter tileGroupLayout: an array of tile groups that we want to use to fill the tile map

pub unsafe fn numberOfColumns(&self) -> NSUInteger

The number of columns in the tile map.

pub unsafe fn setNumberOfColumns(&self, number_of_columns: NSUInteger)

Setter for numberOfColumns.

pub unsafe fn numberOfRows(&self) -> NSUInteger

The number of rows in the tile map.

pub unsafe fn setNumberOfRows(&self, number_of_rows: NSUInteger)

Setter for numberOfRows.

pub unsafe fn tileSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The size of each tile in the map.

pub unsafe fn setTileSize(&self, tile_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for tileSize.

pub unsafe fn mapSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The size of the tile map. This is dependent on the tileSize, the number of columns and rows in the map, and the tile set type.

pub unsafe fn tileSet(&self) -> Retained<SKTileSet>

Available on crate feature SKTileSet only.

The tile set being used by this tile map.

pub unsafe fn setTileSet(&self, tile_set: &SKTileSet)

Available on crate feature SKTileSet only.

Setter for tileSet.

pub unsafe fn colorBlendFactor(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Controls the blending between the texture and the tile map color. The valid interval of values is from 0.0 up to and including 1.0. A value above or below that interval is clamped to the minimum (0.0) if below or the maximum (1.0) if above.

pub unsafe fn setColorBlendFactor(&self, color_blend_factor: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for colorBlendFactor.

pub unsafe fn color(&self) -> Retained<NSColor>

Base color for the tile map (If no texture is present, the color still is drawn).

pub unsafe fn setColor(&self, color: &NSColor)

Setter for color.

pub unsafe fn blendMode(&self) -> SKBlendMode

Sets the blend mode to use when composing the tile map with the final framebuffer.

See: SKNode.SKBlendMode

pub unsafe fn setBlendMode(&self, blend_mode: SKBlendMode)

Setter for blendMode.

pub unsafe fn anchorPoint(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

Used to choose the location in the tile map that maps to its ‘position’ in the parent’s coordinate space. The valid interval for each input is from 0.0 up to and including 1.0.

pub unsafe fn setAnchorPoint(&self, anchor_point: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for anchorPoint.

pub unsafe fn shader(&self) -> Option<Retained<SKShader>>

Available on crate feature SKShader only.

A property that determines whether the tile map is rendered using a custom shader.

pub unsafe fn setShader(&self, shader: Option<&SKShader>)

Available on crate feature SKShader only.

Setter for shader.

pub unsafe fn attributeValues( &self, ) -> Retained<NSDictionary<NSString, SKAttributeValue>>

Available on crate feature SKAttribute only.

Optional dictionary of SKAttributeValues Attributes can be used with custom SKShaders.

pub unsafe fn setAttributeValues( &self, attribute_values: &NSDictionary<NSString, SKAttributeValue>, )

Available on crate feature SKAttribute only.

Setter for attributeValues.

pub unsafe fn valueForAttributeNamed( &self, key: &NSString, ) -> Option<Retained<SKAttributeValue>>

Available on crate feature SKAttribute only.

pub unsafe fn setValue_forAttributeNamed( &self, value: &SKAttributeValue, key: &NSString, )

Available on crate feature SKAttribute only.

pub unsafe fn lightingBitMask(&self) -> u32

Bitmask to indicate being lit by a set of lights using overlapping lighting categories.

A light whose category is set to a value that masks to non-zero using this mask will apply light to this sprite.

When used together with a normal texture, complex lighting effects can be used.

pub unsafe fn setLightingBitMask(&self, lighting_bit_mask: u32)

Setter for lightingBitMask.

pub unsafe fn enableAutomapping(&self) -> bool

pub unsafe fn setEnableAutomapping(&self, enable_automapping: bool)

Setter for enableAutomapping.

pub unsafe fn fillWithTileGroup(&self, tile_group: Option<&SKTileGroup>)

Available on crate feature SKTileSet only.

Fill the entire tile map with the provided tile group.

Parameter tileGroup: the tile group that will be used to fill the map

pub unsafe fn tileDefinitionAtColumn_row( &self, column: NSUInteger, row: NSUInteger, ) -> Option<Retained<SKTileDefinition>>

Available on crate feature SKTileDefinition only.

Look up the tile definition at the specified tile index.

Parameter column: the column index of the tile

Parameter row: the row index of the tile

pub unsafe fn tileGroupAtColumn_row( &self, column: NSUInteger, row: NSUInteger, ) -> Option<Retained<SKTileGroup>>

Available on crate feature SKTileSet only.

Look up the tile group at the specified tile index.

Parameter column: the column index of the tile

Parameter row: the row index of the tile

pub unsafe fn setTileGroup_forColumn_row( &self, tile_group: Option<&SKTileGroup>, column: NSUInteger, row: NSUInteger, )

Available on crate feature SKTileSet only.

Set the tile group at the specified tile index. When automapping is enabled, the appropriate tile definitions will automatically be selected and placed, possibly modifying neighboring tiles. When automapping is disabled, it will simply place the default center tile definition for the group, and will not modify any of the neihboring tiles.

Parameter tileGroup: the tile group we want to place in the map

Parameter column: the column index of the tile

Parameter row: the row index of the tile

pub unsafe fn setTileGroup_andTileDefinition_forColumn_row( &self, tile_group: &SKTileGroup, tile_definition: &SKTileDefinition, column: NSUInteger, row: NSUInteger, )

Available on crate features SKTileDefinition and SKTileSet only.

Set the tile group and tile defintion at the specified tile index. When automapping is enabled, it will attempt to resolve the surrounding tiles to allow the specified tile definition to be placed. When automapping is disabled, it will simply place the tile definition and not modify any of the neighboring tiles.

Parameter tileGroup: the tile group we want to place in the map

Parameter tileDefinition: the tile definition we want to place in the map

Parameter column: the column index of the tile

Parameter row: the row index of the tile

pub unsafe fn tileColumnIndexFromPosition( &self, position: CGPoint, ) -> NSUInteger

Available on crate feature objc2-core-foundation only.

Returns the column index of the tile that lies under the specified position. Returns NSUIntegerMax if the position does not fall within the tile map.

Parameter position: the position we want to check against the tile map

pub unsafe fn tileRowIndexFromPosition(&self, position: CGPoint) -> NSUInteger

Available on crate feature objc2-core-foundation only.

Returns the row index of the tile that lies under the specified position. Returns NSUIntegerMax if the position does not fall within the tile map.

Parameter position: the position we want to check against the tile map

pub unsafe fn centerOfTileAtColumn_row( &self, column: NSUInteger, row: NSUInteger, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

Returns the position of the center of the tile at the specified column and row.

Parameter column: the column index of the tile

Parameter row: the row index of the tile

impl SKTileMapNode

Methods declared on superclass SKNode.

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

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

Support coding and decoding via NSKeyedArchiver.

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

pub unsafe fn nodeWithFileNamed( filename: &NSString, mtm: MainThreadMarker, ) -> Option<Retained<Self>>

pub unsafe fn nodeWithFileNamed_securelyWithClasses_andError( filename: &NSString, classes: &NSSet<AnyClass>, mtm: MainThreadMarker, ) -> Result<Retained<Self>, Retained<NSError>>

impl SKTileMapNode

Methods declared on superclass NSObject.

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

Methods from Deref<Target = SKNode>

pub unsafe fn frame(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn calculateAccumulatedFrame(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

Calculates the bounding box including all child nodes in parents coordinate system.

pub unsafe fn position(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

The position of the node in the parent’s coordinate system

pub unsafe fn setPosition(&self, position: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for position.

pub unsafe fn zPosition(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The z-order of the node (used for ordering). Negative z is “into” the screen, Positive z is “out” of the screen. A greater zPosition will sort in front of a lesser zPosition.

pub unsafe fn setZPosition(&self, z_position: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for zPosition.

pub unsafe fn zRotation(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The Euler rotation about the z axis (in radians)

pub unsafe fn setZRotation(&self, z_rotation: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for zRotation.

pub unsafe fn xScale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The scaling in the X axis

pub unsafe fn setXScale(&self, x_scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for xScale.

pub unsafe fn yScale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The scaling in the Y axis

pub unsafe fn setYScale(&self, y_scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for yScale.

pub unsafe fn speed(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The speed multiplier applied to all actions run on this node. Inherited by its children.

pub unsafe fn setSpeed(&self, speed: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for speed.

pub unsafe fn alpha(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Alpha of this node (multiplied by the output color to give the final result)

pub unsafe fn setAlpha(&self, alpha: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for alpha.

pub unsafe fn isPaused(&self) -> bool

Controls whether or not the node’s actions is updated or paused.

pub unsafe fn setPaused(&self, paused: bool)

Setter for isPaused.

pub unsafe fn isHidden(&self) -> bool

Controls whether or not the node and its children are rendered.

pub unsafe fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub unsafe fn isUserInteractionEnabled(&self) -> bool

Controls whether or not the node receives touch events

pub unsafe fn setUserInteractionEnabled(&self, user_interaction_enabled: bool)

Setter for isUserInteractionEnabled.

pub unsafe fn focusBehavior(&self) -> SKNodeFocusBehavior

Determines how this node participates in the focus system. The default is SKNodeFocusBehaviorNone.

pub unsafe fn setFocusBehavior(&self, focus_behavior: SKNodeFocusBehavior)

Setter for focusBehavior.

pub unsafe fn parent(&self) -> Option<Retained<SKNode>>

The parent of the node.

If this is nil the node has not been added to another group and is thus the root node of its own graph.

pub unsafe fn children(&self) -> Retained<NSArray<SKNode>>

The children of this node.

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

The client assignable name.

In general, this should be unique among peers in the scene graph.

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

Setter for name.

pub unsafe fn scene(&self) -> Option<Retained<SKScene>>

Available on crate features SKEffectNode and SKScene only.

The scene that the node is currently in.

pub unsafe fn physicsBody(&self) -> Option<Retained<SKPhysicsBody>>

Available on crate feature SKPhysicsBody only.

Physics body attached to the node, with synchronized scale, rotation, and position

pub unsafe fn setPhysicsBody(&self, physics_body: Option<&SKPhysicsBody>)

Available on crate feature SKPhysicsBody only.

Setter for physicsBody.

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

An optional dictionary that can be used to store your own data in a node. Defaults to nil.

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

Setter for userData.

pub unsafe fn reachConstraints(&self) -> Option<Retained<SKReachConstraints>>

Available on crate feature SKReachConstraints only.

Kinematic constraints, used in IK solving

pub unsafe fn setReachConstraints( &self, reach_constraints: Option<&SKReachConstraints>, )

Available on crate feature SKReachConstraints only.

Setter for reachConstraints.

pub unsafe fn constraints(&self) -> Option<Retained<NSArray<SKConstraint>>>

Available on crate feature SKConstraint only.

Optional array of SKConstraints Constraints are evaluated each frame after actions and physics. The node’s transform will be changed to satisfy the constraint.

pub unsafe fn setConstraints(&self, constraints: Option<&NSArray<SKConstraint>>)

Available on crate feature SKConstraint only.

Setter for constraints.

pub unsafe fn attributeValues( &self, ) -> Retained<NSDictionary<NSString, SKAttributeValue>>

👎Deprecated

Available on crate feature SKAttribute only.

Optional dictionary of SKAttributeValues Attributes can be used with custom SKShaders. DEPRECATED: Attributes are only available for node classes supporting SKShader (see SKSpriteNode etc.).

pub unsafe fn setAttributeValues( &self, attribute_values: &NSDictionary<NSString, SKAttributeValue>, )

👎Deprecated

Available on crate feature SKAttribute only.

Setter for attributeValues.

pub unsafe fn valueForAttributeNamed( &self, key: &NSString, ) -> Option<Retained<SKAttributeValue>>

👎Deprecated

Available on crate feature SKAttribute only.

pub unsafe fn setValue_forAttributeNamed( &self, value: &SKAttributeValue, key: &NSString, )

👎Deprecated

Available on crate feature SKAttribute only.

pub unsafe fn setScale(&self, scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Sets both the x & y scale

Parameter scale: the uniform scale to set.

pub unsafe fn addChild(&self, node: &SKNode)

Adds a node as a child node of this node

The added node must not have a parent.

Parameter node: the child node to add.

pub unsafe fn insertChild_atIndex(&self, node: &SKNode, index: NSInteger)

pub unsafe fn removeChildrenInArray(&self, nodes: &NSArray<SKNode>)

pub unsafe fn removeAllChildren(&self)

pub unsafe fn removeFromParent(&self)

pub unsafe fn moveToParent(&self, parent: &SKNode)

pub unsafe fn childNodeWithName( &self, name: &NSString, ) -> Option<Retained<SKNode>>

pub unsafe fn enumerateChildNodesWithName_usingBlock( &self, name: &NSString, block: &DynBlock<dyn Fn(NonNull<SKNode>, NonNull<Bool>)>, )

Available on crate feature block2 only.

pub unsafe fn objectForKeyedSubscript( &self, name: &NSString, ) -> Retained<NSArray<SKNode>>

Simplified shorthand for enumerateChildNodesWithName that returns an array of the matching nodes. This allows subscripting of the form: NSArray *childrenMatchingName = node[ “ name“]

or even complex like: NSArray siblingsBeginningWithA = node[ “ ../a“]

Parameter name: An Xpath style path that can include simple regular expressions for matching node names.

See: enumerateChildNodesWithName:usingBlock:

pub unsafe fn inParentHierarchy(&self, parent: &SKNode) -> bool

pub unsafe fn runAction(&self, action: &SKAction)

Available on crate feature SKAction only.

pub unsafe fn runAction_completion( &self, action: &SKAction, block: &DynBlock<dyn Fn()>, )

Available on crate features SKAction and block2 only.

pub unsafe fn runAction_withKey(&self, action: &SKAction, key: &NSString)

Available on crate feature SKAction only.

pub unsafe fn hasActions(&self) -> bool

pub unsafe fn actionForKey(&self, key: &NSString) -> Option<Retained<SKAction>>

Available on crate feature SKAction only.

pub unsafe fn removeActionForKey(&self, key: &NSString)

pub unsafe fn removeAllActions(&self)

pub unsafe fn containsPoint(&self, p: CGPoint) -> bool

Available on crate feature objc2-core-foundation only.

pub unsafe fn nodeAtPoint(&self, p: CGPoint) -> Retained<SKNode>

Available on crate feature objc2-core-foundation only.

Returns the node itself or a child node at the point given. If the receiver is returned there is no child node at the given point.

Returns: a child node or self at the given location.

pub unsafe fn nodesAtPoint(&self, p: CGPoint) -> Retained<NSArray<SKNode>>

Available on crate feature objc2-core-foundation only.

pub unsafe fn convertPoint_fromNode( &self, point: CGPoint, node: &SKNode, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub unsafe fn convertPoint_toNode( &self, point: CGPoint, node: &SKNode, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub unsafe fn intersectsNode(&self, node: &SKNode) -> bool

pub unsafe fn isEqualToNode(&self, node: &SKNode) -> bool

pub unsafe fn isAccessibilityElement(&self) -> bool

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityElement(&self, accessibility_element: bool)

Available on crate feature SKNode_NSAccessibility only.

Setter for isAccessibilityElement.

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

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityRole(&self, accessibility_role: Option<&NSString>)

Available on crate feature SKNode_NSAccessibility only.

Setter for accessibilityRole.

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

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityRoleDescription( &self, accessibility_role_description: Option<&NSString>, )

Available on crate feature SKNode_NSAccessibility only.

Setter for accessibilityRoleDescription.

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

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilitySubrole( &self, accessibility_subrole: Option<&NSString>, )

Available on crate feature SKNode_NSAccessibility only.

Setter for accessibilitySubrole.

pub unsafe fn accessibilityFrame(&self) -> CGRect

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

pub unsafe fn setAccessibilityFrame(&self, accessibility_frame: CGRect)

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

Setter for accessibilityFrame.

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

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityParent( &self, accessibility_parent: Option<&AnyObject>, )

Available on crate feature SKNode_NSAccessibility only.

This is a weak property. Setter for accessibilityParent.

pub unsafe fn accessibilityChildren(&self) -> Option<Retained<NSArray>>

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityChildren( &self, accessibility_children: Option<&NSArray>, )

Available on crate feature SKNode_NSAccessibility only.

Setter for accessibilityChildren.

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

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityHelp(&self, accessibility_help: Option<&NSString>)

Available on crate feature SKNode_NSAccessibility only.

Setter for accessibilityHelp.

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

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityLabel( &self, accessibility_label: Option<&NSString>, )

Available on crate feature SKNode_NSAccessibility only.

Setter for accessibilityLabel.

pub unsafe fn isAccessibilityEnabled(&self) -> bool

Available on crate feature SKNode_NSAccessibility only.

pub unsafe fn setAccessibilityEnabled(&self, accessibility_enabled: bool)

Available on crate feature SKNode_NSAccessibility only.

Setter for isAccessibilityEnabled.

pub unsafe fn accessibilityHitTest( &self, point: CGPoint, ) -> Option<Retained<AnyObject>>

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

Methods from Deref<Target = NSResponder>

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

pub unsafe fn performKeyEquivalent(&self, event: &NSEvent) -> bool

pub unsafe fn mouseDown(&self, event: &NSEvent)

pub unsafe fn rightMouseDown(&self, event: &NSEvent)

pub unsafe fn otherMouseDown(&self, event: &NSEvent)

pub unsafe fn mouseUp(&self, event: &NSEvent)

pub unsafe fn rightMouseUp(&self, event: &NSEvent)

pub unsafe fn otherMouseUp(&self, event: &NSEvent)

pub unsafe fn mouseMoved(&self, event: &NSEvent)

pub unsafe fn mouseDragged(&self, event: &NSEvent)

pub unsafe fn scrollWheel(&self, event: &NSEvent)

pub unsafe fn rightMouseDragged(&self, event: &NSEvent)

pub unsafe fn otherMouseDragged(&self, event: &NSEvent)

pub unsafe fn mouseEntered(&self, event: &NSEvent)

pub unsafe fn mouseExited(&self, event: &NSEvent)

pub unsafe fn keyDown(&self, event: &NSEvent)

pub unsafe fn keyUp(&self, event: &NSEvent)

pub unsafe fn flagsChanged(&self, event: &NSEvent)

pub unsafe fn tabletPoint(&self, event: &NSEvent)

pub unsafe fn tabletProximity(&self, event: &NSEvent)

pub unsafe fn cursorUpdate(&self, event: &NSEvent)

pub unsafe fn magnifyWithEvent(&self, event: &NSEvent)

pub unsafe fn rotateWithEvent(&self, event: &NSEvent)

pub unsafe fn swipeWithEvent(&self, event: &NSEvent)

pub unsafe fn beginGestureWithEvent(&self, event: &NSEvent)

pub unsafe fn endGestureWithEvent(&self, event: &NSEvent)

pub unsafe fn smartMagnifyWithEvent(&self, event: &NSEvent)

pub unsafe fn changeModeWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesBeganWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesMovedWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesEndedWithEvent(&self, event: &NSEvent)

pub unsafe fn touchesCancelledWithEvent(&self, event: &NSEvent)

pub unsafe fn quickLookWithEvent(&self, event: &NSEvent)

pub unsafe fn pressureChangeWithEvent(&self, event: &NSEvent)

pub unsafe fn contextMenuKeyDown(&self, event: &NSEvent)

Handle a key event that should present a context menu at the user focus.

Most applications should not override this method. Instead, you should customize the context menu displayed from a keyboard event by implementing menuForEvent: and selectionAnchorRect, or showContextMenuForSelection:, rather than this method.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

pub unsafe fn noResponderFor(&self, event_selector: Sel)

pub unsafe fn acceptsFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn interpretKeyEvents(&self, event_array: &NSArray<NSEvent>)

pub unsafe fn flushBufferedKeyEvents(&self)

pub unsafe fn showContextHelp(&self, sender: Option<&AnyObject>)

pub unsafe fn helpRequested(&self, event_ptr: &NSEvent)

pub unsafe fn shouldBeTreatedAsInkEvent(&self, event: &NSEvent) -> bool

pub unsafe fn wantsScrollEventsForSwipeTrackingOnAxis( &self, axis: NSEventGestureAxis, ) -> bool

pub unsafe fn wantsForwardedScrollEventsForAxis( &self, axis: NSEventGestureAxis, ) -> bool

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

pub unsafe fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub unsafe fn validateProposedFirstResponder_forEvent( &self, responder: &NSResponder, event: Option<&NSEvent>, ) -> bool

pub unsafe fn presentError(&self, error: &NSError) -> bool

pub unsafe fn willPresentError(&self, error: &NSError) -> Retained<NSError>

pub unsafe fn performTextFinderAction(&self, sender: Option<&AnyObject>)

pub unsafe fn newWindowForTab(&self, sender: Option<&AnyObject>)

pub unsafe fn showWritingTools(&self, sender: Option<&AnyObject>)

pub unsafe fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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 SKTileMapNode

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SKTileMapNode

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for SKTileMapNode

fn as_ref(&self) -> &NSResponder

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

impl AsRef<SKNode> for SKTileMapNode

fn as_ref(&self) -> &SKNode

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

impl AsRef<SKTileMapNode> for SKTileMapNode

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SKTileMapNode

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SKTileMapNode

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for SKTileMapNode

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<SKNode> for SKTileMapNode

fn borrow(&self) -> &SKNode

Immutably borrows from an owned value.

impl ClassType for SKTileMapNode

const NAME: &'static str = "SKTileMapNode"

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

type Super = SKNode

The superclass of this class.

type ThreadKind = <<SKTileMapNode 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 SKTileMapNode

type Result = SKTileMapNode

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

impl Debug for SKTileMapNode

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

Formats the value using the given formatter.

impl Deref for SKTileMapNode

type Target = SKNode

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SKTileMapNode

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 SKTileMapNode

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SKTileMapNode

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSCopying for SKTileMapNode

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 SKTileMapNode

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 SKTileMapNode

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SKTileMapNode

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 SKTileMapNode

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

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

impl DowncastTarget for SKTileMapNode

impl Eq for SKTileMapNode