Struct GKObstacleGraph 

pub struct GKObstacleGraph<NodeType: ?Sized = AnyObject> { /* private fields */ }

Available on crate features GKGraph and GKGraphNode and GKObstacleGraph only.

A collection of GKGraphNodes that are governed by a set of extruded GKPolygonObstacles

See also Apple’s documentation

Implementations

impl<NodeType: ?Sized + Message + AsRef<GKGraphNode2D>> GKObstacleGraph<NodeType>

pub unsafe fn cast_unchecked<NewNodeType: ?Sized + Message + AsRef<GKGraphNode2D>>( &self, ) -> &GKObstacleGraph<NewNodeType>

Unchecked conversion of the generic parameter.

Safety

The generic must be valid to reinterpret as the given type.

impl<NodeType: Message + AsRef<GKGraphNode2D>> GKObstacleGraph<NodeType>

pub unsafe fn obstacles(&self) -> Retained<NSArray<GKPolygonObstacle>>

Available on crate feature GKObstacle only.

pub unsafe fn bufferRadius(&self) -> c_float

pub unsafe fn graphWithObstacles_bufferRadius( obstacles: &NSArray<GKPolygonObstacle>, buffer_radius: c_float, ) -> Retained<Self>

Available on crate feature GKObstacle only.

Creates an optimal bidirectional graph based on a list of obstacles. Each vertex of each obstacle is extruded and a connection is made between each vertex that does not intersect an obstacle Guaranteed not to have any edges which intersect obstacles. Same effect as [[GKObstacleGraph alloc] init], setting bufferRadius, and then calling addObstacles.

Parameter obstacles: a list of obstacles to create the graph from

Parameter bufferRadius: the circular radius of a potential agent that will navigate this graph. Obstacles are extruded by this amount to create the graph. Must be positive. Negative values are clipped to 0.0f

pub unsafe fn initWithObstacles_bufferRadius( this: Allocated<Self>, obstacles: &NSArray<GKPolygonObstacle>, buffer_radius: c_float, ) -> Retained<Self>

Available on crate feature GKObstacle only.

pub unsafe fn graphWithObstacles_bufferRadius_nodeClass( obstacles: &NSArray<GKPolygonObstacle>, buffer_radius: c_float, node_class: &AnyClass, ) -> Retained<Self>

Available on crate feature GKObstacle only.

Creates an optimal bidirectional graph based on a list of obstacles. Each vertex of each obstacle is extruded and a connection is made between each vertex that does not intersect an obstacle Guaranteed not to have any edges which intersect obstacles. Same effect as [[GKObstacleGraph alloc] init], setting bufferRadius, and then calling addObstacles.

Parameter obstacles: a list of obstacles to create the graph from

Parameter bufferRadius: the circular radius of a potential agent that will navigate this graph. Obstacles are extruded by this amount to create the graph. Must be positive. Negative values are clipped to 0.0f

Parameter nodeClass: the class of the nodes that this graph should create. Must descend from GKGraphNode2D

Safety

node_class probably has further requirements.

pub unsafe fn initWithObstacles_bufferRadius_nodeClass( this: Allocated<Self>, obstacles: &NSArray<GKPolygonObstacle>, buffer_radius: c_float, node_class: &AnyClass, ) -> Retained<Self>

Available on crate feature GKObstacle only.

Safety

node_class probably has further requirements.

pub unsafe fn connectNodeUsingObstacles(&self, node: &NodeType)

Connects the node to this graph by testing edge intersection with existing obstacles. Same behavior as if this node had been present during initWithObstacles.

Parameter node: the node to connect

pub unsafe fn connectNodeUsingObstacles_ignoringObstacles( &self, node: &NodeType, obstacles_to_ignore: &NSArray<GKPolygonObstacle>, )

Available on crate feature GKObstacle only.

Same behavior as connectNodeUsingObstacles: except you can optionally ignore certain obstacles from being tested for intersection.

pub unsafe fn connectNodeUsingObstacles_ignoringBufferRadiusOfObstacles( &self, node: &NodeType, obstacles_buffer_radius_to_ignore: &NSArray<GKPolygonObstacle>, )

Available on crate feature GKObstacle only.

Same behavior as connectNodeUsingObstacles: except you can optionally ignore the bounding radius of certain obstacles from being tested for intersection

pub unsafe fn addObstacles(&self, obstacles: &NSArray<GKPolygonObstacle>)

Available on crate feature GKObstacle only.

Adds obstacles to this graph. Obstacle is extruded and graph nodes are generated from its vertices and then connected to this graph Nothing is done if an obstacle is already present in this graph Any existing connections that intersect the new obstacles are destroyed unless they are protected with [GKObstacleGraph lockConnection:]

Parameter obstacles: an array of obstacles to be added

See: lockConnection

pub unsafe fn removeObstacles(&self, obstacles: &NSArray<GKPolygonObstacle>)

Available on crate feature GKObstacle only.

Removes obstacles from this graph. All associated graph nodes are removed and their connections are bidirectionally removed. Connections between obstacle nodes that were previously invalidated by any of these obstacles are restored. Nothing is done if an obstacle is already present in this graph

Parameter obstacles: an array of obstacles to be removed

pub unsafe fn removeAllObstacles(&self)

Removes all obstacles from this graph.

pub unsafe fn nodesForObstacle( &self, obstacle: &GKPolygonObstacle, ) -> Retained<NSArray<NodeType>>

Available on crate feature GKObstacle only.

Returns an array of the graph nodes associated with a given obstacle

Parameter obstacle: the obstacle who’s nodes are to be retrieved

pub unsafe fn lockConnectionFromNode_toNode( &self, start_node: &NodeType, end_node: &NodeType, )

Marks a connection as “locked”, preventing this connection from being destroyed when you add obstacles that would intersect it

Parameter startNode: startNode of the connection to lock

Parameter endNode: endNode of the connection to lock

pub unsafe fn unlockConnectionFromNode_toNode( &self, start_node: &NodeType, end_node: &NodeType, )

“Unlocks” a connection, removing its protection from being destroyed when you add obstacles that would intersect it

Parameter startNode: startNode of the connection to unlock

Parameter endNode: endNode of the connection to unlock

See: lockConnection

pub unsafe fn isConnectionLockedFromNode_toNode( &self, start_node: &NodeType, end_node: &NodeType, ) -> bool

Query if a given connection is locked

Parameter startNode: startNode of the connection to query

Parameter endNode: endNode of the connection to query

See: lockConnection

See: unlockConnection

Returns: YES if the connection was locked with lockConnection, NO if it was never locked or was unlocked via unlockConnection

pub unsafe fn classForGenericArgumentAtIndex( &self, index: NSUInteger, ) -> &'static AnyClass

Returns the class of the specified generic index

impl<NodeType: Message + AsRef<GKGraphNode2D>> GKObstacleGraph<NodeType>

Methods declared on superclass GKGraph.

pub unsafe fn graphWithNodes(nodes: &NSArray<GKGraphNode>) -> Retained<Self>

Creates a graph with the provided array of nodes.

Parameter nodes: the nodes to create the graph with

pub unsafe fn initWithNodes( this: Allocated<Self>, nodes: &NSArray<GKGraphNode>, ) -> Retained<Self>

impl<NodeType: Message + AsRef<GKGraphNode2D>> GKObstacleGraph<NodeType>

Methods declared on superclass NSObject.

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

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = GKGraph>

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

The list of nodes in this graph

pub unsafe fn connectNodeToLowestCostNode_bidirectional( &self, node: &GKGraphNode, bidirectional: bool, )

Connects the node to this graph via the lowest cost node to reach in this graph

Parameter node: the node to connect

Parameter bidirectional: should the connection be bidirectional? Otherwise it is one way connected into the graph

pub unsafe fn removeNodes(&self, nodes: &NSArray<GKGraphNode>)

Removes nodes from this graph. All connections starting and/or ending with this node are removed.

Parameter nodes: an array of nodes to be removed

pub unsafe fn addNodes(&self, nodes: &NSArray<GKGraphNode>)

Adds nodes to this graph. No new connections are added. If the node already exists in this graph this does nothing.

Parameter nodes: and array of nodes to be added

pub unsafe fn findPathFromNode_toNode( &self, start_node: &GKGraphNode, end_node: &GKGraphNode, ) -> Retained<NSArray<GKGraphNode>>

Attempts to find the optimal path between the two nodes indicated. If such a path exists, it is returned in start to end order. If it doesn’t exist, the array returned will be empty. Asserts if neither of these nodes are in this graph. Use [GKGraphNode findPathFromNode:] instead.

Parameter startNode: node to start pathing from

Parameter endNode: goal node of the pathfinding attempt

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<NodeType: ?Sized + Message> AsRef<AnyObject> for GKObstacleGraph<NodeType>

fn as_ref(&self) -> &AnyObject

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

impl<NodeType: ?Sized + Message> AsRef<GKGraph> for GKObstacleGraph<NodeType>

fn as_ref(&self) -> &GKGraph

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

impl<NodeType: ?Sized + Message> AsRef<GKObstacleGraph<NodeType>> for GKObstacleGraph<NodeType>

fn as_ref(&self) -> &Self

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

impl<NodeType: ?Sized + Message> AsRef<NSObject> for GKObstacleGraph<NodeType>

fn as_ref(&self) -> &NSObject

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

impl<NodeType: ?Sized + Message> Borrow<AnyObject> for GKObstacleGraph<NodeType>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<NodeType: ?Sized + Message> Borrow<GKGraph> for GKObstacleGraph<NodeType>

fn borrow(&self) -> &GKGraph

Immutably borrows from an owned value.

impl<NodeType: ?Sized + Message> Borrow<NSObject> for GKObstacleGraph<NodeType>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<NodeType: ?Sized + Message> ClassType for GKObstacleGraph<NodeType>

const NAME: &'static str = "GKObstacleGraph"

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

type Super = GKGraph

The superclass of this class.

type ThreadKind = <<GKObstacleGraph<NodeType> 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<NodeType: ?Sized + Message + AsRef<GKGraphNode2D>> CopyingHelper for GKObstacleGraph<NodeType>

type Result = GKObstacleGraph<NodeType>

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

impl<NodeType: ?Sized> Debug for GKObstacleGraph<NodeType>

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

Formats the value using the given formatter.

impl<NodeType: ?Sized + Message> Deref for GKObstacleGraph<NodeType>

type Target = GKGraph

The resulting type after dereferencing.

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

Dereferences the value.

impl<NodeType: ?Sized> Hash for GKObstacleGraph<NodeType>

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<NodeType: ?Sized + Message> Message for GKObstacleGraph<NodeType>

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

where Self: Sized,

Increment the reference count of the receiver.

impl<NodeType: ?Sized + NSCoding + AsRef<GKGraphNode2D>> NSCoding for GKObstacleGraph<NodeType>

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl<NodeType: ?Sized + AsRef<GKGraphNode2D>> NSCopying for GKObstacleGraph<NodeType>

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<NodeType: ?Sized + AsRef<GKGraphNode2D>> NSObjectProtocol for GKObstacleGraph<NodeType>

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<NodeType: ?Sized + NSSecureCoding + AsRef<GKGraphNode2D>> NSSecureCoding for GKObstacleGraph<NodeType>

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl<NodeType: ?Sized> PartialEq for GKObstacleGraph<NodeType>

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<NodeType: ?Sized + Message> RefEncode for GKObstacleGraph<NodeType>

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

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

impl DowncastTarget for GKObstacleGraph<AnyObject>

impl<NodeType: ?Sized> Eq for GKObstacleGraph<NodeType>