Controller.h
Go to the documentation of this file.
1 /*
2 --------------------------------------------------------------------------------
3 This source file is part of SkyX.
4 Visit http://www.paradise-studios.net/products/skyx/
5 
6 Copyright (C) 2009-2012 Xavier Verguín González <xavyiy@gmail.com>
7 
8 This program is free software; you can redistribute it and/or modify it under
9 the terms of the GNU Lesser General Public License as published by the Free Software
10 Foundation; either version 2 of the License, or (at your option) any later
11 version.
12 
13 This program is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
16 
17 You should have received a copy of the GNU Lesser General Public License along with
18 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
19 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
20 http://www.gnu.org/copyleft/lesser.txt.
21 --------------------------------------------------------------------------------
22 */
23 
24 #ifndef _SkyX_Controller_H_
25 #define _SkyX_Controller_H_
26 
27 #include "Prerequisites.h"
28 
29 namespace SkyX
30 {
33  class Controller
34  {
35  public:
40  explicit inline Controller(const bool& deleteBySkyX)
41  : mDeleteBySkyX(deleteBySkyX)
42  {
43  }
44 
47  inline virtual ~Controller() {}
48 
55  inline virtual void update(const Ogre::Real& /*simDeltaTime*/) {}
56 
60  virtual Ogre::Vector3 getSunDirection() = 0;
61 
65  virtual Ogre::Vector3 getMoonDirection() = 0;
66 
71  virtual Ogre::Real getMoonPhase() = 0;
72 
76  inline const bool& getDeleteBySkyX() const
77  {
78  return mDeleteBySkyX;
79  }
80 
81  private:
83  bool mDeleteBySkyX;
84  };
85 }
86 
87 #endif
virtual Ogre::Vector3 getMoonDirection()=0
Get moon direction.
virtual ~Controller()
Destructor.
Definition: Controller.h:47
const bool & getDeleteBySkyX() const
Must the controller be destroyed by SkyX?
Definition: Controller.h:76
virtual void update(const Ogre::Real &)
Update controller.
Definition: Controller.h:55
SkyX(Ogre::SceneManager *sm, Controller *c)
Contructor.
Controller base class.
Definition: Controller.h:33
virtual Ogre::Vector3 getSunDirection()=0
Get sun direction.
virtual Ogre::Real getMoonPhase()=0
Get moon phase.
Controller(const bool &deleteBySkyX)
Constructor.
Definition: Controller.h:40