FDO API Reference

Feature Data Objects

FdoIEnvelope Class Reference

#include <IEnvelope.h>

Inherits FdoIDisposable.

Inherited by FdoEnvelopeImpl.

Inheritance diagram for FdoIEnvelope:

[legend]List of all members.

---

Detailed Description

The FdoIEnvelope class is a three-dimensional, axis-aligned box. This is a helper type for Geometries, and does not itself inherit from IGeometry. This type is typically used to record the "extents" of a shape, also known in 2 dimensions as an MBR ("Minimum Bounding Rectangle"). The box may be initially empty, meaning that no dimensions have an assigned value. each individual extent may be unassigned, in which case using its accessor will return numeric_limits<double>::quiet_NaN().

Definition at line 39 of file IEnvelope.h.

Public Member Functions
virtual FDO_GEOM_API bool	GetIsEmpty () const =0
	Indicates whether the envelope's extents are set.
virtual FDO_GEOM_API double	GetMaxX () const =0
	Gets the maximum X coordinate value.
virtual FDO_GEOM_API double	GetMaxY () const =0
	Gets the maximum Y coordinate value.
virtual FDO_GEOM_API double	GetMaxZ () const =0
	Gets the maximum Z coordinate value.
virtual FDO_GEOM_API double	GetMinX () const =0
	Gets the minimum X coordinate value.
virtual FDO_GEOM_API double	GetMinY () const =0
	Gets the minimum Y coordinate value.
virtual FDO_GEOM_API double	GetMinZ () const =0
	Gets the minimum Z coordinate value.
virtual FDO_GEOM_API const double *	GetOrdinates ()=0
	Gets the ordinates as an array.
Protected Member Functions
FDO_GEOM_API	FdoIEnvelope ()
	Constructs a default instance.
virtual FDO_GEOM_API	~FdoIEnvelope ()
	Default destructor.

---

Constructor & Destructor Documentation

FDO_GEOM_API FdoIEnvelope::FdoIEnvelope (   )  [inline, protected]

Constructs a default instance. Returns: Returns nothing Definition at line 156 of file IEnvelope.h. References FDO_GEOM_API.

virtual FDO_GEOM_API FdoIEnvelope::~FdoIEnvelope (   )  [inline, protected, virtual]

Default destructor. Returns: Returns nothing Definition at line 164 of file IEnvelope.h. References FDO_GEOM_API.

---

Member Function Documentation

virtual FDO_GEOM_API bool FdoIEnvelope::GetIsEmpty (   )  const [pure virtual]

Indicates whether the envelope's extents are set. Returns: Returns 'true' if none of the X, Y and Z extents have been set; 'false' otherwise Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API double FdoIEnvelope::GetMaxX (   )  const [pure virtual]

Gets the maximum X coordinate value. Remarks: This is the largest X ordinate value for the envelope, regardless of the sense of the axes. In a conventional right-handed system, this would be the X coordinate for the point in the front, upper-right corner of the envelope. Returns: Returns the maxiumum X ordinate; numeric_limits<double>::quiet_NaN() by default Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API double FdoIEnvelope::GetMaxY (   )  const [pure virtual]

Gets the maximum Y coordinate value. Remarks: This is the largest Y ordinate value for the envelope, regardless of the sense of the axes. In a conventional right-handed system, this would be the Y coordinate for the point in the front, upper-right corner of the envelope. Returns: Returns the maxiumum Y ordinate; numeric_limits<double>::quiet_NaN() by default Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API double FdoIEnvelope::GetMaxZ (   )  const [pure virtual]

Gets the maximum Z coordinate value. Remarks: This is the largest Z ordinate value for the envelope, regardless of the sense of the axes. In a conventional right-handed system, this would be the Z coordinate for the point in the front, upper-right corner of the envelope. Returns: Returns the maxiumum Z ordinate; numeric_limits<double>::quiet_NaN() by default Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API double FdoIEnvelope::GetMinX (   )  const [pure virtual]

Gets the minimum X coordinate value. Remarks: This is the smallest X ordinate value for the envelope, regardless of the sense of the axes. In a conventional right-handed system, this would be the X coordinate for the point in the rear, lower-left corner of the envelope. Returns: Returns the miniumum X ordinate; numeric_limits<double>::quiet_NaN() by default Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API double FdoIEnvelope::GetMinY (   )  const [pure virtual]

Gets the minimum Y coordinate value. Remarks: This is the smallest Y ordinate value for the envelope, regardless of the sense of the axes. In a conventional right-handed system, this would be the Y coordinate for the point in the rear, lower-left corner of the envelope. Returns: Returns the miniumum Y ordinate; numeric_limits<double>::quiet_NaN() by default Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API double FdoIEnvelope::GetMinZ (   )  const [pure virtual]

Gets the minimum Z coordinate value. Remarks: This is the smallest Z ordinate value for the envelope, regardless of the sense of the axes. In a conventional right-handed system, this would be the Z coordinate for the point in the rear, lower-left corner of the envelope. Returns: Returns the miniumum Z ordinate; numeric_limits<double>::quiet_NaN() by default Implemented in FdoEnvelopeImpl.

virtual FDO_GEOM_API const double* FdoIEnvelope::GetOrdinates (   )  [pure virtual]

Gets the ordinates as an array. Remarks: The caller must not free the returned array. The ordinates are in the order XYZXYZ, with only those present according to the dimensionality. Returns: Returns the ordinates Implemented in FdoEnvelopeImpl.

---

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

• IEnvelope.h

---

Comments or suggestions? Send us feedback.