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

Public Member Functions | Properties

ISkpDimensionRadial Interface Reference

A radial dimension type. More...

Inheritance diagram for ISkpDimensionRadial:
SkpDimensionRadial

List of all members.

Public Member Functions

HRESULT _GetCenter ([out] double pPoint3d[3])
 Returns the center point of the radial dimension.
HRESULT _GetLeaderPoints ([out] double p1Point3d[3],[out] double p2Point3d[3],[out] double p3Point3d[3])
 Returns the leader points for this dimension.
HRESULT LeaderPoints ([out] ISkpPoint3d **p1Point3d,[out] ISkpPoint3d **p2Point3d,[out] ISkpPoint3d **p3Point3d)
 Returns the leader points for this dimension.
HRESULT _GetTextInfo ([in] ISkpView *pView,[in] double p1Point3d[3],[in] double p2Point3d[3],[in] ISkpPlane *plane,[out] double pTextPositionPoint3d[3],[out] SkpTextJustification *just,[out] SkpTextAlignment *align,[out] BOOL *pVal)
 Calculate text position, alignment, justification, and whether we have a leader extension.
HRESULT TextInfo ([in] ISkpView *pView,[in] ISkpPoint3d **p1Point3d,[in] ISkpPoint3d **p2Point3d,[in] ISkpPlane *plane,[out] ISkpPoint3d **pTextPositionPoint3d,[out] SkpTextJustification *just,[out] SkpTextAlignment *align,[out] BOOL *pVal)
 Calculate text position, alignment, justification, and whether we have a leader extension.

Properties

SkpRadialDimensionType RadialType [get]
 [propget] Returns the radial type of this dimension
ISkpPoint3d Center [get]
 [propget] Returns the center point of the radial dimension.
double Ratio [get]
 [propget] Returns the radial ratio of this dimension
double T [get]
 [propget] Returns the 't' parameter of this dimension

Detailed Description

A radial dimension type.

This interface covers both the radius and diameter type dimensions.


Member Function Documentation

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

Returns the center point of the radial dimension.

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

Parameters:
pPoint3d The caller-allocated space for the center point of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionRadial::_GetLeaderPoints ( [out] double  p1Point3d[3],
[out] double  p2Point3d[3],
[out] double  p3Point3d[3] 
)

Returns the leader points for this dimension.

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

The leader points are defined as: [0] = Break point ... text extension attaches here
[1] = Attach point ... leader touches arc/circle here
[2] = Opposite point ... diameter leader goes across circle

Parameters:
p1Point3d The caller-allocated space for the Break point.
p2Point3d The caller-allocated space for the Attach point.
p3Point3d The caller-allocated space for the Opposite point.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionRadial::_GetTextInfo ( [in] ISkpView pView,
[in] double  p1Point3d[3],
[in] double  p2Point3d[3],
[in] ISkpPlane plane,
[out] double  pTextPositionPoint3d[3],
[out] SkpTextJustification *  just,
[out] SkpTextAlignment *  align,
[out] BOOL *  pVal 
)

Calculate text position, alignment, justification, and whether we have a leader extension.

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

Parameters:
pView The non-NULL view.
p1Point3d The caller allocated space for the Break point as defined in the LeaderPoints method.
p2Point3d The caller allocated space for the Attach point as defined in the LeaderPoints method.
plane The ISkpPlane of the dimension.
pTextPositionPoint3d The position at which the text will lie. The caller is expected to have allocated this space prior to the invocation of this method.
just The text justification.
align The text alignment.
pVal TRUE if the method succeeds.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionRadial::LeaderPoints ( [out] ISkpPoint3d **  p1Point3d,
[out] ISkpPoint3d **  p2Point3d,
[out] ISkpPoint3d **  p3Point3d 
)

Returns the leader points for this dimension.

The leader points are defined as: [0] = Break point ... text extension attaches here
[1] = Attach point ... leader touches arc/circle here
[2] = Opposite point ... diameter leader goes across circle

Parameters:
p1Point3d The ISkpPoint3d for the Break point.
p2Point3d The ISkpPoint3d for the Attach point.
p3Point3d The ISkpPoint3d space for the Opposite point.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpDimensionRadial::TextInfo ( [in] ISkpView pView,
[in] ISkpPoint3d **  p1Point3d,
[in] ISkpPoint3d **  p2Point3d,
[in] ISkpPlane plane,
[out] ISkpPoint3d **  pTextPositionPoint3d,
[out] SkpTextJustification *  just,
[out] SkpTextAlignment *  align,
[out] BOOL *  pVal 
)

Calculate text position, alignment, justification, and whether we have a leader extension.

Parameters:
pView The non-NULL view.
p1Point3d The ISkpPoint3d for the Break point as defined in the LeaderPoints method.
p2Point3d The ISkpPoint3d for the Attach point as defined in the LeaderPoints method.
plane The ISkpPlane of the dimension.
pTextPositionPoint3d The position at which the text will lie.
just The text justification.
align The text alignment.
pVal TRUE if the method succeeds.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

Property Documentation

ISkpPoint3d ISkpDimensionRadial::Center [get]

[propget] Returns the center point of the radial dimension.

Parameters:
pPoint3d The ISkpPoint3d holding the center point of the dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
SkpRadialDimensionType ISkpDimensionRadial::RadialType [get]

[propget] Returns the radial type of this dimension

Return values:
pVal The type of this dimension - what is measured.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpDimensionRadial::Ratio [get]

[propget] Returns the radial ratio of this dimension

Together with the 't' value, this helps define the position of leader break point.

The distance from the center of the arc/circle defined as a ratio of the radius if >= 0 and as the negative of the absolute distance outside the circle if it is < 0. Note that we cannot specify a point inside the circle as absolute.

Return values:
pVal The radial ratio for this dimension.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpDimensionRadial::T [get]

[propget] Returns the 't' parameter of this dimension

Together with the radial ratio value, this helps define the position of leader break point.

The position along the arc/circle where the leader would cross defined as the parameter value for the full circle.

Return values:
pVal The paramter 't' for this 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