A plane and related functions. More...

#include <ignition/math/Plane.hh>

Public Types
enum	PlaneSide { NEGATIVE_SIDE = 0 , POSITIVE_SIDE = 1 , NO_SIDE = 2 , BOTH_SIDE = 3 }
	Enum used to indicate a side of the plane, no side, or both sides for entities on the plane. More...

Public Member Functions
	Plane ()
	Constructor.

	Plane (const Vector3< T > &_normal, const Vector2< T > &_size, T _offset)
	Constructor.

	Plane (const Vector3< T > &_normal, T _offset=0.0)
	Constructor from a normal and a distance.

virtual	~Plane ()
	Destructor.

T	Distance (const Vector3< T > &_origin, const Vector3< T > &_dir) const
	Get distance to the plane give an origin and direction.

T	Distance (const Vector3< T > &_point) const
	The distance to the plane from the given point.

Vector3< T > &	Normal ()
	Get the plane offset.

const Vector3< T > &	Normal () const
	Get the plane offset.

T	Offset () const
	Get the plane offset.

Plane< T > &	operator= (const Plane< T > &_p)
	Equal operator.

void	Set (const Vector3< T > &_normal, const Vector2< T > &_size, T _offset)
	Set the plane.

void	Set (const Vector3< T > &_normal, T _offset)
	Set the plane.

PlaneSide	Side (const math::Box &_box) const
	The side of the plane a box is on.

PlaneSide	Side (const Vector3< T > &_point) const
	The side of the plane a point is on.

Vector2< T > &	Size ()
	Get the plane size.

const Vector2< T > &	Size () const
	Get the plane size.

Detailed Description

template<typename T>
class ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >

A plane and related functions.

Member Enumeration Documentation

◆ PlaneSide

template<typename T>

enum ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane::PlaneSide

Enum used to indicate a side of the plane, no side, or both sides for entities on the plane.

See also: Side

Enumerator
NEGATIVE_SIDE	Negative side of the plane. This is the side that is opposite the normal.
POSITIVE_SIDE	Positive side of the plane. This is the side that has the normal vector.
NO_SIDE	On the plane.
BOTH_SIDE	On both sides of the plane.

Constructor & Destructor Documentation

◆ Plane() [1/3]

template<typename T>

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Plane ( )

inline

Constructor.

◆ Plane() [2/3]

template<typename T>

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Plane	(	const Vector3< T > &	_normal,
		T	_offset = 0.0 )

inline

Constructor from a normal and a distance.

Parameters

[in]	_normal	The plane normal
[in]	_offset	Offset along the normal

◆ Plane() [3/3]

template<typename T>

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Plane	(	const Vector3< T > &	_normal,
		const Vector2< T > &	_size,
		T	_offset )

inline

Constructor.

Parameters

[in]	_normal	The plane normal
[in]	_size	Size of the plane
[in]	_offset	Offset along the normal

◆ ~Plane()

template<typename T>

virtual ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::~Plane ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Distance() [1/2]

template<typename T>

T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Distance	(	const Vector3< T > &	_origin,
		const Vector3< T > &	_dir ) const

inline

Get distance to the plane give an origin and direction.

Parameters

[in]	_origin	the origin
[in]	_dir	a direction

Returns: the shortest distance

◆ Distance() [2/2]

template<typename T>

T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Distance ( const Vector3< T > & _point ) const

inline

The distance to the plane from the given point.

The distance can be negative, which indicates the point is on the negative side of the plane.

Parameters

[in] _point 3D point to calculate distance from.

Returns: Distance from the point to the plane.

See also: Side

Referenced by ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< int >::Side(), and ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< int >::Side().

◆ Normal() [1/2]

template<typename T>

Vector3< T > & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Normal ( )

inline

Get the plane offset.

◆ Normal() [2/2]

template<typename T>

const Vector3< T > & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Normal ( ) const

inline

Get the plane offset.

◆ Offset()

template<typename T>

T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Offset ( ) const

inline

Get the plane offset.

◆ operator=()

template<typename T>

Plane< T > & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::operator= ( const Plane< T > & _p )

inline

Equal operator.

Parameters

_p	another plane

Returns: itself

◆ Set() [1/2]

template<typename T>

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Set	(	const Vector3< T > &	_normal,
		const Vector2< T > &	_size,
		T	_offset )

inline

Set the plane.

Parameters

[in]	_normal	The plane normal
[in]	_size	Size of the plane
[in]	_offset	Offset along the normal

◆ Set() [2/2]

template<typename T>

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Set	(	const Vector3< T > &	_normal,
		T	_offset )

inline

Set the plane.

Parameters

[in]	_normal	The plane normal
[in]	_offset	Offset along the normal

Referenced by ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< int >::Plane().

◆ Side() [1/2]

template<typename T>

PlaneSide ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Side ( const math::Box & _box ) const

inline

The side of the plane a box is on.

Parameters

[in] _box The 3D box to check.

Returns: Plane::NEGATIVE_SIDE if the distance from the box to the plane is negative, Plane::POSITIVE_SIDE if the distance from the box to the plane is positive, or Plane::BOTH_SIDE if the box is on the plane.

◆ Side() [2/2]

template<typename T>

PlaneSide ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Side ( const Vector3< T > & _point ) const

inline

The side of the plane a point is on.

Parameters

[in] _point The 3D point to check.

Returns: Plane::NEGATIVE_SIDE if the distance from the point to the plane is negative, Plane::POSITIVE_SIDE if the distance from the point to the plane is positive, or Plane::NO_SIDE if the point is on the plane.

◆ Size() [1/2]

template<typename T>

Vector2< T > & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Size ( )

inline

Get the plane size.

◆ Size() [2/2]

template<typename T>

const Vector2< T > & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Plane< T >::Size ( ) const

inline

Get the plane size.

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

Plane.hh

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ PlaneSide

Constructor & Destructor Documentation

◆ Plane() [1/3]

◆ Plane() [2/3]

◆ Plane() [3/3]

◆ ~Plane()

Member Function Documentation

◆ Distance() [1/2]

◆ Distance() [2/2]

◆ Normal() [1/2]

◆ Normal() [2/2]

◆ Offset()

◆ operator=()

◆ Set() [1/2]

◆ Set() [2/2]

◆ Side() [1/2]

◆ Side() [2/2]

◆ Size() [1/2]

◆ Size() [2/2]