SFGeometryEnvelope
Objective-C
@interface SFGeometryEnvelope : NSObject <NSMutableCopying, NSSecureCoding>Swift
class SFGeometryEnvelope : NSObject, NSMutableCopying, NSSecureCodingGeometry envelope containing x and y range with optional z and m range
- 
                  
                  X coordinate range DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *minX;Swift var minX: NSDecimalNumber! { get set }
- 
                  
                  Undocumented DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *maxXSwift var maxX: NSDecimalNumber! { get set }
- 
                  
                  Y coordinate range DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *minY;Swift var minY: NSDecimalNumber! { get set }
- 
                  
                  Undocumented DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *maxYSwift var maxY: NSDecimalNumber! { get set }
- 
                  
                  Has Z value and Z coordinate range DeclarationObjective-C @property (nonatomic) BOOL hasZ;Swift var hasZ: Bool { get set }
- 
                  
                  Undocumented DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *minZSwift var minZ: NSDecimalNumber! { get set }
- 
                  
                  Undocumented DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *maxZSwift var maxZ: NSDecimalNumber! { get set }
- 
                  
                  Has M value and M coordinate range DeclarationObjective-C @property (nonatomic) BOOL hasM;Swift var hasM: Bool { get set }
- 
                  
                  Undocumented DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *minMSwift var minM: NSDecimalNumber! { get set }
- 
                  
                  Undocumented DeclarationObjective-C @property (nonatomic, strong) NSDecimalNumber *maxMSwift var maxM: NSDecimalNumber! { get set }
- 
                  
                  Create with no z or m DeclarationObjective-C + (SFGeometryEnvelope *)envelope;Return Valuenew geometry envelope 
- 
                  
                  Create with the has z and m values DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithHasZ:(BOOL)hasZ andHasM:(BOOL)hasM;ParametershasZgeometry has z hasMgeometry has m Return Valuenew geometry envelope 
- 
                  
                  Create with number range DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithMinX:(NSDecimalNumber *)minX andMinY:(NSDecimalNumber *)minY andMaxX:(NSDecimalNumber *)maxX andMaxY:(NSDecimalNumber *)maxY;ParametersminXminimum x minYminimum y maxXmaximum x maxYmaximum y Return Valuenew geometry envelope 
- 
                  
                  Create with double range DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithMinXValue:(double)minX andMinYValue:(double)minY andMaxXValue:(double)maxX andMaxYValue:(double)maxY;ParametersminXminimum x minYminimum y maxXmaximum x maxYmaximum y Return Valuenew geometry envelope 
- 
                  
                  Create with number range DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithMinX:(NSDecimalNumber *)minX andMinY:(NSDecimalNumber *)minY andMinZ:(NSDecimalNumber *)minZ andMaxX:(NSDecimalNumber *)maxX andMaxY:(NSDecimalNumber *)maxY andMaxZ:(NSDecimalNumber *)maxZ;ParametersminXminimum x minYminimum y minZminimum z maxXmaximum x maxYmaximum y maxZmaximum z Return Valuenew geometry envelope 
- 
                  
                  Create with double range DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithMinXValue:(double)minX andMinYValue:(double)minY andMinZValue:(double)minZ andMaxXValue:(double)maxX andMaxYValue:(double)maxY andMaxZValue:(double)maxZ;ParametersminXminimum x minYminimum y minZminimum z maxXmaximum x maxYmaximum y maxZmaximum z Return Valuenew geometry envelope 
- 
                  
                  Create with number range DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithMinX:(NSDecimalNumber *)minX andMinY:(NSDecimalNumber *)minY andMinZ:(NSDecimalNumber *)minZ andMinM:(NSDecimalNumber *)minM andMaxX:(NSDecimalNumber *)maxX andMaxY:(NSDecimalNumber *)maxY andMaxZ:(NSDecimalNumber *)maxZ andMaxM:(NSDecimalNumber *)maxM;ParametersminXminimum x minYminimum y minZminimum z minMminimum m maxXmaximum x maxYmaximum y maxZmaximum z maxMmaximum m Return Valuenew geometry envelope 
- 
                  +envelopeWithMinXValue:andMinYValue: andMinZValue: andMinMValue: andMaxXValue: andMaxYValue: andMaxZValue: andMaxMValue: Create with double range DeclarationObjective-C + (SFGeometryEnvelope *)envelopeWithMinXValue:(double)minX andMinYValue:(double)minY andMinZValue:(double)minZ andMinMValue:(double)minM andMaxXValue:(double)maxX andMaxYValue:(double)maxY andMaxZValue:(double)maxZ andMaxMValue:(double)maxM;ParametersminXminimum x minYminimum y minZminimum z minMminimum m maxXmaximum x maxYmaximum y maxZmaximum z maxMmaximum m Return Valuenew geometry envelope 
- 
                  
                  Create DeclarationObjective-C + (SFGeometryEnvelope *)geometryEnvelopeWithGeometryEnvelope: (SFGeometryEnvelope *)geometryEnvelope;ParametersgeometryEnvelopegeometry envelope Return Valuenew geometry envelope 
- 
                  
                  Initialize with no z or m DeclarationObjective-C - (instancetype)init;Swift init!()Return Valuenew geometry envelope 
- 
                  
                  Initialize with the has z and m values DeclarationObjective-C - (instancetype)initWithHasZ:(BOOL)hasZ andHasM:(BOOL)hasM;Swift init!(hasZ: Bool, andHasM hasM: Bool)ParametershasZgeometry has z hasMgeometry has m Return Valuenew geometry envelope 
- 
                  
                  Initialize with number range DeclarationObjective-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!)ParametersminXminimum x minYminimum y maxXmaximum x maxYmaximum y Return Valuenew geometry envelope 
- 
                  
                  Initialize with double range DeclarationObjective-C - (instancetype)initWithMinXValue:(double)minX andMinYValue:(double)minY andMaxXValue:(double)maxX andMaxYValue:(double)maxY;Swift init!(minXValue minX: Double, andMinYValue minY: Double, andMaxXValue maxX: Double, andMaxYValue maxY: Double)ParametersminXminimum x minYminimum y maxXmaximum x maxYmaximum y Return Valuenew geometry envelope 
- 
                  
                  Initialize with number range DeclarationObjective-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!)ParametersminXminimum x minYminimum y minZminimum z maxXmaximum x maxYmaximum y maxZmaximum z Return Valuenew geometry envelope 
- 
                  
                  Initialize with double range DeclarationObjective-C - (instancetype)initWithMinXValue:(double)minX andMinYValue:(double)minY andMinZValue:(double)minZ andMaxXValue:(double)maxX andMaxYValue:(double)maxY andMaxZValue:(double)maxZ;Swift init!(minXValue minX: Double, andMinYValue minY: Double, andMinZValue minZ: Double, andMaxXValue maxX: Double, andMaxYValue maxY: Double, andMaxZValue maxZ: Double)ParametersminXminimum x minYminimum y minZminimum z maxXmaximum x maxYmaximum y maxZmaximum z Return Valuenew geometry envelope 
- 
                  
                  Initialize with number range DeclarationObjective-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!)ParametersminXminimum x minYminimum y minZminimum z minMminimum m maxXmaximum x maxYmaximum y maxZmaximum z maxMmaximum m Return Valuenew geometry envelope 
- 
                  -initWithMinXValue:andMinYValue: andMinZValue: andMinMValue: andMaxXValue: andMaxYValue: andMaxZValue: andMaxMValue: Initialize with double range DeclarationObjective-C - (instancetype)initWithMinXValue:(double)minX andMinYValue:(double)minY andMinZValue:(double)minZ andMinMValue:(double)minM andMaxXValue:(double)maxX andMaxYValue:(double)maxY andMaxZValue:(double)maxZ andMaxMValue:(double)maxM;Swift init!(minXValue minX: Double, andMinYValue minY: Double, andMinZValue minZ: Double, andMinMValue minM: Double, andMaxXValue maxX: Double, andMaxYValue maxY: Double, andMaxZValue maxZ: Double, andMaxMValue maxM: Double)ParametersminXminimum x minYminimum y minZminimum z minMminimum m maxXmaximum x maxYmaximum y maxZmaximum z maxMmaximum m Return Valuenew geometry envelope 
- 
                  
                  Initialize DeclarationObjective-C - (instancetype)initWithGeometryEnvelope:(SFGeometryEnvelope *)geometryEnvelope;Swift init!(geometryEnvelope: SFGeometryEnvelope!)ParametersgeometryEnvelopegeometry envelope Return Valuenew geometry envelope 
- 
                  
                  Get the min x value DeclarationObjective-C - (double)minXValue;Swift func minXValue() -> DoubleReturn Valuex coordinate 
- 
                  
                  Set the min x value DeclarationObjective-C - (void)setMinXValue:(double)x;Swift func setMinXValue(_ x: Double)Parametersxx coordinate 
- 
                  
                  Get the max x value DeclarationObjective-C - (double)maxXValue;Swift func maxXValue() -> DoubleReturn Valuex coordinate 
- 
                  
                  Set the max x value DeclarationObjective-C - (void)setMaxXValue:(double)x;Swift func setMaxXValue(_ x: Double)Parametersxx coordinate 
- 
                  
                  Get the min y value DeclarationObjective-C - (double)minYValue;Swift func minYValue() -> DoubleReturn Valuey coordinate 
- 
                  
                  Set the min y value DeclarationObjective-C - (void)setMinYValue:(double)y;Swift func setMinYValue(_ y: Double)Parametersyy coordinate 
- 
                  
                  Get the max y value DeclarationObjective-C - (double)maxYValue;Swift func maxYValue() -> DoubleReturn Valuey coordinate 
- 
                  
                  Set the max y value DeclarationObjective-C - (void)setMaxYValue:(double)y;Swift func setMaxYValue(_ y: Double)Parametersyy coordinate 
- 
                  
                  Get the min z value DeclarationObjective-C - (double)minZValue;Swift func minZValue() -> DoubleReturn Valuez coordinate 
- 
                  
                  Set the min z value DeclarationObjective-C - (void)setMinZValue:(double)z;Swift func setMinZValue(_ z: Double)Parameterszz coordinate 
- 
                  
                  Get the max z value DeclarationObjective-C - (double)maxZValue;Swift func maxZValue() -> DoubleReturn Valuez coordinate 
- 
                  
                  Set the max z value DeclarationObjective-C - (void)setMaxZValue:(double)z;Swift func setMaxZValue(_ z: Double)Parameterszz coordinate 
- 
                  
                  Get the min m value DeclarationObjective-C - (double)minMValue;Swift func minMValue() -> DoubleReturn Valuem coordinate 
- 
                  
                  Set the min m value DeclarationObjective-C - (void)setMinMValue:(double)m;Swift func setMinMValue(_ m: Double)Parametersmm coordinate 
- 
                  
                  Get the max m value DeclarationObjective-C - (double)maxMValue;Swift func maxMValue() -> DoubleReturn Valuem coordinate 
- 
                  
                  Set the max m value DeclarationObjective-C - (void)setMaxMValue:(double)m;Swift func setMaxMValue(_ m: Double)Parametersmm coordinate 
- 
                  
                  True if has Z coordinates DeclarationObjective-C - (BOOL)is3D;Swift func is3D() -> BoolReturn Valuehas z 
- 
                  
                  True if has M measurements DeclarationObjective-C - (BOOL)isMeasured;Swift func isMeasured() -> BoolReturn Valuehas m 
- 
                  
                  Get the x range DeclarationObjective-C - (double)xRange;Swift func xRange() -> DoubleReturn Valuex range 
- 
                  
                  Get the y range DeclarationObjective-C - (double)yRange;Swift func yRange() -> DoubleReturn Valuey range 
- 
                  
                  Get the z range DeclarationObjective-C - (NSDecimalNumber *)zRange;Swift func zRange() -> NSDecimalNumber!Return Valuez range 
- 
                  
                  Get the m range DeclarationObjective-C - (NSDecimalNumber *)mRange;Swift func mRange() -> NSDecimalNumber!Return Valuem range 
- 
                  
                  Determine if the envelope is of a single point DeclarationObjective-C - (BOOL)isPoint;Swift func isPoint() -> BoolReturn Valuetrue if a single point bounds 
- 
                  
                  Get the top left point Return Valuetop left point 
- 
                  
                  Get the bottom left point Return Valuebottom left point 
- 
                  
                  Get the bottom right point Return Valuebottom right point 
- 
                  
                  Get the top right point Return Valuetop right point 
- 
                  
                  Get the left mid point Return Valueleft mid point 
- 
                  
                  Get the bottom mid point Return Valuebottom mid point 
- 
                  
                  Get the right mid point Return Valueright mid point 
- 
                  
                  Get the top mid point Return Valuetop mid point 
- 
                  
                  Get the left line Return Valueleft line 
- 
                  
                  Get the bottom line Return Valuebottom line 
- 
                  
                  Get the right line Return Valueright line 
- 
                  
                  Get the top line Return Valuetop line 
- 
                  
                  Get the envelope mid x DeclarationObjective-C - (double)midX;Swift func midX() -> DoubleReturn Valuemid x 
- 
                  
                  Get the envelope mid y DeclarationObjective-C - (double)midY;Swift func midY() -> DoubleReturn Valuemid y 
- 
                  
                  Get the envelope centroid point Return Valuecentroid point 
- 
                  
                  Determine if the envelope is empty DeclarationObjective-C - (BOOL)isEmpty;Swift func isEmpty() -> BoolReturn Valuetrue if empty 
- 
                  
                  Determine if intersects with the provided envelope DeclarationObjective-C - (BOOL)intersectsWithEnvelope:(SFGeometryEnvelope *)envelope;Swift func intersects(with envelope: SFGeometryEnvelope!) -> BoolParametersenvelopegeometry envelope Return Valuetrue if intersects 
- 
                  
                  Determine if intersects with the provided envelope DeclarationObjective-C - (BOOL)intersectsWithEnvelope:(SFGeometryEnvelope *)envelope withAllowEmpty:(BOOL)allowEmpty;Swift func intersects(with envelope: SFGeometryEnvelope!, withAllowEmpty allowEmpty: Bool) -> BoolParametersenvelopegeometry envelope allowEmptyallow empty ranges when determining intersection Return Valuetrue if intersects 
- 
                  
                  Get the overlapping geometry envelope with the provided envelope DeclarationObjective-C - (SFGeometryEnvelope *)overlapWithEnvelope:(SFGeometryEnvelope *)envelope;Swift func overlap(with envelope: SFGeometryEnvelope!) -> SFGeometryEnvelope!Parametersenvelopegeometry envelope Return Valuegeometry envelope 
- 
                  
                  Get the overlapping geometry envelope with the provided envelope DeclarationObjective-C - (SFGeometryEnvelope *)overlapWithEnvelope:(SFGeometryEnvelope *)envelope withAllowEmpty:(BOOL)allowEmpty;Swift func overlap(with envelope: SFGeometryEnvelope!, withAllowEmpty allowEmpty: Bool) -> SFGeometryEnvelope!Parametersenvelopegeometry envelope allowEmptyallow empty ranges when determining overlap Return Valuegeometry envelope 
- 
                  
                  Get the union geometry envelope combined with the provided envelope DeclarationObjective-C - (SFGeometryEnvelope *)unionWithEnvelope:(SFGeometryEnvelope *)envelope;Swift func union(with envelope: SFGeometryEnvelope!) -> SFGeometryEnvelope!Parametersenvelopegeometry envelope Return Valuegeometry envelope 
- 
                  
                  Determine if contains the coordinate DeclarationObjective-C - (BOOL)containsX:(double)x andY:(double)y;Swift func containsX(_ x: Double, andY y: Double) -> BoolParametersxx value yy value Return Valuetrue if contains 
- 
                  
                  Determine if contains the coordinate DeclarationObjective-C - (BOOL)containsX:(double)x andY:(double)y withEpsilon:(double)epsilon;Swift func containsX(_ x: Double, andY y: Double, withEpsilon epsilon: Double) -> BoolParametersxx value yy value epsilonepsilon equality tolerance Return Valuetrue if contains 
- 
                  
                  Determine if inclusively contains the provided envelope DeclarationObjective-C - (BOOL)containsEnvelope:(SFGeometryEnvelope *)envelope;Swift func contains(_ envelope: SFGeometryEnvelope!) -> BoolParametersenvelopegeometry envelope Return Valuetrue if contains 
- 
                  
                  Determine if inclusively contains the provided envelope DeclarationObjective-C - (BOOL)containsEnvelope:(SFGeometryEnvelope *)envelope withEpsilon:(double)epsilon;Swift func contains(_ envelope: SFGeometryEnvelope!, withEpsilon epsilon: Double) -> BoolParametersenvelopegeometry envelope epsilonepsilon equality tolerance Return Valuetrue if contains 
- 
                  
                  Build a geometry representation of the geometry envelope Return Valuegeometry, polygon or point 
 View on GitHub
View on GitHub SFGeometryEnvelope Class Reference
        SFGeometryEnvelope Class Reference