0031087: Configuration - make FreeType dependency optional [part 2]
[occt.git] / src / ViewerTest / ViewerTest_ContinuousRedrawer.hxx
1 // Copyright (c) 2019-2020 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _ViewerTest_ContinuousRedrawer_HeaderFile
15 #define _ViewerTest_ContinuousRedrawer_HeaderFile
16
17 #include <OSD_Thread.hxx>
18 #include <Standard_Condition.hxx>
19 #include <Standard_Mutex.hxx>
20 #include <Standard_Type.hxx>
21
22 class Aspect_Window;
23 class V3d_View;
24
25 //! Auxiliary tool performing continuous redraws of specified window.
26 //! Tool creates an extra working thread pushing content invalidation messages to specific window using Aspect_Window::InvalidateContent() method.
27 //! Normally, GUI application should done continuous rendering in simple fashion - just by drawing next frame without waiting for new events from windowing system;
28 //! however, implementation of this approach is problematic in context of ViewerTest due to message loop binding mechanism implied by Tcl/Tk.
29 class ViewerTest_ContinuousRedrawer
30 {
31 public:
32   //! Return global instance.
33   Standard_EXPORT static ViewerTest_ContinuousRedrawer& Instance();
34 public:
35
36   //! Destructor.
37   Standard_EXPORT ~ViewerTest_ContinuousRedrawer();
38
39   //! Return TRUE if redrawer thread is started.
40   bool IsStarted() const { return myThread.GetId() != 0; }
41
42   //! Start thread.
43   Standard_EXPORT void Start (const Handle(V3d_View)& theView,
44                               Standard_Real theTargetFps);
45
46   //! Stop thread.
47   Standard_EXPORT void Stop (const Handle(V3d_View)& theView = NULL);
48
49   //! Return TRUE if redrawer thread is in paused state.
50   bool IsPaused() const { return myToPause; }
51
52   //! Pause working thread, but does not terminate it.
53   Standard_EXPORT void Pause();
54
55 private:
56
57   //! Thread loop.
58   void doThreadLoop();
59
60   //! Thread creation callback.
61   static Standard_Address doThreadWrapper (Standard_Address theData)
62   {
63     ViewerTest_ContinuousRedrawer* aThis = (ViewerTest_ContinuousRedrawer* )theData;
64     aThis->doThreadLoop();
65     return 0;
66   }
67
68   //! Empty constructor.
69   ViewerTest_ContinuousRedrawer();
70
71 private:
72   Handle(V3d_View)   myView;      //!< view to invalidate
73   OSD_Thread         myThread;    //!< working thread
74   Standard_Mutex     myMutex;     //!< mutex for accessing common variables
75   Standard_Condition myWakeEvent; //!< event to wake up working thread
76   Standard_Real      myTargetFps; //!< desired update framerate
77   volatile bool      myToStop;    //!< flag to stop working thread
78   volatile bool      myToPause;   //!< flag to put  working thread asleep without stopping
79 };
80
81 #endif // _ViewerTest_ContinuousRedrawer_HeaderFile