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::EnvelopeImpl Class Reference

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

Inheritance diagram for OSGeo::FDO::Geometry::EnvelopeImpl:

[legend]
List of all members.

Detailed Description

The EnvelopeImpl class is a default implementation of IEnvelope. EnvelopeImpl implements accessors from IEnvelope, matching mutators, and simple data members. Assignment, exact equality operators, and utility methods are also provided.


Public Member Functions

 EnvelopeImpl (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs an Envelope based on an unmanaged instance of the object.
 EnvelopeImpl (System::Int32 dimensionType, System::Double ordinates __gc[])
 Constructs a EnvelopeImpl object by copying from an array of ordinates.
 EnvelopeImpl (OSGeo::FDO::Geometry::IDirectPosition *lowerLeft, OSGeo::FDO::Geometry::IDirectPosition *upperRight)
 Constructs a EnvelopeImpl object from two positions.
 EnvelopeImpl (EnvelopeImpl *envelopeImpl)
 Constructs a copy of a EnvelopeImpl.
 EnvelopeImpl (System::Double minX, System::Double minY, System::Double minZ, System::Double maxX, System::Double maxY, System::Double maxZ)
 Constructs a 3D EnvelopeImpl object from X, Y and Z ordinates.
 EnvelopeImpl (System::Double minX, System::Double minY, System::Double maxX, System::Double maxY)
 Constructs a 2D EnvelopeImpl object from X and Y ordinates.
 EnvelopeImpl ()
 Constructs a default instance of a EnvelopeImpl object.
System::Boolean Equals (System::Object *obj)
 Equality function for EnvelopeImpl.
System::Void Expand (OSGeo::FDO::Geometry::IEnvelope *envelope)
 Expands the envelope's extents to include another envelope.
System::Void Expand (OSGeo::FDO::Geometry::IDirectPosition *position)
 Expands the envelope's extents to include a given position.
__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.
System::Int32 GetHashCode ()
 DOXYGEN-IGNORE
__property System::Void set_MaxX (System::Double maxX)
 Sets the maximum X coordinate value.
__property System::Void set_MaxY (System::Double maxY)
 Sets the maximum Y coordinate value.
__property System::Void set_MaxZ (System::Double maxZ)
 Sets the maximum Z coordinate value.
__property System::Void set_MinX (System::Double minX)
 Sets the minimum X coordinate value.
__property System::Void set_MinY (System::Double minY)
 Sets the minimum Y coordinate value.
__property System::Void set_MinZ (System::Double minZ)
 Sets the minimum Z coordinate value.

Static Public Member Functions

System::Boolean op_Equality (EnvelopeImpl *left, EnvelopeImpl *right)
 Equality function for EnvelopeImpl.
System::Boolean op_Inequality (EnvelopeImpl *left, EnvelopeImpl *right)
 InEquality function for EnvelopeImpl.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Geometry::EnvelopeImpl::EnvelopeImpl  ) 
 

Constructs a default instance of a EnvelopeImpl object.

Remarks:
Ordinate values default to System::Double::NaN.

OSGeo::FDO::Geometry::EnvelopeImpl::EnvelopeImpl System::Double  minX,
System::Double  minY,
System::Double  maxX,
System::Double  maxY
 

Constructs a 2D EnvelopeImpl object from X and Y ordinates.

Remarks:
Z ordinate value defaults to System::Double::NaN.
Parameters:
minX Input Lower-left X ordinate
minY Input Lower-left Y ordinate
maxX Input Upper-right X ordinate
maxY Input Upper-right Y ordinate

OSGeo::FDO::Geometry::EnvelopeImpl::EnvelopeImpl System::Double  minX,
System::Double  minY,
System::Double  minZ,
System::Double  maxX,
System::Double  maxY,
System::Double  maxZ
 

Constructs a 3D EnvelopeImpl object from X, Y and Z ordinates.

Parameters:
minX Input Lower-left X ordinate
minY Input Lower-left Y ordinate
minZ Input Lower-left, rear Z ordinate
maxX Input Upper-right X ordinate
maxY Input Upper-right Y ordinate
maxZ Input Upper-right, front Z ordinate

OSGeo::FDO::Geometry::EnvelopeImpl::EnvelopeImpl EnvelopeImpl envelopeImpl  ) 
 

Constructs a copy of a EnvelopeImpl.

Parameters:
envelopeImpl Input envelope to copy

OSGeo::FDO::Geometry::EnvelopeImpl::EnvelopeImpl OSGeo::FDO::Geometry::IDirectPosition lowerLeft,
OSGeo::FDO::Geometry::IDirectPosition upperRight
 

Constructs a EnvelopeImpl object from two positions.

Parameters:
lowerLeft Input Lower-left position
upperRight Input Upper-right position

OSGeo::FDO::Geometry::EnvelopeImpl::EnvelopeImpl System::Int32  dimensionType,
System::Double ordinates  __gc[]
 

Constructs a EnvelopeImpl object by copying from an array of ordinates.

Parameters:
dimensionType Input dimensionality of the ordinates (see Dimensionality)
ordinates Input ordinate array representing two positions

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

Constructs an Envelope based on an unmanaged instance of the object.

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

Member Function Documentation

System::Boolean OSGeo::FDO::Geometry::EnvelopeImpl::Equals System::Object *  obj  )  [virtual]
 

Equality function for EnvelopeImpl.

Parameters:
obj Input envelope for comparison (right-hand-side of equation)
Returns:
Returns true if all non-NaN ordinates exactly equal to this instance. All NaN values compare as equal to each other.

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

System::Void OSGeo::FDO::Geometry::EnvelopeImpl::Expand OSGeo::FDO::Geometry::IEnvelope envelope  ) 
 

Expands the envelope's extents to include another envelope.

Parameters:
envelope Input envelope to include in extent
Returns:
Returns nothing

System::Void OSGeo::FDO::Geometry::EnvelopeImpl::Expand OSGeo::FDO::Geometry::IDirectPosition position  ) 
 

Expands the envelope's extents to include a given position.

Parameters:
position Input position to include in extent
Returns:
Returns nothing

__property System::Boolean OSGeo::FDO::Geometry::EnvelopeImpl::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::EnvelopeImpl::get_MaxX  ) 
 

Gets the maximum X coordinate value.

Returns:
Returns the maximum X ordinate; numeric_limits::quiet_NaN() by default

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

Gets the maximum Y coordinate value.

Returns:
Returns the maximum Y ordinate; numeric_limits::quiet_NaN() by default

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

Gets the maximum Z coordinate value.

Returns:
Returns the maximum Z ordinate; numeric_limits::quiet_NaN() by default

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

Gets the minimum X coordinate value.

Returns:
Returns the minimum X ordinate; numeric_limits::quiet_NaN() by default

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

Gets the minimum Y coordinate value.

Returns:
Returns the minimum Y ordinate; numeric_limits::quiet_NaN() by default

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

Gets the minimum Z coordinate value.

Returns:
Returns the minimum Z ordinate; numeric_limits::quiet_NaN() by default

System::Int32 OSGeo::FDO::Geometry::EnvelopeImpl::GetHashCode  ) 
 

DOXYGEN-IGNORE

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

System::Boolean OSGeo::FDO::Geometry::EnvelopeImpl::op_Equality EnvelopeImpl left,
EnvelopeImpl right
[static]
 

Equality function for EnvelopeImpl.

Parameters:
right Input envelope for comparison (right-hand-side of equation)
left Input envelope for comparison (left-hand-side of equation)
Returns:
Returns true if all non-NaN ordinates exactly equal. All NaN values compare as equal to each other.

System::Boolean OSGeo::FDO::Geometry::EnvelopeImpl::op_Inequality EnvelopeImpl left,
EnvelopeImpl right
[static]
 

InEquality function for EnvelopeImpl.

Parameters:
right Input envelope for comparison (right-hand-side of equation)
left Input envelope for comparison (left-hand-side of equation)
Returns:
Returns true if the envelope ordinates are not equal.

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

DOXYGEN-IGNORE

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

__property System::Void OSGeo::FDO::Geometry::EnvelopeImpl::set_MaxX System::Double  maxX  ) 
 

Sets the maximum X coordinate value.

Parameters:
maxX Input Upper-right X ordinate
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Geometry::EnvelopeImpl::set_MaxY System::Double  maxY  ) 
 

Sets the maximum Y coordinate value.

Parameters:
maxY Input Upper-right Y ordinate
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Geometry::EnvelopeImpl::set_MaxZ System::Double  maxZ  ) 
 

Sets the maximum Z coordinate value.

Parameters:
maxZ Input Upper-right, front Z ordinate
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Geometry::EnvelopeImpl::set_MinX System::Double  minX  ) 
 

Sets the minimum X coordinate value.

Parameters:
minX Input Lower-left X ordinate
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Geometry::EnvelopeImpl::set_MinY System::Double  minY  ) 
 

Sets the minimum Y coordinate value.

Parameters:
minY Input Lower-left Y ordinate
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Geometry::EnvelopeImpl::set_MinZ System::Double  minZ  ) 
 

Sets the minimum Z coordinate value.

Parameters:
minZ Input Lower-left, rear Z ordinate
Returns:
Returns nothing

Comments or suggestions? Send us feedback.