SUPoint2D Struct Reference

Represents a point in 2-dimensional space. More...

#include <SketchUpAPI/geometry.h>

Data Fields
double	x
	X coordinate.
double	y
	Y coordinate.

Related Functions
(Note that these are not member functions.)
enum SUResult	SUPoint2DToSUPoint2D (const struct SUPoint2D *point1, const struct SUPoint2D *point2, struct SUVector2D *vector)
	Creates a vector between two point objects. More...
enum SUResult	SUPoint2DGetEqual (const struct SUPoint2D *point1, const struct SUPoint2D *point2, bool *equal)
	Determines if two points are equal. More...
enum SUResult	SUPoint2DOffset (const struct SUPoint2D *point1, const struct SUVector2D *vector, struct SUPoint2D *point2)
	Creates a new point that is offset from another point. More...
enum SUResult	SUPoint2DDistanceToSUPoint2D (const struct SUPoint2D *point1, const struct SUPoint2D *point2, double *distance)
	Gets the distance between two point objects. More...
enum SUResult	SUPoint2DTransform (const struct SUTransformation2D *transform, struct SUPoint2D *point)
	Transforms a point by applying a 2D transformation. More...

Detailed Description

Represents a point in 2-dimensional space.

Friends And Related Function Documentation

enum SUResult SUPoint2DDistanceToSUPoint2D ( const struct SUPoint2D *  point1, const struct SUPoint2D *  point2, double *  distance  )

related

Gets the distance between two point objects.

Since

SketchUp 2017, API 5.0

Parameters

[in]	point1	The first point object.
[in]	point2	The second point object.
[out]	distance	The distance between the two points.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if point1 or point2 is NULL
• SU_ERROR_NULL_POINTER_OUTPUT if distance is NULL

enum SUResult SUPoint2DGetEqual ( const struct SUPoint2D *  point1, const struct SUPoint2D *  point2, bool *  equal  )

related

Determines if two points are equal.

Since

SketchUp 2017, API 5.0

Parameters

[in]	point1	The first point object.
[in]	point2	The second point object.
[out]	equal	Whether the two points are the same.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if point1 or point2 is NULL
• SU_ERROR_NULL_POINTER_OUTPUT if equal is NULL

enum SUResult SUPoint2DOffset ( const struct SUPoint2D *  point1, const struct SUVector2D *  vector, struct SUPoint2D *  point2  )

related

Creates a new point that is offset from another point.

Since

SketchUp 2017, API 5.0

Parameters

[in]	point1	The point object.
[in]	vector	The offset vector object.
[out]	point2	The new point.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if point1 or vector is NULL
• SU_ERROR_NULL_POINTER_OUTPUT if point2 is NULL

enum SUResult SUPoint2DToSUPoint2D ( const struct SUPoint2D *  point1, const struct SUPoint2D *  point2, struct SUVector2D *  vector  )

related

Creates a vector between two point objects.

Since

SketchUp 2017, API 5.0

Deprecated:

The functionality is replaced by SUVector2DCreate.

Parameters

[in]	point1	The first point object.
[in]	point2	The second point object.
[out]	vector	The vector from point1 to point2.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if point1 or point2 is NULL
• SU_ERROR_NULL_POINTER_OUTPUT if vector is NULL

enum SUResult SUPoint2DTransform ( const struct SUTransformation2D *  transform, struct SUPoint2D *  point  )

related

Transforms a point by applying a 2D transformation.

Since

SketchUp 2019, API 7.0

Parameters

[in]	transform	The transformation to be applied.
[in,out]	point	The point to be transformed.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if transform is NULL
• SU_ERROR_NULL_POINTER_OUTPUT if point is NULL

---

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

• SketchUpAPI/geometry.h
• SketchUpAPI/geometry/point2d.h