SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Data Fields | Related Functions
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]point1The first point object.
[in]point2The second point object.
[out]distanceThe distance between the two points.
Returns
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]point1The first point object.
[in]point2The second point object.
[out]equalWhether the two points are the same.
Returns
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]point1The point object.
[in]vectorThe offset vector object.
[out]point2The new point.
Returns
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]point1The first point object.
[in]point2The second point object.
[out]vectorThe vector from point1 to point2.
Returns
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]transformThe transformation to be applied.
[in,out]pointThe point to be transformed.
Returns

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