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

Public Member Functions | Properties

ISkpOpening Interface Reference

An opening object. More...

List of all members.

Public Member Functions

HRESULT _GetPoints ([in]long pointCount,[out, size_is(pointCount *3)]double pPoints[*])
 Get the properly transformed points deliminating the opening loop.

Properties

long PointCount [get]
 [propget] Returns the number of points defining this opening loop.
ISkpPoint3d Point ([in] long nIndex) [get]
 [propget] Get the nIndexth properly transformed point.
ISkpVector3d VertexNormal ([in] long nIndex) [get]
 [propget] Get the nIndexth vertex normal
ISkpComponentInstance ComponentInstance [get]
 [propget] Get the ComponentInstance that created this opening.

Detailed Description

An opening object.

This object will return the points the define an opening in a face.

See also:
ISkpFace.

Member Function Documentation

HRESULT ISkpOpening::_GetPoints ( [in] long  pointCount,
[out, size_is(pointCount *3)] double  pPoints[*] 
)

Get the properly transformed points deliminating the opening loop.

It is assumed that the calling application has allocated space for the return values.

Parameters:
pointCount The number of points to retrieve, as determined by the ISkpOpening::GetPointCount property.
Return values:
pPoints The points defining this opening loop.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

Property Documentation

ISkpComponentInstance ISkpOpening::ComponentInstance [get]

[propget] Get the ComponentInstance that created this opening.

Return values:
pVal The component instance that created the opening.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpOpening::Point([in] long nIndex) [get]

[propget] Get the nIndexth properly transformed point.

Parameters:
nIndex The 0-based index of the point to retrieve.
Return values:
pPoint The specified point.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_INVALIDARG : if nIndex < 0 or nIndex >= GetPointCount
E_FAIL : internal errors
long ISkpOpening::PointCount [get]

[propget] Returns the number of points defining this opening loop.

Return values:
pVal The number of points defining this opening loop.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpVector3d ISkpOpening::VertexNormal([in] long nIndex) [get]

[propget] Get the nIndexth vertex normal

Parameters:
nIndex The 0-based index of the point to retrieve.
Return values:
pNormal The normal to the vertex (point) at the specified index.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_INVALIDARG : if nIndex < 0 or nIndex >= GetPointCount
E_FAIL : internal errors

©2010 Google - Google Home - About Google