Struct MKMultiPolygonRenderer

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

Available on crate features MKMultiPolygonRenderer and MKOverlayPathRenderer and MKOverlayRenderer only.

Apple’s documentation

Implementations

impl MKMultiPolygonRenderer

pub unsafe fn initWithMultiPolygon( this: Allocated<Self>, multi_polygon: &MKMultiPolygon, ) -> Retained<Self>

Available on crate features MKMultiPolygon and MKShape only.

pub unsafe fn multiPolygon(&self) -> Retained<MKMultiPolygon>

Available on crate features MKMultiPolygon and MKShape only.

impl MKMultiPolygonRenderer

Methods declared on superclass MKOverlayRenderer.

pub unsafe fn initWithOverlay( this: Allocated<Self>, overlay: &ProtocolObject<dyn MKOverlay>, ) -> Retained<Self>

Available on crate features MKAnnotation and MKOverlay only.

impl MKMultiPolygonRenderer

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = MKOverlayPathRenderer>

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

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

pub unsafe fn setFillColor(&self, fill_color: Option<&NSColor>)

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

Setter for fillColor.

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

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

pub unsafe fn setStrokeColor(&self, stroke_color: Option<&NSColor>)

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

Setter for strokeColor.

pub unsafe fn lineWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLineWidth(&self, line_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineWidth.

pub unsafe fn lineJoin(&self) -> CGLineJoin

Available on crate feature objc2-core-graphics only.

pub unsafe fn setLineJoin(&self, line_join: CGLineJoin)

Available on crate feature objc2-core-graphics only.

Setter for lineJoin.

pub unsafe fn lineCap(&self) -> CGLineCap

Available on crate feature objc2-core-graphics only.

pub unsafe fn setLineCap(&self, line_cap: CGLineCap)

Available on crate feature objc2-core-graphics only.

Setter for lineCap.

pub unsafe fn miterLimit(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMiterLimit(&self, miter_limit: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for miterLimit.

pub unsafe fn lineDashPhase(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLineDashPhase(&self, line_dash_phase: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineDashPhase.

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

pub unsafe fn setLineDashPattern( &self, line_dash_pattern: Option<&NSArray<NSNumber>>, )

Setter for lineDashPattern.

pub unsafe fn shouldRasterize(&self) -> bool

pub unsafe fn setShouldRasterize(&self, should_rasterize: bool)

Setter for shouldRasterize.

pub unsafe fn createPath(&self)

pub unsafe fn path(&self) -> Option<Retained<CGPath>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn setPath(&self, path: Option<&CGPath>)

Available on crate feature objc2-core-graphics only.

Setter for path.

pub unsafe fn invalidatePath(&self)

pub unsafe fn applyStrokePropertiesToContext_atZoomScale( &self, context: &CGContext, zoom_scale: MKZoomScale, )

Available on crate features MKGeometry and objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn applyFillPropertiesToContext_atZoomScale( &self, context: &CGContext, zoom_scale: MKZoomScale, )

Available on crate features MKGeometry and objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn strokePath_inContext(&self, path: &CGPath, context: &CGContext)

Available on crate feature objc2-core-graphics only.

pub unsafe fn fillPath_inContext(&self, path: &CGPath, context: &CGContext)

Available on crate feature objc2-core-graphics only.

Methods from Deref<Target = MKOverlayRenderer>

pub unsafe fn overlay(&self) -> Retained<ProtocolObject<dyn MKOverlay>>

Available on crate features MKAnnotation and MKOverlay only.

pub unsafe fn pointForMapPoint(&self, map_point: MKMapPoint) -> CGPoint

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

pub unsafe fn mapPointForPoint(&self, point: CGPoint) -> MKMapPoint

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

pub unsafe fn rectForMapRect(&self, map_rect: MKMapRect) -> CGRect

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

pub unsafe fn mapRectForRect(&self, rect: CGRect) -> MKMapRect

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

pub unsafe fn canDrawMapRect_zoomScale( &self, map_rect: MKMapRect, zoom_scale: MKZoomScale, ) -> bool

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

pub unsafe fn drawMapRect_zoomScale_inContext( &self, map_rect: MKMapRect, zoom_scale: MKZoomScale, context: &CGContext, )

Available on crate features MKGeometry and objc2-core-foundation and objc2-core-graphics only.

pub unsafe fn setNeedsDisplay(&self)

pub unsafe fn setNeedsDisplayInMapRect(&self, map_rect: MKMapRect)

Available on crate feature MKGeometry only.

pub unsafe fn setNeedsDisplayInMapRect_zoomScale( &self, map_rect: MKMapRect, zoom_scale: MKZoomScale, )

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

pub unsafe fn alpha(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

Setter for alpha.

pub unsafe fn contentScaleFactor(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn blendMode(&self) -> CGBlendMode

Available on crate feature objc2-core-graphics only.

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

Available on crate feature objc2-core-graphics only.

Setter for blendMode.

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 MKMultiPolygonRenderer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MKMultiPolygonRenderer> for MKMultiPolygonRenderer

fn as_ref(&self) -> &Self

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

impl AsRef<MKOverlayPathRenderer> for MKMultiPolygonRenderer

fn as_ref(&self) -> &MKOverlayPathRenderer

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

impl AsRef<MKOverlayRenderer> for MKMultiPolygonRenderer

fn as_ref(&self) -> &MKOverlayRenderer

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

impl AsRef<NSObject> for MKMultiPolygonRenderer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MKMultiPolygonRenderer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MKOverlayPathRenderer> for MKMultiPolygonRenderer

fn borrow(&self) -> &MKOverlayPathRenderer

Immutably borrows from an owned value.

impl Borrow<MKOverlayRenderer> for MKMultiPolygonRenderer

fn borrow(&self) -> &MKOverlayRenderer

Immutably borrows from an owned value.

impl Borrow<NSObject> for MKMultiPolygonRenderer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MKMultiPolygonRenderer

const NAME: &'static str = "MKMultiPolygonRenderer"

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

type Super = MKOverlayPathRenderer

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MKMultiPolygonRenderer

type Target = MKOverlayPathRenderer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MKMultiPolygonRenderer

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 MKMultiPolygonRenderer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MKMultiPolygonRenderer

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 PartialEq for MKMultiPolygonRenderer

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 MKMultiPolygonRenderer

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

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

impl DowncastTarget for MKMultiPolygonRenderer

impl Eq for MKMultiPolygonRenderer