Defines a plane in 3D space. More...

#include <OgrePlane.h>

Inheritance diagram for Ogre::Plane:

Public Types
enum	Side { NO_SIDE , POSITIVE_SIDE , NEGATIVE_SIDE , BOTH_SIDE }
	The "positive side" of the plane is the half space to which the plane normal points. More...

Public Member Functions
	Plane ()
	Default constructor - sets everything to 0. More...

	Plane (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)

	Plane (const Vector3 &rkNormal, const Vector3 &rkPoint)

	Plane (const Vector3 &rkNormal, Real fConstant)
	Construct a plane through a normal, and a distance to move the plane along the normal. More...

	Plane (const Vector4 &v)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

	Plane (Real a, Real b, Real c, Real _d)
	Construct a plane using the 4 constants directly. More...

Real	getDistance (const Vector3 &rkPoint) const
	This is a pseudodistance. More...

Side	getSide (const AxisAlignedBox &box) const
	Returns the side where the alignedBox is. More...

Side	getSide (const Vector3 &centre, const Vector3 &halfSize) const
	Returns which side of the plane that the given box lies on. More...

Side	getSide (const Vector3 &rkPoint) const

Real	normalise (void)
	Normalises the plane. More...

bool	operator!= (const Plane &rhs) const

Plane	operator- () const
	Get flipped plane, with same location but reverted orientation. More...

bool	operator== (const Plane &rhs) const
	Comparison operator. More...

Vector3	projectVector (const Vector3 &v) const
	Project a vector onto the plane. More...

void	redefine (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
	Redefine this plane based on 3 points. More...

void	redefine (const Vector3 &rkNormal, const Vector3 &rkPoint)
	Redefine this plane based on a normal and a point. More...

Public Attributes
Real	d

Vector3	normal

Detailed Description

Defines a plane in 3D space.

A plane is defined in 3D space by the equation
Ax + By + Cz + D = 0

: This equates to a vector (the normal of the plane, whose x, y and z components equate to the coefficients A, B and C respectively), and a constant (D) which is the distance along the normal you have to go to move the plane back to the origin.

Member Enumeration Documentation

◆ Side

enum Ogre::Plane::Side

The "positive side" of the plane is the half space to which the plane normal points.

The "negative side" is the other half space. The flag "no side" indicates the plane itself.

Enumerator
NO_SIDE
POSITIVE_SIDE
NEGATIVE_SIDE
BOTH_SIDE

Constructor & Destructor Documentation

◆ Plane() [1/6]

Ogre::Plane::Plane ( )

inline

Default constructor - sets everything to 0.

◆ Plane() [2/6]

Ogre::Plane::Plane	(	const Vector3 &	rkNormal,
		Real	fConstant
	)

inline

Construct a plane through a normal, and a distance to move the plane along the normal.

◆ Plane() [3/6]

Ogre::Plane::Plane	(	Real	a,
		Real	b,
		Real	c,
		Real	_d
	)

inline

Construct a plane using the 4 constants directly.

◆ Plane() [4/6]

Ogre::Plane::Plane ( const Vector4 & v )

inlineexplicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ Plane() [5/6]

Ogre::Plane::Plane	(	const Vector3 &	rkNormal,
		const Vector3 &	rkPoint
	)

inline

◆ Plane() [6/6]

Ogre::Plane::Plane	(	const Vector3 &	p0,
		const Vector3 &	p1,
		const Vector3 &	p2
	)

inline

Member Function Documentation

◆ getSide() [1/3]

Side Ogre::Plane::getSide ( const Vector3 & rkPoint ) const

inline

References NEGATIVE_SIDE, NO_SIDE, and POSITIVE_SIDE.

Referenced by Ogre::PlaneBoundedVolume::intersects(), and Ogre::Math::intersects().

◆ getSide() [2/3]

Side Ogre::Plane::getSide ( const AxisAlignedBox & box ) const

inline

Returns the side where the alignedBox is.

The flag BOTH_SIDE indicates an intersecting box. One corner ON the plane is sufficient to consider the box and the plane intersecting.

References Ogre::AxisAlignedBox::getCenter(), Ogre::AxisAlignedBox::getHalfSize(), Ogre::AxisAlignedBox::isInfinite(), and Ogre::AxisAlignedBox::isNull().

◆ getSide() [3/3]

Side Ogre::Plane::getSide	(	const Vector3 &	centre,
		const Vector3 &	halfSize
	)		const

inline

Returns which side of the plane that the given box lies on.

The box is defined as centre/half-size pairs for effectively.

Parameters

centre	The centre of the box.
halfSize	The half-size of the box.

Returns: POSITIVE_SIDE if the box complete lies on the "positive side" of the plane, NEGATIVE_SIDE if the box complete lies on the "negative side" of the plane, and BOTH_SIDE if the box intersects the plane.

◆ getDistance()

Real Ogre::Plane::getDistance ( const Vector3 & rkPoint ) const

inline

This is a pseudodistance.

The sign of the return value is positive if the point is on the positive side of the plane, negative if the point is on the negative side, and zero if the point is on the plane.

: The absolute value of the return value is the true distance only when the plane normal is a unit length vector.

References Ogre::Vector< dims, T >::dotProduct().

Referenced by Ogre::Sphere::intersects(), and Ogre::PlaneBoundedVolume::intersects().

◆ redefine() [1/2]

void Ogre::Plane::redefine	(	const Vector3 &	p0,
		const Vector3 &	p1,
		const Vector3 &	p2
	)

inline

Redefine this plane based on 3 points.

References Ogre::Math::calculateBasicFaceNormal(), and Ogre::Vector< dims, T >::dotProduct().

◆ redefine() [2/2]

void Ogre::Plane::redefine	(	const Vector3 &	rkNormal,
		const Vector3 &	rkPoint
	)

inline

Redefine this plane based on a normal and a point.

References Ogre::Vector< dims, T >::dotProduct().

◆ projectVector()

Vector3 Ogre::Plane::projectVector ( const Vector3 & v ) const

inline

Project a vector onto the plane.

Remarks: This gives you the element of the input vector that is perpendicular to the normal of the plane. You can get the element which is parallel to the normal of the plane by subtracting the result of this method from the original vector, since parallel + perpendicular = original.

Parameters

v	The input vector

◆ normalise()

Real Ogre::Plane::normalise ( void )

inline

Normalises the plane.

This method normalises the plane's normal and the length scale of d
is as well.

Note: This function will not crash for zero-sized vectors, but there will be no changes made to their components.

Returns: The previous length of the plane's normal.

References Ogre::Vector< dims, T >::length().

◆ operator-()

Plane Ogre::Plane::operator- ( ) const

inline

Get flipped plane, with same location but reverted orientation.

◆ operator==()

bool Ogre::Plane::operator== ( const Plane & rhs ) const

inline

Comparison operator.

References d, and normal.

◆ operator!=()

bool Ogre::Plane::operator!= ( const Plane & rhs ) const

inline

References d, and normal.

Member Data Documentation

◆ normal

Vector3 Ogre::Plane::normal

Referenced by Ogre::Ray::intersects(), operator!=(), Ogre::operator*(), and operator==().

◆ d

Real Ogre::Plane::d

Referenced by Ogre::Ray::intersects(), operator!=(), Ogre::operator*(), and operator==().

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

OgrePlane.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ Side

Constructor & Destructor Documentation

◆ Plane() [1/6]

◆ Plane() [2/6]

◆ Plane() [3/6]

◆ Plane() [4/6]

◆ Plane() [5/6]

◆ Plane() [6/6]

Member Function Documentation

◆ getSide() [1/3]

◆ getSide() [2/3]

◆ getSide() [3/3]

◆ getDistance()

◆ redefine() [1/2]

◆ redefine() [2/2]

◆ projectVector()

◆ normalise()

◆ operator-()

◆ operator==()

◆ operator!=()

Member Data Documentation

◆ normal

◆ d