CDirectionalLight.h
Go to the documentation of this file.
1 //==============================================================================
2 /*
3  Software License Agreement (BSD License)
4  Copyright (c) 2003-2016, CHAI3D.
5  (www.chai3d.org)
6 
7  All rights reserved.
8 
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions
11  are met:
12 
13  * Redistributions of source code must retain the above copyright
14  notice, this list of conditions and the following disclaimer.
15 
16  * Redistributions in binary form must reproduce the above
17  copyright notice, this list of conditions and the following
18  disclaimer in the documentation and/or other materials provided
19  with the distribution.
20 
21  * Neither the name of CHAI3D nor the names of its contributors may
22  be used to endorse or promote products derived from this software
23  without specific prior written permission.
24 
25  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  POSSIBILITY OF SUCH DAMAGE.
37 
38  \author <http://www.chai3d.org>
39  \author Francois Conti
40  \version 3.2.0 $Rev: 1869 $
41 */
42 //==============================================================================
43 
44 //------------------------------------------------------------------------------
45 #ifndef CDirectionalLightH
46 #define CDirectionalLightH
47 //------------------------------------------------------------------------------
48 #include "lighting/CGenericLight.h"
49 //------------------------------------------------------------------------------
50 
51 //------------------------------------------------------------------------------
52 namespace chai3d {
53 //------------------------------------------------------------------------------
54 
55 //==============================================================================
62 //==============================================================================
63 
64 //==============================================================================
80 //==============================================================================
81 class cDirectionalLight : public virtual cGenericLight
82 {
83  friend class cCamera;
84 
85  //--------------------------------------------------------------------------
86  // CONSTRUCTOR & DESTRUCTOR:
87  //--------------------------------------------------------------------------
88 
89 public:
90 
92  cDirectionalLight(cWorld* a_world);
93 
95  virtual ~cDirectionalLight();
96 
97 
98  //-----------------------------------------------------------------------
99  // PUBLIC METHODS:
100  //-----------------------------------------------------------------------
101 
102 public:
103 
105  void setDir(const cVector3d& a_direction);
106 
108  void setDir(const double a_x, const double a_y, const double a_z);
109 
111  cVector3d getDir() const { return (m_globalRot.getCol0()); }
112 
113 
114  //-----------------------------------------------------------------------
115  // VIRTUAL PROTECTED METHODS:
116  //-----------------------------------------------------------------------
117 
118 protected:
119 
121  virtual void renderLightSource(cRenderOptions& a_options);
122 
124  virtual void render(cRenderOptions& a_options){}
125 };
126 
127 //------------------------------------------------------------------------------
128 } // namespace chai3d
129 //------------------------------------------------------------------------------
130 
131 //------------------------------------------------------------------------------
132 #endif
133 //------------------------------------------------------------------------------
134 
This class implements a 3D vector.
Definition: CVector3d.h:88
Implements a base class for light sources.
This structures provide a containers for storing rendering options that are passed through the sceneg...
Definition: CRenderOptions.h:82
cVector3d getCol0() const
This method returns column vector 0 of matrix.
Definition: CMatrix3d.h:536
virtual void renderLightSource(cRenderOptions &a_options)
This method renders the lighting properties of this light source using OpenGL.
Definition: CDirectionalLight.cpp:144
void setDir(const cVector3d &a_direction)
This method sets the direction of the light beam.
Definition: CDirectionalLight.cpp:83
This class implements a base class for modeling light sources.
Definition: CGenericLight.h:79
This class implements a virtual world.
Definition: CWorld.h:92
virtual void render(cRenderOptions &a_options)
This method renders a graphical representation (display model) of the light source. (used for debugging purposes typically).
Definition: CDirectionalLight.h:124
cMatrix3d m_globalRot
The rotation matrix that rotates my reference frame into the world&#39;s reference frame.
Definition: CGenericObject.h:758
cVector3d getDir() const
This method returns the direction of the light beam.
Definition: CDirectionalLight.h:111
cDirectionalLight(cWorld *a_world)
Constructor of cDirectionalLight.
Definition: CDirectionalLight.cpp:59
This class implements a virtual camera.
Definition: CCamera.h:110
virtual ~cDirectionalLight()
Destructor of cDirectionalLight.
Definition: CDirectionalLight.cpp:71
Definition: CAudioBuffer.cpp:56
This class implements a directional light source.
Definition: CDirectionalLight.h:81