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

Public Member Functions | Properties

ISkpArcCurve Interface Reference

An arc curve interface. More...

Inheritance diagram for ISkpArcCurve:
SkpArcCurve

List of all members.

Public Member Functions

HRESULT _GetStartPoint ([out]double pPoint3d[3])
 Get the start point of this arc.
HRESULT _GetEndPoint ([out]double pPoint3d[3])
 Get the end point of this arc.
HRESULT _GetXAxis ([out]double pVector3d[3])
 Get the x-axis of this arc.
HRESULT _GetYAxis ([out]double pVector3d[3])
 Get the y-axis of this arc.
HRESULT _GetCenter ([out]double pPoint3d[3])
 Get the center point of this arc.
HRESULT _GetNormal ([out]double pVector3d[3])
 Get the normal vector of this arc.

Properties

double Radius [get]
 [propget] Get the radius of this arc.
ISkpPoint3d StartPoint [get]
 [propget] Get the start point of this arc.
ISkpPoint3d EndPoint [get]
 [propget] Get the end point of this arc.
ISkpVector3d XAxis [get]
 [propget] Get the x-axis of this arc.
ISkpVector3d YAxis [get]
 [propget] Get the y-axis of this arc.
ISkpPoint3d Center [get]
 [propget] Get the center point of this arc.
ISkpVector3d Normal [get]
 [propget] Get the normal vector of this arc.
double StartAngle [get]
 [propget] Get the start angle of this arc.
double EndAngle [get]
 [propget] Get the end angle of this arc.
BOOL IsFullCircle [get]
 [propget] Returns TRUE iff the arc is a full circle.

Detailed Description

An arc curve interface.


Member Function Documentation

HRESULT ISkpArcCurve::_GetCenter ( [out] double  pPoint3d[3]  ) 

Get the center point of this arc.

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

Return values:
pVal The center point of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
HRESULT ISkpArcCurve::_GetEndPoint ( [out] double  pPoint3d[3]  ) 

Get the end point of this arc.

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

Return values:
pVal The end point of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
HRESULT ISkpArcCurve::_GetNormal ( [out] double  pVector3d[3]  ) 

Get the normal vector of this arc.

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

Return values:
pVal The normal vector of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
HRESULT ISkpArcCurve::_GetStartPoint ( [out] double  pPoint3d[3]  ) 

Get the start point of this arc.

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

Return values:
pVal The start point of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
HRESULT ISkpArcCurve::_GetXAxis ( [out] double  pVector3d[3]  ) 

Get the x-axis of this arc.

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

Return values:
pVal The x-axis of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
HRESULT ISkpArcCurve::_GetYAxis ( [out] double  pVector3d[3]  ) 

Get the y-axis of this arc.

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

Return values:
pVal The y-axis of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.

Property Documentation

ISkpPoint3d ISkpArcCurve::Center [get]

[propget] Get the center point of this arc.

Return values:
pVal The center point of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
double ISkpArcCurve::EndAngle [get]

[propget] Get the end angle of this arc.

Return values:
pVal The end angle of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpPoint3d ISkpArcCurve::EndPoint [get]

[propget] Get the end point of this arc.

Return values:
pVal The end point of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
BOOL ISkpArcCurve::IsFullCircle [get]

[propget] Returns TRUE iff the arc is a full circle.

Return values:
pVal TRUE iff the arc is a full circle.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVector3d ISkpArcCurve::Normal [get]

[propget] Get the normal vector of this arc.

Return values:
pVal The normal vector of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
double ISkpArcCurve::Radius [get]

[propget] Get the radius of this arc.

Return values:
pVal The radius of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
double ISkpArcCurve::StartAngle [get]

[propget] Get the start angle of this arc.

Return values:
pVal The start angle of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpPoint3d ISkpArcCurve::StartPoint [get]

[propget] Get the start point of this arc.

Return values:
pVal The start point of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVector3d ISkpArcCurve::XAxis [get]

[propget] Get the x-axis of this arc.

Return values:
pVal The x-axis of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.
ISkpVector3d ISkpArcCurve::YAxis [get]

[propget] Get the y-axis of this arc.

Return values:
pVal The y-axis of this arc.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : on internal errors.

©2010 Google - Google Home - About Google