SYGeoBoundingBox Class Reference

Represents a bounding box that defines a rectangular area in a geographic coordinate system. More...

#import <SYPositioning.h>

Inheritance diagram for SYGeoBoundingBox:
Collaboration diagram for SYGeoBoundingBox:

Instance Methods

(nonnull instancetype) - initWithTopLeft:bottomRight:
 Initializes a SYGeoBoundingBox instance with specified top-left and bottom-right SYGeoCoordinates. More...
 
(nullable SYGeoBoundingBox *) - intersectionWithGeoBoundingBox:
 
(nullable SYGeoBoundingBox *) - unionWithGeoBoundingBox:
 
(nullable SYGeoBoundingBox *) - scale:
 
(nullable SYGeoBoundingBox *) - offsetWithGeoCoordinate:
 
(BOOL) - containsGeoCoordinate:
 
(BOOL) - containsGeoBoundingBox:
 

Properties

SYGeoCoordinatetopLeft
 The SYGeoCoordinates representing the top-left corner of the SYGeoBoundingBox. More...
 
SYGeoCoordinatebottomRight
 The SYGeoCoordinates representing the bottom-right corner of the SYGeoBoundingBox. More...
 

Detailed Description

Represents a bounding box that defines a rectangular area in a geographic coordinate system.

Method Documentation

◆ initWithTopLeft:bottomRight:

- (nonnull instancetype) initWithTopLeft: (nonnull SYGeoCoordinate *)  topLeft
bottomRight: (nonnull SYGeoCoordinate *)  bottomRight 

Initializes a SYGeoBoundingBox instance with specified top-left and bottom-right SYGeoCoordinates.

◆ intersectionWithGeoBoundingBox:

- (nullable SYGeoBoundingBox*) intersectionWithGeoBoundingBox: (nonnull SYGeoBoundingBox *)  boundingBox

Computes intersection of this SYGeoBoundingBox and the specified SYGeoBoundingBox. Returns nil if intersection is empty.

◆ unionWithGeoBoundingBox:

- (nullable SYGeoBoundingBox*) unionWithGeoBoundingBox: (nonnull SYGeoBoundingBox *)  boundingBox

Computes union of this SYGeoBoundingBox and the specified SYGeoBoundingBox.

◆ scale:

- (nullable SYGeoBoundingBox*) scale: (CGFloat)  scale

Computes scale of this SYGeoBoundingBox with the specified scale.

◆ offsetWithGeoCoordinate:

- (nullable SYGeoBoundingBox*) offsetWithGeoCoordinate: (nonnull SYGeoCoordinate *)  coordinate

Computes offset of this SYGeoBoundingBox with the specified SYGeoCoordinate.

◆ containsGeoCoordinate:

- (BOOL) containsGeoCoordinate: (nonnull SYGeoCoordinate *)  coordinate

Determines whether the specified SYGeoCoordinate is contained within this SYGeoBoundingBox.

◆ containsGeoBoundingBox:

- (BOOL) containsGeoBoundingBox: (nonnull SYGeoBoundingBox *)  boundingBox

Determines whether the specified SYGeoBoundingBox is covered entirely by this SYGeoBoundingBox.

Property Documentation

◆ topLeft

- (SYGeoCoordinate*) topLeft
readnonatomicassign

The SYGeoCoordinates representing the top-left corner of the SYGeoBoundingBox.

◆ bottomRight

- (SYGeoCoordinate*) bottomRight
readnonatomicassign

The SYGeoCoordinates representing the bottom-right corner of the SYGeoBoundingBox.


The documentation for this class was generated from the following file: