code cleanup: make header defines more consistent, JOYSENSOR header guard had a typo...
[blender-staging.git] / source / gameengine / Rasterizer / RAS_TexVert.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file RAS_TexVert.h
29  *  \ingroup bgerast
30  */
31
32 #ifndef __RAS_TEXVERT_H__
33 #define __RAS_TEXVERT_H__
34
35
36 #include "MT_Point3.h"
37 #include "MT_Point2.h"
38 #include "MT_Transform.h"
39
40 #ifdef WITH_CXX_GUARDEDALLOC
41 #include "MEM_guardedalloc.h"
42 #endif
43
44 static MT_Point3 g_pt3;
45 static MT_Point2 g_pt2;
46
47 class RAS_TexVert
48 {
49         
50         float                   m_localxyz[3];  // 3*4 = 12
51         float                   m_uv1[2];               // 2*4 =  8
52         float                   m_uv2[2];               // 2*4 =  8
53         unsigned int    m_rgba;                 //        4
54         float                   m_tangent[4];   // 4*4 =  16
55         float                   m_normal[3];    // 3*4 =  12
56         short                   m_flag;                 //        2
57         short                   m_softBodyIndex;                //2
58         unsigned int    m_unit;                 //                4
59         unsigned int    m_origindex;            //    4
60                                                                         //---------
61                                                                         //       56+6+8+2=72
62         // 32 bytes total size, fits nice = 56 = not fit nice.
63
64 public:
65         enum {
66                 FLAT = 1,
67                 SECOND_UV = 2,
68                 MAX_UNIT = 8
69         };
70
71         short getFlag() const;
72         unsigned int getUnit() const;
73         
74         RAS_TexVert()// :m_xyz(0,0,0),m_uv(0,0),m_rgba(0)
75         {}
76         RAS_TexVert(const MT_Point3& xyz,
77                                 const MT_Point2& uv,
78                                 const MT_Point2& uv2,
79                                 const MT_Vector4& tangent,
80                                 const unsigned int rgba,
81                                 const MT_Vector3& normal,
82                                 const bool flat,
83                                 const unsigned int origindex);
84         ~RAS_TexVert() {};
85
86         const float* getUV1 () const { 
87                 return m_uv1;
88         };
89
90         const float* getUV2 () const { 
91                 return m_uv2;
92         };
93
94         const float* getXYZ() const { 
95                 return m_localxyz;
96         };
97         
98         const float* getNormal() const {
99                 return m_normal;
100         }
101         
102         short int getSoftBodyIndex() const
103         {
104                 return m_softBodyIndex;
105         }
106         
107         void    setSoftBodyIndex(short int sbIndex)
108         {
109                 m_softBodyIndex = sbIndex;
110         }
111
112         const float* getTangent() const {
113                 return m_tangent;
114         }
115
116         const unsigned char* getRGBA() const {
117                 return (unsigned char *) &m_rgba;
118         }
119
120         unsigned int getOrigIndex() const {
121                 return m_origindex;
122         }
123
124         void                            SetXYZ(const MT_Point3& xyz);
125         void                            SetXYZ(const float *xyz);
126         void                            SetUV(const MT_Point2& uv);
127         void                            SetUV2(const MT_Point2& uv);
128
129         void                            SetRGBA(const unsigned int rgba);
130         void                            SetNormal(const MT_Vector3& normal);
131         void                            SetTangent(const MT_Vector3& tangent);
132         void                            SetFlag(const short flag);
133         void                            SetUnit(const unsigned u);
134         
135         void                            SetRGBA(const MT_Vector4& rgba);
136         const MT_Point3&        xyz();
137
138         void                            Transform(const class MT_Matrix4x4& mat,
139                                       const class MT_Matrix4x4& nmat);
140
141         // compare two vertices, to test if they can be shared, used for
142         // splitting up based on uv's, colors, etc
143         bool                            closeTo(const RAS_TexVert* other);
144
145
146 #ifdef WITH_CXX_GUARDEDALLOC
147         MEM_CXX_CLASS_ALLOC_FUNCS("GE:RAS_TexVert")
148 #endif
149 };
150
151 #endif  /* __RAS_TEXVERT_H__ */