FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Geometry::IEnvelopeImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Geometry::OSGeo::FDO::Geometry::IEnvelope.

Inheritance diagram for OSGeo::FDO::Geometry::IEnvelopeImp:

[legend]
List of all members.

Detailed Description

The IEnvelopeImp class is a three-dimensional, axis-aligned box. This is a helper type for Geometries, and does not itself inherit from IGeometry.

Remarks:
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::quiet_NaN().


Public Member Functions

__property System::Boolean get_IsEmpty ()
 Indicates whether the envelope's extents are set.
__property System::Double get_MaxX ()
 Gets the maximum X coordinate value.
__property System::Double get_MaxY ()
 Gets the maximum Y coordinate value.
__property System::Double get_MaxZ ()
 Gets the maximum Z coordinate value.
__property System::Double get_MinX ()
 Gets the minimum X coordinate value.
__property System::Double get_MinY ()
 Gets the minimum Y coordinate value.
__property System::Double get_MinZ ()
 Gets the minimum Z coordinate value.
 IEnvelopeImp (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs an IEnvelopeImp managed object based on an unmanaged instance of the object.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Geometry::IEnvelopeImp::IEnvelopeImp System::IntPtr  unmanaged,
System::Boolean  autoDelete
 

Constructs an IEnvelopeImp managed object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

__property System::Boolean OSGeo::FDO::Geometry::IEnvelopeImp::get_IsEmpty  ) 
 

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

__property System::Double OSGeo::FDO::Geometry::IEnvelopeImp::get_MaxX  ) 
 

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::quiet_NaN() by default

__property System::Double OSGeo::FDO::Geometry::IEnvelopeImp::get_MaxY  ) 
 

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::quiet_NaN() by default

__property System::Double OSGeo::FDO::Geometry::IEnvelopeImp::get_MaxZ  ) 
 

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::quiet_NaN() by default

__property System::Double OSGeo::FDO::Geometry::IEnvelopeImp::get_MinX  ) 
 

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::quiet_NaN() by default

__property System::Double OSGeo::FDO::Geometry::IEnvelopeImp::get_MinY  ) 
 

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::quiet_NaN() by default

__property System::Double OSGeo::FDO::Geometry::IEnvelopeImp::get_MinZ  ) 
 

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::quiet_NaN() by default

System::Void OSGeo::FDO::Geometry::IEnvelopeImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.


Comments or suggestions? Send us feedback.