1 // Created by: Kirill GAVRILOV
2 // Copyright (c) 2013-2014 OPEN CASCADE SAS
4 // This file is part of Open CASCADE Technology software library.
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.
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
15 #ifndef _NCollection_Vec4_H__
16 #define _NCollection_Vec4_H__
18 #include <NCollection_Vec3.hxx>
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
31 //! Returns the number of components.
37 //! Empty constructor. Construct the zero vector.
40 std::memset (this, 0, sizeof(NCollection_Vec4));
43 //! Initialize ALL components of vector within specified value.
44 explicit NCollection_Vec4 (const Element_t theValue)
46 v[0] = v[1] = v[2] = v[3] = theValue;
49 //! Per-component constructor.
50 explicit NCollection_Vec4 (const Element_t theX,
61 //! Constructor from 2-components vector.
62 explicit NCollection_Vec4 (const NCollection_Vec2<Element_t>& theVec2)
66 v[2] = v[3] = Element_t (0);
69 //! Constructor from 3-components vector.
70 explicit NCollection_Vec4(const NCollection_Vec3<Element_t>& theVec3)
72 std::memcpy (this, &theVec3, sizeof(NCollection_Vec3<Element_t>));
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>));
84 NCollection_Vec4 (const NCollection_Vec4& theVec4)
86 std::memcpy (this, &theVec4, sizeof(NCollection_Vec4));
89 //! Assignment operator.
90 const NCollection_Vec4& operator= (const NCollection_Vec4& theVec4)
92 std::memcpy (this, &theVec4, sizeof(NCollection_Vec4));
96 //! Alias to 1st component as X coordinate in XYZW.
97 Element_t x() const { return v[0]; }
99 //! Alias to 1st component as RED channel in RGBA.
100 Element_t r() const { return v[0]; }
102 //! Alias to 2nd component as Y coordinate in XYZW.
103 Element_t y() const { return v[1]; }
105 //! Alias to 2nd component as GREEN channel in RGBA.
106 Element_t g() const { return v[1]; }
108 //! Alias to 3rd component as Z coordinate in XYZW.
109 Element_t z() const { return v[2]; }
111 //! Alias to 3rd component as BLUE channel in RGBA.
112 Element_t b() const { return v[2]; }
114 //! Alias to 4th component as W coordinate in XYZW.
115 Element_t w() const { return v[3]; }
117 //! Alias to 4th component as ALPHA channel in RGBA.
118 Element_t a() const { return v[3]; }
120 //! @return 2 of XYZW components in specified order as vector in GLSL-style
121 NCOLLECTION_VEC_COMPONENTS_2D(x, y)
122 NCOLLECTION_VEC_COMPONENTS_2D(x, z)
123 NCOLLECTION_VEC_COMPONENTS_2D(x, w)
124 NCOLLECTION_VEC_COMPONENTS_2D(y, z)
125 NCOLLECTION_VEC_COMPONENTS_2D(y, w)
126 NCOLLECTION_VEC_COMPONENTS_2D(z, w)
128 //! @return 3 of XYZW components in specified order as vector in GLSL-style
129 NCOLLECTION_VEC_COMPONENTS_3D(x, y, z)
130 NCOLLECTION_VEC_COMPONENTS_3D(x, y, w)
131 NCOLLECTION_VEC_COMPONENTS_3D(x, z, w)
132 NCOLLECTION_VEC_COMPONENTS_3D(y, z, w)
134 //! @return RGB components as vector
135 NCOLLECTION_VEC_COMPONENTS_3D(r, g, b)
137 //! Alias to 1st component as X coordinate in XYZW.
138 Element_t& x() { return v[0]; }
140 //! Alias to 1st component as RED channel in RGBA.
141 Element_t& r() { return v[0]; }
143 //! Alias to 2nd component as Y coordinate in XYZW.
144 Element_t& y() { return v[1]; }
146 //! Alias to 2nd component as GREEN channel in RGBA.
147 Element_t& g() { return v[1]; } // Green color
149 //! Alias to 3rd component as Z coordinate in XYZW.
150 Element_t& z() { return v[2]; }
152 //! Alias to 3rd component as BLUE channel in RGBA.
153 Element_t& b() { return v[2]; }
155 //! Alias to 4th component as W coordinate in XYZW.
156 Element_t& w() { return v[3]; }
158 //! Alias to 4th component as ALPHA channel in RGBA.
159 Element_t& a() { return v[3]; }
161 //! @return XY-components modifiable vector
162 NCollection_Vec2<Element_t>& xy()
164 return *((NCollection_Vec2<Element_t>* )&v[0]);
167 //! @return YZ-components modifiable vector
168 NCollection_Vec2<Element_t>& yz()
170 return *((NCollection_Vec2<Element_t>* )&v[1]);
173 //! @return YZ-components modifiable vector
174 NCollection_Vec2<Element_t>& zw()
176 return *((NCollection_Vec2<Element_t>* )&v[2]);
179 //! @return XYZ-components modifiable vector
180 NCollection_Vec3<Element_t>& xyz()
182 return *((NCollection_Vec3<Element_t>* )&v[0]);
185 //! @return YZW-components modifiable vector
186 NCollection_Vec3<Element_t>& yzw()
188 return *((NCollection_Vec3<Element_t>* )&v[1]);
191 //! Raw access to the data (for OpenGL exchange).
192 const Element_t* GetData() const { return v; }
193 Element_t* ChangeData() { return v; }
194 operator const Element_t*() const { return v; }
195 operator Element_t*() { return v; }
197 //! Compute per-component summary.
198 NCollection_Vec4& operator+= (const NCollection_Vec4& theAdd)
207 //! Compute per-component summary.
208 friend NCollection_Vec4 operator+ (const NCollection_Vec4& theLeft,
209 const NCollection_Vec4& theRight)
211 NCollection_Vec4 aSumm = NCollection_Vec4 (theLeft);
212 return aSumm += theRight;
216 NCollection_Vec4 operator-() const
218 return NCollection_Vec4 (-x(), -y(), -z(), -w());
221 //! Compute per-component subtraction.
222 NCollection_Vec4& operator-= (const NCollection_Vec4& theDec)
231 //! Compute per-component subtraction.
232 friend NCollection_Vec4 operator- (const NCollection_Vec4& theLeft,
233 const NCollection_Vec4& theRight)
235 NCollection_Vec4 aSumm = NCollection_Vec4 (theLeft);
236 return aSumm -= theRight;
239 //! Compute per-component multiplication.
240 NCollection_Vec4& operator*= (const NCollection_Vec4& theRight)
242 v[0] *= theRight.v[0];
243 v[1] *= theRight.v[1];
244 v[2] *= theRight.v[2];
245 v[3] *= theRight.v[3];
249 //! Compute per-component multiplication.
250 friend NCollection_Vec4 operator* (const NCollection_Vec4& theLeft,
251 const NCollection_Vec4& theRight)
253 NCollection_Vec4 aResult = NCollection_Vec4 (theLeft);
254 return aResult *= theRight;
257 //! Compute per-component multiplication.
258 void Multiply (const Element_t theFactor)
266 //! Compute per-component multiplication.
267 NCollection_Vec4& operator*=(const Element_t theFactor)
269 Multiply (theFactor);
273 //! Compute per-component multiplication.
274 NCollection_Vec4 operator* (const Element_t theFactor) const
276 return Multiplied (theFactor);
279 //! Compute per-component multiplication.
280 NCollection_Vec4 Multiplied (const Element_t theFactor) const
282 NCollection_Vec4 aCopyVec4 (*this);
283 aCopyVec4 *= theFactor;
287 //! Compute component-wise minimum of two vectors.
288 NCollection_Vec4 cwiseMin (const NCollection_Vec4& theVec) const
290 return NCollection_Vec4 (v[0] < theVec.v[0] ? v[0] : theVec.v[0],
291 v[1] < theVec.v[1] ? v[1] : theVec.v[1],
292 v[2] < theVec.v[2] ? v[2] : theVec.v[2],
293 v[3] < theVec.v[3] ? v[3] : theVec.v[3]);
296 //! Compute component-wise maximum of two vectors.
297 NCollection_Vec4 cwiseMax (const NCollection_Vec4& theVec) const
299 return NCollection_Vec4 (v[0] > theVec.v[0] ? v[0] : theVec.v[0],
300 v[1] > theVec.v[1] ? v[1] : theVec.v[1],
301 v[2] > theVec.v[2] ? v[2] : theVec.v[2],
302 v[3] > theVec.v[3] ? v[3] : theVec.v[3]);
305 //! Compute component-wise modulus of the vector.
306 NCollection_Vec4 cwiseAbs() const
308 return NCollection_Vec4 (std::abs (v[0]),
314 //! Compute maximum component of the vector.
315 Element_t maxComp() const
317 const Element_t aMax1 = v[0] > v[1] ? v[0] : v[1];
318 const Element_t aMax2 = v[2] > v[3] ? v[2] : v[3];
320 return aMax1 > aMax2 ? aMax1 : aMax2;
323 //! Compute minimum component of the vector.
324 Element_t minComp() const
326 const Element_t aMin1 = v[0] < v[1] ? v[0] : v[1];
327 const Element_t aMin2 = v[2] < v[3] ? v[2] : v[3];
329 return aMin1 < aMin2 ? aMin1 : aMin2;
332 //! Compute per-component division by scale factor.
333 NCollection_Vec4& operator/= (const Element_t theInvFactor)
335 v[0] /= theInvFactor;
336 v[1] /= theInvFactor;
337 v[2] /= theInvFactor;
338 v[3] /= theInvFactor;
342 //! Compute per-component division by scale factor.
343 NCollection_Vec4 operator/ (const Element_t theInvFactor)
345 NCollection_Vec4 aResult(*this);
346 return aResult /= theInvFactor;
351 Element_t v[4]; //!< define the vector as array to avoid structure alignment issues
355 //! Optimized concretization for float type.
356 template<> inline NCollection_Vec4<float>& NCollection_Vec4<float>::operator/= (const float theInvFactor)
358 Multiply (1.0f / theInvFactor);
362 //! Optimized concretization for double type.
363 template<> inline NCollection_Vec4<double>& NCollection_Vec4<double>::operator/= (const double theInvFactor)
365 Multiply (1.0 / theInvFactor);
369 #endif // _NCollection_Vec4_H__