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

An axes entity reference. More...

#include <SketchUpAPI/model/axes.h>

Inherits SUEntityRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SUAxesToEntity (SUAxesRef axes)
 Converts from an SUAxesRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SUAxesRef SUAxesFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUAxesRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUAxesRef. More...
 
SUDrawingElementRef SUAxesToDrawingElement (SUAxesRef axes)
 Converts from an SUAxesRef to an SUDrawingElementRef. This is essentially an upcast operation. More...
 
SUAxesRef SUAxesFromDrawingElement (SUDrawingElementRef drawing_elem)
 Converts from an SUDrawingElementRef to an SUAxesRef. This is essentially a downcast operation so the given element must be convertible to an SUAxesRef. More...
 
enum SUResult SUAxesCreate (SUAxesRef *axes)
 Creates a default constructed axes object. The axes object must be subsequently deallocated with SUAxesRelease() unless it is associated with a parent object. More...
 
enum SUResult SUAxesCreateCustom (SUAxesRef *axes, const struct SUPoint3D *origin, const struct SUVector3D *xaxis, const struct SUVector3D *yaxis, const struct SUVector3D *zaxis)
 Creates an axes object. The axes object must be subsequently deallocated with SUAxesRelease() unless it is associated with a parent object. More...
 
enum SUResult SUAxesRelease (SUAxesRef *axes)
 Releases aa axes object. The axes object must have been created with SUAxesCreate() and not subsequently associated with a parent object (e.g. SUEntitiesRef). More...
 
enum SUResult SUAxesGetOrigin (SUAxesRef axes, struct SUPoint3D *origin)
 Retrieves the origin point value, not a reference. More...
 
enum SUResult SUAxesSetOrigin (SUAxesRef axes, const struct SUPoint3D *origin)
 Sets the origin point value for the provided axes. More...
 
enum SUResult SUAxesGetXAxis (SUAxesRef axes, struct SUVector3D *axis)
 Retrieves the 1st axis vector value, not a reference. More...
 
enum SUResult SUAxesGetYAxis (SUAxesRef axes, struct SUVector3D *axis)
 Retrieves the 2nd axis vector value, not a reference. More...
 
enum SUResult SUAxesGetZAxis (SUAxesRef axes, struct SUVector3D *axis)
 Retrieves the 3rd axis vector value, not a reference. More...
 
enum SUResult SUAxesSetAxesVecs (SUAxesRef axes, const struct SUVector3D *xaxis, const struct SUVector3D *yaxis, const struct SUVector3D *zaxis)
 Sets the axes' vectors. Fails if vectors don't make an orthogonal axes. More...
 
enum SUResult SUAxesGetTransform (SUAxesRef axes, struct SUTransformation *transform)
 Retrieves a copy of the transformation. More...
 
enum SUResult SUAxesGetPlane (SUAxesRef axes, struct SUPlane3D *plane)
 Retrieves a copy of the plane. More...
 

Detailed Description

An axes entity reference.

Since
SketchUp 2016, API 4.0

Friends And Related Function Documentation

enum SUResult SUAxesCreate ( SUAxesRef axes)
related

Creates a default constructed axes object. The axes object must be subsequently deallocated with SUAxesRelease() unless it is associated with a parent object.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
Returns
enum SUResult SUAxesCreateCustom ( SUAxesRef axes,
const struct SUPoint3D origin,
const struct SUVector3D xaxis,
const struct SUVector3D yaxis,
const struct SUVector3D zaxis 
)
related

Creates an axes object. The axes object must be subsequently deallocated with SUAxesRelease() unless it is associated with a parent object.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[in]originThe origin of the new axes.
[in]xaxisThe 1st axis for the custom 3D axes.
[in]yaxisThe 2nd axis for the custom 3D axes.
[in]zaxisThe 3rd axis for the custom 3D axes.
Returns
SUAxesRef SUAxesFromDrawingElement ( SUDrawingElementRef  drawing_elem)
related

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

Since
SketchUp 2016, API 4.0
Parameters
[in]drawing_elemThe given element reference.
Returns
  • The converted SUAxesRef if the downcast operation succeeds
  • If not, the returned reference will be invalid.
SUAxesRef SUAxesFromEntity ( SUEntityRef  entity)
related

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

Since
SketchUp 2016, API 4.0
Parameters
[in]entityThe entity object.
Returns
  • The converted SUAxesRef if the downcast operation succeeds
  • If the downcast operation fails, the returned reference will be invalid
enum SUResult SUAxesGetOrigin ( SUAxesRef  axes,
struct SUPoint3D origin 
)
related

Retrieves the origin point value, not a reference.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[out]originPointer to a SUPoint3D struct for returning the origin.
Returns
enum SUResult SUAxesGetPlane ( SUAxesRef  axes,
struct SUPlane3D plane 
)
related

Retrieves a copy of the plane.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[out]planePointer to a SUPlane3D struct for getting the plane data.
Returns
enum SUResult SUAxesGetTransform ( SUAxesRef  axes,
struct SUTransformation transform 
)
related

Retrieves a copy of the transformation.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[out]transformPointer to a SUTransformation struct for getting the transformation data.
Returns
enum SUResult SUAxesGetXAxis ( SUAxesRef  axes,
struct SUVector3D axis 
)
related

Retrieves the 1st axis vector value, not a reference.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[out]axisPointer to a SUVector3D struct for getting the 1st axis.
Returns
enum SUResult SUAxesGetYAxis ( SUAxesRef  axes,
struct SUVector3D axis 
)
related

Retrieves the 2nd axis vector value, not a reference.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[out]axisPointer to a SUVector3D struct for getting the 2nd axis.
Returns
enum SUResult SUAxesGetZAxis ( SUAxesRef  axes,
struct SUVector3D axis 
)
related

Retrieves the 3rd axis vector value, not a reference.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[out]axisPointer to a SUVector3D struct for getting the 3rd axis.
Returns
enum SUResult SUAxesRelease ( SUAxesRef axes)
related

Releases aa axes object. The axes object must have been created with SUAxesCreate() and not subsequently associated with a parent object (e.g. SUEntitiesRef).

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
Returns
enum SUResult SUAxesSetAxesVecs ( SUAxesRef  axes,
const struct SUVector3D xaxis,
const struct SUVector3D yaxis,
const struct SUVector3D zaxis 
)
related

Sets the axes' vectors. Fails if vectors don't make an orthogonal axes.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[in]xaxisPointer to a SUVector3D struct for setting the 1st axis.
[in]yaxisPointer to a SUVector3D struct for setting the 2nd axis.
[in]zaxisPointer to a SUVector3D struct for setting the 3rd axis.
Returns
enum SUResult SUAxesSetOrigin ( SUAxesRef  axes,
const struct SUPoint3D origin 
)
related

Sets the origin point value for the provided axes.

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
[in]originPointer to a SUPoint3D struct for setting the origin.
Returns
SUDrawingElementRef SUAxesToDrawingElement ( SUAxesRef  axes)
related

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

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe given axes reference.
Returns
  • The converted SUEntityRef if axes is a valid axes
  • If not, the returned reference will be invalid
SUEntityRef SUAxesToEntity ( SUAxesRef  axes)
related

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

Since
SketchUp 2016, API 4.0
Parameters
[in]axesThe axes object.
Returns
  • The converted SUEntityRef if axes is a valid object
  • If not, the returned reference will be invalid

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