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

Provides access to members that manipulate the points of a Multipoint, Curve, Ring, Surface, TriangleFan, TriangleStrip or Triangles. More...

#include <geometry.h>

Inheritance diagram for IPointCollection:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetPointCount (SDKUInt32 &point_count) const =0 throw ()
 Returns the number of Points in the PointCollection.
 
virtual SDKResult SDK_CALLTYPE GetItemCount (SDKUInt32 &item_count) const =0 throw ()
 Returns the number of Items in the PointCollection. (e.g. Rings.)
 
virtual SDKResult SDK_CALLTYPE GetItemPointCount (SDKUInt32 item, SDKUInt32 &point_count) const =0 throw ()
 Returns the number of Points in the Item of the PointCollection.
 
virtual SDKResult SDK_CALLTYPE GetPointDimension (PointDimensionType &point_dimension) const =0 throw ()
 Returns the dimension of the Points.
 
virtual SDKResult SDK_CALLTYPE GetPoints (SDKUInt32 index, SDKUInt32 count, PointType type, void *points) const =0 throw ()
 Gets the ith IPoint from the PointCollection. The first Point in the PointCollection has index 0, and the last Point has index equal to PointCount - 1. 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 manipulate the points of a Multipoint, Curve, Ring, Surface, TriangleFan, TriangleStrip or Triangles.

Member Function Documentation

◆ GetPoints()

virtual SDKResult SDK_CALLTYPE GetPoints ( SDKUInt32  index,
SDKUInt32  count,
PointType  type,
void *  points 
) const
throw (
)
pure virtual

Gets the ith IPoint from the PointCollection. The first Point in the PointCollection has index 0, and the last Point has index equal to PointCount - 1.

Parameters
index[in] An index of the requested element.
point[out] Address of variable that receives the pointer to IPoint interface.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotExist

Populates an array with references to points.

Parameters
index[in] An start index of the requested elements.
count[in] Number of requested elements.
point[out] A pointer of an array of pointers to IPoint interface that receives requested elements.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotExist

Copies some points to an existing array of point structures.

Parameters
index[in] An start index of the requested elements.
count[in] Number of requested elements.
type[in] The data type of output points.
point[out] A pointer to an array of point structures that receives requested elements.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotExist

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