0026641: Visualization, TKOpenGl - handle correctly transformation persistence within...
[occt.git] / src / Graphic3d / Graphic3d_TransformPers.hxx
1 // Created on: 2015-06-18
2 // Created by: Anton POLETAEV
3 // Copyright (c) 2015 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _Graphic3d_TransformPers_HeaderFile
17 #define _Graphic3d_TransformPers_HeaderFile
18
19 #include <Bnd_Box.hxx>
20 #include <BVH_Box.hxx>
21 #include <Graphic3d_TransformUtils.hxx>
22 #include <Graphic3d_TransModeFlags.hxx>
23 #include <NCollection_Mat4.hxx>
24 #include <NCollection_Vec4.hxx>
25
26 //! Class for keeping and computing transformation persistence.
27 class Graphic3d_TransformPers
28 {
29 public:
30
31   DEFINE_STANDARD_ALLOC
32
33   //! Default constructor.
34   Graphic3d_TransformPers()
35   : Flags (Graphic3d_TMF_None),
36     Point (0.0, 0.0, 0.0) {}
37
38   //! Transformation persistence mode flags.
39   Graphic3d_TransModeFlags Flags;
40
41   //! Reference point for transformation.
42   Graphic3d_Vec3d Point;
43
44 public:
45
46   //! Apply transformation to bounding box of presentation.
47   //! @param theProjection [in] the projection transformation matrix.
48   //! @param theWorldView [in] the world view transformation matrix.
49   //! @param theViewportWidth [in] the width of viewport (for 2d persistence).
50   //! @param theViewportHeight [in] the height of viewport (for 2d persistence).
51   //! @param theBoundingBox [in/out] the bounding box to transform.
52   template<class T>
53   void Apply (const NCollection_Mat4<T>& theProjection,
54               const NCollection_Mat4<T>& theWorldView,
55               const Standard_Integer theViewportWidth,
56               const Standard_Integer theViewportHeight,
57               Bnd_Box& theBoundingBox) const;
58
59   //! Apply transformation to bounding box of presentation
60   //! @param theProjection [in] the projection transformation matrix.
61   //! @param theWorldView [in] the world view transformation matrix.
62   //! @param theViewportWidth [in] the width of viewport (for 2d persistence).
63   //! @param theViewportHeight [in] the height of viewport (for 2d persistence).
64   //! @param theBoundingBox [in/out] the bounding box to transform.
65   template<class T>
66   void Apply (const NCollection_Mat4<T>& theProjection,
67               const NCollection_Mat4<T>& theWorldView,
68               const Standard_Integer theViewportWidth,
69               const Standard_Integer theViewportHeight,
70               BVH_Box<T, 4>& theBoundingBox) const;
71
72   //! Compute transformation.
73   //! Computed matrix can be applied to model world transformation
74   //! of an object to implement effect of transformation persistence.
75   //! @param theProjection [in] the projection transformation matrix.
76   //! @param theWorldView [in] the world view transformation matrix.
77   //! @param theViewportWidth [in] the width of viewport (for 2d persistence).
78   //! @param theViewportHeight [in] the height of viewport (for 2d persistence).
79   //! @return transformation matrix to be applied to model world transformation of an object.
80   template<class T>
81   NCollection_Mat4<T> Compute (const NCollection_Mat4<T>& theProjection,
82                                const NCollection_Mat4<T>& theWorldView,
83                                const Standard_Integer theViewportWidth,
84                                const Standard_Integer theViewportHeight) const;
85
86   template<class T>
87   void Apply (NCollection_Mat4<T>& theProjection,
88               NCollection_Mat4<T>& theWorldView,
89               const Standard_Integer theViewportWidth,
90               const Standard_Integer theViewportHeight) const;
91 };
92
93 // =======================================================================
94 // function : Apply
95 // purpose  : Apply transformation to world view and projection matrices.
96 // =======================================================================
97 template<class T>
98 void Graphic3d_TransformPers::Apply (NCollection_Mat4<T>& theProjection,
99                                      NCollection_Mat4<T>& theWorldView,
100                                      const Standard_Integer theViewportWidth,
101                                      const Standard_Integer theViewportHeight) const
102 {
103   if (!Flags)
104   {
105     return;
106   }
107
108   if (Flags & Graphic3d_TMF_2d)
109   {
110     T aLeft   = -static_cast<T> (theViewportWidth  / 2);
111     T aRight  =  static_cast<T> (theViewportWidth  / 2);
112     T aBottom = -static_cast<T> (theViewportHeight / 2);
113     T aTop    =  static_cast<T> (theViewportHeight / 2);
114     T aGap    =  static_cast<T> (Point.z());
115     if (Point.x() > 0)
116     {
117       aLeft  -= static_cast<T> (theViewportWidth / 2) - aGap;
118       aRight -= static_cast<T> (theViewportWidth / 2) - aGap;
119     }
120     else if (Point.x() < 0)
121     {
122       aLeft  += static_cast<T> (theViewportWidth / 2) - aGap;
123       aRight += static_cast<T> (theViewportWidth / 2) - aGap;
124     }
125     if (Point.y() > 0)
126     {
127       aBottom -= static_cast<T> (theViewportHeight / 2) - aGap;
128       aTop    -= static_cast<T> (theViewportHeight / 2) - aGap;
129     }
130     else if (Point.y() < 0)
131     {
132       aBottom += static_cast<T> (theViewportHeight / 2) - aGap;
133       aTop    += static_cast<T> (theViewportHeight / 2) - aGap;
134     }
135     if (Flags == Graphic3d_TMF_2d_IsTopDown)
136     {
137       const T aTemp = aTop;
138       aTop    = aBottom;
139       aBottom = aTemp;
140     }
141
142     Graphic3d_TransformUtils::Ortho2D<T> (theProjection, aLeft, aRight, aBottom, aTop);
143
144     theWorldView.InitIdentity();
145   }
146   else
147   {
148     // Compute reference point for transformation in untransformed projection space.
149     NCollection_Vec4<T> aRefPoint (static_cast<T> (Point.x()),
150                                    static_cast<T> (Point.y()),
151                                    static_cast<T> (Point.z()),
152                                    static_cast<T> (1.0));
153     NCollection_Vec4<T> aRefPointProj;
154     if ((Flags & Graphic3d_TMF_PanPers) != Graphic3d_TMF_PanPers)
155     {
156       aRefPointProj  = theProjection * (theWorldView * aRefPoint);
157       aRefPointProj /= aRefPointProj.w();
158     }
159
160     // Prevent zooming.
161     if ((Flags == Graphic3d_TMF_TriedronPers)
162      || (Flags & Graphic3d_TMF_ZoomPers))
163     {
164       const T aSize = static_cast<T> (1.0);
165       const Standard_Integer aViewport[4] = { 0, 0, theViewportHeight, theViewportHeight };
166       NCollection_Mat4<T> aWorldView;
167       aWorldView.InitIdentity();
168
169       NCollection_Vec3<T> aWinCoordsRefPoint;
170       Graphic3d_TransformUtils::Project (static_cast<T> (Point.x()),
171                                          static_cast<T> (Point.y()),
172                                          static_cast<T> (Point.z()),
173                                          theWorldView, theProjection, aViewport,
174                                          aWinCoordsRefPoint.x(), aWinCoordsRefPoint.y(), aWinCoordsRefPoint.z());
175
176       NCollection_Vec3<T> anUnProj1;
177       Graphic3d_TransformUtils::UnProject (aWinCoordsRefPoint.x(), aWinCoordsRefPoint.y(), aWinCoordsRefPoint.z(),
178                                            aWorldView, theProjection, aViewport,
179                                            anUnProj1.x(), anUnProj1.y(), anUnProj1.z());
180
181       NCollection_Vec3<T> anUnProj2;
182       Graphic3d_TransformUtils::UnProject (aWinCoordsRefPoint.x(), aWinCoordsRefPoint.y() + aSize, aWinCoordsRefPoint.z(),
183                                            aWorldView, theProjection, aViewport,
184                                            anUnProj2.x(), anUnProj2.y(), anUnProj2.z());
185
186       const T aScale = (anUnProj2.y() - anUnProj1.y()) / aSize;
187
188       Graphic3d_TransformUtils::Scale (theWorldView, aScale, aScale, aScale);
189     }
190
191     // Prevent translation by nullifying translation component.
192     if ((Flags & Graphic3d_TMF_PanPers) || Flags == Graphic3d_TMF_TriedronPers)
193     {
194       theWorldView .SetValue (0, 3, static_cast<T> (0.0));
195       theWorldView .SetValue (1, 3, static_cast<T> (0.0));
196       theWorldView .SetValue (2, 3, static_cast<T> (0.0));
197       theProjection.SetValue (0, 3, static_cast<T> (0.0));
198       theProjection.SetValue (1, 3, static_cast<T> (0.0));
199       theProjection.SetValue (2, 3, static_cast<T> (0.0));
200     }
201
202     // Prevent rotation by nullifying rotation component.
203     if (Flags & Graphic3d_TMF_RotatePers)
204     {
205       theWorldView.SetValue (0, 0, static_cast<T> (1.0));
206       theWorldView.SetValue (1, 0, static_cast<T> (0.0));
207       theWorldView.SetValue (2, 0, static_cast<T> (0.0));
208
209       theWorldView.SetValue (0, 1, static_cast<T> (0.0));
210       theWorldView.SetValue (1, 1, static_cast<T> (1.0));
211       theWorldView.SetValue (2, 1, static_cast<T> (0.0));
212
213       theWorldView.SetValue (0, 2, static_cast<T> (0.0));
214       theWorldView.SetValue (1, 2, static_cast<T> (0.0));
215       theWorldView.SetValue (2, 2, static_cast<T> (1.0));
216     }
217
218     if (Flags == Graphic3d_TMF_TriedronPers)
219     {
220       if (Point.x() != 0.0 && Point.y() != 0.0)
221       {
222         NCollection_Mat4<T> anUnviewMat;
223
224         if (!(theProjection).Inverted (anUnviewMat))
225         {
226           Standard_ProgramError::Raise ("Graphic3d_TransformPers::Apply, can not inverse projection matrix.");
227         }
228
229         NCollection_Vec4<T> aProjMax (static_cast<T> ( 1.0), static_cast<T> ( 1.0), static_cast<T> (0.0), static_cast<T> (1.0));
230         NCollection_Vec4<T> aProjMin (static_cast<T> (-1.0), static_cast<T> (-1.0), static_cast<T> (0.0), static_cast<T> (1.0));
231         NCollection_Vec4<T> aViewMax = anUnviewMat * aProjMax;
232         NCollection_Vec4<T> aViewMin = anUnviewMat * aProjMin;
233
234         aViewMax /= aViewMax.w();
235         aViewMin /= aViewMin.w();
236
237         T aMoveX = static_cast<T> (0.5) * (aViewMax.x() - aViewMin.x() - static_cast<T> (Point.z()));
238         T aMoveY = static_cast<T> (0.5) * (aViewMax.y() - aViewMin.y() - static_cast<T> (Point.z()));
239
240         aMoveX = (Point.x() > 0.0) ? aMoveX : -aMoveX;
241         aMoveY = (Point.y() > 0.0) ? aMoveY : -aMoveY;
242
243         Graphic3d_TransformUtils::Translate<T> (theProjection, aMoveX, aMoveY, static_cast<T> (0.0));
244       }
245     }
246     else if ((Flags & Graphic3d_TMF_PanPers) != Graphic3d_TMF_PanPers)
247     {
248       NCollection_Mat4<T> anUnviewMat;
249
250       if (!(theProjection * theWorldView).Inverted (anUnviewMat))
251       {
252         Standard_ProgramError::Raise ("Graphic3d_TransformPers::Apply, can not inverse world view projection matrix.");
253       }
254
255       // Move to reference point location in transformed view projection space.
256       aRefPoint  = anUnviewMat * aRefPointProj;
257       aRefPoint /= aRefPoint.w();
258
259       Graphic3d_TransformUtils::Translate<T> (theWorldView, aRefPoint.x(), aRefPoint.y(), aRefPoint.z());
260     }
261   }
262 }
263
264 // =======================================================================
265 // function : Apply
266 // purpose  : Apply transformation to bounding box of presentation.
267 // =======================================================================
268 template<class T>
269 void Graphic3d_TransformPers::Apply (const NCollection_Mat4<T>& theProjection,
270                                      const NCollection_Mat4<T>& theWorldView,
271                                      const Standard_Integer theViewportWidth,
272                                      const Standard_Integer theViewportHeight,
273                                      Bnd_Box& theBoundingBox) const
274 {
275   T aXmin, aYmin, aZmin, aXmax, aYmax, aZmax;
276
277   theBoundingBox.Get (aXmin, aYmin, aZmin, aXmax, aYmax, aZmax);
278
279   typename BVH_Box<T, 4>::BVH_VecNt aMin (aXmin, aYmin, aZmin, static_cast<T> (1.0));
280   typename BVH_Box<T, 4>::BVH_VecNt aMax (aXmax, aYmax, aZmax, static_cast<T> (1.0));
281   BVH_Box<T, 4> aBBox (aMin, aMax);
282
283   Apply (theProjection, theWorldView, theViewportWidth, theViewportHeight, aBBox);
284
285   theBoundingBox = Bnd_Box();
286   theBoundingBox.Update (aBBox.CornerMin().x(), aBBox.CornerMin().y(), aBBox.CornerMin().z(),
287                          aBBox.CornerMax().x(), aBBox.CornerMax().y(), aBBox.CornerMax().z());
288 }
289
290 // =======================================================================
291 // function : Apply
292 // purpose  : Apply transformation to bounding box of presentation.
293 // =======================================================================
294 template<class T>
295 void Graphic3d_TransformPers::Apply (const NCollection_Mat4<T>& theProjection,
296                                      const NCollection_Mat4<T>& theWorldView,
297                                      const Standard_Integer theViewportWidth,
298                                      const Standard_Integer theViewportHeight,
299                                      BVH_Box<T, 4>& theBoundingBox) const
300 {
301   NCollection_Mat4<T> aTPers = Compute (theProjection, theWorldView, theViewportWidth, theViewportHeight);
302
303   if (aTPers.IsIdentity())
304   {
305     return;
306   }
307
308   const typename BVH_Box<T, 4>::BVH_VecNt& aMin = theBoundingBox.CornerMin();
309   const typename BVH_Box<T, 4>::BVH_VecNt& aMax = theBoundingBox.CornerMax();
310
311   typename BVH_Box<T, 4>::BVH_VecNt anArrayOfCorners[8];
312   anArrayOfCorners[0] = typename BVH_Box<T, 4>::BVH_VecNt (aMin.x(), aMin.y(), aMin.z(), static_cast<T> (1.0));
313   anArrayOfCorners[1] = typename BVH_Box<T, 4>::BVH_VecNt (aMin.x(), aMin.y(), aMax.z(), static_cast<T> (1.0));
314   anArrayOfCorners[2] = typename BVH_Box<T, 4>::BVH_VecNt (aMin.x(), aMax.y(), aMin.z(), static_cast<T> (1.0));
315   anArrayOfCorners[3] = typename BVH_Box<T, 4>::BVH_VecNt (aMin.x(), aMax.y(), aMax.z(), static_cast<T> (1.0));
316   anArrayOfCorners[4] = typename BVH_Box<T, 4>::BVH_VecNt (aMax.x(), aMin.y(), aMin.z(), static_cast<T> (1.0));
317   anArrayOfCorners[5] = typename BVH_Box<T, 4>::BVH_VecNt (aMax.x(), aMin.y(), aMax.z(), static_cast<T> (1.0));
318   anArrayOfCorners[6] = typename BVH_Box<T, 4>::BVH_VecNt (aMax.x(), aMax.y(), aMin.z(), static_cast<T> (1.0));
319   anArrayOfCorners[7] = typename BVH_Box<T, 4>::BVH_VecNt (aMax.x(), aMax.y(), aMax.z(), static_cast<T> (1.0));
320
321   theBoundingBox.Clear();
322   for (Standard_Integer anIt = 0; anIt < 8; ++anIt)
323   {
324     typename BVH_Box<T, 4>::BVH_VecNt& aCorner = anArrayOfCorners[anIt];
325     aCorner  = aTPers * aCorner;
326     aCorner /= aCorner.w();
327     theBoundingBox.Add (aCorner);
328   }
329 }
330
331 // =======================================================================
332 // function : Compute
333 // purpose  : Compute transformation.
334 // =======================================================================
335 template<class T>
336 NCollection_Mat4<T> Graphic3d_TransformPers::Compute (const NCollection_Mat4<T>& theProjection,
337                                                       const NCollection_Mat4<T>& theWorldView,
338                                                       const Standard_Integer theViewportWidth,
339                                                       const Standard_Integer theViewportHeight) const
340 {
341   if (Flags == Graphic3d_TMF_None)
342   {
343     return NCollection_Mat4<T>();
344   }
345
346   NCollection_Mat4<T> anUnviewMat;
347
348   if (!(theProjection * theWorldView).Inverted (anUnviewMat))
349   {
350     return NCollection_Mat4<T>();
351   }
352
353   NCollection_Mat4<T> aProjection (theProjection);
354   NCollection_Mat4<T> aWorldView (theWorldView);
355
356   Apply (aProjection, aWorldView, theViewportWidth, theViewportHeight);
357
358   return anUnviewMat * (aProjection * aWorldView);
359 }
360
361 #endif // _Graphic3d_TransformPers_HeaderFile