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

Properties

ISkpDimensionStyle Interface Reference

The style supported by a dimension. More...

List of all members.

Properties

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.
SkpDimensionTextPosition TextPosition [get]
 [propget] Returns the text position type for this style
SkpDimensionArrow ArrowType [get]
 [propget] Returns the arrow type for this style
long ArrowSize [get]
 [propget] Returns the arrow size for this style
OLE_COLOR Color [get]
 [propget] Returns the color of the dimension if no color is assigned to the dimension itself.
OLE_COLOR TextColor [get]
 [propget] Returns the text color of the dimension.
BOOL AlwaysReadable [get]
 [propget] Returns TRUE if the text is aligned so that it is always readable.
long ExtensionLineOffset [get]
 [propget] Gets the extension line offset.
long ExtensionLineOvershoot [get]
 [propget] Gets the extension line overshoot.
long LineWeight [get]
 [propget] Gets line weight.
BOOL HighlightNonAssociativeDimensions [get]
 [propget] Control whether we show non-associative dimensions (including edited text) in a special color.
OLE_COLOR HighlightNonAssociativeDimensionsColor [get]
 [propget] If we do show non-associative dimensions (including edited text) in a special color, what color?
BOOL ShowRadialDiamPrefix [get]
 [propget] Gets whether or not the text "DIA" or "R" is shown in the dimension.
BOOL HideOutOfPlane [get]
 [propget] Gets whether or not out of plane dimensions are drawn.
double HideOutOfPlaneValue [get]
 [propget] What is the limiting value that determines the out-of-plane property?
BOOL HideSmall [get]
 [propget] Gets whether or not small dimensions are drawn.
double HideSmallValue [get]
 [propget] What is the limiting value that determines the small property?

Detailed Description

The style supported by a dimension.


Property Documentation

BOOL ISkpDimensionStyle::AlwaysReadable [get]

[propget] Returns TRUE if the text is aligned so that it is always readable.

Return values:
pVal TRUE if the text is aligned so that it is always readable.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
long ISkpDimensionStyle::ArrowSize [get]

[propget] Returns the arrow size for this style

Return values:
pVal The arrow size for this style.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
SkpDimensionArrow ISkpDimensionStyle::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
OLE_COLOR ISkpDimensionStyle::Color [get]

[propget] Returns the color of the dimension if no color is assigned to the dimension itself.

Return values:
pColor The color of the dimension if no color is assigned to the dimension itself.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
long ISkpDimensionStyle::ExtensionLineOffset [get]

[propget] Gets the extension line offset.

Return values:
pVal The value of the offset.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
long ISkpDimensionStyle::ExtensionLineOvershoot [get]

[propget] Gets the extension line overshoot.

Return values:
pVal The value of the overshoot.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpFont ISkpDimensionStyle::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 ISkpDimensionStyle::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
BOOL ISkpDimensionStyle::HideOutOfPlane [get]

[propget] Gets whether or not out of plane dimensions are drawn.

Return values:
pVal TRUE if the out of plane dimensions are drawn.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpDimensionStyle::HideOutOfPlaneValue [get]

[propget] What is the limiting value that determines the out-of-plane property?

Return values:
pVal The limiting out-of-plane value.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpDimensionStyle::HideSmall [get]

[propget] Gets whether or not small dimensions are drawn.

Return values:
pVal TRUE if the small dimensions are drawn.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpDimensionStyle::HideSmallValue [get]

[propget] What is the limiting value that determines the small property?

Return values:
pVal The limiting small value.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpDimensionStyle::HighlightNonAssociativeDimensions [get]

[propget] Control whether we show non-associative dimensions (including edited text) in a special color.

Return values:
pVal TRUE iff non-associative dimensions are displayed in a special color.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
OLE_COLOR ISkpDimensionStyle::HighlightNonAssociativeDimensionsColor [get]

[propget] If we do show non-associative dimensions (including edited text) in a special color, what color?

Return values:
pVal The non-associative dimension color
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
long ISkpDimensionStyle::LineWeight [get]

[propget] Gets line weight.

Return values:
pVal The value line weight.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpDimensionStyle::ShowRadialDiamPrefix [get]

[propget] Gets whether or not the text "DIA" or "R" is shown in the dimension.

Return values:
pVal TRUE if the radial dimension type is drawn in the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
OLE_COLOR ISkpDimensionStyle::TextColor [get]

[propget] Returns the text color of the dimension.

If "no-color", use dimension color, unless not to scale, then use that.

Return values:
pColor The default text color
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
SkpDimensionTextPosition ISkpDimensionStyle::TextPosition [get]

[propget] Returns the text position type for this style

Return values:
pVal The positioning option for this style.
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