clippingShader.h 4.08 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
* Copyright (C) 2009-2011, IGG Team, LSIIT, University of Strasbourg           *
*                                                                              *
* This library is free software; you can redistribute it and/or modify it      *
* under the terms of the GNU Lesser General Public License as published by the *
* Free Software Foundation; either version 2.1 of the License, or (at your     *
* option) any later version.                                                   *
*                                                                              *
* This library is distributed in the hope that it will be useful, but WITHOUT  *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License  *
* for more details.                                                            *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this library; if not, write to the Free Software Foundation,      *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
*                                                                              *
* Web site: http://cgogn.u-strasbg.fr/                                         *
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef _CGoGN_CLIPPINGSHADER_H_
#define _CGoGN_CLIPPINGSHADER_H_

#include "Utils/GLSLShader.h"
#include "Geometry/vector_gen.h"
30 31 32
#include "glm/glm.hpp"
#include "Geometry/matrix.h"
#include "Utils/trackball.h"
33 34
#include "Utils/cgognStream.h"
#include "Utils/shaderMutator.h"
35
#include "Utils/drawer.h"
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
#include <string>

namespace CGoGN
{

namespace Utils
{

class ClippingShader : public GLSLShader
{

public:
	/**
	 * constructor
	 */
	ClippingShader();

53 54 55 56 57
	/**
	 * destructor
	 */
	~ClippingShader();

58 59
	/**
	 * set the plane equation for plane clipping
60
	 * @param clipPlane plane equation
61
	 */
62
	void setClippingPlaneEquation(Geom::Vec4f clipPlane);
63
	
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
	/**
	 * get the plane equation for plane clipping
	 */
	Geom::Vec4f getClippingPlaneEquation();

	/**
	 * set the plane quaternion for plane clipping
	 * @param quat plane quaternion
	 */
	void setClippingPlaneQuaternion(float quat[4]);

	/**
	 * get the plane quaternion for plane clipping
	 */
	Geom::Vec4f getClippingPlaneQuaternion();

80 81
	/**
	 * set the color attenuation factor for clipping
82
	 * @param colorAttenuationFactor color attenuation factor
83 84 85
	 */
	void setClippingColorAttenuationFactor(float colorAttenuationFactor);

86 87 88 89 90
	/**
	 * get the color attenuation factor for clipping
	 */
	float getClippingColorAttenuationFactor();

91 92 93 94 95 96 97 98
	/**
	 * insert plane clipping instructions into vertex and fragment shader source code
	 * - does not modify the geometry shader source code
	 * @warning this function is designed for shaders which do not use a geometry shader
	 */
	void addPlaneClippingToShaderSource();
	
	/**
99
	 * update uniforms (get their locations and resend their values) for clipping
100 101 102
	 */
	void updateClippingUniforms();

103 104 105 106 107
	/**
	 * displays a quad corresponding to the current clipping plane position and orientation
	 */
	void displayClippingPlane();

108 109 110 111 112 113

private:

	/**
	 * clip plane vector (a, b, c, d)
	 */
114
	Geom::Vec4f m_clipPlaneEquation;
115
	
116 117 118 119 120
	/**
	 * clip plane quaternion
	 */
	float m_clipPlaneQuaternion[4];

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
	/**
	 * clip plane vector uniform id
	 */
	GLint m_unif_clipPlane;
	
	/**
	 * color attenuation factor
	 */
	float m_colorAttenuationFactor;
	
	/**
	 * color attenuation factor uniform id
	 */
	GLint m_unif_colorAttenuationFactor;

136 137 138 139 140
	/**
	 * plane drawer
	 */
	Drawer* m_planeDrawer;

141 142 143 144 145 146 147 148
};


} // namespace Utils

} // namespace CGoGN

#endif