lightMapParams.h

Engine/source/lighting/common/lightMapParams.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _LIGHTMAPPARAMS_H_
25#define _LIGHTMAPPARAMS_H_
26
27#ifndef _LIGHTINFO_H_
28#include "lighting/lightInfo.h"
29#endif
30
31class LightMapParams : public LightInfoEx
32{
33public:
34   LightMapParams( LightInfo *light );
35   virtual ~LightMapParams();
36
37   /// The LightInfoEx hook type.
38   static LightInfoExType Type;
39
40   // LightInfoEx
41   virtual void set( const LightInfoEx *ex );
42   virtual const LightInfoExType& getType() const { return Type; }
43   virtual void packUpdate( BitStream *stream ) const;
44   virtual void unpackUpdate( BitStream *stream );
45
46public:
47   // We're leaving these public for easy access 
48   // for console protected fields.
49
50   bool representedInLightmap;   ///< This light is represented in lightmaps (static light, default: false)
51   LinearColorF shadowDarkenColor;     ///< The color that should be used to multiply-blend dynamic shadows onto lightmapped geometry (ignored if 'representedInLightmap' is false)
52   bool includeLightmappedGeometryInShadow; ///< This light should render lightmapped geometry during its shadow-map update (ignored if 'representedInLightmap' is false)
53};
54
55#endif
56