Represents a 3D plane by the parameters a, b, c, d. For any point on the plane, ax + by + cz + d = 0. The coeficients are normalized so that a*a + b*b + c*c = 1. More...

#include <SketchUpAPI/geometry.h>

Data Fields
double	a
	The "a" factor in the plane equation.

double	b
	The "b" factor in the plane equation.

double	c
	The "c" factor in the plane equation.

double	d
	The "d" factor in the plane equation.

Related Functions
(Note that these are not member functions.)
enum SUResult	SUPlane3DSetWithPoints (struct SUPlane3D plane, const struct SUPoint3D point1, const struct SUPoint3D point2, const struct SUPoint3D point3)
	Sets the plane using three points. More...

enum SUResult	SUPlane3DSetWithPointAndNormal (struct SUPlane3D plane, const struct SUPoint3D point, const struct SUVector3D *normal)
	Sets the plane using a point and normal vector. More...

enum SUResult	SUPlane3DSetWithCoefficients (struct SUPlane3D *plane, double a, double b, double c, double d)
	Sets the plane using equation coefficients. More...

enum SUResult	SUPlane3DGetPosition (const struct SUPlane3D plane, struct SUPoint3D position)
	Gets the position on the plane closest to the origin. More...

enum SUResult	SUPlane3DGetNormal (const struct SUPlane3D plane, struct SUVector3D normal)
	Gets the plane's unit normal vector. More...

enum SUResult	SUPlane3DIsOn (const struct SUPlane3D plane, const struct SUPoint3D point, bool *is_on)
	Gets whether or not the point is on the plane. More...

enum SUResult	SUPlane3DDistanceTo (const struct SUPlane3D plane, const struct SUPoint3D point, double *distance)
	Gets the distance from the point to the nearest point on the plane. More...

enum SUResult	SUPlane3DProjectTo (const struct SUPlane3D plane, const struct SUPoint3D point, struct SUPoint3D *projected_point)
	Projects a point onto the plane. More...

enum SUResult	SUPlane3DTransform (const struct SUTransformation transform, struct SUPlane3D plane)
	Transforms the provided 3D plane by applying the provided 3D transformation. More...

Detailed Description

Represents a 3D plane by the parameters a, b, c, d. For any point on the plane, ax + by + cz + d = 0. The coeficients are normalized so that a*a + b*b + c*c = 1.

Friends And Related Function Documentation

enum SUResult SUPlane3DDistanceTo	(	const struct SUPlane3D *	plane,
		const struct SUPoint3D *	point,
		double *	distance
	)

Since: SketchUp 2018, API 6.0

Parameters

[in]	plane	The plane.
[in]	point	The 3D point.
[out]	distance	The distance between the plane and point.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if plane or point are NULL
SU_ERROR_NULL_POINTER_OUTPUT if distance is NULL

enum SUResult SUPlane3DGetNormal	(	const struct SUPlane3D *	plane,
		struct SUVector3D *	normal
	)

Since: SketchUp 2017, API 5.0

Parameters

[in]	plane	The plane from which to get the normal.
[out]	normal	The 3D vector struct retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if plane is NULL
SU_ERROR_NULL_POINTER_OUTPUT if normal is NULL

enum SUResult SUPlane3DGetPosition	(	const struct SUPlane3D *	plane,
		struct SUPoint3D *	position
	)

Since: SketchUp 2016, API 4.0

Parameters

[in]	plane	The plane from which to get the position.
[out]	position	The 3D point struct retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if plane is NULL
SU_ERROR_NULL_POINTER_OUTPUT if position is NULL

enum SUResult SUPlane3DIsOn	(	const struct SUPlane3D *	plane,
		const struct SUPoint3D *	point,
		bool *	is_on
	)

Since: SketchUp 2018, API 6.0

Parameters

[in]	plane	The plane.
[in]	point	The 3D point.
[out]	is_on	Whether or not the point is on the plane.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if plane or point are NULL
SU_ERROR_NULL_POINTER_OUTPUT if is_on is NULL

enum SUResult SUPlane3DProjectTo	(	const struct SUPlane3D *	plane,
		const struct SUPoint3D *	point,
		struct SUPoint3D *	projected_point
	)

Since: SketchUp 2018, API 6.0

Parameters

[in]	plane	The plane.
[in]	point	The 3D point to project onto the plane.
[out]	projected_point	The point resulting from the projection.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if plane or point are NULL
SU_ERROR_NULL_POINTER_OUTPUT if projected_point is NULL

enum SUResult SUPlane3DSetWithCoefficients	(	struct SUPlane3D *	plane,
		double	a,
		double	b,
		double	c,
		double	d
	)

Since: SketchUp 2018, API 6.0

Parameters

[out]	plane	The plane defined by the coefficients.
[in]	a	The first coefficient.
[in]	b	The second coefficient.
[in]	c	The third coefficient.
[in]	d	The fourth coefficient.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_OUTPUT if plane is NULL

enum SUResult SUPlane3DSetWithPointAndNormal	(	struct SUPlane3D *	plane,
		const struct SUPoint3D *	point,
		const struct SUVector3D *	normal
	)

Since: SketchUp 2018, API 6.0

Parameters

[out]	plane	The plane defined by the point and normal.
[in]	point	The point.
[in]	normal	The normal vector.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_OUTPUT if plane is NULL
SU_ERROR_NULL_POINTER_INPUT if point or normal are NULL

enum SUResult SUPlane3DSetWithPoints	(	struct SUPlane3D *	plane,
		const struct SUPoint3D *	point1,
		const struct SUPoint3D *	point2,
		const struct SUPoint3D *	point3
	)

Since: SketchUp 2018, API 6.0

Parameters

[out]	plane	The plane defined by the three points.
[in]	point1	The first point.
[in]	point2	The second point.
[in]	point3	The third point.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_OUTPUT if plane is NULL
SU_ERROR_NULL_POINTER_INPUT if point1, point2, or point3 are NULL

enum SUResult SUPlane3DTransform	(	const struct SUTransformation *	transform,
		struct SUPlane3D *	plane
	)

Since: SketchUp 2018, API 6.0

Parameters

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

Returns

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

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

SketchUpAPI/geometry.h
SketchUpAPI/geometry/plane3d.h

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation