0027787: Visualization, TKOpenGl - Optimize rendering by additional check whether...
[occt.git] / src / NCollection / NCollection_Vec4.hxx
1 // Created by: Kirill GAVRILOV
2 // Copyright (c) 2013-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _NCollection_Vec4_H__
16 #define _NCollection_Vec4_H__
17
18 #include <NCollection_Vec3.hxx>
19
20 //! Generic 4-components vector.
21 //! To be used as RGBA color vector or XYZW 3D-point with special W-component
22 //! for operations with projection / model view matrices.
23 //! Use this class for 3D-points carefully because declared W-component may
24 //! results in incorrect results if used without matrices.
25 template<typename Element_t>
26 class NCollection_Vec4
27 {
28
29 public:
30
31   //! Returns the number of components.
32   static int Length()
33   {
34     return 4;
35   }
36
37   //! Empty constructor. Construct the zero vector.
38   NCollection_Vec4()
39   {
40     std::memset (this, 0, sizeof(NCollection_Vec4));
41   }
42
43   //! Initialize ALL components of vector within specified value.
44   explicit NCollection_Vec4 (const Element_t theValue)
45   {
46     v[0] = v[1] = v[2] = v[3] = theValue;
47   }
48
49   //! Per-component constructor.
50   explicit NCollection_Vec4 (const Element_t theX,
51                              const Element_t theY,
52                              const Element_t theZ,
53                              const Element_t theW)
54   {
55     v[0] = theX;
56     v[1] = theY;
57     v[2] = theZ;
58     v[3] = theW;
59   }
60
61   //! Constructor from 2-components vector.
62   explicit NCollection_Vec4 (const NCollection_Vec2<Element_t>& theVec2)
63   {
64     v[0] = theVec2[0];
65     v[1] = theVec2[1];
66     v[2] = v[3] = Element_t (0);
67   }
68
69   //! Constructor from 3-components vector.
70   explicit NCollection_Vec4(const NCollection_Vec3<Element_t>& theVec3)
71   {
72     std::memcpy (this, &theVec3, sizeof(NCollection_Vec3<Element_t>));
73     v[3] = Element_t (0);
74   }
75
76   //! Constructor from 3-components vector + alpha value.
77   explicit NCollection_Vec4(const NCollection_Vec3<Element_t>& theVec3,
78                             const Element_t                    theAlpha) {
79     std::memcpy (this, &theVec3, sizeof(NCollection_Vec3<Element_t>));
80     v[3] = theAlpha;
81   }
82
83   //! Alias to 1st component as X coordinate in XYZW.
84   Element_t x() const { return v[0]; }
85
86   //! Alias to 1st component as RED channel in RGBA.
87   Element_t r() const { return v[0]; }
88
89   //! Alias to 2nd component as Y coordinate in XYZW.
90   Element_t y() const { return v[1]; }
91
92   //! Alias to 2nd component as GREEN channel in RGBA.
93   Element_t g() const { return v[1]; }
94
95   //! Alias to 3rd component as Z coordinate in XYZW.
96   Element_t z() const { return v[2]; }
97
98   //! Alias to 3rd component as BLUE channel in RGBA.
99   Element_t b() const { return v[2]; }
100
101   //! Alias to 4th component as W coordinate in XYZW.
102   Element_t w() const { return v[3]; }
103
104   //! Alias to 4th component as ALPHA channel in RGBA.
105   Element_t a() const { return v[3]; }
106
107   //! @return 2 of XYZW components in specified order as vector in GLSL-style
108   NCOLLECTION_VEC_COMPONENTS_2D(x, y)
109   NCOLLECTION_VEC_COMPONENTS_2D(x, z)
110   NCOLLECTION_VEC_COMPONENTS_2D(x, w)
111   NCOLLECTION_VEC_COMPONENTS_2D(y, z)
112   NCOLLECTION_VEC_COMPONENTS_2D(y, w)
113   NCOLLECTION_VEC_COMPONENTS_2D(z, w)
114
115   //! @return 3 of XYZW components in specified order as vector in GLSL-style
116   NCOLLECTION_VEC_COMPONENTS_3D(x, y, z)
117   NCOLLECTION_VEC_COMPONENTS_3D(x, y, w)
118   NCOLLECTION_VEC_COMPONENTS_3D(x, z, w)
119   NCOLLECTION_VEC_COMPONENTS_3D(y, z, w)
120
121   //! @return RGB components as vector
122   NCOLLECTION_VEC_COMPONENTS_3D(r, g, b)
123
124   //! Alias to 1st component as X coordinate in XYZW.
125   Element_t& x() { return v[0]; }
126
127   //! Alias to 1st component as RED channel in RGBA.
128   Element_t& r() { return v[0]; }
129
130   //! Alias to 2nd component as Y coordinate in XYZW.
131   Element_t& y() { return v[1]; }
132
133   //! Alias to 2nd component as GREEN channel in RGBA.
134   Element_t& g() { return v[1]; } // Green color
135
136   //! Alias to 3rd component as Z coordinate in XYZW.
137   Element_t& z() { return v[2]; }
138
139   //! Alias to 3rd component as BLUE channel in RGBA.
140   Element_t& b() { return v[2]; }
141
142   //! Alias to 4th component as W coordinate in XYZW.
143   Element_t& w() { return v[3]; }
144
145   //! Alias to 4th component as ALPHA channel in RGBA.
146   Element_t& a() { return v[3]; }
147
148   //! @return XY-components modifiable vector
149   NCollection_Vec2<Element_t>& xy()
150   {
151     return *((NCollection_Vec2<Element_t>* )&v[0]);
152   }
153
154   //! @return YZ-components modifiable vector
155   NCollection_Vec2<Element_t>& yz()
156   {
157     return *((NCollection_Vec2<Element_t>* )&v[1]);
158   }
159
160   //! @return YZ-components modifiable vector
161   NCollection_Vec2<Element_t>& zw()
162   {
163     return *((NCollection_Vec2<Element_t>* )&v[2]);
164   }
165
166   //! @return XYZ-components modifiable vector
167   NCollection_Vec3<Element_t>& xyz()
168   {
169     return *((NCollection_Vec3<Element_t>* )&v[0]);
170   }
171
172   //! @return YZW-components modifiable vector
173   NCollection_Vec3<Element_t>& yzw()
174   {
175     return *((NCollection_Vec3<Element_t>* )&v[1]);
176   }
177
178   //! Raw access to the data (for OpenGL exchange).
179   const Element_t* GetData()    const { return v; }
180         Element_t* ChangeData()       { return v; }
181   operator const   Element_t*() const { return v; }
182   operator         Element_t*()       { return v; }
183
184   //! Compute per-component summary.
185   NCollection_Vec4& operator+= (const NCollection_Vec4& theAdd)
186   {
187     v[0] += theAdd.v[0];
188     v[1] += theAdd.v[1];
189     v[2] += theAdd.v[2];
190     v[3] += theAdd.v[3];
191     return *this;
192   }
193
194   //! Compute per-component summary.
195   friend NCollection_Vec4 operator+ (const NCollection_Vec4& theLeft,
196                                      const NCollection_Vec4& theRight)
197   {
198     NCollection_Vec4 aSumm = NCollection_Vec4 (theLeft);
199     return aSumm += theRight;
200   }
201
202   //! Unary -.
203   NCollection_Vec4 operator-() const
204   {
205     return NCollection_Vec4 (-x(), -y(), -z(), -w());
206   }
207
208   //! Compute per-component subtraction.
209   NCollection_Vec4& operator-= (const NCollection_Vec4& theDec)
210   {
211     v[0] -= theDec.v[0];
212     v[1] -= theDec.v[1];
213     v[2] -= theDec.v[2];
214     v[3] -= theDec.v[3];
215     return *this;
216   }
217
218   //! Compute per-component subtraction.
219   friend NCollection_Vec4 operator- (const NCollection_Vec4& theLeft,
220                                      const NCollection_Vec4& theRight)
221   {
222     NCollection_Vec4 aSumm = NCollection_Vec4 (theLeft);
223     return aSumm -= theRight;
224   }
225
226   //! Compute per-component multiplication.
227   NCollection_Vec4& operator*= (const NCollection_Vec4& theRight)
228   {
229     v[0] *= theRight.v[0];
230     v[1] *= theRight.v[1];
231     v[2] *= theRight.v[2];
232     v[3] *= theRight.v[3];
233     return *this;
234   }
235
236   //! Compute per-component multiplication.
237   friend NCollection_Vec4 operator* (const NCollection_Vec4& theLeft,
238                                      const NCollection_Vec4& theRight)
239   {
240     NCollection_Vec4 aResult = NCollection_Vec4 (theLeft);
241     return aResult *= theRight;
242   }
243
244   //! Compute per-component multiplication.
245   void Multiply (const Element_t theFactor)
246   {
247     v[0] *= theFactor;
248     v[1] *= theFactor;
249     v[2] *= theFactor;
250     v[3] *= theFactor;
251   }
252
253   //! Compute per-component multiplication.
254   NCollection_Vec4& operator*=(const Element_t theFactor)
255   {
256     Multiply (theFactor);
257     return *this;
258   }
259
260   //! Compute per-component multiplication.
261   NCollection_Vec4 operator* (const Element_t theFactor) const
262   {
263     return Multiplied (theFactor);
264   }
265
266   //! Compute per-component multiplication.
267   NCollection_Vec4 Multiplied (const Element_t theFactor) const
268   {
269     NCollection_Vec4 aCopyVec4 (*this);
270     aCopyVec4 *= theFactor;
271     return aCopyVec4;
272   }
273
274   //! Compute component-wise minimum of two vectors.
275   NCollection_Vec4 cwiseMin (const NCollection_Vec4& theVec) const
276   {
277     return NCollection_Vec4 (v[0] < theVec.v[0] ? v[0] : theVec.v[0],
278                              v[1] < theVec.v[1] ? v[1] : theVec.v[1],
279                              v[2] < theVec.v[2] ? v[2] : theVec.v[2],
280                              v[3] < theVec.v[3] ? v[3] : theVec.v[3]);
281   }
282
283   //! Compute component-wise maximum of two vectors.
284   NCollection_Vec4 cwiseMax (const NCollection_Vec4& theVec) const
285   {
286     return NCollection_Vec4 (v[0] > theVec.v[0] ? v[0] : theVec.v[0],
287                              v[1] > theVec.v[1] ? v[1] : theVec.v[1],
288                              v[2] > theVec.v[2] ? v[2] : theVec.v[2],
289                              v[3] > theVec.v[3] ? v[3] : theVec.v[3]);
290   }
291
292   //! Compute component-wise modulus of the vector.
293   NCollection_Vec4 cwiseAbs() const
294   {
295     return NCollection_Vec4 (std::abs (v[0]),
296                              std::abs (v[1]),
297                              std::abs (v[2]),
298                              std::abs (v[3]));
299   }
300
301   //! Compute maximum component of the vector.
302   Element_t maxComp() const
303   {
304     const Element_t aMax1 = v[0] > v[1] ? v[0] : v[1];
305     const Element_t aMax2 = v[2] > v[3] ? v[2] : v[3];
306
307     return aMax1 > aMax2 ? aMax1 : aMax2;
308   }
309
310   //! Compute minimum component of the vector.
311   Element_t minComp() const
312   {
313     const Element_t aMin1 = v[0] < v[1] ? v[0] : v[1];
314     const Element_t aMin2 = v[2] < v[3] ? v[2] : v[3];
315
316     return aMin1 < aMin2 ? aMin1 : aMin2;
317   }
318
319   //! Computes the dot product.
320   Element_t Dot (const NCollection_Vec4& theOther) const
321   {
322     return x() * theOther.x() +
323            y() * theOther.y() +
324            z() * theOther.z() +
325            w() * theOther.w();
326   }
327
328   //! Compute per-component division by scale factor.
329   NCollection_Vec4& operator/= (const Element_t theInvFactor)
330   {
331     v[0] /= theInvFactor;
332     v[1] /= theInvFactor;
333     v[2] /= theInvFactor;
334     v[3] /= theInvFactor;
335     return *this;
336   }
337
338   //! Compute per-component division by scale factor.
339   NCollection_Vec4 operator/ (const Element_t theInvFactor)
340   {
341     NCollection_Vec4 aResult(*this);
342     return aResult /= theInvFactor;
343   }
344
345 private:
346
347   Element_t v[4]; //!< define the vector as array to avoid structure alignment issues
348
349 };
350
351 //! Optimized concretization for float type.
352 template<> inline NCollection_Vec4<float>& NCollection_Vec4<float>::operator/= (const float theInvFactor)
353 {
354   Multiply (1.0f / theInvFactor);
355   return *this;
356 }
357
358 //! Optimized concretization for double type.
359 template<> inline NCollection_Vec4<double>& NCollection_Vec4<double>::operator/= (const double theInvFactor)
360 {
361   Multiply (1.0 / theInvFactor);
362   return *this;
363 }
364
365 #endif // _NCollection_Vec4_H__