LuciadCPillar C# 2024.0.05
Luciad.Geometries.Bounds Class Reference

Represents a bounds. More...

Inheritance diagram for Luciad.Geometries.Bounds:
Luciad.Geometries.Geometry

Public Member Functions

 Bounds (Luciad.Geodesy.CoordinateReference reference, Luciad.Cartesian.Coordinate location, double width, double height, double depth)
 Creates a new bounds instance based on a point, and the width, height and depth with respect to that point. More...
 
 Bounds (Luciad.Geodesy.CoordinateReference reference, Luciad.Cartesian.Coordinate lowerLeft, Luciad.Cartesian.Coordinate upperRight)
 Creates a new bounds instance based on lower left and upper right corners. More...
 
 Bounds (Luciad.Geometries.Bounds other)
 
override bool Equals (object other)
 
override int GetHashCode ()
 
- Public Member Functions inherited from Luciad.Geometries.Geometry
void Dispose ()
 

Static Public Member Functions

static Luciad.Geometries.Bounds BoundsUnion (Luciad.Geometries.Bounds bounds1, Luciad.Geometries.Bounds bounds2)
 Returns the union of the two bounds objects, provided they are defined in the same coordinate reference. More...
 
static bool Contains2D (Luciad.Geometries.Bounds bounds, Luciad.Cartesian.Coordinate coordinate, double eps=0)
 Checks if this bounds contains the specified coordinate, considering only the x and y values. More...
 
static bool Contains2D (Luciad.Geometries.Bounds bounds1, Luciad.Geometries.Bounds bounds2, double eps=0)
 Checks if the first bounds contains the second bounds, only considering x and y values. More...
 
static bool Contains3D (Luciad.Geometries.Bounds bounds, Luciad.Cartesian.Coordinate coordinate, double eps=0)
 Checks if the first bounds contains the second bounds. More...
 
static bool Interacts2D (Luciad.Geometries.Bounds bounds1, Luciad.Geometries.Bounds bounds2, double eps=0)
 Checks of two given bounds geometries have an interaction, only considering x and y values. More...
 
static Luciad.Geometries.Bounds Intersection2D (Luciad.Geometries.Bounds bounds1, Luciad.Geometries.Bounds bounds2)
 Returns the intersection of the two given bounds geometries. More...
 

Properties

Luciad.Cartesian.Coordinate Center [get]
 The center of this bounds instance. More...
 
double Depth [get]
 The depth of this bounds instance. More...
 
double Height [get]
 The height of this bounds instance. More...
 
Luciad.Cartesian.Coordinate Location [get]
 The lower left corner of this bounds instance. More...
 
Luciad.Cartesian.Coordinate LowerLeftCorner [get]
 The lower left corner of this bounds instance. More...
 
Luciad.Cartesian.Coordinate LowerRightCorner [get]
 The lower right corner of this bounds instance. More...
 
Luciad.Cartesian.Coordinate UpperLeftCorner [get]
 The upper left corner of this bounds instance. More...
 
Luciad.Cartesian.Coordinate UpperRightCorner [get]
 The upper right corner of this bounds instance. More...
 
double Width [get]
 The width of this bounds instance. More...
 
- Properties inherited from Luciad.Geometries.Geometry
Luciad.Geometries.Bounds Bounds [get]
 The bounds for the geometry object. More...
 
Luciad.Geodesy.CoordinateReference Reference [get]
 The coordinate reference of the geometry. More...
 

Detailed Description

Represents a bounds.

See also
GeometryFactory.CreateBounds
Bounds.Bounds

Constructor & Destructor Documentation

◆ Bounds() [1/3]

Luciad.Geometries.Bounds.Bounds ( Luciad.Geometries.Bounds  other)
inline

◆ Bounds() [2/3]

Luciad.Geometries.Bounds.Bounds ( Luciad.Geodesy.CoordinateReference  reference,
Luciad.Cartesian.Coordinate  location,
double  width,
double  height,
double  depth 
)
inline

Creates a new bounds instance based on a point, and the width, height and depth with respect to that point.

Parameters
referencethe coordinate reference
locationthe lower left location of the bounds
widththe width
heightthe height
depththe depth

◆ Bounds() [3/3]

Luciad.Geometries.Bounds.Bounds ( Luciad.Geodesy.CoordinateReference  reference,
Luciad.Cartesian.Coordinate  lowerLeft,
Luciad.Cartesian.Coordinate  upperRight 
)
inline

Creates a new bounds instance based on lower left and upper right corners.

This method takes wrap-around the 180° meridian into account when the coordinate reference is geodetic.

Parameters
referencethe coordinate reference
lowerLeftthe lower left corner of the bounds
upperRightthe upper right corner of the bounds

Member Function Documentation

◆ BoundsUnion()

static Luciad.Geometries.Bounds Luciad.Geometries.Bounds.BoundsUnion ( Luciad.Geometries.Bounds  bounds1,
Luciad.Geometries.Bounds  bounds2 
)
inlinestatic

Returns the union of the two bounds objects, provided they are defined in the same coordinate reference.

Parameters
bounds1the first bounds.
bounds2the second bounds.
Returns
the union of the two bounds objects.
Exceptions
System.ArgumentExceptionif the bounds are not defined in the same coordinate reference.

◆ Contains2D() [1/2]

static bool Luciad.Geometries.Bounds.Contains2D ( Luciad.Geometries.Bounds  bounds,
Luciad.Cartesian.Coordinate  coordinate,
double  eps = 0 
)
inlinestatic

Checks if this bounds contains the specified coordinate, considering only the x and y values.

Returns
true if this bounds contains the specified coordinate, considering only the x and y values.

◆ Contains2D() [2/2]

static bool Luciad.Geometries.Bounds.Contains2D ( Luciad.Geometries.Bounds  bounds1,
Luciad.Geometries.Bounds  bounds2,
double  eps = 0 
)
inlinestatic

Checks if the first bounds contains the second bounds, only considering x and y values.

Parameters
bounds1a bounds instance.
bounds2an other bounds instance.
epsa tolerance for the contains check.
Returns
if the first bounds contains the second bounds.
Exceptions
System.ArgumentExceptionif the bounds are not defined in the same coordinate reference.

◆ Contains3D()

static bool Luciad.Geometries.Bounds.Contains3D ( Luciad.Geometries.Bounds  bounds,
Luciad.Cartesian.Coordinate  coordinate,
double  eps = 0 
)
inlinestatic

Checks if the first bounds contains the second bounds.

Parameters
boundsa bounds instance.
coordinatea coordinate.
epsa tolerance for the contains check.
Returns
true if this bounds contains the specified coordinate.

◆ Equals()

override bool Luciad.Geometries.Bounds.Equals ( object  other)
inline

◆ GetHashCode()

override int Luciad.Geometries.Bounds.GetHashCode ( )
inline

◆ Interacts2D()

static bool Luciad.Geometries.Bounds.Interacts2D ( Luciad.Geometries.Bounds  bounds1,
Luciad.Geometries.Bounds  bounds2,
double  eps = 0 
)
inlinestatic

Checks of two given bounds geometries have an interaction, only considering x and y values.

Parameters
bounds1the first bounds.
bounds2the second bounds.
epsa tolerance for the interaction check.
Returns
true if the two bounds interact in 2D.
Exceptions
System.ArgumentExceptionif the bounds are not defined in the same coordinate reference.

◆ Intersection2D()

static Luciad.Geometries.Bounds Luciad.Geometries.Bounds.Intersection2D ( Luciad.Geometries.Bounds  bounds1,
Luciad.Geometries.Bounds  bounds2 
)
inlinestatic

Returns the intersection of the two given bounds geometries.

Parameters
bounds1a bounds instance
bounds2an other bounds instance
Returns
the intersection of the given bounds geometries. If geodetic bounds, the result is normalized.

Property Documentation

◆ Center

Luciad.Cartesian.Coordinate Luciad.Geometries.Bounds.Center
get

The center of this bounds instance.

[get]

Returns the center of this bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

◆ Depth

double Luciad.Geometries.Bounds.Depth
get

The depth of this bounds instance.

[get]

Returns the depth of this bounds instance.

◆ Height

double Luciad.Geometries.Bounds.Height
get

The height of this bounds instance.

[get]

Returns the height of this bounds instance.

◆ Location

Luciad.Cartesian.Coordinate Luciad.Geometries.Bounds.Location
get

The lower left corner of this bounds instance.

[get]

Returns the lower left corner of this bounds instance.

◆ LowerLeftCorner

Luciad.Cartesian.Coordinate Luciad.Geometries.Bounds.LowerLeftCorner
get

The lower left corner of this bounds instance.

[get]

Returns the lower left corner of this bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

◆ LowerRightCorner

Luciad.Cartesian.Coordinate Luciad.Geometries.Bounds.LowerRightCorner
get

The lower right corner of this bounds instance.

[get]

Returns the lower right corner of this bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

◆ UpperLeftCorner

Luciad.Cartesian.Coordinate Luciad.Geometries.Bounds.UpperLeftCorner
get

The upper left corner of this bounds instance.

[get]

Returns the upper left corner of this bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

◆ UpperRightCorner

Luciad.Cartesian.Coordinate Luciad.Geometries.Bounds.UpperRightCorner
get

The upper right corner of this bounds instance.

[get]

Returns the upper right corner of this bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

◆ Width

double Luciad.Geometries.Bounds.Width
get

The width of this bounds instance.

[get]

Returns the width of this bounds instance.