SO3EnvironmentComponent.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 __SO3_ENVIRONMENT_COMPONENT_H__
#define __SO3_ENVIRONMENT_COMPONENT_H__
 
#include "SCOLBasic/SO3DataScol.h"
 
namespace SO3
{
 
class _SO3_Export SEnvironmentComponent : public SData
{
public:
protected:
  SEnvironment* parentEnvironment;
  typedef std::set<SViewPort*> ViewportList;
private:
  bool cleaned;
  bool isEnable;
  ViewportList viewportList;
 
public:
  SEnvironmentComponent(SEnvironment* parent, const std::string& environmentComponentName);
 
  virtual ~SEnvironmentComponent();
 
  virtual void Update(const Ogre::Real& updateTime)=0;
 
  virtual void UpdateCamera(SViewPort* viewport);
 
  SEnvironment* GetEnvironment();
 
  bool GetEnable();
 
  void SetEnable(const bool& enableComponent);
 
  void RegisterViewport(SViewPort* viewport);
 
  void UnregisterViewport(SViewPort* viewport);
 
  void UnregisterCamera(Ogre::Camera* cam);
protected:
  void Cleanup();
 
  ViewportList GetRegisteredViewports();
 
  virtual void SetEnableImpl(const bool& enableComponent)=0;
 
  virtual void RegisterViewportImpl(SViewPort* viewport)=0;
 
  virtual void UnregisterViewportImpl(SViewPort* viewport)=0;
 
  virtual void UnregisterCameraImpl(Ogre::Camera* cam);
private:
  SEnvironmentComponent();
};
 
}
 
#endif