All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSketcherUseItf Interface IDMPolyline2D

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface IDMPolyline2D

OLE for Design and Modeling 2D Polyline Definition.
Role: This interface describes a 2D polyline. This is a geometric construct consisting of an ordered set of points that are connected by line segments. The methods provide access to the point geometry, which fully describe the polyline. Some special properties are also returned by the methods. Some of the output arguments consist of arrays, the memory for which has to be supplied by the caller. The size of the memory is computable from the call to one of the methods of this interface.

Method Index

o GetPolylineData(ULONG,double*): Obtains the points that fully define the polyline.
o GetPolylineInfo(ULONG*,boolean*): Returns overall information related to the polyline.

Methods

o GetPolylineData

public virtual GetPolylineData(		`nPoints`,
		`pPoints`)

Obtains the points that fully define the polyline. The memory is allocated and freed by the caller.

Parameters:

ULONG: nPoints [in] Inputs the number of points expected to be returned in the pPoints argument. The function is expecting nPoints * 2 * sizeof (double) bytes of memory allocated by the caller in pPoints.
double: *pPoints [out] Outputs the points making up the polyline. The memory is pre-allocated by the caller and is assumed to be able to hold upto nPoints. If the size falls short of what is required, an error is returned.

o GetPolylineInfo

public virtual GetPolylineInfo(		`pNumPoints`,
		`pIsClosed`)

Returns overall information related to the polyline. It is to be used in order to determine the amount of memory needed to obtain the variable length information that fully defines the polyline. When the polyline is closed, the endpoints are not repeated. So a rectangle will return 4 points.

Parameters:

ULONG: *pNumPoints [out] Outputs the number of points in the polyline.
boolean: *pIsClosed [out] Outputs TRUE if the polyline is closed. The first point connects to the last point.

This object is included in the file: IDMPolyline2D.h
If needed, your Imakefile.mk should include the module: CATSketcherUseItf