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

A polyline3d object. These are curve-like entities that do not generate inference snaps or affect geometry in any way. More...

#include <SketchUpAPI/model/polyline3d.h>

Inherits SUEntityRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SUPolyline3dToEntity (SUPolyline3dRef line)
 Converts from an SUPolyline3dRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SUPolyline3dRef SUPolyline3dFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUPolyline3dRef. This is essentially a downcast operation so the given entity must be convertible to an SUPolyline3dRef. More...
 
SUDrawingElementRef SUPolyline3dToDrawingElement (SUPolyline3dRef line)
 Converts from an SUPolyline3dRef to an SUDrawingElementRef. This is essentially an upcast operation. More...
 
SUPolyline3dRef SUPolyline3dFromDrawingElement (SUDrawingElementRef drawing_elem)
 Converts from an SUDrawingElementRef to an SUPolyline3dRef. This is essentially a downcast operation so the given element must be convertible to an SUPolyline3dRef. More...
 
enum SUResult SUPolyline3dCreate (SUPolyline3dRef *polyline)
 Creates a new polyline3d object. The polyline3d object must be subsequently deallocated with SUPolyline3dRelease() unless it is associated with a parent object. More...
 
enum SUResult SUPolyline3dRelease (SUPolyline3dRef *polyline)
 Releases a new polyline3d object. The polyline3d object must not be associated with a parent object. More...
 
enum SUResult SUPolyline3dAddPoints (SUPolyline3dRef polyline, size_t num_points, struct SUPoint3D points[])
 Adds points to a polyline3d object. More...
 
enum SUResult SUPolyline3dGetNumPoints (SUPolyline3dRef line, size_t *count)
 Retrieves the number of points contained by a polyline3d. More...
 
enum SUResult SUPolyline3dGetPoints (SUPolyline3dRef line, size_t len, struct SUPoint3D points[], size_t *count)
 Retrieves the points in the polyline3d object. More...
 

Detailed Description

A polyline3d object. These are curve-like entities that do not generate inference snaps or affect geometry in any way.

Friends And Related Function Documentation

enum SUResult SUPolyline3dAddPoints ( SUPolyline3dRef  polyline,
size_t  num_points,
struct SUPoint3D  points[] 
)
related

Adds points to a polyline3d object.

Parameters
[in]polylineThe polyline3d object.
[in]num_pointsNumber of points being added.
[in]pointsArray of points to add.
Returns
enum SUResult SUPolyline3dCreate ( SUPolyline3dRef polyline)
related

Creates a new polyline3d object. The polyline3d object must be subsequently deallocated with SUPolyline3dRelease() unless it is associated with a parent object.

Parameters
[out]polylineThe polyline3d object.
Returns
SUPolyline3dRef SUPolyline3dFromDrawingElement ( SUDrawingElementRef  drawing_elem)
related

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

Parameters
[in]drawing_elemThe drawing element object.
Returns
  • The converted SUPolyline3dRef if the downcast operation succeeds. If not, the returned reference will be invalid.
SUPolyline3dRef SUPolyline3dFromEntity ( SUEntityRef  entity)
related

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

Parameters
[in]entityThe given entity reference.
Returns
  • The converted SUPolyline3dRef if the downcast operation succeeds. If not, the returned reference will be invalid.
enum SUResult SUPolyline3dGetNumPoints ( SUPolyline3dRef  line,
size_t *  count 
)
related

Retrieves the number of points contained by a polyline3d.

Parameters
[in]lineThe polyline3d object.
[out]countThe number of points available.
Returns
enum SUResult SUPolyline3dGetPoints ( SUPolyline3dRef  line,
size_t  len,
struct SUPoint3D  points[],
size_t *  count 
)
related

Retrieves the points in the polyline3d object.

Parameters
[in]lineThe polyline3d object.
[in]lenThe maximum number of points to retrieve.
[out]pointsThe points retrieved.
[out]countThe number of points retrieved.
Returns
enum SUResult SUPolyline3dRelease ( SUPolyline3dRef polyline)
related

Releases a new polyline3d object. The polyline3d object must not be associated with a parent object.

Parameters
[in]polylineThe polyline3d object.
Returns
SUDrawingElementRef SUPolyline3dToDrawingElement ( SUPolyline3dRef  line)
related

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

Parameters
[in]lineThe polyline3d object.
Returns
  • The converted SUEntityRef if line is a valid object. If not, the returned reference will be invalid.
SUEntityRef SUPolyline3dToEntity ( SUPolyline3dRef  line)
related

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

Parameters
[in]lineThe polyline3d object.
Returns
  • The converted SUEntityRef if line is a valid object. If not, the returned reference will be invalid.

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