MSFMapPos

Objective-C


@interface MSFMapPos : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFMapPos : NSObject

A double precision map position defined using three coordinates. X and y coordinates denote positions on the map, while z coordinate is height from the ground plane. Actual units for x, y and z depend on map projection. For example, in EPSG:4326 x is used for latitude, y for longitude and z for height in meters.

  • Checks if this object is equal to the specified object.

    Declaration

    Objective-C

    - (BOOL)isEqual:(id)object;

    Swift

    func isEqual(_ object: Any!) -> Bool

    Parameters

    object

    The reference object.

    Return Value

    True when objects are equal, false otherwise.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (NSUInteger)hash;

    Swift

    func hash() -> UInt

    Return Value

    The hash value of this object.

  • Constructs a MapPos object. All coordinates will be 0.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Constructs a MapPos object from 2 coordinates. The z coordinate will be 0.

    Declaration

    Objective-C

    - (id)initWithX:(double)x y:(double)y;

    Swift

    init!(x: Double, y: Double)

    Parameters

    x

    The x coordinate.
    y

    The y coordinate.

  • Constructs a MapPos object from 3 coordinates.

    Declaration

    Objective-C

    - (id)initWithX:(double)x y:(double)y z:(double)z;

    Swift

    init!(x: Double, y: Double, z: Double)

    Parameters

    x

    The x coordinate.
    y

    The y coordinate.
    z

    The z coordinate.

  • Returns the x coordinate of this map position.

    Declaration

    Objective-C

    - (double)getX;

    Swift

    func getX() -> Double

    Return Value

    The x coordinate of this map position.

  • Returns the y coordinate of this map position.

    Declaration

    Objective-C

    - (double)getY;

    Swift

    func getY() -> Double

    Return Value

    The y coordinate of this map position.

  • Returns the z coordinate of this map position.

    Declaration

    Objective-C

    - (double)getZ;

    Swift

    func getZ() -> Double

    Return Value

    The z coordinate of this map position.

  • Creates a new map position by adding a map vector to this map position.

    Declaration

    Objective-C

    - (MSFMapPos *)add:(MSFMapVec *)v;

    Swift

    func add(_ v: MSFMapVec!) -> MSFMapPos!

    Parameters

    v

    The map vector to be added.

    Return Value

    The new map position.

  • Creates a new map position by subtracting a map vector from this map position.

    Declaration

    Objective-C

    - (MSFMapPos *)subVec:(MSFMapVec *)v;

    Swift

    func subVec(_ v: MSFMapVec!) -> MSFMapPos!

    Parameters

    v

    The map vector to be subtracted.

    Return Value

    The new map position.

  • Creates a new map vector by subtracting a map position from this map position.

    Declaration

    Objective-C

    - (MSFMapVec *)subPos:(MSFMapPos *)p;

    Swift

    func subPos(_ p: MSFMapPos!) -> MSFMapVec!

    Parameters

    p

    The map position to be subtracted.

    Return Value

    The new map vector.

  • Checks for equality between this and another map position.

    Declaration

    Objective-C

    - (BOOL)isEqualInternal:(MSFMapPos *)p;

    Swift

    func isEqualInternal(_ p: MSFMapPos!) -> Bool

    Parameters

    p

    The other map position.

    Return Value

    True if equal.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (int)hashInternal;

    Swift

    func hashInternal() -> Int32

    Return Value

    The hash value of this object.

  • Creates a string representation of this map position, useful for logging.

    Declaration

    Objective-C

    - (NSString *)description;

    Swift

    func description() -> String!

    Return Value

    The string representation of this map position.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()