Mezzanine::Plane Class Reference

This is used to represent a flat infinite slice of the game world. More...

#include <plane.h>

List of all members.

Public Member Functions
	Plane ()
	Default constructor.
	Plane (Vector3 Normal_, Real Distance_)
	Thorough constructor.
	Plane (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2)
	Triangle constructor.
	Plane (Ogre::Plane Plane_)
	Compatibily constructor.
void	ExtractOgrePlane (const Ogre::Plane &Plane2)
	Changes this Plane to match the Ogre Plane.
Ogre::Plane	GetOgrePlane () const
	Gets an Ogre::Plane that contains this Plane's information.
void	operator= (const Ogre::Plane &Plane2)
	The assignment operator from Ogre::Plane to Mezzanine::Plane.
Public Attributes
Real	Distance
	How from from the origin the plane is.
Vector3	Normal
	The rotation of the plane.

---

Detailed Description

This is used to represent a flat infinite slice of the game world.

The Normal value represents how rotated the plane will be, and The Distance with represent how far you need to move down a line perpendicular to the plane, (ie the normal, which is defined by the Normal value) from the Origin.

Definition at line 62 of file plane.h.

---

Constructor & Destructor Documentation

Mezzanine::Plane::Plane

(

)

Default constructor.

This create a Plane with gimbals 0,0,0 and 0 distance from the Origin

Definition at line 59 of file plane.cpp.

Mezzanine::Plane::Plane	(	Vector3	Normal_,
		Real	Distance_
	)

Thorough constructor.

This accepts 2 Vector3s and uses them to build the ray

Parameters:

Normal_	The rotation of the plane
Distance_	Distance from origin to the plane

Definition at line 62 of file plane.cpp.

Mezzanine::Plane::Plane

(

Ogre::Plane

Plane_

)

[explicit]

Compatibily constructor.

This accepts an Ogre Plane, (graphics subsystem) to make this Plane

Parameters:

Plane_

This is the Ogre::Plane

Definition at line 65 of file plane.cpp.

Mezzanine::Plane::Plane	(	const Vector3 &	rkPoint0,
		const Vector3 &	rkPoint1,
		const Vector3 &	rkPoint2
	)

Triangle constructor.

This determines the plane the triangle this resides on and uses that plane here

Parameters:

rkPoint0	This is one point in the triangle
rkPoint1	This is another point in the triangle
rkPoint2	This is one point in the triangle

Definition at line 68 of file plane.cpp.

---

Member Function Documentation

void Mezzanine::Plane::ExtractOgrePlane

(

const Ogre::Plane &

Plane2

)

Changes this Plane to match the Ogre Plane.

Used to aid interopability, this will result in this Plane exactly matching the Ogre::Plane

Parameters:

Plane2

The Ogre::Plane to copy

Definition at line 82 of file plane.cpp.

Ogre::Plane Mezzanine::Plane::GetOgrePlane

(

)

const

Gets an Ogre::Plane that contains this Plane's information.

Used to aid interopability, this will return a fresh Ogre::Plane with the same data as this Plane

Returns:

This returns an Ogre::Plnae that contains the same information as this Plane's information

Definition at line 79 of file plane.cpp.

void Mezzanine::Plane::operator=

(

const Ogre::Plane &

Plane2

)

The assignment operator from Ogre::Plane to Mezzanine::Plane.

this simply call Mezzanine::Plane::ExtractOgrePlane

Parameters:

Plane2

The Ogre::Plane to take data from.

Definition at line 88 of file plane.cpp.

---

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

• plane.h
• plane.cpp