EnvironmentRenderer::WaterSurface::Plane Class Reference

#include <vrs/environment/watersurface.h>

List of all members.

Public Member Functions
	Plane (VRS::Vector normal=VRS::Vector(0.0, 1.0, 0.0), VRS::Vector anchor=VRS::Vector())
	creates a plane defined by an anchor-point and a normal.
	Plane (const Plane &other)
void	setAnchor (VRS::Vector anchor)
void	setNormal (VRS::Vector normal)
VRS::Vector	getAnchor () const
VRS::Vector	getNormal () const
VRS::Vector	getTangent () const
VRS::Vector	getBitangent () const
double	getDistanceToOrigin () const
bool	operator== (const Plane &other)
bool	operator!= (const Plane &other)
bool	operator< (const Plane &other)
const Plane &	operator= (const Plane &other)

---

Constructor & Destructor Documentation

EnvironmentRenderer::WaterSurface::Plane::Plane	(	VRS::Vector	normal = VRS::Vector(0.0, 1.0, 0.0),
		VRS::Vector	anchor = VRS::Vector()
	)

creates a plane defined by an anchor-point and a normal.

'getDistanceToOrigin' denotes the plane's distance to (0,0,0). 'tangent' and 'bitangent' are perpendicular to 'normal' and perpendicular to each other. they are calculated as follows: if 'normal' points towards (0, 1, 0) the tangent is (1, 0, 0). otherwise 'tangent' is calcualted by crossProduct(normal, (0, 1, 0)). 'bitangent' is always calculated by crossProduct(tangent, normal);

EnvironmentRenderer::WaterSurface::Plane::Plane

(

const Plane &

other

)

---

Member Function Documentation

void EnvironmentRenderer::WaterSurface::Plane::setAnchor

(

VRS::Vector

anchor

)

void EnvironmentRenderer::WaterSurface::Plane::setNormal

(

VRS::Vector

normal

)

VRS::Vector EnvironmentRenderer::WaterSurface::Plane::getAnchor

(

)

const

VRS::Vector EnvironmentRenderer::WaterSurface::Plane::getNormal

(

)

const

VRS::Vector EnvironmentRenderer::WaterSurface::Plane::getTangent

(

)

const

VRS::Vector EnvironmentRenderer::WaterSurface::Plane::getBitangent

(

)

const

double EnvironmentRenderer::WaterSurface::Plane::getDistanceToOrigin

(

)

const

bool EnvironmentRenderer::WaterSurface::Plane::operator==

(

const Plane &

other

)

bool EnvironmentRenderer::WaterSurface::Plane::operator!=

(

const Plane &

other

)

bool EnvironmentRenderer::WaterSurface::Plane::operator<

(

const Plane &

other

)

const Plane& EnvironmentRenderer::WaterSurface::Plane::operator=

(

const Plane &

other

)

---

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

• watersurface.h