MSFMapEnvelope

Objective-C


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

Swift

class MSFMapEnvelope : NSObject

A bounding area on the map. Can be defined by a map bounds object or by a convex bounding polygon. This class is intended for conservative object area estimation and fast intersection testing.

  • 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 MapEnvelope object. Nothing is contained within this envelope.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Constructs a MapEnvelope object using map bounds.

    Declaration

    Objective-C

    - (id)initWithBounds:(MSFMapBounds *)bounds;

    Swift

    init!(bounds: MSFMapBounds!)

    Parameters

    bounds

    The bounds for the envelope.

  • Constructs a MapEnvelope object from a convex bounding polygon.

    Declaration

    Objective-C

    - (id)initWithConvexHull:(MSFMapPosVector *)convexHull;

    Swift

    init!(convexHull: MSFMapPosVector!)

    Parameters

    convexHull

    The list of convex hull points.

  • Returns the map bounds of this map envelope.

    Declaration

    Objective-C

    - (MSFMapBounds *)getBounds;

    Swift

    func getBounds() -> MSFMapBounds!

    Return Value

    The map bounds of this map envelope.

  • Returns the convex hull of this map envelope.

    Declaration

    Objective-C

    - (MSFMapPosVector *)getConvexHull;

    Swift

    func getConvexHull() -> MSFMapPosVector!

    Return Value

    The convex hull of this map envelope.

  • Tests whether this map envelope contains another map envelope.

    Declaration

    Objective-C

    - (BOOL)contains:(MSFMapEnvelope *)envelope;

    Swift

    func contains(_ envelope: MSFMapEnvelope!) -> Bool

    Parameters

    envelope

    The other map envelope.

    Return Value

    True if this map envelope contains the other map envelope.

  • Tests whether this map envelope intersects with another map envelope.

    Declaration

    Objective-C

    - (BOOL)intersects:(MSFMapEnvelope *)envelope;

    Swift

    func intersects(_ envelope: MSFMapEnvelope!) -> Bool

    Parameters

    envelope

    The other map envelope.

    Return Value

    True if this map envelope intersects the other map envelope.

  • Checks for equality between this and another envelope.

    Declaration

    Objective-C

    - (BOOL)isEqualInternal:(MSFMapEnvelope *)envelope;

    Swift

    func isEqualInternal(_ envelope: MSFMapEnvelope!) -> Bool

    Parameters

    envelope

    The other map envelope object.

    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 envelope, useful for logging.

    Declaration

    Objective-C

    - (NSString *)description;

    Swift

    func description() -> String!

    Return Value

    The string representation of this map envelope.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()