SceneLight.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLGeom/src/ICLGeom/SceneLight.h                       **
** Module : ICLGeom                                                **
** Authors: Christof Elbrechter, Matthias Esau                     **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#ifndef ICL_HAVE_OPENGL
  #ifdef WIN32
    #pragma WARNING("this header must not be included if ICL_HAVE_OPENGL is not defined")
  #else
    #warning "this header must not be included if ICL_HAVE_OPENGL is not defined"
  #endif
#else

#include <ICLUtils/CompatMacros.h>
#include <ICLGeom/GeomDefs.h>
#include <ICLUtils/Uncopyable.h>

namespace icl{
  namespace geom{
    
    class SceneObject;
    class Scene;
    class Camera;
    class SceneLightObject;


    class ICLGeom_API SceneLight : public utils::Uncopyable{

      void setupGL(const Scene &scene, const Camera &cam) const;
      
      void updatePositions(const Scene &scene, const Camera &cam) const;
      
      const int index;
      
      bool on;
      
      Vec position;
      
      bool ambientOn;
  
      bool diffuseOn;
  
      bool specularOn;
      
      //flag weather the light casts a shadow
      bool shadowOn;
      
      //flag weather the light casts a shadow
      bool twoSidedOn;
      
      GeomColor ambient;
      
      GeomColor diffuse;
      
      GeomColor specular;
      
      Vec spotDirection;
      

      float spotExponent;
      

      float spotCutoff;
      

      Vec attenuation;
  
      enum Anchor{
        WorldAnchor, 
        CamAnchor,   
        ObjectAnchor 
      } anchor; 
      
      int camAnchor;
      
      Camera *shadowCam;
      
      SceneObject *objectAnchor;
  
      SceneLightObject *lightObject;
      
      SceneLight(Scene *parent, int index);
      

      SceneLight(const SceneLight &other);
     

      public:
  
      ~SceneLight();
      
      inline SceneLightObject *getLightObject(){ return lightObject; }

      inline const SceneLightObject *getLightObject() const { return lightObject; }

      void setObjectSize(float size);
      
      friend class Scene;
  

      void setOn(bool on=true);
      
      void setAnchorToWorld();
  

      void setAnchor(SceneObject *sceneObject);
      

      void setCameraAnchor(int cameraIndex=-1);
  

      void setPosition(const Vec &position);
      
      void setAmbient(const GeomColor &color);
  
      void setDiffuse(const GeomColor &color);
      
      void setSpecular(const GeomColor &color);
      
      void setAmbientEnabled(bool on=true);
  
      void setDiffuseEnabled(bool on=true);
  
      void setSpecularEnabled(bool on=true);
      
      void setSpotDirection(const Vec &vec=Vec(0,0,-1,1));
  
      void setSpotExponent(float value=0);
  
      void setSpotCutoff(float value=180);
  
      void setAttenuation(float constant=1, float linear=0, float quadratic=0);
      
      void setShadowEnabled(bool on=true);
      
      void setTwoSidedEnabled(bool on=true);

      bool isOn() const;

      bool getShadowEnabled() const;
      
      bool getTwoSidedEnabled() const;
      
      const Camera* getShadowCam() const;
      
      Camera* getShadowCam();
      
      void setShadowCam(Camera* cam);
      
      void reset();
    };
  } // namespace geom
}

#endif