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

Public Member Functions | Properties

ISkpDimension Interface Reference

Base interface for all dimension objects. More...

Inheritance diagram for ISkpDimension:
SkpDimensionLinear SkpDimensionRadial

List of all members.

Public Member Functions

HRESULT GetFormattedText ([in]ISkpView *pView,[in]BOOL bNotToScale,[out, retval] BSTR *pVal)
 Returns the formatted text for this ISkpDimension given the current view.
HRESULT _GetTextPosition ([in]ISkpView *pView,[out]double textPositionPoint3d[3],[out]SkpTextJustification *just,[out]SkpTextAlignment *align)
 Returns the text position for this ISkpDimension given the current view.
HRESULT TextPosition ([in]ISkpView *pView,[out]ISkpPoint3d **textPositionPoint3d,[out]SkpTextJustification *just,[out]SkpTextAlignment *align)
 Returns the text position for this ISkpDimension given the current view.

Properties

ISkpDimensionStyle Style [get]
 [propget] Returns the ISkpDimensionStyle associated with this ISkpDimension.
BSTR Text [get]
 [propget] Returns the text displayed by this ISkpDimension.
ISkpPlane Plane [get]
 [propget] Returns the ISkpPlane for this ISkpDimension.
ISkpFont Font [get]
 [propget] Returns the ISkpFont associated with this style.
BOOL Has3DText [get]
 [propget] Returns TRUE iff the style renders the font in 3d text.
SkpDimensionArrow ArrowType [get]
 [propget] Returns the arrow type for this style

Detailed Description

Base interface for all dimension objects.


Member Function Documentation

HRESULT ISkpDimension::_GetTextPosition ( [in] ISkpView pView,
[out] double  textPositionPoint3d[3],
[out] SkpTextJustification *  just,
[out] SkpTextAlignment *  align 
)

Returns the text position for this ISkpDimension given the current view.

This method assumes that the caller has allocated space in the textPositionPoint3d parameter.

Parameters:
pView A non-NULL view.
textPositionPoint3d A caller allocated array of 3 doubles that will be populated with the position, in model space, of the text
just The justification value of the text.
align The alignment value of the text.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimension::GetFormattedText ( [in] ISkpView pView,
[in] BOOL  bNotToScale,
[out, retval] BSTR *  pVal 
)

Returns the formatted text for this ISkpDimension given the current view.

Parameters:
pView A non-NULL view.
bNotToScale If TRUE, the result is not scaled.
Return values:
pVal The formatted text.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimension::TextPosition ( [in] ISkpView pView,
[out] ISkpPoint3d **  textPositionPoint3d,
[out] SkpTextJustification *  just,
[out] SkpTextAlignment *  align 
)

Returns the text position for this ISkpDimension given the current view.

Parameters:
pView A non-NULL view.
textPositionPoint3d An ISkpPoint3d that will be populated with the position, in model space, of the text.
just The justification value of the text.
align The alignment value of the text.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

Property Documentation

SkpDimensionArrow ISkpDimension::ArrowType [get]

[propget] Returns the arrow type for this style

Return values:
pVal The arrow option for this style.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpFont ISkpDimension::Font [get]

[propget] Returns the ISkpFont associated with this style.

Return values:
pVal The ISkpFont.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpDimension::Has3DText [get]

[propget] Returns TRUE iff the style renders the font in 3d text.

Return values:
pVal TRUE iff the style renders the font in 3d text.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpPlane ISkpDimension::Plane [get]

[propget] Returns the ISkpPlane for this ISkpDimension.

Return values:
pVal The ISkpPlane for this ISkpDimension.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
E_FAIL : indicates internal errors
ISkpDimensionStyle ISkpDimension::Style [get]

[propget] Returns the ISkpDimensionStyle associated with this ISkpDimension.

Return values:
ppVal The ISkpDimensionStyle associated with this ISkpDimension.
Returns:
S_OK : if successful
E_POINTER : if ppVal == NULL
E_FAIL : indicates internal errors
BSTR ISkpDimension::Text [get]

[propget] Returns the text displayed by this ISkpDimension.

Return values:
pVal The text displayed by this ISkpDimension.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
E_FAIL : indicates internal errors

©2010 Google - Google Home - About Google