source/materials/lighting.h

   1 #ifndef MSP_GL_LIGHTING_H_
   2 #define MSP_GL_LIGHTING_H_
   3
   4 #include <vector>
   5 #include <msp/geometry/angle.h>
   6 #include "color.h"
   7 #include "gl.h"
   8 #include "programdata.h"
   9
  10 namespace Msp {
  11 namespace GL {
  12
  13 class Light;
  14
  15 /**
  16 Encapsulates global lighting parameters and any number of individual light
  17 sources.
  18 */
  19 class Lighting
  20 {
  21 public:
  22         class Loader: public DataFile::ObjectLoader<Lighting>
  23         {
  24         private:
  25                 static ActionMap shared_actions;
  26
  27         public:
  28                 Loader(Lighting &);
  29
  30         private:
  31                 virtual void init_actions();
  32
  33                 void ambient(float, float, float);
  34                 void fog_color(float, float, float);
  35                 void fog_density(float);
  36                 void fog_half_distance(float);
  37                 void horizon_angle(float);
  38                 void light(unsigned);
  39                 void sky_color(float, float, float);
  40                 void zenith_direction(float, float, float);
  41         };
  42
  43 private:
  44         Color ambient;
  45         Color sky_color;
  46         Vector3 zenith_direction;
  47         Geometry::Angle<float> horizon_angle;
  48         Color fog_color;
  49         float fog_density;
  50         std::vector<const Light *> lights;
  51         std::vector<Light *> owned_data;
  52
  53 public:
  54         Lighting();
  55         ~Lighting();
  56
  57         /** Sets the ambient lighting color.  Affects all surfaces in the scene. */
  58         void set_ambient(const Color &);
  59
  60         const Color &get_ambient() const { return ambient; }
  61
  62         /** Sets the color of the sky at zenith.  Has no effect without shaders. */
  63         void set_sky_color(const Color &);
  64
  65         /** Sets the direction of the zenith.  Defaults to positive Z axis.  Has no
  66         effect without shaders. */
  67         void set_zenith_direction(const Vector3 &);
  68
  69         /** Sets the angle where skylight cuts off, counted from the true horizon.
  70         Has no effect without shaders. */
  71         void set_horizon_angle(const Geometry::Angle<float> &);
  72
  73         /** Sets the fog color, which is blended into distant surfaces. */
  74         void set_fog_color(const Color &);
  75
  76         /** Sets the density of the fog.  Zero means no fog. */
  77         void set_fog_density(float);
  78
  79         /** Sets the density of the fog so that the blending factor at the given
  80         distance is 50%. */
  81         void set_fog_half_distance(float);
  82
  83         /** Attaches a light source. */
  84         void attach(unsigned, const Light &);
  85
  86         /** Detaches a light source. */
  87         void detach(unsigned);
  88
  89         /** Returns an attached light.  If no light is attached at that index, null
  90         is returned. */
  91         const Light *get_attached_light(unsigned) const;
  92
  93         /** Updates a ProgramData object with the uniforms for the Lighting,
  94         including all attached light sources.  A view matrix must be passed in. */
  95         void update_shader_data(ProgramData &, const Matrix &) const;
  96 };
  97
  98 } // namespace GL
  99 } // namespace Msp
 100
 101 #endif