SFGeometryEnvelope

@interface SFGeometryEnvelope : NSObject <NSMutableCopying, NSCoding>

Geometry envelope containing x and y range with optional z and m range

  • X coordinate range

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDecimalNumber *minX;

    Swift

    var minX: NSDecimalNumber! { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber * maxX

    Swift

    var maxX: NSDecimalNumber! { get set }
  • Y coordinate range

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDecimalNumber *minY;

    Swift

    var minY: NSDecimalNumber! { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber * maxY

    Swift

    var maxY: NSDecimalNumber! { get set }
  • Has Z value and Z coordinate range

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL hasZ;

    Swift

    var hasZ: Bool { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber * minZ

    Swift

    var minZ: NSDecimalNumber! { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber * maxZ

    Swift

    var maxZ: NSDecimalNumber! { get set }
  • Has M value and M coordinate range

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL hasM;

    Swift

    var hasM: Bool { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber * minM

    Swift

    var minM: NSDecimalNumber! { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber * maxM

    Swift

    var maxM: NSDecimalNumber! { get set }
  • Initialize with no z or m

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()

    Return Value

    new instance

  • Initialize with the has z and m values

    Declaration

    Objective-C

    - (instancetype)initWithHasZ:(BOOL)hasZ andHasM:(BOOL)hasM;

    Swift

    init!(hasZ: Bool, andHasM hasM: Bool)

    Parameters

    hasZ

    geometry has z

    hasM

    geometry has m

    Return Value

    new geometry envelope

  • Initialize with number range

    Declaration

    Objective-C

    - (instancetype)initWithMinX:(NSDecimalNumber *)minX
                         andMinY:(NSDecimalNumber *)minY
                         andMaxX:(NSDecimalNumber *)maxX
                         andMaxY:(NSDecimalNumber *)maxY;

    Swift

    init!(minX: NSDecimalNumber!, andMinY minY: NSDecimalNumber!, andMaxX maxX: NSDecimalNumber!, andMaxY maxY: NSDecimalNumber!)

    Parameters

    minX

    minimum x

    minY

    minimum y

    maxX

    maximum x

    maxY

    maximum y

    Return Value

    new geometry envelope

  • Initialize with double range

    Declaration

    Objective-C

    - (instancetype)initWithMinXDouble:(double)minX
                         andMinYDouble:(double)minY
                         andMaxXDouble:(double)maxX
                         andMaxYDouble:(double)maxY;

    Swift

    init!(minXDouble minX: Double, andMinYDouble minY: Double, andMaxXDouble maxX: Double, andMaxYDouble maxY: Double)

    Parameters

    minX

    minimum x

    minY

    minimum y

    maxX

    maximum x

    maxY

    maximum y

    Return Value

    new geometry envelope

  • Initialize with number range

    Declaration

    Objective-C

    - (instancetype)initWithMinX:(NSDecimalNumber *)minX
                         andMinY:(NSDecimalNumber *)minY
                         andMinZ:(NSDecimalNumber *)minZ
                         andMaxX:(NSDecimalNumber *)maxX
                         andMaxY:(NSDecimalNumber *)maxY
                         andMaxZ:(NSDecimalNumber *)maxZ;

    Swift

    init!(minX: NSDecimalNumber!, andMinY minY: NSDecimalNumber!, andMinZ minZ: NSDecimalNumber!, andMaxX maxX: NSDecimalNumber!, andMaxY maxY: NSDecimalNumber!, andMaxZ maxZ: NSDecimalNumber!)

    Parameters

    minX

    minimum x

    minY

    minimum y

    minZ

    minimum z

    maxX

    maximum x

    maxY

    maximum y

    maxZ

    maximum z

    Return Value

    new geometry envelope

  • Initialize with number range

    Declaration

    Objective-C

    - (instancetype)initWithMinX:(NSDecimalNumber *)minX
                         andMinY:(NSDecimalNumber *)minY
                         andMinZ:(NSDecimalNumber *)minZ
                         andMinM:(NSDecimalNumber *)minM
                         andMaxX:(NSDecimalNumber *)maxX
                         andMaxY:(NSDecimalNumber *)maxY
                         andMaxZ:(NSDecimalNumber *)maxZ
                         andMaxM:(NSDecimalNumber *)maxM;

    Swift

    init!(minX: NSDecimalNumber!, andMinY minY: NSDecimalNumber!, andMinZ minZ: NSDecimalNumber!, andMinM minM: NSDecimalNumber!, andMaxX maxX: NSDecimalNumber!, andMaxY maxY: NSDecimalNumber!, andMaxZ maxZ: NSDecimalNumber!, andMaxM maxM: NSDecimalNumber!)

    Parameters

    minX

    minimum x

    minY

    minimum y

    minZ

    minimum z

    minM

    minimum m

    maxX

    maximum x

    maxY

    maximum y

    maxZ

    maximum z

    maxM

    maximum m

    Return Value

    new geometry envelope

  • True if has Z coordinates

    Declaration

    Objective-C

    - (BOOL)is3D;

    Swift

    func is3D() -> Bool

    Return Value

    has z

  • True if has M measurements

    Declaration

    Objective-C

    - (BOOL)isMeasured;

    Swift

    func isMeasured() -> Bool

    Return Value

    has m

  • Determine if intersects with the provided envelope

    Declaration

    Objective-C

    - (BOOL)intersectsWithEnvelope:(SFGeometryEnvelope *)envelope;

    Swift

    func intersects(with envelope: SFGeometryEnvelope!) -> Bool

    Parameters

    envelope

    geometry envelope

    Return Value

    true if intersects

  • Determine if intersects with the provided envelope

    Declaration

    Objective-C

    - (BOOL)intersectsWithEnvelope:(SFGeometryEnvelope *)envelope
                    withAllowEmpty:(BOOL)allowEmpty;

    Swift

    func intersects(with envelope: SFGeometryEnvelope!, withAllowEmpty allowEmpty: Bool) -> Bool

    Parameters

    envelope

    geometry envelope

    allowEmpty

    allow empty ranges when determining intersection

    Return Value

    true if intersects

  • Get the overlapping geometry envelope with the provided envelope

    Declaration

    Objective-C

    - (SFGeometryEnvelope *)overlapWithEnvelope:(SFGeometryEnvelope *)envelope;

    Swift

    func overlap(with envelope: SFGeometryEnvelope!) -> SFGeometryEnvelope!

    Parameters

    envelope

    geometry envelope

    Return Value

    geometry envelope

  • Get the overlapping geometry envelope with the provided envelope

    Declaration

    Objective-C

    - (SFGeometryEnvelope *)overlapWithEnvelope:(SFGeometryEnvelope *)envelope
                                 withAllowEmpty:(BOOL)allowEmpty;

    Swift

    func overlap(with envelope: SFGeometryEnvelope!, withAllowEmpty allowEmpty: Bool) -> SFGeometryEnvelope!

    Parameters

    envelope

    geometry envelope

    allowEmpty

    allow empty ranges when determining overlap

    Return Value

    geometry envelope

  • Get the union geometry envelope combined with the provided envelope

    Declaration

    Objective-C

    - (SFGeometryEnvelope *)unionWithEnvelope:(SFGeometryEnvelope *)envelope;

    Swift

    func union(with envelope: SFGeometryEnvelope!) -> SFGeometryEnvelope!

    Parameters

    envelope

    geometry envelope

    Return Value

    geometry envelope

  • Determine if inclusively contains the provided envelope

    Declaration

    Objective-C

    - (BOOL)containsEnvelope:(SFGeometryEnvelope *)envelope;

    Swift

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

    Parameters

    envelope

    geometry envelope

    Return Value

    true if contains