Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Public Member Functions | Properties

ISkpPolyline3d Interface Reference

A polyline3d object. More...

List of all members.

Public Member Functions

HRESULT _GetPosition ([in] long nIndex,[out] double pPoint3d[3])
 Gets the nIndexth point in the polyline.

Properties

long Count [get]
 The number of points in the polyline.
ISkpPoint3d Position ([in] long nIndex) [get]
 [propget] Gets the nIndexth point in the polyline.

Detailed Description

A polyline3d object.


Member Function Documentation

HRESULT ISkpPolyline3d::_GetPosition ( [in] long  nIndex,
[out] double  pPoint3d[3] 
)

Gets the nIndexth point in the polyline.

It is expected that the calling application has allocated space for the return value.

Parameters:
nIndex The 0-based index of the desired point.
Return values:
pPoint3d The point at the given index.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_INVALIDARG : if nIndex < 0 or >= Count of this polyline
E_FAIL : internal errors

Property Documentation

long ISkpPolyline3d::Count [get]

The number of points in the polyline.

Return values:
pVal The number of points in this polyline.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
E_FAIL : internal errors
ISkpPoint3d ISkpPolyline3d::Position([in] long nIndex) [get]

[propget] Gets the nIndexth point in the polyline.

Parameters:
nIndex The 0-based index of the desired point.
Return values:
pPoint3d The point at the given index.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_INVALIDARG : if nIndex < 0 or >= Count of this polyline
E_FAIL : internal errors

©2010 Google - Google Home - About Google