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

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

#include <geometry.h>

Inheritance diagram for IGeometry:
ISDKComponent IBezierCurve ICompositeCurve ICurve ICurveSegment IGrid IMultipoint IMultiSurface INullGeometry IPoint IRing ISurface

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetGeometryType (GeometryType &type) const =0 throw ()
 Returns the type of a geometry.
 
virtual SDKResult SDK_CALLTYPE GetDimension (GeometryDimension &dimension) const =0 throw ()
 Returns the topological dimension of the geometry object.
 
virtual SDKResult SDK_CALLTYPE GetEnvelope (IEnvelope **envelope) const =0 throw ()
 Returns the unique Envelope that binds the Geometry object. This is the smallest Envelope that Contains the object. More...
 
virtual SDKResult SDK_CALLTYPE IsEmpty () const =0 throw ()
 Indicates whether this geometry contains any points. More...
 
virtual SDKResult SDK_CALLTYPE IsInfinite () const =0 throw ()
 Indicates whether a Geometry object has infinite coordinates in any dimension. More...
 
virtual SDKResult SDK_CALLTYPE GetBoundary (IGeometry **geometry)=0 throw ()
 Returns boundary of the geometry object. More...
 
virtual SDKResult SDK_CALLTYPE GetPointCollection (IPointCollectionParameters *parameters, IPointCollection **point_collection)=0 throw ()
 Returns the point collection of the Geometry object. More...
 
virtual SDKResult SDK_CALLTYPE Project (sdk::crs::IProjection *projection, IGeometry **projected_geometry)=0 throw ()
 Projects the geometry into a new projection. More...
 
virtual SDKResult SDK_CALLTYPE GetHorizontalCoordinateSystem (sdk::crs::IHorizontalCoordinateSystem **coordinate_system) const =0 throw ()
 Returns an interface that provides access to properties of the horizontal coordinate system. More...
 
virtual SDKResult SDK_CALLTYPE GetVerticalCoordinateSystem (sdk::crs::IVerticalCoordinateSystem **coordinate_system) const =0 throw ()
 Returns an interface that provides access to properties of the vertical coordinate system. More...
 
virtual SDKResult SDK_CALLTYPE GetHorizontalDatum (SDKUInt16 &hordat) const =0 throw ()
 Returns the horizontal datum of the geometry. More...
 
virtual SDKResult SDK_CALLTYPE GetGeometryFlags (SDKUInt64 &flags) const =0 throw ()
 Returns geometry flags. More...
 
virtual SDKResult SDK_CALLTYPE GetGeometryID (SDKUInt64 &flags) const =0 throw ()
 Returns geometry identifier. 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 all geometric objects.

Member Function Documentation

◆ GetEnvelope()

virtual SDKResult SDK_CALLTYPE GetEnvelope ( IEnvelope **  envelope) const
throw (
)
pure virtual

Returns the unique Envelope that binds the Geometry object. This is the smallest Envelope that Contains the object.

Parameters
envelope[out] Address of a variable that receives the pointer to the IEnvelope interface associated with the geometry envelope.
Returns
SDKResult_Succeeded
SDKResult_NotImplemented

◆ IsEmpty()

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

Indicates whether this geometry contains any points.

Returns
kSDKResult_False if this geometry is not empty. kSDKResult_True if this geometry is 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.

◆ GetBoundary()

virtual SDKResult SDK_CALLTYPE GetBoundary ( IGeometry **  geometry)
throw (
)
pure virtual

Returns boundary of the geometry object.

Parameters
geometry[out] Address of a variable that receives the pointer to the IGeometry interface associated with the geometry object containing boundaries.
Returns
SDKResult_Succeeded
SDKResult_NotImplemented
SDKResult_NotExist

◆ GetPointCollection()

virtual SDKResult SDK_CALLTYPE GetPointCollection ( IPointCollectionParameters *  parameters,
IPointCollection **  point_collection 
)
throw (
)
pure virtual

Returns the point collection of the Geometry object.

Parameters
parameters[in] A pointer to parameters that specifies the requested point collection.
point_collection[out] Address of variable that receives the pointer to a PointCollection.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotExist

◆ Project()

virtual SDKResult SDK_CALLTYPE Project ( sdk::crs::IProjection *  projection,
IGeometry **  projected_geometry 
)
throw (
)
pure virtual

Projects the geometry into a new projection.

Parameters
projection[in] Pointer to the IProjection interface associated with the projection object.
projected_geometry[out] Address of a variable that receives the interface IGeomatry associated with the projected geometry.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

◆ GetHorizontalCoordinateSystem()

virtual SDKResult SDK_CALLTYPE GetHorizontalCoordinateSystem ( sdk::crs::IHorizontalCoordinateSystem **  coordinate_system) const
throw (
)
pure virtual

Returns an interface that provides access to properties of the horizontal coordinate system.

Parameters
coordinate_system[out] Address of variable that receives the pointer to the IGeographicCoordinateSystem interface associated with the geographic coordinate system.
Returns
SDKResult_Succeeded
SDKResult_NotImplemented
SDKResult_NotExist

◆ GetVerticalCoordinateSystem()

virtual SDKResult SDK_CALLTYPE GetVerticalCoordinateSystem ( sdk::crs::IVerticalCoordinateSystem **  coordinate_system) const
throw (
)
pure virtual

Returns an interface that provides access to properties of the vertical coordinate system.

Parameters
coordinate_system[out] Address of variable that receives the pointer to the IVerticalCoordinateSystem interface associated with the vertical coordinate system.
Returns
SDKResult_Succeeded
SDKResult_NotImplemented
SDKResult_NotExist

◆ GetHorizontalDatum()

virtual SDKResult SDK_CALLTYPE GetHorizontalDatum ( SDKUInt16 &  hordat) const
throw (
)
pure virtual

Returns the horizontal datum of the geometry.

Parameters
hordat[out] Address of variable that receives the horizontal datum (see in crs_horizontal_coordinate_system.h)
Returns
SDKResult_Succeeded
SDKResult_NotImplemented
SDKResult_NotExist

◆ GetGeometryFlags()

virtual SDKResult SDK_CALLTYPE GetGeometryFlags ( SDKUInt64 &  flags) const
throw (
)
pure virtual

Returns geometry flags.

Parameters
flags[out] Address of variable that receives the flags (see GMFL_FLAGS in senc_feature_dataset_s101.h for GDBGeometry)
Returns
SDKResult_Succeeded
SDKResult_NotImplemented
SDKResult_NotExist

◆ GetGeometryID()

virtual SDKResult SDK_CALLTYPE GetGeometryID ( SDKUInt64 &  flags) const
throw (
)
pure virtual

Returns geometry identifier.

Parameters
id[out] Address of variable that receives the geometry id
Returns
SDKResult_Succeeded
SDKResult_NotImplemented
SDKResult_NotExist

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