fogStructs.h

Engine/source/scene/fogStructs.h

More...

Classes:

class

The aerial fog settings.

class

The water fog settings.

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 _FOGSTRUCTS_H_
25#define _FOGSTRUCTS_H_
26
27/// The aerial fog settings.
28struct FogData
29{   
30   F32 density;
31   F32 densityOffset;
32   F32 atmosphereHeight;
33   LinearColorF color;
34
35   FogData()
36   {
37      density = 0.0f;
38      densityOffset = 0.0f;
39      atmosphereHeight = 0.0f;
40      color.set( 0.5f, 0.5f, 0.5f, 1.0f );
41   }
42};
43
44
45/// The water fog settings.
46struct WaterFogData
47{   
48   F32 density;
49   F32 densityOffset;   
50   F32 wetDepth;
51   F32 wetDarkening;
52   ColorI color;
53   PlaneF plane;
54   F32 depthGradMax;
55
56   WaterFogData()
57   {
58      density = 0.0f;
59      densityOffset = 0.0f;     
60      wetDepth = 0.0f;
61      wetDarkening = 0.0f;
62      color = ColorI(128, 128, 128, 128);
63      plane.set( 0.0f, 0.0f, 1.0f, 1e10 ); // Default to global bounds distance
64      depthGradMax = 0.0f;
65   }
66};
67
68#endif // _FOGSTRUCTS_H_
69