0031313: Foundation Classes - Dump improvement for classes
[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 #include <Standard_Dump.hxx>
20
21 //! Generic 4-components vector.
22 //! To be used as RGBA color vector or XYZW 3D-point with special W-component
23 //! for operations with projection / model view matrices.
24 //! Use this class for 3D-points carefully because declared W-component may
25 //! results in incorrect results if used without matrices.
26 template<typename Element_t>
27 class NCollection_Vec4
28 {
29
30 public:
31
32   //! Returns the number of components.
33   static int Length()
34   {
35     return 4;
36   }
37
38   //! Empty constructor. Construct the zero vector.
39   NCollection_Vec4()
40   {
41     std::memset (this, 0, sizeof(NCollection_Vec4));
42   }
43
44   //! Initialize ALL components of vector within specified value.
45   explicit NCollection_Vec4 (const Element_t theValue)
46   {
47     v[0] = v[1] = v[2] = v[3] = theValue;
48   }
49
50   //! Per-component constructor.
51   explicit NCollection_Vec4 (const Element_t theX,
52                              const Element_t theY,
53                              const Element_t theZ,
54                              const Element_t theW)
55   {
56     v[0] = theX;
57     v[1] = theY;
58     v[2] = theZ;
59     v[3] = theW;
60   }
61
62   //! Constructor from 2-components vector.
63   explicit NCollection_Vec4 (const NCollection_Vec2<Element_t>& theVec2)
64   {
65     v[0] = theVec2[0];
66     v[1] = theVec2[1];
67     v[2] = v[3] = Element_t (0);
68   }
69
70   //! Constructor from 3-components vector + optional 4th value.
71   explicit NCollection_Vec4(const NCollection_Vec3<Element_t>& theVec3, const Element_t theW = Element_t(0))
72   {
73     std::memcpy (this, &theVec3, sizeof(NCollection_Vec3<Element_t>));
74     v[3] = theW;
75   }
76
77   //! Conversion constructor (explicitly converts some 4-component vector with other element type
78   //! to a new 4-component vector with the element type Element_t,
79   //! whose elements are static_cast'ed corresponding elements of theOtherVec4 vector)
80   //! @tparam OtherElement_t the element type of the other 4-component vector theOtherVec4
81   //! @param theOtherVec4 the 4-component vector that needs to be converted
82   template <typename OtherElement_t>
83   explicit NCollection_Vec4 (const NCollection_Vec4<OtherElement_t>& theOtherVec4)
84   {
85     v[0] = static_cast<Element_t> (theOtherVec4[0]);
86     v[1] = static_cast<Element_t> (theOtherVec4[1]);
87     v[2] = static_cast<Element_t> (theOtherVec4[2]);
88     v[3] = static_cast<Element_t> (theOtherVec4[3]);
89   }
90
91   //! Assign new values to the vector.
92   void SetValues (const Element_t theX,
93                   const Element_t theY,
94                   const Element_t theZ,
95                   const Element_t theW)
96   {
97     v[0] = theX;
98     v[1] = theY;
99     v[2] = theZ;
100     v[3] = theW;
101   }
102
103   //! Assign new values as 3-component vector and a 4-th value.
104   void SetValues (const NCollection_Vec3<Element_t>& theVec3, const Element_t theW)
105   {
106     v[0] = theVec3.x();
107     v[1] = theVec3.y();
108     v[2] = theVec3.z();
109     v[3] = theW;
110   }
111
112   //! Alias to 1st component as X coordinate in XYZW.
113   Element_t x() const { return v[0]; }
114
115   //! Alias to 1st component as RED channel in RGBA.
116   Element_t r() const { return v[0]; }
117
118   //! Alias to 2nd component as Y coordinate in XYZW.
119   Element_t y() const { return v[1]; }
120
121   //! Alias to 2nd component as GREEN channel in RGBA.
122   Element_t g() const { return v[1]; }
123
124   //! Alias to 3rd component as Z coordinate in XYZW.
125   Element_t z() const { return v[2]; }
126
127   //! Alias to 3rd component as BLUE channel in RGBA.
128   Element_t b() const { return v[2]; }
129
130   //! Alias to 4th component as W coordinate in XYZW.
131   Element_t w() const { return v[3]; }
132
133   //! Alias to 4th component as ALPHA channel in RGBA.
134   Element_t a() const { return v[3]; }
135
136   //! @return 2 of XYZW components in specified order as vector in GLSL-style
137   NCOLLECTION_VEC_COMPONENTS_2D(x, y)
138   NCOLLECTION_VEC_COMPONENTS_2D(x, z)
139   NCOLLECTION_VEC_COMPONENTS_2D(x, w)
140   NCOLLECTION_VEC_COMPONENTS_2D(y, z)
141   NCOLLECTION_VEC_COMPONENTS_2D(y, w)
142   NCOLLECTION_VEC_COMPONENTS_2D(z, w)
143
144   //! @return 3 of XYZW components in specified order as vector in GLSL-style
145   NCOLLECTION_VEC_COMPONENTS_3D(x, y, z)
146   NCOLLECTION_VEC_COMPONENTS_3D(x, y, w)
147   NCOLLECTION_VEC_COMPONENTS_3D(x, z, w)
148   NCOLLECTION_VEC_COMPONENTS_3D(y, z, w)
149
150   //! @return RGB components as vector
151   NCOLLECTION_VEC_COMPONENTS_3D(r, g, b)
152
153   //! Alias to 1st component as X coordinate in XYZW.
154   Element_t& x() { return v[0]; }
155
156   //! Alias to 1st component as RED channel in RGBA.
157   Element_t& r() { return v[0]; }
158
159   //! Alias to 2nd component as Y coordinate in XYZW.
160   Element_t& y() { return v[1]; }
161
162   //! Alias to 2nd component as GREEN channel in RGBA.
163   Element_t& g() { return v[1]; } // Green color
164
165   //! Alias to 3rd component as Z coordinate in XYZW.
166   Element_t& z() { return v[2]; }
167
168   //! Alias to 3rd component as BLUE channel in RGBA.
169   Element_t& b() { return v[2]; }
170
171   //! Alias to 4th component as W coordinate in XYZW.
172   Element_t& w() { return v[3]; }
173
174   //! Alias to 4th component as ALPHA channel in RGBA.
175   Element_t& a() { return v[3]; }
176
177   //! Check this vector with another vector for equality (without tolerance!).
178   bool IsEqual (const NCollection_Vec4& theOther) const
179   {
180     return v[0] == theOther.v[0]
181         && v[1] == theOther.v[1]
182         && v[2] == theOther.v[2]
183         && v[3] == theOther.v[3];
184   }
185
186   //! Check this vector with another vector for equality (without tolerance!).
187   bool operator== (const NCollection_Vec4& theOther)       { return IsEqual (theOther); }
188   bool operator== (const NCollection_Vec4& theOther) const { return IsEqual (theOther); }
189
190   //! Check this vector with another vector for non-equality (without tolerance!).
191   bool operator!= (const NCollection_Vec4& theOther)       { return !IsEqual (theOther); }
192   bool operator!= (const NCollection_Vec4& theOther) const { return !IsEqual (theOther); }
193
194   //! Raw access to the data (for OpenGL exchange).
195   const Element_t* GetData()    const { return v; }
196         Element_t* ChangeData()       { return v; }
197   operator const   Element_t*() const { return v; }
198   operator         Element_t*()       { return v; }
199
200   //! Compute per-component summary.
201   NCollection_Vec4& operator+= (const NCollection_Vec4& theAdd)
202   {
203     v[0] += theAdd.v[0];
204     v[1] += theAdd.v[1];
205     v[2] += theAdd.v[2];
206     v[3] += theAdd.v[3];
207     return *this;
208   }
209
210   //! Compute per-component summary.
211   friend NCollection_Vec4 operator+ (const NCollection_Vec4& theLeft,
212                                      const NCollection_Vec4& theRight)
213   {
214     NCollection_Vec4 aSumm = NCollection_Vec4 (theLeft);
215     return aSumm += theRight;
216   }
217
218   //! Unary -.
219   NCollection_Vec4 operator-() const
220   {
221     return NCollection_Vec4 (-x(), -y(), -z(), -w());
222   }
223
224   //! Compute per-component subtraction.
225   NCollection_Vec4& operator-= (const NCollection_Vec4& theDec)
226   {
227     v[0] -= theDec.v[0];
228     v[1] -= theDec.v[1];
229     v[2] -= theDec.v[2];
230     v[3] -= theDec.v[3];
231     return *this;
232   }
233
234   //! Compute per-component subtraction.
235   friend NCollection_Vec4 operator- (const NCollection_Vec4& theLeft,
236                                      const NCollection_Vec4& theRight)
237   {
238     NCollection_Vec4 aSumm = NCollection_Vec4 (theLeft);
239     return aSumm -= theRight;
240   }
241
242   //! Compute per-component multiplication.
243   NCollection_Vec4& operator*= (const NCollection_Vec4& theRight)
244   {
245     v[0] *= theRight.v[0];
246     v[1] *= theRight.v[1];
247     v[2] *= theRight.v[2];
248     v[3] *= theRight.v[3];
249     return *this;
250   }
251
252   //! Compute per-component multiplication.
253   friend NCollection_Vec4 operator* (const NCollection_Vec4& theLeft,
254                                      const NCollection_Vec4& theRight)
255   {
256     NCollection_Vec4 aResult = NCollection_Vec4 (theLeft);
257     return aResult *= theRight;
258   }
259
260   //! Compute per-component multiplication.
261   void Multiply (const Element_t theFactor)
262   {
263     v[0] *= theFactor;
264     v[1] *= theFactor;
265     v[2] *= theFactor;
266     v[3] *= theFactor;
267   }
268
269   //! Compute per-component multiplication.
270   NCollection_Vec4& operator*=(const Element_t theFactor)
271   {
272     Multiply (theFactor);
273     return *this;
274   }
275
276   //! Compute per-component multiplication.
277   NCollection_Vec4 operator* (const Element_t theFactor) const
278   {
279     return Multiplied (theFactor);
280   }
281
282   //! Compute per-component multiplication.
283   NCollection_Vec4 Multiplied (const Element_t theFactor) const
284   {
285     NCollection_Vec4 aCopyVec4 (*this);
286     aCopyVec4 *= theFactor;
287     return aCopyVec4;
288   }
289
290   //! Compute component-wise minimum of two vectors.
291   NCollection_Vec4 cwiseMin (const NCollection_Vec4& theVec) const
292   {
293     return NCollection_Vec4 (v[0] < theVec.v[0] ? v[0] : theVec.v[0],
294                              v[1] < theVec.v[1] ? v[1] : theVec.v[1],
295                              v[2] < theVec.v[2] ? v[2] : theVec.v[2],
296                              v[3] < theVec.v[3] ? v[3] : theVec.v[3]);
297   }
298
299   //! Compute component-wise maximum of two vectors.
300   NCollection_Vec4 cwiseMax (const NCollection_Vec4& theVec) const
301   {
302     return NCollection_Vec4 (v[0] > theVec.v[0] ? v[0] : theVec.v[0],
303                              v[1] > theVec.v[1] ? v[1] : theVec.v[1],
304                              v[2] > theVec.v[2] ? v[2] : theVec.v[2],
305                              v[3] > theVec.v[3] ? v[3] : theVec.v[3]);
306   }
307
308   //! Compute component-wise modulus of the vector.
309   NCollection_Vec4 cwiseAbs() const
310   {
311     return NCollection_Vec4 (std::abs (v[0]),
312                              std::abs (v[1]),
313                              std::abs (v[2]),
314                              std::abs (v[3]));
315   }
316
317   //! Compute maximum component of the vector.
318   Element_t maxComp() const
319   {
320     const Element_t aMax1 = v[0] > v[1] ? v[0] : v[1];
321     const Element_t aMax2 = v[2] > v[3] ? v[2] : v[3];
322
323     return aMax1 > aMax2 ? aMax1 : aMax2;
324   }
325
326   //! Compute minimum component of the vector.
327   Element_t minComp() const
328   {
329     const Element_t aMin1 = v[0] < v[1] ? v[0] : v[1];
330     const Element_t aMin2 = v[2] < v[3] ? v[2] : v[3];
331
332     return aMin1 < aMin2 ? aMin1 : aMin2;
333   }
334
335   //! Computes the dot product.
336   Element_t Dot (const NCollection_Vec4& theOther) const
337   {
338     return x() * theOther.x() +
339            y() * theOther.y() +
340            z() * theOther.z() +
341            w() * theOther.w();
342   }
343
344   //! Compute per-component division by scale factor.
345   NCollection_Vec4& operator/= (const Element_t theInvFactor)
346   {
347     v[0] /= theInvFactor;
348     v[1] /= theInvFactor;
349     v[2] /= theInvFactor;
350     v[3] /= theInvFactor;
351     return *this;
352   }
353
354   //! Compute per-component division.
355   NCollection_Vec4& operator/= (const NCollection_Vec4& theRight)
356   {
357     v[0] /= theRight.v[0];
358     v[1] /= theRight.v[1];
359     v[2] /= theRight.v[2];
360     v[3] /= theRight.v[3];
361     return *this;
362   }
363
364   //! Compute per-component division by scale factor.
365   NCollection_Vec4 operator/ (const Element_t theInvFactor)
366   {
367     NCollection_Vec4 aResult(*this);
368     return aResult /= theInvFactor;
369   }
370
371   //! Compute per-component division.
372   friend NCollection_Vec4 operator/ (const NCollection_Vec4& theLeft,
373                                      const NCollection_Vec4& theRight)
374   {
375     NCollection_Vec4 aResult = NCollection_Vec4 (theLeft);
376     return aResult /= theRight;
377   }
378
379   //! Dumps the content of me into the stream
380   void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const
381   {
382     (void)theDepth;
383     OCCT_DUMP_FIELD_VALUES_NUMERICAL (theOStream, "Vec4", 4, v[0], v[1], v[2], v[3])
384   }
385
386 private:
387
388   Element_t v[4]; //!< define the vector as array to avoid structure alignment issues
389
390 };
391
392 //! Optimized concretization for float type.
393 template<> inline NCollection_Vec4<float>& NCollection_Vec4<float>::operator/= (const float theInvFactor)
394 {
395   Multiply (1.0f / theInvFactor);
396   return *this;
397 }
398
399 //! Optimized concretization for double type.
400 template<> inline NCollection_Vec4<double>& NCollection_Vec4<double>::operator/= (const double theInvFactor)
401 {
402   Multiply (1.0 / theInvFactor);
403   return *this;
404 }
405
406 #endif // _NCollection_Vec4_H__