SUCRSLocationRef Struct Reference

A Coordinate Reference System (CRS) location object. More...

#include <SketchUpAPI/model/crslocation.h>

Related Functions
(Note that these are not member functions.)
enum SUResult	SUCRSLocationCreate (SUCRSLocationRef *location_ref)
	Creates an empty CRS location struct. More...
enum SUResult	SUCRSLocationRelease (SUCRSLocationRef *location_ref)
	Releases a CRS location object. More...
enum SUResult	SUCRSLocationSetEastings (SUCRSLocationRef location_ref, double value)
	Sets the eastings value of a CRS location object. More...
enum SUResult	SUCRSLocationGetEastings (SUCRSLocationRef location_ref, double *value)
	Gets the eastings value of a CRS location object. More...
enum SUResult	SUCRSLocationSetNorthings (SUCRSLocationRef location_ref, double value)
	Sets the northings value of a CRS location object. More...
enum SUResult	SUCRSLocationGetNorthings (SUCRSLocationRef location_ref, double *value)
	Gets the northings value of a CRS location object. More...
enum SUResult	SUCRSLocationSetHeight (SUCRSLocationRef location_ref, double value)
	Sets the orthogonal height value of a CRS location object. More...
enum SUResult	SUCRSLocationGetHeight (SUCRSLocationRef location_ref, double *value)
	Gets the orthogonal height value of a CRS location object. More...
enum SUResult	SUCRSLocationSetXAxis (SUCRSLocationRef location_ref, const struct SUVector2D *value)
	Sets the x-axis of a CRS location object. More...
enum SUResult	SUCRSLocationGetXAxis (SUCRSLocationRef location_ref, struct SUVector2D *value)
	Gets the x-axis of a CRS location object. More...
enum SUResult	SUCRSLocationSetScale (SUCRSLocationRef location_ref, double value)
	Sets the scale value of a CRS location object. More...
enum SUResult	SUCRSLocationGetScale (SUCRSLocationRef location_ref, double *value)
	Gets the scale value of a CRS location object. More...
enum SUResult	SUCRSLocationSetName (SUCRSLocationRef location_ref, const char *value)
	Sets the CRS name of a CRS location object. More...
enum SUResult	SUCRSLocationGetName (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the CRS name of a CRS location object. More...
enum SUResult	SUCRSLocationSetDescription (SUCRSLocationRef location_ref, const char *value)
	Sets the description of a CRS location object. More...
enum SUResult	SUCRSLocationGetDescription (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the description of a CRS location object. More...
enum SUResult	SUCRSLocationSetGeodeticDatum (SUCRSLocationRef location_ref, const char *value)
	Sets the geodetic datum of a CRS location object. More...
enum SUResult	SUCRSLocationGetGeodeticDatum (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the geodetic datum of a CRS location object. More...
enum SUResult	SUCRSLocationSetVerticalDatum (SUCRSLocationRef location_ref, const char *value)
	Sets the vertical datum of a CRS location object. More...
enum SUResult	SUCRSLocationGetVerticalDatum (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the vertical datum of a CRS location object. More...
enum SUResult	SUCRSLocationSetMapProjection (SUCRSLocationRef location_ref, const char *value)
	Sets the map projection of a CRS location object. More...
enum SUResult	SUCRSLocationGetMapProjection (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the map projection of a CRS location object. More...
enum SUResult	SUCRSLocationSetMapZone (SUCRSLocationRef location_ref, const char *value)
	Sets the map zone of a CRS location object. More...
enum SUResult	SUCRSLocationGetMapZone (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the map zone of a CRS location object. More...
enum SUResult	SUCRSLocationSetMapUnit (SUCRSLocationRef location_ref, const char *name, double conversion)
	Sets the map unit of a CRS location object. More...
enum SUResult	SUCRSLocationGetMapUnit (SUCRSLocationRef location_ref, SUStringRef *name, double *conversion)
	Gets the map unit of a CRS location object. More...
enum SUResult	SUCRSLocationSetTGLId (SUCRSLocationRef location_ref, const char *value)
	Sets the TGL identifier of a CRS location object. More...
enum SUResult	SUCRSLocationGetTGLId (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the TGL identifier of a CRS location object. More...
enum SUResult	SUCRSLocationSetCalibrationFileName (SUCRSLocationRef location_ref, const char *value)
	Sets the calibration file name of a CRS location object. More...
enum SUResult	SUCRSLocationGetCalibrationFileName (SUCRSLocationRef location_ref, SUStringRef *value)
	Gets the calibration file name of a CRS location object. More...

Detailed Description

A Coordinate Reference System (CRS) location object.

Stores all data properties used to represent a CRS location. Not all properties are mandatory and data validation does not happen until the object is applied to a model via SUModelSetCRSLocationCopy(). This object is not associated with a model but rather a model's CRS location data can be copied to or from it.

Since

SketchUp 2027.0, API 15.0

Friends And Related Function Documentation

enum SUResult SUCRSLocationCreate ( SUCRSLocationRef *  location_ref )

related

Creates an empty CRS location struct.

Constructs a CRS location object and leaves each individual property set to a default value.

You must use SUCRSLocationRelease() on this CRS location object to free its memory.

Since

SketchUp 2027.0, API 15.0

Parameters

[out]

location_ref

The CRS location object to be created.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_OUTPUT if location_ref is NULL
• SU_ERROR_OVERWRITE_VALID if location_ref does not refer to an invalid object

enum SUResult SUCRSLocationGetCalibrationFileName ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the calibration file name of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The calibration file name string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no calibration file name is set

enum SUResult SUCRSLocationGetDescription ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the description of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The description string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no description is set

enum SUResult SUCRSLocationGetEastings ( SUCRSLocationRef  location_ref, double *  value  )

related

Gets the eastings value of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The eastings value retrieved (meters).

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL

enum SUResult SUCRSLocationGetGeodeticDatum ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the geodetic datum of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The geodetic datum string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no geodetic datum is set

enum SUResult SUCRSLocationGetHeight ( SUCRSLocationRef  location_ref, double *  value  )

related

Gets the orthogonal height value of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The height value retrieved (meters).

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL

enum SUResult SUCRSLocationGetMapProjection ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the map projection of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The map projection string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no map projection is set

enum SUResult SUCRSLocationGetMapUnit ( SUCRSLocationRef  location_ref, SUStringRef *  name, double *  conversion  )

related

Gets the map unit of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	name	The map unit name string retrieved.
[out]	conversion	The map unit conversion factor to meters retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if name or conversion is NULL
• SU_ERROR_INVALID_OUTPUT if name is not a valid string object
• SU_ERROR_NO_DATA if no map unit is set

enum SUResult SUCRSLocationGetMapZone ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the map zone of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The map zone string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no map zone is set

enum SUResult SUCRSLocationGetName ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the CRS name of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The CRS name string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object

enum SUResult SUCRSLocationGetNorthings ( SUCRSLocationRef  location_ref, double *  value  )

related

Gets the northings value of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The northings value retrieved (meters).

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL

enum SUResult SUCRSLocationGetScale ( SUCRSLocationRef  location_ref, double *  value  )

related

Gets the scale value of a CRS location object.

The scale converts CRS units to SketchUp's internal units (inches).

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The scale value retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL

enum SUResult SUCRSLocationGetTGLId ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the TGL identifier of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The TGL identifier string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no TGL identifier is set

enum SUResult SUCRSLocationGetVerticalDatum ( SUCRSLocationRef  location_ref, SUStringRef *  value  )

related

Gets the vertical datum of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The vertical datum string retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL
• SU_ERROR_INVALID_OUTPUT if value is not a valid string object
• SU_ERROR_NO_DATA if no vertical datum is set

enum SUResult SUCRSLocationGetXAxis ( SUCRSLocationRef  location_ref, struct SUVector2D *  value  )

related

Gets the x-axis of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in]	location_ref	The CRS location object.
[out]	value	The x-axis unit vector retrieved.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if value is NULL

enum SUResult SUCRSLocationRelease ( SUCRSLocationRef *  location_ref )

related

Releases a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]

location_ref

The CRS location object to be released.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if location_ref is NULL
• SU_ERROR_INVALID_INPUT if location_ref does not refer to a valid object

enum SUResult SUCRSLocationSetCalibrationFileName ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the calibration file name of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The calibration file name string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetDescription ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the description of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The description string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetEastings ( SUCRSLocationRef  location_ref, double  value  )

related

Sets the eastings value of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The eastings value (meters).

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object

enum SUResult SUCRSLocationSetGeodeticDatum ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the geodetic datum of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The geodetic datum string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetHeight ( SUCRSLocationRef  location_ref, double  value  )

related

Sets the orthogonal height value of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The height value (meters).

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object

enum SUResult SUCRSLocationSetMapProjection ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the map projection of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The map projection string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetMapUnit ( SUCRSLocationRef  location_ref, const char *  name, double  conversion  )

related

Sets the map unit of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	name	The map unit name string.
[in]	conversion	The map unit conversion factor to meters. Must be greater than zero.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if name is NULL
• SU_ERROR_INVALID_ARGUMENT if conversion is not greater than zero

enum SUResult SUCRSLocationSetMapZone ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the map zone of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The map zone string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetName ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the CRS name of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The CRS name string. Must not be empty.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetNorthings ( SUCRSLocationRef  location_ref, double  value  )

related

Sets the northings value of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The northings value (meters).

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object

enum SUResult SUCRSLocationSetScale ( SUCRSLocationRef  location_ref, double  value  )

related

Sets the scale value of a CRS location object.

The scale converts CRS units to SketchUp's internal units (inches).

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The scale value. Must be greater than zero.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_INVALID_ARGUMENT if value is not greater than zero

enum SUResult SUCRSLocationSetTGLId ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the TGL identifier of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The TGL identifier string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetVerticalDatum ( SUCRSLocationRef  location_ref, const char *  value  )

related

Sets the vertical datum of a CRS location object.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The vertical datum string.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL

enum SUResult SUCRSLocationSetXAxis ( SUCRSLocationRef  location_ref, const struct SUVector2D *  value  )

related

Sets the x-axis of a CRS location object.

The x-axis is expressed as a 2D unit vector and defines the orientation of the CRS axes relative to the model axes. The x and y components correspond to IfcMapConversion::XAxisAbscissa and IfcMapConversion::XAxisOrdinate respectively.

Note

If a non unit vector is provided only the normalized value will be stored.

Since

SketchUp 2027.0, API 15.0

Parameters

[in,out]	location_ref	The CRS location object.
[in]	value	The x-axis unit vector.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if location_ref is not a valid object
• SU_ERROR_NULL_POINTER_INPUT if value is NULL
• SU_ERROR_INVALID_ARGUMENT if value is not a unit vector

---

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

• SketchUpAPI/model/defs.h
• SketchUpAPI/model/crslocation.h