PathCollectionObject

Objective-C


@interface PathCollectionObject : NSObject

Swift

class PathCollectionObject : NSObject

This class encapsulates path collection information.

  • Initializes and returns a newly allocated object using the model data..

    Declaration

    Objective-C

    - (nonnull instancetype)initWithModelData:(nonnull void *)data;

  • Get the number of paths in this collection.

    Declaration

    Objective-C

    - (int)size;

    Swift

    func size() -> Int32

  • Get the path specified by index.

    Declaration

    Objective-C

    - (nullable PathObject *)getPathAt:(int)index;

    Swift

    func getPathAt(_ index: Int32) -> PathObject?

  • Get the path specified by name.

    Declaration

    Objective-C

    - (nullable PathObject *)getPathByName:(nonnull NSString *)name;

    Swift

    func getPathByName(_ name: String) -> PathObject?

  • Get the border color for the path specified by index.

    Declaration

    Objective-C

    - (nonnull UIColor *)getBorderColorAt:(int)index;

    Swift

    func getBorderColor(at index: Int32) -> UIColor

  • Get the inner color for the path specified by index.

    Declaration

    Objective-C

    - (nonnull UIColor *)getFillColorAt:(int)index;

    Swift

    func getFillColor(at index: Int32) -> UIColor

  • Get the border size for the path specified by index.

    Declaration

    Objective-C

    - (double)getBorderSizeAt:(int)index;

    Swift

    func getBorderSize(at index: Int32) -> Double

  • Get the inner size for the path specified by index.

    Declaration

    Objective-C

    - (double)getInnerSizeAt:(int)index;

    Swift

    func getInnerSize(at index: Int32) -> Double

  • Add a path in the collection.

    Declaration

    Objective-C

    - (BOOL)add:(nonnull PathObject *)path
    colorBorder:(nullable UIColor *)colorBorder
     colorInner:(nullable UIColor *)colorInner
       szBorder:(double)szBorder
        szInner:(double)szInner;

    Swift

    func add(_ path: PathObject, colorBorder: UIColor?, colorInner: UIColor?, szBorder: Double, szInner: Double) -> Bool

    Parameters

    path

    The path to be added.
    colorBorder

    The color of the path border. By default the one from the current map view style is used.
    colorInner

    The color of the path inner. By default the one from the current map view style is used.
    szBorder

    The size of the path border in mm. If < 0 the one from the current map view style is used.
    szInner

    The size of the path inner in mm. If < 0 the one from the current map view style is used.

    Return Value

    Operation with success.

  • Remove the path from collection.

    Declaration

    Objective-C

    - (BOOL)remove:(nonnull PathObject *)object;

    Swift

    func remove(_ object: PathObject) -> Bool

    Return Value

    Operation with success.

  • Remove the path specified by index.

    Declaration

    Objective-C

    - (BOOL)removeAt:(int)index;

    Swift

    func remove(at index: Int32) -> Bool

    Return Value

    Operation with success.

  • Remove all paths from collection.

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()