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