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

A guide point that has a position. More...

#include <SketchUpAPI/model/guide_point.h>

Inherits SUDrawingElementRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SUGuidePointToEntity (SUGuidePointRef guide_point)
 Converts from an SUGuidePointRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SUGuidePointRef SUGuidePointFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUGuidePointRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUGuidePointRef. More...
 
SUDrawingElementRef SUGuidePointToDrawingElement (SUGuidePointRef guide_point)
 Converts from an SUGuidePointRef to an SUDrawingElementRef. This is essentially an upcast operation. More...
 
SUGuidePointRef SUGuidePointFromDrawingElement (SUDrawingElementRef drawing_elem)
 Converts from an SUDrawingElementRef to an SUGuidePointRef. This is essentially a downcast operation so the given element must be convertible to an SUGuidePointRef. More...
 
enum SUResult SUGuidePointCreate (SUGuidePointRef *guide_point, const struct SUPoint3D *position)
 Creates a guide point object. The guide point object must be subsequently deallocated with SUGuidePointRelease() unless it is associated with a parent object. More...
 
enum SUResult SUGuidePointRelease (SUGuidePointRef *guide_point)
 Releases a guide point object. The guide point object must have been created with SUGuidePointCreate() and not subsequently associated with a parent object (e.g. SUEntitiesAddGuidePoints()). More...
 
enum SUResult SUGuidePointGetPosition (SUGuidePointRef guide_point, struct SUPoint3D *position)
 Retrieves the position of a guide point object. More...
 
enum SUResult SUGuidePointGetFromPosition (SUGuidePointRef guide_point, struct SUPoint3D *position)
 Retrieves the anchor position of a guide point object. If the point was created in SketchUp then the anchor is the position that was first clicked during the point creation. If the point was created with SUGuidePointCreate the anchor is the origin. More...
 
enum SUResult SUGuidePointGetDisplayAsLine (SUGuidePointRef guide_point, bool *as_line)
 Retrieves the boolean indicating if the point should be displayed as a line. More...
 

Detailed Description

A guide point that has a position.

Since
SketchUp 2014 M1, API 2.1

Friends And Related Function Documentation

enum SUResult SUGuidePointCreate ( SUGuidePointRef guide_point,
const struct SUPoint3D position 
)
related

Creates a guide point object. The guide point object must be subsequently deallocated with SUGuidePointRelease() unless it is associated with a parent object.

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]guide_pointThe guide point object.
[out]positionThe guide point position.
Returns
SUGuidePointRef SUGuidePointFromDrawingElement ( SUDrawingElementRef  drawing_elem)
related

Converts from an SUDrawingElementRef to an SUGuidePointRef. This is essentially a downcast operation so the given element must be convertible to an SUGuidePointRef.

Since
SketchUp 2015 M0, API 3.0
Parameters
[in]drawing_elemThe given element reference.
Returns
  • The converted SUGuidePointRef if the downcast operation succeeds
  • If not, the returned reference will be invalid
SUGuidePointRef SUGuidePointFromEntity ( SUEntityRef  entity)
related

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

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]entityThe entity object.
Returns
  • The converted SUGuidePointRef if the downcast operation succeeds
  • If the downcast operation fails, the returned reference will be invalid
enum SUResult SUGuidePointGetDisplayAsLine ( SUGuidePointRef  guide_point,
bool *  as_line 
)
related

Retrieves the boolean indicating if the point should be displayed as a line.

Since
SketchUp 2016, API 4.0
Parameters
[in]guide_pointThe guide point object.
[out]as_lineReturn true if the point is set to be displayed as a line.
Returns
enum SUResult SUGuidePointGetFromPosition ( SUGuidePointRef  guide_point,
struct SUPoint3D position 
)
related

Retrieves the anchor position of a guide point object. If the point was created in SketchUp then the anchor is the position that was first clicked during the point creation. If the point was created with SUGuidePointCreate the anchor is the origin.

Since
SketchUp 2016, API 4.0
Parameters
[in]guide_pointThe guide point object.
[out]positionThe guide point anchor position.
Returns
enum SUResult SUGuidePointGetPosition ( SUGuidePointRef  guide_point,
struct SUPoint3D position 
)
related

Retrieves the position of a guide point object.

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]guide_pointThe guide point object.
[out]positionThe guide point position.
Returns
enum SUResult SUGuidePointRelease ( SUGuidePointRef guide_point)
related

Releases a guide point object. The guide point object must have been created with SUGuidePointCreate() and not subsequently associated with a parent object (e.g. SUEntitiesAddGuidePoints()).

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]guide_pointThe guide point object.
Returns
SUDrawingElementRef SUGuidePointToDrawingElement ( SUGuidePointRef  guide_point)
related

Converts from an SUGuidePointRef to an SUDrawingElementRef. This is essentially an upcast operation.

Since
SketchUp 2015 M0, API 3.0
Parameters
[in]guide_pointThe given guide point reference.
Returns
  • The converted SUEntityRef if guide_point is a valid guide point.
  • If not, the returned reference will be invalid.
SUEntityRef SUGuidePointToEntity ( SUGuidePointRef  guide_point)
related

Converts from an SUGuidePointRef to an SUEntityRef. This is essentially an upcast operation.

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]guide_pointThe guide point object.
Returns
  • The converted SUEntityRef if guide_point is a valid object
  • If not, the returned reference will be invalid

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