Math class that represents a plane in 3D. More...

Public Member Functions
	Plane (T normalX, T normalY, T normalZ, T Distance)
	Constructs a Plane object from its components. More...

	Plane (const T plane[4])
	Constructs a Plane object from an array of four elements. More...

	Plane (const Vector3< T > &Normal, T Distance)
	Constructs a Plane object from a normal and a distance. More...

	Plane (const Vector3< T > &Normal, const Vector3< T > &point)
	Constructs a Plane object from a normal and a point. More...

	Plane (const Vector3< T > &point1, const Vector3< T > &point2, const Vector3< T > &point3)
	Constructs a Plane object from three points. More...

template<typename U >
	Plane (const Plane< U > &plane)
	Constructs a Plane object from another type of Plane. More...

	Plane (const Plane &plane)=default

T	Distance (T x, T y, T z) const
	Returns the distance from the plane to the point. More...

T	Distance (const Vector3< T > &point) const
	Returns the distance from the plane to the point. More...

Plane &	MakeXY ()
	Makes the plane (0, 0, 1, 0) More...

Plane &	MakeXZ ()
	Makes the plane (0, 1, 0, 0) More...

Plane &	MakeYZ ()
	Makes the plane (1, 0, 0, 0) More...

Plane &	Set (T normalX, T normalY, T normalZ, T Distance)
	Sets the components of the plane. More...

Plane &	Set (const T plane[4])
	Sets the components of the plane from an array of four elements. More...

Plane &	Set (const Plane &plane)
	Sets the components of the plane from another plane. More...

Plane &	Set (const Vector3< T > &Normal, T Distance)
	Sets the components of the plane from a normal and a distance. More...

Plane &	Set (const Vector3< T > &Normal, const Vector3< T > &point)
	Sets the components of the plane from a normal and a point. More...

Plane &	Set (const Vector3< T > &point1, const Vector3< T > &point2, const Vector3< T > &point3)
	Sets the components of the plane from three points. More...

template<typename U >
Plane &	Set (const Plane< U > &plane)

String	ToString () const
	Gives a string representation. More...

Plane &	operator= (const Plane &other)=default

bool	operator== (const Plane &plane) const
	Compares the plane to other one. More...

bool	operator!= (const Plane &plane) const
	Compares the plane to other one. More...

template<typename U >
Plane< T > &	Set (const Plane< U > &plane)
	Sets the components of the plane from another type of Plane. More...

Static Public Member Functions
static Plane	Lerp (const Plane &from, const Plane &to, T interpolation)
	Interpolates the plane to other one with a factor of interpolation. More...

static Plane	XY ()
	Shorthand for the plane (0, 0, 1, 0) More...

static Plane	XZ ()
	Shorthand for the plane (0, 1, 0, 0) More...

static Plane	YZ ()
	Shorthand for the plane (1, 0, 0, 0) More...

Public Attributes
Vector3< T >	normal

T	distance

Detailed Description

template<typename T>
class Nz::Plane< T >

Math class that represents a plane in 3D.

Remarks: The convention used in this class is: If you ask for plane with normal (0, 1, 0) and distance 1, you will get 0 * X + 1 * Y + 0 * Z - 1 = 0 or Y = 1. Notice the sign minus before the distance on the left side of the equation

Constructor & Destructor Documentation

◆ Plane() [1/6]

template<typename T >

Nz::Plane< T >::Plane	(	T	normalX,
		T	normalY,
		T	normalZ,
		T	D
	)

Constructs a Plane object from its components.

Parameters

normalX	X component of the normal
normalY	Y component of the normal
normalZ	Z component of the normal
D	Distance to origin

◆ Plane() [2/6]

template<typename T >

Nz::Plane< T >::Plane ( const T plane[4] )

Constructs a Plane object from an array of four elements.

Parameters

plane[4] plane[0] is X component, plane[1] is Y component, plane[2] is Z component and plane[3] is D

◆ Plane() [3/6]

template<typename T >

Nz::Plane< T >::Plane	(	const Vector3< T > &	Normal,
		T	D
	)

Constructs a Plane object from a normal and a distance.

Parameters

Normal	normal of the vector
D	Distance to origin

◆ Plane() [4/6]

template<typename T >

Nz::Plane< T >::Plane	(	const Vector3< T > &	Normal,
		const Vector3< T > &	point
	)

Constructs a Plane object from a normal and a point.

Parameters

Normal	Normal of the plane
point	Point which verifies the equation of the plane

◆ Plane() [5/6]

template<typename T >

Nz::Plane< T >::Plane	(	const Vector3< T > &	point1,
		const Vector3< T > &	point2,
		const Vector3< T > &	point3
	)

Constructs a Plane object from three points.

Parameters

point1	First point
point2	Second point
point3	Third point

Remarks: They are expected not to be colinear

◆ Plane() [6/6]

template<typename T >

template<typename U >

Nz::Plane< T >::Plane ( const Plane< U > & plane )

explicit

Constructs a Plane object from another type of Plane.

Parameters

plane Plane of type U to convert to type T

Member Function Documentation

◆ Distance() [1/2]

template<typename T >

T Nz::Plane< T >::Distance	(	T	x,
		T	y,
		T	z
	)		const

Returns the distance from the plane to the point.

Returns: Distance to the point

Parameters

X	X position of the point
Y	Y position of the point
Z	Z position of the point

Remarks: If T is negative, it means that the point is in the opposite direction of the normal

See also: Distance

◆ Distance() [2/2]

template<typename T >

T Nz::Plane< T >::Distance ( const Vector3< T > & point ) const

Returns the distance from the plane to the point.

Returns: Distance to the point

Parameters

point Position of the point

Remarks: If T is negative, it means that the point is in the opposite direction of the normal

See also: Distance

◆ Lerp()

template<typename T >

Plane< T > Nz::Plane< T >::Lerp	(	const Plane< T > &	from,
		const Plane< T > &	to,
		T	interpolation
	)

static

Interpolates the plane to other one with a factor of interpolation.

Returns: A new plane which is the interpolation of two planes

Parameters

from	Initial plane
to	Target plane
interpolation	Factor of interpolation

Remarks: interpolation is meant to be between 0 and 1, other values are potentially undefined behavior; With NAZARA_DEBUG, a NazaraError is thrown and Plane() is returned

See also: Lerp

◆ MakeXY()

template<typename T >

Plane< T > & Nz::Plane< T >::MakeXY ( )

Makes the plane (0, 0, 1, 0)

Returns: A reference to this plane with components (0, 0, 1, 0)

See also: XY

◆ MakeXZ()

template<typename T >

Plane< T > & Nz::Plane< T >::MakeXZ ( )

Makes the plane (0, 1, 0, 0)

Returns: A reference to this plane with components (0, 1, 0, 0)

See also: XZ

◆ MakeYZ()

template<typename T >

Plane< T > & Nz::Plane< T >::MakeYZ ( )

Makes the plane (1, 0, 0, 0)

Returns: A reference to this plane with components (1, 0, 0, 0)

See also: YZ

◆ operator!=()

template<typename T >

bool Nz::Plane< T >::operator!= ( const Plane< T > & plane ) const

Compares the plane to other one.

Returns: false if the planes are the same

Parameters

plane Other plane to compare with

Remarks: Plane with normal N and distance D is the same than with normal -N et distance -D

◆ operator==()

template<typename T >

bool Nz::Plane< T >::operator== ( const Plane< T > & plane ) const

Compares the plane to other one.

Returns: true if the planes are the same

Parameters

vec	Other vector to compare with

Remarks: Plane with normal N and distance D is the same than with normal -N et distance -D

◆ Set() [1/7]

template<typename T >

Plane< T > & Nz::Plane< T >::Set	(	T	normalX,
		T	normalY,
		T	normalZ,
		T	D
	)

Sets the components of the plane.

Returns: A reference to this plane

Parameters

normalX	X component of the normal
normalY	Y component of the normal
normalZ	Z component of the normal
D	Distance to origin

◆ Set() [2/7]

template<typename T >

Plane< T > & Nz::Plane< T >::Set ( const T plane[4] )

Sets the components of the plane from an array of four elements.

Returns: A reference to this plane

Parameters

plane[4] plane[0] is X component, plane[1] is Y component, plane[2] is Z component and plane[3] is D

◆ Set() [3/7]

template<typename T >

Plane< T > & Nz::Plane< T >::Set ( const Plane< T > & plane )

Sets the components of the plane from another plane.

Returns: A reference to this plane

Parameters

plane The other plane

◆ Set() [4/7]

template<typename T >

Plane< T > & Nz::Plane< T >::Set	(	const Vector3< T > &	Normal,
		T	D
	)

Sets the components of the plane from a normal and a distance.

Returns: A reference to this plane

Parameters

Normal	Normal of the vector
D	Distance to origin

◆ Set() [5/7]

template<typename T >

Plane< T > & Nz::Plane< T >::Set	(	const Vector3< T > &	Normal,
		const Vector3< T > &	point
	)

Sets the components of the plane from a normal and a point.

Returns: A reference to this plane

Parameters

Normal	Normal of the plane
point	Point which verifies the equation of the plane

◆ Set() [6/7]

template<typename T >

Plane< T > & Nz::Plane< T >::Set	(	const Vector3< T > &	point1,
		const Vector3< T > &	point2,
		const Vector3< T > &	point3
	)

Sets the components of the plane from three points.

Returns: A reference to this plane

Parameters

point1	First point
point2	Second point
point3	Third point

Remarks: They are expected not to be colinear

◆ Set() [7/7]

template<typename T>

template<typename U >

Plane<T>& Nz::Plane< T >::Set ( const Plane< U > & plane )

Sets the components of the plane from another type of Plane.

Returns: A reference to this plane

Parameters

plane Plane of type U to convert its components

◆ ToString()

template<typename T >

String Nz::Plane< T >::ToString ( ) const

Gives a string representation.

Returns: A string representation of the object: "Plane(Normal: Vector3(x, y, z); Distance: w)"

◆ XY()

template<typename T >

Plane< T > Nz::Plane< T >::XY ( )

static

Shorthand for the plane (0, 0, 1, 0)

Returns: A plane with components (0, 0, 1, 0)

See also: MakeXY

◆ XZ()

template<typename T >

Plane< T > Nz::Plane< T >::XZ ( )

static

Shorthand for the plane (0, 1, 0, 0)

Returns: A plane with components (0, 1, 0, 0)

See also: MakeXZ

◆ YZ()

template<typename T >

Plane< T > Nz::Plane< T >::YZ ( )

static

Shorthand for the plane (1, 0, 0, 0)

Returns: A plane with components (1, 0, 0, 0)

See also: MakeYZ

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

include/Nazara/Math/Plane.hpp
include/Nazara/Math/Plane.inl

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

template<typename T> class Nz::Plane< T >

Constructor & Destructor Documentation

◆ Plane() [1/6]

◆ Plane() [2/6]

◆ Plane() [3/6]

◆ Plane() [4/6]

◆ Plane() [5/6]

◆ Plane() [6/6]

Member Function Documentation

◆ Distance() [1/2]

◆ Distance() [2/2]

◆ Lerp()

◆ MakeXY()

◆ MakeXZ()

◆ MakeYZ()

◆ operator!=()

◆ operator==()

◆ Set() [1/7]

◆ Set() [2/7]

◆ Set() [3/7]

◆ Set() [4/7]

◆ Set() [5/7]

◆ Set() [6/7]

◆ Set() [7/7]

◆ ToString()

◆ XY()

◆ XZ()

◆ YZ()

template<typename T>
class Nz::Plane< T >