Class BoundingBox

Represents a bounding box with lower-left and upper-right coordinate.

Inheritance

System.Object

BoundingBox

Namespace: Mars.Interfaces.Environments

Assembly: Mars.Interfaces.dll

Syntax

public class BoundingBox : object

Constructors

BoundingBox()

Creates a BoundingBox where each corner position is set to 0.

Declaration

public BoundingBox()

BoundingBox(Envelope)

Creates a BoundingBox from an input bounding box.

Declaration

public BoundingBox(Envelope inputBox)

Parameters

Type	Name	Description
Envelope	inputBox

BoundingBox(Position, Position)

Creates a new BoundingBox with the lower left and upper right corner to span out the box.

Declaration

public BoundingBox(Position lowerLeft, Position upperRight)

Parameters

Type	Name	Description
Position	lowerLeft	The lower left corner of the box (minX/Lon, minY/Lat).
Position	upperRight	The upper right corner of the box (maxX/Lon, maxY/Lat).

BoundingBox(Double, Double, Double)

Creates a new BoundingBox based on a midpoint and a passed distance to span out an mark the boundaries. When the source coordinate are geospatial coordinates then the distance is interpreted as meters.

Declaration

public BoundingBox(double x, double y, double distance)

Parameters

Type	Name	Description
System.Double	x	The x or longitude coordinate of the source.
System.Double	y	The y or latitude coordinate of the source.
System.Double	distance	The distance of the source to the corners in meters (m)

BoundingBox(Double, Double, Double, Double)

Creates a new BoundingBox with the lower left and upper right corner to span out the box.

Declaration

public BoundingBox(double minX, double minY, double maxX, double maxY)

Parameters

Type	Name	Description
System.Double	minX	The lower left x or longitude coordinate.
System.Double	minY	The lower left y or latitude coordinate.
System.Double	maxX	The upper right x or longitude coordinate.
System.Double	maxY	The upper right y or latitude coordinate.

Properties

Envelope

Gets the Envelope object of this box containing additional informations.

Declaration

public Envelope Envelope { get; }

Property Value

Type	Description
Envelope

LowerLeft

Gets the lower right corner coordinate

Declaration

public Position LowerLeft { get; }

Property Value

Type	Description
Position

LowerRight

Gets the lower right corner coordinate of this box

Declaration

public Position LowerRight { get; }

Property Value

Type	Description
Position

MaxX

Gets the maximum y or longitude value (upper-right)

Declaration

public double MaxX { get; }

Property Value

Type	Description
System.Double

MaxY

Gets the maximum y or latitude value (upper-right)

Declaration

public double MaxY { get; }

Property Value

Type	Description
System.Double

Midpoint

Gets the central point of the box

Declaration

public Position Midpoint { get; }

Property Value

Type	Description
Position

MinX

Gets the minimum x or longitude value (lower-left)

Declaration

public double MinX { get; }

Property Value

Type	Description
System.Double

MinY

Gets the minimum y or latitude value (lower-left)

Declaration

public double MinY { get; }

Property Value

Type	Description
System.Double

UpperLeft

Declaration

public Position UpperLeft { get; }

Property Value

Type	Description
Position

UpperRight

Gets the upper right corner coordinate

Declaration

public Position UpperRight { get; }

Property Value

Type	Description
Position

Methods

CreateGeoBoundingBox(Double, Double, Double)

Creates a new BoundingBox based on a midpoint and a passed distance to span out an mark the boundaries. When the source coordinate are geospatial coordinates then the distance is interpreted as meters.

Declaration

public static BoundingBox CreateGeoBoundingBox(double longitude, double latitude, double distance)

Parameters

Type	Name	Description
System.Double	longitude	The x or longitude coordinate of the source.
System.Double	latitude	The y or latitude coordinate of the source.
System.Double	distance	The distance of the source to all directions in meters

Returns

Type	Description
BoundingBox

CreateGeoBoundingBox(Double, Double, Double, Double)

Creates a new BoundingBox based on a midpoint and a passed distance for x/lon and y/lat direction, to span out an mark the boundaries. When the source coordinate are geospatial coordinates then the distance is interpreted as meters.

Declaration

public static BoundingBox CreateGeoBoundingBox(double longitude, double latitude, double distanceLongitude, double distanceLatitude)

Parameters

Type	Name	Description
System.Double	longitude	The x or longitude coordinate of the source.
System.Double	latitude	The y or latitude coordinate of the source.
System.Double	distanceLongitude	The distance of the source in both y/latitude directions in meters
System.Double	distanceLatitude	The distance of the source in both x/longitude directions in meters

Returns

Type	Description
BoundingBox