simgear/scene/tgdb/pt_lights.hxx

   1 // pt_lights.hxx -- build a 'directional' light on the fly
   2 //
   3 // Written by Curtis Olson, started March 2002.
   4 //
   5 // Copyright (C) 2002  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _SG_PT_LIGHTS_HXX
  25 #define _SG_PT_LIGHTS_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32
  33 #include <simgear/compiler.h>
  34
  35 #include STL_STRING
  36 #include <vector>               // STL
  37
  38 #include <plib/sg.h>
  39 #include <plib/ssg.h>           // plib include
  40
  41 #include <simgear/math/sg_types.hxx>
  42 #include <simgear/scene/material/matlib.hxx>
  43
  44 SG_USING_STD(string);
  45 SG_USING_STD(vector);
  46
  47
  48 typedef vector < int > int_list;
  49 typedef int_list::iterator int_list_iterator;
  50 typedef int_list::const_iterator int_point_list_iterator;
  51
  52
  53 // Generate a directional light.  This routines creates a
  54 // 'directional' light that can only be viewed from within 90 degrees
  55 // of the specified dir vector.
  56
  57 // To accomplish this, he routine creates a triangle with the 1st
  58 // point coincident with the specified pt and the 2nd and 3rd points
  59 // extending upward.  The 1st point is created with an 'alpha' value
  60 // of 1 while the 2nd and 3rd points are created with an 'alpha' of
  61 // 0.0.
  62
  63 // If the triangle is drawn in glPolygonMode(GL_FRONT, GL_POINT) mode,
  64 // then two important things happen:
  65
  66 // 1) Only the 3 vertex points are drawn, the 2nd two with an alpha of
  67 // 0 so actually only the desired point is rendered.
  68
  69 // 2) since we are drawing a triangle, back face culling takes care of
  70 // eliminating this poing when the view angle relative to dir is
  71 // greater than 90 degrees.
  72
  73 // The final piece of this puzzle is that if we now use environment
  74 // mapping on this point, via an appropriate texture we can then
  75 // control the intensity and color of the point based on the view
  76 // angle relative to 'dir' the optimal view direction of the light
  77 // (i.e. the direction the light is pointing.)
  78
  79 // Yes this get's to be long and convoluted.  If you can suggest a
  80 // simpler way, please do! :-)
  81
  82 ssgLeaf *sgMakeDirectionalLight( sgVec3 pt, sgVec3 dir, sgVec3 up );
  83
  84
  85 ssgBranch *sgMakeDirectionalLights( const point_list &nodes,
  86                                     const point_list &normals,
  87                                     const int_list &pnt_i,
  88                                     const int_list &nml_i,
  89                                     SGMaterialLib *matlib,
  90                                     const string &material,
  91                                     sgdVec3 dup );
  92
  93
  94 #endif // _SG_PT_LIGHTS_HXX