clippingPresetsAnimated.h 5.02 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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/*******************************************************************************
* 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_CLIPPINGPRESETSANIMATED_H_
#define _CGoGN_CLIPPINGPRESETSANIMATED_H_

#include "Utils/clippingPresets.h"
#include "Utils/clippingShader.h"
#include "Geometry/vector_gen.h"

namespace CGoGN
{

namespace Utils
{


/***********************************************
 *
 * 		Base Class
 *
 ***********************************************/


class ClippingPresetAnimated : public ClippingPreset
{

public :

	/// constructor
	ClippingPresetAnimated():
		m_attachedClippingShader (NULL),
		m_animationOneStepIncrement (0.01),
		m_animationSpeedFactor (1.0),
		m_animParam (0.0)
		{}

public :

	/*
	 * sets the animation speed factor (can be negative for reverse animation)
	 * @param speedFactor speed factor
	 */
	void setAnimationSpeedFactor(float speedFactor) { m_animationSpeedFactor = speedFactor; }

	/// gets the animation speed factor
	float getAnimationSpeedFactor() { return m_animationSpeedFactor; }

protected :

	/// attached Clipping Shader, used for updating clipping shapes params
	ClippingShader *m_attachedClippingShader;

	/// stored ids used for updating clipping shapes params
	std::vector<unsigned int> m_planesIds;

	/// stored ids used for updating clipping shapes params
	std::vector<unsigned int> m_spheresIds;

	/// one step increment of animation parameter
	float m_animationOneStepIncrement;

	/// speed factor of the animation
	float m_animationSpeedFactor;

	/// animation parameter value (usually between 0.0 and 1.0)
	float m_animParam;

public :

	/**
	 * applies the preset on a clipping shader and store its pointer
	 * @param clipShader pointer to the clipping shader object
	 * @param planesIds returns the new added planes ids
	 * @param spheresIds returns the new added spheres ids
	 * @warning clipShader, planesIds and spheresIds must not be NULL, otherwise the function does nothing
	 * @warning clipShader must remain valid as long as step is being used and apply has not been called again
	 */
	void apply(ClippingShader* clipShader, std::vector<unsigned int> *planesIds, std::vector<unsigned int> *spheresIds);

	/**
	 * runs the animation some steps further
	 * @param amount amount of steps the animation should do
	 */
	virtual void step(unsigned int amount) = 0;

};


/***********************************************
 *
 * 		Derived Classes
 *
 ***********************************************/


class ClippingPresetAnimatedDualPlanes : public ClippingPresetAnimated
{

public :

	/**
	 * constructor
	 * @param centerStart center between planes at the start of the animation
	 * @param centerEnd center between planes at the end of the animation
	 * @param size distance between planes
	 * @param axis axis on which planes are aligned (0 for x, 1 for y, 2 for z)
	 * @param facing true means having facing planes
	 */
	ClippingPresetAnimatedDualPlanes(
			Geom::Vec3f centerStart, Geom::Vec3f centerEnd, float size, int axis, bool facing);

	/**
	 * runs the animation some steps further
	 * @param amount amount of steps the animation should do
	 */
	void step(unsigned int amount);

private :

	/// direction vector
	Geom::Vec3f m_dirVec;

	/// start point of the animation
	Geom::Vec3f m_startPoint;

	/// end point of the animation
	Geom::Vec3f m_endPoint;

};


} // namespace Utils

} // namespace CGoGN

#endif