Plane

Infinite plane container. (In 3D space) More...

#include <plane.hpp>

Public Member Functions
	Plane (f32x4 normal, float distance=0.0f, bool normalize=true) noexcept
	Creates a new plane structure. (In 3D space)
	Plane ()=default
	Creates a new empty plane structure.
	Plane (const Triangle &triangle) noexcept
	Calculates a new plane from the triangle. (Polygon)
f32x4	getNormal () const noexcept
	Returns plane normal vector in 3D space.
void	setNormal (f32x4 normal, bool normalize=true) noexcept
	Sets plane normal vector in 3D space.
float	getDistance () const noexcept
	Returns distance to the plane.
void	setDistance (float distance) noexcept
	Sets distance to the plane.
void	normalize () noexcept
	Normalizes plane normal vector.
bool	operator== (const Plane &v) const noexcept
bool	operator!= (const Plane &v) const noexcept

Static Public Attributes
static constexpr uint8	frustumCount = 6
	Frustum plane count. (Box side count)
static const Plane	left = Plane(f32x4(-1.0f, 0.0f, 0.0f, 0.0f), 0.0f, false)
static const Plane	right = Plane(f32x4(1.0f, 0.0f, 0.0f, 0.0f), 0.0f, false)
static const Plane	bottom = Plane(f32x4(0.0f, -1.0f, 0.0f, 0.0f), 0.0f, false)
static const Plane	top = Plane(f32x4(0.0f, 1.0f, 0.0f, 0.0f), 0.0f, false)
static const Plane	back = Plane(f32x4(0.0f, 0.0f, -1.0f, 0.0f), 0.0f, false)
static const Plane	front = Plane(f32x4(0.0f, 0.0f, 1.0f, 0.0f), 0.0f, false)

Protected Attributes
f32x4	normDist = f32x4::zero

Detailed Description

Infinite plane container. (In 3D space)

Defined by a normal vector and distance to the plane.

Constructor & Destructor Documentation

Plane() [1/2]

Plane ( f32x4 normal, float distance = 0.0f, bool normalize = true )

inlinenoexcept

Creates a new plane structure. (In 3D space)

Parameters

normal	target plane normal vector in 3D space
distance	target distance to the plane
normalize	is normal vector should be normalized

Plane() [2/2]

Plane ( const Triangle & triangle )

inlinenoexcept

Calculates a new plane from the triangle. (Polygon)

Parameters

[in]

triangle

target triangle (polygon)

Member Function Documentation

setNormal()

void setNormal ( f32x4 normal, bool normalize = true )

inlinenoexcept

Sets plane normal vector in 3D space.

Parameters

normal	target plane normal vector in 3D space
normalize	is normal vector should be normalized

setDistance()

void setDistance ( float distance )

inlinenoexcept

Sets distance to the plane.

Parameters

distance

target distance to the plane