← Back to branch summary

~ubuntu-branches/debian/sid/ember/sid

« back to all changes in this revision

Viewing changes to src/components/ogre/environment/SimpleWater.h

  • Committer: Bazaar Package Importer
  • Author(s): Michael Koch
  • Date: 2009-07-23 07:46:40 UTC
  • Revision ID: james.westby@ubuntu.com-20090723074640-wh0ukzis0kda36qv
Tags: upstream-0.5.6
Import upstream version 0.5.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/components/ogre/environment/SimpleWater.h
 
1
//
 
2
// C++ Interface: SimpleWater
 
3
//
 
4
// Description: 
 
5
//
 
6
//
 
7
// Author: Erik Hjortsberg <erik.hjortsberg@gmail.com>, (C) 2008
 
8
//
 
9
// This program is free software; you can redistribute it and/or modify
 
10
// it under the terms of the GNU General Public License as published by
 
11
// the Free Software Foundation; either version 2 of the License, or
 
12
// (at your option) any later version.
 
13
// 
 
14
// This program is distributed in the hope that it will be useful,
 
15
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
// GNU General Public License for more details.
 
18
// 
 
19
// You should have received a copy of the GNU General Public License
 
20
// along with this program; if not, write to the Free Software
 
21
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.//
 
22
//
 
23
#ifndef EMBEROGRE_ENVIRONMENTSIMPLEWATER_H
 
24
#define EMBEROGRE_ENVIRONMENTSIMPLEWATER_H
 
25
 
 
26
#include "components/ogre/EmberOgrePrerequisites.h"
 
27
#include "Environment.h"
 
28
 
 
29
namespace EmberOgre {
 
30
 
 
31
namespace Environment {
 
32
 
 
33
/**
 
34
@brief A very simple water implementation which just shows a flat textured water plane.
 
35
 
 
36
@author Erik Hjortsberg <erik.hjortsberg@gmail.com>
 
37
*/
 
38
class SimpleWater : public IWater
 
39
{
 
40
public:
 
41
        SimpleWater(Ogre::Camera& camera, Ogre::SceneManager& sceneMgr);
 
42
        
 
43
        virtual ~SimpleWater();
 
44
        
 
45
        /**
 
46
         * @brief Performs checks to see whether this technique is supported on the current hardware.
 
47
         * @return True if the water technique is supported.
 
48
         */
 
49
        virtual bool isSupported() const;
 
50
        /**
 
51
         * @brief Initializes the water. You must call this in order for the water to show up.
 
52
         * @return True if the water technique could be setup, else false.
 
53
         */
 
54
        virtual bool initialize();
 
55
 
 
56
protected:
 
57
 
 
58
        /**
 
59
         * @brief The camera used.
 
60
         */
 
61
        Ogre::Camera& mCamera;
 
62
        
 
63
        /**
 
64
         * @brief The scene manager to which the water will be added.
 
65
         */
 
66
        Ogre::SceneManager& mSceneMgr;
 
67
 
 
68
        /**
 
69
         * @brief The node to which the water entity is attached to. Owned by this instance-
 
70
         */
 
71
        Ogre::SceneNode *mWaterNode;
 
72
        
 
73
        /**
 
74
         * @brief The entity representing the water plane. Owned by this instance-
 
75
         */
 
76
        Ogre::Entity* mWaterEntity;
 
77
 
 
78
};
 
79
 
 
80
}
 
81
 
 
82
}
 
83
 
 
84
#endif