SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Related Functions
SUDimensionRadialRef Struct Reference

A radial dimension entity reference. More...

#include <SketchUpAPI/model/dimension_radial.h>

Inherits SUDimensionRef.

Related Functions

(Note that these are not member functions.)

SUDimensionRef SUDimensionRadialToDimension (SUDimensionRadialRef dimension)
 Converts from an SUDimensionRadialRef to an SUDimensionRef. This is essentially an upcast operation. More...
 
SUDimensionRadialRef SUDimensionRadialFromDimension (SUDimensionRef dimension)
 Converts from an SUDimensionRef to an SUDimensionRadialRef. This is essentially a downcast operation so the given SUDimensionRef must be convertible to an SUDimensionRadialRef. More...
 
enum SUResult SUDimensionRadialCreate (SUDimensionRadialRef *dimension, SUInstancePathRef path)
 Creates a new radial dimension for measuring the provided arccurve. More...
 
enum SUResult SUDimensionRadialRelease (SUDimensionRadialRef *dimension)
 Releases a dimension object. More...
 
enum SUResult SUDimensionRadialGetCurveInstancePath (SUDimensionRadialRef dimension, SUInstancePathRef *path)
 Retrieves the arccurve instance being mesured by a dimension object. The given instance path object either must have been constructed using one of the SUInstancePathCreate* functions or it will be generated on the fly if it is invalid. It must be released using SUInstancePathRelease() when it is no longer needed. More...
 
enum SUResult SUDimensionRadialSetCurveInstancePath (SUDimensionRadialRef dimension, SUInstancePathRef path)
 Sets which arccurve instance is measured by the radial dimension. The instance path's leaf entity must be an arccurve for this method to succeed. More...
 
enum SUResult SUDimensionRadialGetDiameter (SUDimensionRadialRef dimension, bool *is_diameter)
 Retrieves whether the dimension is a diameter. Radial dimensions can be used to measure either diameter or radius. More...
 
enum SUResult SUDimensionRadialSetDiameter (SUDimensionRadialRef dimension, bool is_diameter)
 Sets whether the dimension measures diameter or radius. More...
 
enum SUResult SUDimensionRadialGetLeaderBreakPoint (SUDimensionRadialRef dimension, struct SUPoint3D *point)
 Gets the radial dimension's leader line break point. The leader line break point is the point where the leader line bends towards the dimension label. More...
 
enum SUResult SUDimensionRadialSetLeaderBreakPoint (SUDimensionRadialRef dimension, const struct SUPoint3D *point)
 Sets the radial dimension's leader break point. More...
 
enum SUResult SUDimensionRadialGetLeaderPoints (SUDimensionRadialRef dimension, struct SUPoint3D points[3])
 Retrieves the a dimension object's leader points. The three returned pointe are [0] the point at which the dimension's text touches the leader line, [1] the point at which the dimension's arrow attaches to the dimensioned curve, [2] the point on the dimensioned curve's full circle opposite of point [1]. More...
 

Detailed Description

A radial dimension entity reference.

Since
SketchUp 2017, API 5.0

Friends And Related Function Documentation

enum SUResult SUDimensionRadialCreate ( SUDimensionRadialRef dimension,
SUInstancePathRef  path 
)
related

Creates a new radial dimension for measuring the provided arccurve.

Since
SketchUp 2017, API 5.0
Parameters
[in,out]dimensionThe dimension object created.
[in]pathThe and instance path to the arccurve to be measured.
Returns
SUDimensionRadialRef SUDimensionRadialFromDimension ( SUDimensionRef  dimension)
related

Converts from an SUDimensionRef to an SUDimensionRadialRef. This is essentially a downcast operation so the given SUDimensionRef must be convertible to an SUDimensionRadialRef.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe given dimension reference.
Returns
  • The converted SUDimensionRadialRef if the downcast operation succeeds
  • If not, the returned reference will be invalid
enum SUResult SUDimensionRadialGetCurveInstancePath ( SUDimensionRadialRef  dimension,
SUInstancePathRef path 
)
related

Retrieves the arccurve instance being mesured by a dimension object. The given instance path object either must have been constructed using one of the SUInstancePathCreate* functions or it will be generated on the fly if it is invalid. It must be released using SUInstancePathRelease() when it is no longer needed.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
[out]pathThe instance path retrieved.
Returns
enum SUResult SUDimensionRadialGetDiameter ( SUDimensionRadialRef  dimension,
bool *  is_diameter 
)
related

Retrieves whether the dimension is a diameter. Radial dimensions can be used to measure either diameter or radius.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
[out]is_diameterThe flag value retrieved.
Returns
enum SUResult SUDimensionRadialGetLeaderBreakPoint ( SUDimensionRadialRef  dimension,
struct SUPoint3D point 
)
related

Gets the radial dimension's leader line break point. The leader line break point is the point where the leader line bends towards the dimension label.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
[out]pointThe point retrieved.
Returns
enum SUResult SUDimensionRadialGetLeaderPoints ( SUDimensionRadialRef  dimension,
struct SUPoint3D  points[3] 
)
related

Retrieves the a dimension object's leader points. The three returned pointe are [0] the point at which the dimension's text touches the leader line, [1] the point at which the dimension's arrow attaches to the dimensioned curve, [2] the point on the dimensioned curve's full circle opposite of point [1].

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
[out]pointsThe array of 3 3d points retrieved.
Returns
enum SUResult SUDimensionRadialRelease ( SUDimensionRadialRef dimension)
related

Releases a dimension object.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
Returns
enum SUResult SUDimensionRadialSetCurveInstancePath ( SUDimensionRadialRef  dimension,
SUInstancePathRef  path 
)
related

Sets which arccurve instance is measured by the radial dimension. The instance path's leaf entity must be an arccurve for this method to succeed.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object modified.
[in]pathThe and instance path to the arccurve to be measured.
Returns
enum SUResult SUDimensionRadialSetDiameter ( SUDimensionRadialRef  dimension,
bool  is_diameter 
)
related

Sets whether the dimension measures diameter or radius.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
[in]is_diameterThe flag specifying if the dimension measures diameter.
Returns
enum SUResult SUDimensionRadialSetLeaderBreakPoint ( SUDimensionRadialRef  dimension,
const struct SUPoint3D point 
)
related

Sets the radial dimension's leader break point.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe dimension object.
[in]pointThe point retrieved.
Returns
SUDimensionRef SUDimensionRadialToDimension ( SUDimensionRadialRef  dimension)
related

Converts from an SUDimensionRadialRef to an SUDimensionRef. This is essentially an upcast operation.

Since
SketchUp 2017, API 5.0
Parameters
[in]dimensionThe given dimension reference.
Returns
  • The converted SUDimensionRef if dimension is a valid object
  • If not, the returned reference will be invalid

The documentation for this struct was generated from the following files: