SO3Light.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 __SO3LIGHT_H__
#define __SO3LIGHT_H__
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SO3SceneGraph/SO3NodeScol.h"
#include "SO3Renderer/SO3LightShaft.h"
 
namespace SO3
{
 
class SLight : public SNode
{
public:
  enum LightType
  {
    SO3_POINT_LIGHT       = 0,
    SO3_DIRECTIONAL_LIGHT = 1,
    SO3_SPOT_LIGHT   = 2,
    SO3_RECT_LIGHT   = 3
  };
protected:
private:
        Ogre::Light* O3Light;
  Ogre::Real mShadowFarDistance;
  SLightShaft* mLightShaft;
  bool mVolumetric;
  float mRange;
public:
  SLight(SScene* parent, const std::string& lightName);
 
  ~SLight();
 
  Ogre::Light* GetOgreLightPointer();
 
  void SetVolumetric(bool state);
 
  bool GetVolumetric();
 
  void SetDiffuseColour(const int& diffuseColor);
 
  int GetDiffuseColour();
 
  void SetSpecularColour(const int& specularColor);
 
  void SetDiffuseColour(Ogre::ColourValue color);
 
  void SetSpecularColour(Ogre::ColourValue color);
  
  int GetSpecularColour();
 
  void SetPowerScale(const float& powerScale);
 
  float GetPowerScale();
 
  void SetVisible(const bool& isVisible);
 
  bool GetVisible();
 
  void SetAttenuation(const float& range, const float& constant, const float& linear, const float& quadratic);
 
  void SetAttenuation(const float& range);
  
  Ogre::Vector4 GetAttenuation();
 
  void SetShadowFarDistance(const float& distance);
 
  void UpdateShadowFarDistance(const float& distance);
 
  void UpdateShadowFarClipDistance(const float& distance);
 
  float GetShadowFarDistance();
 
  void SetType(const LightType& type);
 
  LightType GetType();
 
  void SetSpotlightInnerAngle(const float& radianAngle);
 
  float GetSpotlightInnerAngle();
 
  void SetSpotlightOuterAngle(const float& radianAngle);
 
  float GetSpotlightOuterAngle();
 
  void SetSpotlightFalloff(const float& value);
 
  float GetSpotlightFalloff();
 
  void SetSourceSize(float x, float y);
 
  Ogre::Vector2f GetSourceSize();
 
  virtual void SetCastShadows(const bool& castShadows);
 
  virtual bool GetCastShadows();
 
  virtual void SetRenderingDistance(const float& distance);
 
  virtual float GetRenderingDistance();
 
  virtual Ogre::Vector3 GetBoundingBoxSize(const bool& childs = false);
 
  virtual Ogre::Vector3 GetBoundingBoxCenter(const bool& childs = false);
 
  virtual Ogre::Vector3 GetWorldBoundingBoxSize(const bool& childs = false);
 
  virtual Ogre::Vector3 GetWorldBoundingBoxCenter(const bool& childs = false);
protected:
private:
  SLight();
 
  void UpdateVolumetric(bool force = false);
};
 
}
 
#endif