NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IEnvelope Class Referenceabstract

Provides access to members that describe properties and behavior of geometric envelope. More...

#include <geometry.h>

Inheritance diagram for IEnvelope:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetCoordinates (SDKAnyType type, void *xmin, void *ymin, void *xmax, void *ymax) const =0 throw ()
 Returns coordinates formatted in the specified type. More...
 
virtual SDKResult SDK_CALLTYPE GetZCoordinates (SDKAnyType type, void *zmin, void *zmax) const =0 throw ()
 Returns the minimum and maximum Z values. More...
 
virtual SDKResult SDK_CALLTYPE IsEmpty () const =0 throw ()
 Returns whether the width and height are equal to 0. More...
 
virtual SDKResult SDK_CALLTYPE GetDimension (GeometryDimension &dimension) const =0 throw ()
 Returns the topological dimension of the envelope.
 
virtual SDKResult SDK_CALLTYPE IsInfinite () const =0 throw ()
 Indicates whether a Geometry object has infinite coordinates in any dimension. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

Provides access to members that describe properties and behavior of geometric envelope.

Member Function Documentation

◆ GetCoordinates()

virtual SDKResult SDK_CALLTYPE GetCoordinates ( SDKAnyType  type,
void *  xmin,
void *  ymin,
void *  xmax,
void *  ymax 
) const
throw (
)
pure virtual

Returns coordinates formatted in the specified type.

Parameters
type[in] type of the coordinates.

◆ GetZCoordinates()

virtual SDKResult SDK_CALLTYPE GetZCoordinates ( SDKAnyType  type,
void *  zmin,
void *  zmax 
) const
throw (
)
pure virtual

Returns the minimum and maximum Z values.

Parameters
type[in] type of the coordinates.

◆ IsEmpty()

virtual SDKResult SDK_CALLTYPE IsEmpty ( ) const
throw (
)
pure virtual

Returns whether the width and height are equal to 0.

Returns
kSDKResult_True if this envelope is empty.
kSDKResult_False if this envelope is not empty.

◆ IsInfinite()

virtual SDKResult SDK_CALLTYPE IsInfinite ( ) const
throw (
)
pure virtual

Indicates whether a Geometry object has infinite coordinates in any dimension.

Returns
kSDKResult_False if this geometry is finite. kSDKResult_True if this geometry is infinite.

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