doxygen: bge scenegraph and videotexture
[blender-staging.git] / source / gameengine / VideoTexture / FilterNormal.h
1 /* $Id$
2 -----------------------------------------------------------------------------
3 This source file is part of blendTex library
4
5 Copyright (c) 2007 The Zdeno Ash Miklas
6
7 This program is free software; you can redistribute it and/or modify it under
8 the terms of the GNU Lesser General Public License as published by the Free Software
9 Foundation; either version 2 of the License, or (at your option) any later
10 version.
11
12 This program is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License along with
17 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
18 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
19 http://www.gnu.org/copyleft/lesser.txt.
20 -----------------------------------------------------------------------------
21 */
22
23 /** \file FilterNormal.h
24  *  \ingroup bgevideotex
25  */
26  
27 #if !defined FILTERNORMAL_H
28 #define FILTERNORMAL_H
29
30 #include "Common.h"
31
32 #include "FilterBase.h"
33
34
35 // scale constants for normals
36 const float depthScaleKoef = 255.0;
37 const float normScaleKoef = float(depthScaleKoef / 2.0);
38
39
40 /// pixel filter for normal mapping
41 class FilterNormal : public FilterBase
42 {
43 public:
44         /// constructor
45         FilterNormal (void);
46         /// destructor
47         virtual ~FilterNormal (void) {}
48
49         /// get index of color used to calculate normals
50         unsigned short getColor (void) { return m_colIdx; }
51         /// set index of color used to calculate normals
52         void setColor (unsigned short colIdx);
53
54         /// get depth
55         float getDepth (void) { return m_depth; }
56         /// set depth
57         void setDepth (float depth);
58
59 protected:
60         /// depth of normal relief
61         float m_depth;
62         /// scale to calculate normals
63         float m_depthScale;
64
65         /// color index, 0=red, 1=green, 2=blue, 3=alpha
66         unsigned short m_colIdx;
67
68         /// filter pixel, source int buffer
69         template <class SRC> unsigned int tFilter (SRC * src, short x, short y,
70                 short * size, unsigned int pixSize, unsigned int val = 0)
71         {
72                 // get value of required color
73                 int actPix = int(VT_C(val,m_colIdx));
74                 int upPix = actPix;
75                 int leftPix = actPix;
76                 // get upper and left pixel from actual pixel
77                 if (y > 0)
78                 {
79                         val = convertPrevious(src - pixSize * size[0], x, y - 1, size, pixSize);
80                         upPix = VT_C(val,m_colIdx);
81                 }
82                 if (x > 0)
83                 {
84                         val = convertPrevious(src - pixSize, x - 1, y, size, pixSize);
85                         leftPix = VT_C(val,m_colIdx);
86                 }
87                 // height differences (from blue color)
88                 float dx = (actPix - leftPix) * m_depthScale;
89                 float dy = (actPix - upPix) * m_depthScale;
90                 // normalize vector
91                 float dz = float(normScaleKoef / sqrt(dx * dx + dy * dy + 1.0));
92                 dx = dx * dz + normScaleKoef;
93                 dy = dy * dz + normScaleKoef;
94                 dz += normScaleKoef;
95                 // return normal vector converted to color
96                 VT_RGBA(val, dx, dy, dz, 0xFF);
97                 return val;
98         }
99
100         /// filter pixel, source byte buffer
101         virtual unsigned int filter (unsigned char * src, short x, short y,
102                 short * size, unsigned int pixSize, unsigned int val = 0)
103         { return tFilter(src, x, y, size, pixSize, val); }
104         /// filter pixel, source int buffer
105         virtual unsigned int filter (unsigned int * src, short x, short y,
106                 short * size, unsigned int pixSize, unsigned int val = 0)
107         { return tFilter(src, x, y, size, pixSize, val); }
108 };
109
110
111 #endif