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

Public Member Functions | Properties

ISkpDimensionLinear Interface Reference

A linear dimension type. More...

Inheritance diagram for ISkpDimensionLinear:
SkpDimensionLinear

List of all members.

Public Member Functions

HRESULT _GetStartPoint ([out] double pPoint3d[3])
 Returns the starting point of the linear dimension.
HRESULT _GetEndPoint ([out] double pPoint3d[3])
 Returns the ending point of the linear dimension.
HRESULT _GetNormal ([out] double pVector3d[3])
 Returns the normal vector of the linear dimension.
HRESULT _GetXAxis ([out] double pVector3d[3])
 Returns the x-axis of the linear dimension.

Properties

ISkpPoint3d StartPoint [get]
 [propget] Returns the starting point of the linear dimension.
ISkpPoint3d EndPoint [get]
 [propget] Returns the ending point of the linear dimension.
ISkpVector3d Normal [get]
 [propget] Returns the normal vector of the linear dimension.
ISkpVector3d XAxis [get]
 [propget] Returns the x-axis of the linear dimension.
double XPosition [get]
 [propget] Returns the x-position of the linear dimension.
double YPosition [get]
 [propget] Returns the y-position of the linear dimension.
SkpLinearDimensionType Type [get]
 [propget] Returns the type of the linear dimension.
SkpDimensionTextPosition TextPosition [get]
 [propget] Returns the text position type for this dimension

Detailed Description

A linear dimension type.


Member Function Documentation

HRESULT ISkpDimensionLinear::_GetEndPoint ( [out] double  pPoint3d[3]  ) 

Returns the ending point of the linear dimension.

This method assumes that the caller has allocated space for the return value.

Parameters:
pPoint3d The caller-allocated space for the end point of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionLinear::_GetNormal ( [out] double  pVector3d[3]  ) 

Returns the normal vector of the linear dimension.

This method assumes that the caller has allocated space for the return value.

Parameters:
pVector3d The caller-allocated space for the normal vector of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionLinear::_GetStartPoint ( [out] double  pPoint3d[3]  ) 

Returns the starting point of the linear dimension.

This method assumes that the caller has allocated space for the return value.

Parameters:
pPoint3d The caller-allocated space for the start point of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionLinear::_GetXAxis ( [out] double  pVector3d[3]  ) 

Returns the x-axis of the linear dimension.

This method assumes that the caller has allocated space for the return value.

Parameters:
pVector3d The caller-allocated space for the x-axis of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

Property Documentation

ISkpPoint3d ISkpDimensionLinear::EndPoint [get]

[propget] Returns the ending point of the linear dimension.

Parameters:
pPoint3d The ISkpPoint3d that will hold the start point of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpVector3d ISkpDimensionLinear::Normal [get]

[propget] Returns the normal vector of the linear dimension.

Parameters:
pVector3d The ISkpVector3d that will hold the normal vector of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpPoint3d ISkpDimensionLinear::StartPoint [get]

[propget] Returns the starting point of the linear dimension.

Parameters:
pPoint3d The ISkpPoint3d that will hold the start point of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
SkpDimensionTextPosition ISkpDimensionLinear::TextPosition [get]

[propget] Returns the text position type for this dimension

Return values:
pVal The positioning option for this dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
SkpLinearDimensionType ISkpDimensionLinear::Type [get]

[propget] Returns the type of the linear dimension.

Parameters:
pVal The type of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpVector3d ISkpDimensionLinear::XAxis [get]

[propget] Returns the x-axis of the linear dimension.

Parameters:
pVector3d The ISkpVector3d holding the x-axis of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpDimensionLinear::XPosition [get]

[propget] Returns the x-position of the linear dimension.

Parameters:
pVal The x-position of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpDimensionLinear::YPosition [get]

[propget] Returns the y-position of the linear dimension.

Parameters:
pVal The y-position of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

©2010 Google - Google Home - About Google