SO3Environment.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OpenSpace3D
For the latest info, see http://www.openspace3d.com
 
Copyright (c) 2012 I-maginer
 
This program 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 of the License, or (at your option) any later
version.
 
This program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt
 
-----------------------------------------------------------------------------
*/
 
#ifndef __SO3ENVIRONMENT_H__
#define __SO3ENVIRONMENT_H__
 
#include "SCOLBasic/SO3DataScol.h"
#include "SO3Utils/SO3UniversalClock.h"
#include "SO3Utils/SO3DateTime.h"
#include "SO3Water.h"
#include "SO3Sky.h"
 
namespace SO3
{
 
class _SO3_Export SEnvironment : public SData,
                                 public Ogre::FrameListener,
                                 public Ogre::RenderTargetListener
{
public:
  typedef std::set<SViewPort*> ViewportList;
protected:
private:
  ViewportList viewportList;
  typedef std::map<Ogre::RenderTarget*, int> RenderTargetList;
  RenderTargetList mRenderTargetList;
  SScene* scene;
  SWater* water;
  SSky* sky;
  SSun* sun;
  SMoon* moon;
  bool paused;
  bool enabled;
  bool skyEnabled;
  bool waterEnabled;
  SUniversalClock* universalClock; 
  Ogre::Degree observerLatitude;   
  Ogre::Degree observerLongitude;  
  float windSpeed;
  Ogre::Vector2 windDirection;
  float humidityFactor;
 
public:
  SEnvironment(SScene* parent, const std::string& environmentName);
 
  ~SEnvironment();
 
  SScene* GetScene();
 
  void RegisterViewport(SViewPort* targetViewport);
 
  void UnregisterViewport(SViewPort* targetViewport);
 
  void UnregisterCamera(Ogre::Camera* cam);
 
  bool IsRegisteredViewport(SViewPort* targetViewport);
 
  bool IsRegisteredViewport(Ogre::Viewport* targetViewport);
 
  void UnregisterAllViewports();
 
  ViewportList GetRegisteredViewports();
 
  SUniversalClock* GetUniversalClock();
 
  SWater* GetWater();
 
  SSky* GetSky();
 
  SSun* GetSun();
 
  SMoon* GetMoon();
 
  bool GetEnable();
 
  void SetEnable(const bool& enableEnvironment);
 
  bool GetPaused();
 
  void SetPaused(const bool& pauseSimulation);
 
  bool GetWaterEnable();
 
  void SetWaterEnable(const bool& enableWater);
 
  bool GetSkyEnable();
 
  void SetSkyEnable(const bool& enableSky);
 
  float GetWindSpeed();
 
  void SetWindSpeed(const float& newWindSpeed);
 
  Ogre::Vector2 GetWindDirection();
 
  void SetWindDirection(const Ogre::Vector2& newWindDirection);
 
  float GetHumidity();
 
  void SetHumidity(const float& newHumidity);
 
  float GetTimeSpeedFactor();
 
  void SetTimeSpeedFactor(const float& newTimeSpeedFactor);
 
  SDateTime GetDateTime();
 
  void SetDateTime(const SDateTime& newDateTime);
 
  Ogre::Degree GetLongitude();
 
  void SetLongitude(const Ogre::Degree& newLongitude);
 
  Ogre::Degree GetLatitude();
 
  void SetLatitude(const Ogre::Degree& newLatitude);
 
  // TODO: sea level is important for sky too: offset on the altitude (in horinzontal coordinate terms) of sun for example
 
  void _NotifyEnvironmentComponentRegisterRenderTarget(Ogre::Viewport* targetViewport);
 
  void _NotifyEnvironmentComponentUnRegisterRenderTarget(Ogre::Viewport* targetViewport);
 
  void UpdateCamera(SViewPort* viewport);
 
protected:
  virtual bool frameStarted(const Ogre::FrameEvent& evt);
private:
  SEnvironment();
};
 
}
 
#endif