reto::ClippingPlane Class Reference

Class to manage a clipping plane. More...

#include <ClippingSystem.h>

Collaboration diagram for reto::ClippingPlane:

Public Member Functions
	ClippingPlane (const reto::ClippingMode &clippingMode=ClippingMode::Global)
	ClippingPlane constructor. More...
	ClippingPlane (const float &a, const float &b, const float &c, const float &d, const reto::ClippingMode &clippingMode=ClippingMode::Global)
	ClippingPlane constructor. More...
	~ClippingPlane (void)
	ClippingPlane destructor.
std::vector< float >	getEquation (void) const
	Method to get the clipping plane equation. More...
void	setEquation (const float &a, const float &b, const float &c, const float &d)
	Method to set the clipping plane equation. More...
void	setEquationByPointAndNormal (const Eigen::Vector3f &point, const Eigen::Vector3f &normal)
	Method to set the clipping plane equation. More...
void	setEquationByPointAndVectors (const Eigen::Vector3f &point, const Eigen::Vector3f &vector1, const Eigen::Vector3f &vector2)
	Method to set the clipping plane equation. More...
void	setEquationByPoints (const Eigen::Vector3f &point1, const Eigen::Vector3f &point2, const Eigen::Vector3f &point3)
	Method to set the clipping plane equation. More...
reto::ClippingMode	getClippingMode (void) const
	Method to get the plane clipping mode. More...
void	setClippingMode (const reto::ClippingMode &clippingMode)
	Method to set the plane clipping mode. More...
void	activate (reto::ShaderProgram *program, const unsigned int &index) const
	Method to activate the clipping plane and activate it's uniforms. More...
void	deactivate (const unsigned int &index) const
	Method to deactivate the clipping plane. More...
void	clear (void)
	Method to clear clipping plane.

Detailed Description

Class to manage a clipping plane.

Definition at line 59 of file ClippingSystem.h.

Constructor & Destructor Documentation

reto::ClippingPlane::ClippingPlane

(

const reto::ClippingMode &

clippingMode = ClippingMode::Global

)

ClippingPlane constructor.

Parameters

clippingMode

clipping mode (global or local, global by default)

reto::ClippingPlane::ClippingPlane	(	const float &	a,
		const float &	b,
		const float &	c,
		const float &	d,
		const reto::ClippingMode &	clippingMode = ClippingMode::Global
	)

ClippingPlane constructor.

Parameters

a	x coefficient
b	y coefficient
c	z coefficient
d	distance from the origin
clippingMode	clipping mode (global or local, global by default)

Member Function Documentation

void reto::ClippingPlane::activate	(	reto::ShaderProgram *	program,
		const unsigned int &	index
	)		const

Method to activate the clipping plane and activate it's uniforms.

Parameters

program	program pointer
index	index of clipping plane

void reto::ClippingPlane::deactivate

(

const unsigned int &

index

)

const

Method to deactivate the clipping plane.

Parameters

index

index of clipping plane

reto::ClippingMode reto::ClippingPlane::getClippingMode

(

void

)

const

Method to get the plane clipping mode.

Returns

clipping mode

std::vector< float > reto::ClippingPlane::getEquation

(

void

)

const

Method to get the clipping plane equation.

Returns

clipping plane equation

void reto::ClippingPlane::setClippingMode

(

const reto::ClippingMode &

clippingMode

)

Method to set the plane clipping mode.

Parameters

clippingMode

clipping mode (global or local)

void reto::ClippingPlane::setEquation	(	const float &	a,
		const float &	b,
		const float &	c,
		const float &	d
	)

Method to set the clipping plane equation.

Parameters

a	x coefficient
b	y coefficient
c	z coefficient
d	distance from the origin

void reto::ClippingPlane::setEquationByPointAndNormal	(	const Eigen::Vector3f &	point,
		const Eigen::Vector3f &	normal
	)

Method to set the clipping plane equation.

Parameters

point	point on the plane
normal	normal vector

void reto::ClippingPlane::setEquationByPointAndVectors	(	const Eigen::Vector3f &	point,
		const Eigen::Vector3f &	vector1,
		const Eigen::Vector3f &	vector2
	)

Method to set the clipping plane equation.

Parameters

point	point on the plane
vector1	vector on the plane
vector2	vector on the plane

void reto::ClippingPlane::setEquationByPoints	(	const Eigen::Vector3f &	point1,
		const Eigen::Vector3f &	point2,
		const Eigen::Vector3f &	point3
	)

Method to set the clipping plane equation.

Parameters

point1	point on the plane
point2	point on the plane
point3	point on the plane

---

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

• ClippingSystem.h