You are here: Start » Function Reference » Geometry 3D Spatial Transforms » AlignPoint3DArrayToPlane

AlignPoint3DArrayToPlane

Header:	AVL.h
Namespace:	avl

Rotates an array of 3D points with a rotation that transforms the input plane to be parallel to XY plane.

Syntax

void avl::AlignPoint3DArrayToPlane
(
	const atl::Array<avl::Point3D>& inPoints,
	const avl::Plane3D& inPlane,
	atl::Array<avl::Point3D>& outPoints,
	atl::Optional<avl::Matrix&> outTransform = atl::NIL,
	atl::Optional<avl::Matrix&> outInvertedTransform = atl::NIL
)

Parameters

Name	Type	Default	Description
inPoints	const Array<Point3D>&
inPlane	const Plane3D&		The plane that determines rotation transform
outPoints	Array<Point3D>&
outTransform	Optional<Matrix&>	NIL	Matrix of the transform used to align the input points
outInvertedTransform	Optional<Matrix&>	NIL	Matrix of the transform rotating the output points to the input ones

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outTransform, outInvertedTransform.

Errors

List of possible exceptions:

Error type	Description
DomainError	Indefinite plane on input in AlignPoint3DArrayToPlane.