MSFMapBounds

Objective-C


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

Swift

class MSFMapBounds : NSObject

A container class that defines an axis aligned cuboid on the map using minimum and maximum map positions. Valid ranges for map bounds depend on the projection used.

  • 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 an empty MapBounds object. The coordinates of the minimum map position will be set to positive infinity and the coordinates of the maximum map position will be set to negative infinity.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Constructs a MapBounds object from a minimum and maximum map position. If a coordinate of the minimum map positon is larger than the same coordinate of the maximum map position then those coordinates will be swapped.

    Declaration

    Objective-C

    - (id)initWithMin:(MSFMapPos *)min max:(MSFMapPos *)max;

    Swift

    init!(min: MSFMapPos!, max: MSFMapPos!)

    Parameters

    min

    The minimum map position (south-west).
    max

    The maximum map position (north-east).

  • Checks for equality between this and another map bounds object.

    Declaration

    Objective-C

    - (BOOL)isEqualInternal:(MSFMapBounds *)mapBounds;

    Swift

    func isEqualInternal(_ mapBounds: MSFMapBounds!) -> Bool

    Parameters

    mapBounds

    The other map bounds object.

    Return Value

    True if equal.

  • Calculates the center map position of this map envelope object.

    Declaration

    Objective-C

    - (MSFMapPos *)getCenter;

    Swift

    func getCenter() -> MSFMapPos!

    Return Value

    The center postion if this map envelope object.

  • Calculates the difference vector between the maximum and minimum map positions of this map bounds object.

    Declaration

    Objective-C

    - (MSFMapVec *)getDelta;

    Swift

    func getDelta() -> MSFMapVec!

    Return Value

    The difference vector between maximum and minimum map positions of this map bounds object.

  • Returns the minimum (south west) map position of this map envelope object.

    Declaration

    Objective-C

    - (MSFMapPos *)getMin;

    Swift

    func getMin() -> MSFMapPos!

    Return Value

    The minimum (south west) map position of this map envelope object.

  • Returns the maximum (north east) map position of this map envelope object.

    Declaration

    Objective-C

    - (MSFMapPos *)getMax;

    Swift

    func getMax() -> MSFMapPos!

    Return Value

    The maximum (north east) map position of this map envelope object.

  • Tests whether this map bounds object contains a map position.

    Declaration

    Objective-C

    - (BOOL)containsPos:(MSFMapPos *)pos;

    Swift

    func contains(_ pos: MSFMapPos!) -> Bool

    Parameters

    pos

    The map position.

    Return Value

    True if this map bounds object contains the map position.

  • Tests whether this map bounds object contains a another map bounds object.

    Declaration

    Objective-C

    - (BOOL)containsBounds:(MSFMapBounds *)bounds;

    Swift

    func contains(_ bounds: MSFMapBounds!) -> Bool

    Parameters

    bounds

    The other map bounds object.

    Return Value

    True if this map bounds object contains the other map bounds object.

  • Tests whether this map bounds object intersects with a another map bounds object.

    Declaration

    Objective-C

    - (BOOL)intersects:(MSFMapBounds *)bounds;

    Swift

    func intersects(_ bounds: MSFMapBounds!) -> Bool

    Parameters

    bounds

    The other map bounds object.

    Return Value

    True if this map bounds object intersects with the other map bounds object.

  • Shrinks this map bounds object to the intersection of this bounds and given bounds object.

    Declaration

    Objective-C

    - (void)shrinkToIntersection:(MSFMapBounds *)bounds;

    Swift

    func shrink(toIntersection bounds: MSFMapBounds!)

    Parameters

    bounds

    The other map bounds object.

  • 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 bounds object, useful for logging.

    Declaration

    Objective-C

    - (NSString *)description;

    Swift

    func description() -> String!

    Return Value

    The string representation of this map bounds object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()