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

#include <geometry.h>

Data Fields
double	x
	X magnitude. More...

double	y
	Y magnitude. More...

Related Functions
(Note that these are not member functions.)
SU_RESULT	SUVector2DCreate (struct SUVector2D vector, const struct SUPoint2D from, const struct SUPoint2D *to)
	Creates a vector between two point objects. More...

SU_RESULT	SUVector2DIsValid (const struct SUVector2D vector, bool valid)
	Determines if a vector is valid. A vector is invalid if its length is zero. More...

SU_RESULT	SUVector2DIsParallelTo (const struct SUVector2D vector1, const struct SUVector2D vector2, bool *parallel)
	Determines if two vectors are parallel. More...

SU_RESULT	SUVector2DIsPerpendicularTo (const struct SUVector2D vector1, const struct SUVector2D vector2, bool *perpendicular)
	Determines if two vectors are perpendicular. More...

SU_RESULT	SUVector2DIsSameDirectionAs (const struct SUVector2D vector1, const struct SUVector2D vector2, bool *same_direction)
	Determines if two vectors are parallel and pointing the same direction. More...

SU_RESULT	SUVector2DIsEqual (const struct SUVector2D vector1, const struct SUVector2D vector2, bool *equal)
	Determines if two vectors are equal. More...

SU_RESULT	SUVector2DNormalize (struct SUVector2D *vector)
	Normalizes a vector. More...

SU_RESULT	SUVector2DReverse (struct SUVector2D *vector)
	Reverses a vector. More...

SU_RESULT	SUVector2DDot (const struct SUVector2D vector1, const struct SUVector2D vector2, double *dot)
	Computes the dot product of two vectors. More...

SU_RESULT	SUVector2DCross (const struct SUVector2D vector1, const struct SUVector2D vector2, double *cross)
	Computes the cross product of two vectors. More...

SU_RESULT	SUVector2DIsUnitVector (const struct SUVector2D vector, bool is_unit_vector)
	Determines if a vector has a length of one. More...

SU_RESULT	SUVector2DGetLength (const struct SUVector2D vector, double length)
	Gets the length of a vector. More...

SU_RESULT	SUVector2DSetLength (struct SUVector2D *vector, double length)
	Sets the length of a vector. More...

SU_RESULT	SUVector2DAngleBetween (const struct SUVector2D vector1, const struct SUVector2D vector2, double *angle)
	Gets the angle between two vectors. More...

SU_RESULT	SUVector2DTransform (const struct SUTransformation2D transform, struct SUVector2D vector)
	Transforms a vector by applying a 2D transformation. More...

Detailed Description

Represents a vector in 2-dimensional space.

Friends And Related Function Documentation

SU_RESULT SUVector2DAngleBetween	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		double *	angle
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	angle	The angle between the vectors.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if angle is NULL

SU_RESULT SUVector2DCreate	(	struct SUVector2D *	vector,
		const struct SUPoint2D *	from,
		const struct SUPoint2D *	to
	)

Since: SketchUp 2018 M0, API 6.0

Parameters

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

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if from or to is NULL
SU_ERROR_NULL_POINTER_OUTPUT if vector is NULL

SU_RESULT SUVector2DCross	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		double *	cross
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	cross	The value of the cross product.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if cross is NULL

SU_RESULT SUVector2DDot	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		double *	dot
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	dot	The value of the dot product.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if dot is NULL

SU_RESULT SUVector2DGetLength	(	const struct SUVector2D *	vector,
		double *	length
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector	The vector object.
[out]	length	The length of the vector.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector is NULL
SU_ERROR_NULL_POINTER_OUTPUT if length is NULL

SU_RESULT SUVector2DIsEqual	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		bool *	equal
	)

Since: SketchUp 2018, API 6.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	equal	Whether the vectors are equal.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if equal is NULL

SU_RESULT SUVector2DIsParallelTo	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		bool *	parallel
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	parallel	Whether the vectors are parallel.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if parallel is NULL
SU_ERROR_INVALID_ARGUMENT if vector1 or vector2 is not a valid vector

SU_RESULT SUVector2DIsPerpendicularTo	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		bool *	perpendicular
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	perpendicular	Whether the vectors are perpendicular.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if perpendicular is NULL
SU_ERROR_INVALID_ARGUMENT if vector1 or vector2 is not a valid vector

SU_RESULT SUVector2DIsSameDirectionAs	(	const struct SUVector2D *	vector1,
		const struct SUVector2D *	vector2,
		bool *	same_direction
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector1	The first vector object.
[in]	vector2	The second vector object.
[out]	same_direction	Whether the vectors are pointing in the same direction.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector1 or vector2 is NULL
SU_ERROR_NULL_POINTER_OUTPUT if same_direction is NULL
SU_ERROR_INVALID_ARGUMENT if vector1 or vector2 is not a valid vector

SU_RESULT SUVector2DIsUnitVector	(	const struct SUVector2D *	vector,
		bool *	is_unit_vector
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector	The vector object.
[out]	is_unit_vector	Whether the vector has a length of one.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector is NULL
SU_ERROR_NULL_POINTER_OUTPUT if is_unit_vector is NULL

SU_RESULT SUVector2DIsValid	(	const struct SUVector2D *	vector,
		bool *	valid
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	vector	The vector object.
[out]	valid	Whether the vector is valid.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector is NULL
SU_ERROR_NULL_POINTER_OUTPUT if valid is NULL

SU_RESULT SUVector2DNormalize ( struct SUVector2D * vector )

Since: SketchUp 2017, API 5.0

Parameters

[in,out] vector The vector object.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector is NULL
SU_ERROR_INVALID_ARGUMENT if vector is not a valid vector

SU_RESULT SUVector2DReverse ( struct SUVector2D * vector )

Since: SketchUp 2017, API 5.0

Parameters

[in] vector The vector object.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector is NULL

SU_RESULT SUVector2DSetLength	(	struct SUVector2D *	vector,
		double	length
	)

Since: SketchUp 2017, API 5.0

Parameters

[in,out]	vector	The vector object.
[in]	length	The new length the vector should be.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if vector is NULL
SU_ERROR_OUT_OF_RANGE if length is zero
SU_ERROR_INVALID_ARGUMENT if vector is not a valid vector

SU_RESULT SUVector2DTransform	(	const struct SUTransformation2D *	transform,
		struct SUVector2D *	vector
	)

Since: SketchUp 2019, API 7.0

Parameters

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

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if transform is NULL
SU_ERROR_NULL_POINTER_OUTPUT if vector is NULL

Field Documentation

double SUVector2D::x

X magnitude.

double SUVector2D::y

Y magnitude.

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

SketchUpAPI/geometry.h
SketchUpAPI/geometry/vector2d.h

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation