Logo ROOT  
Reference Guide
RCanvas.hxx
Go to the documentation of this file.
1/*************************************************************************
2 * Copyright (C) 1995-2015, Rene Brun and Fons Rademakers. *
3 * All rights reserved. *
4 * *
5 * For the licensing terms see $ROOTSYS/LICENSE. *
6 * For the list of contributors see $ROOTSYS/README/CREDITS. *
7 *************************************************************************/
8
9#ifndef ROOT7_RCanvas
10#define ROOT7_RCanvas
11
12#include "ROOT/RPadBase.hxx"
15
16#include <memory>
17#include <string>
18#include <vector>
19#include <list>
20
21namespace ROOT {
22namespace Experimental {
23
25 std::vector<std::string> ids; ///< array of ids
26 std::vector<std::string> names; ///< array of attribute names
27 std::vector<std::unique_ptr<RAttrMap::Value_t>> values; ///< array of values
28 bool update{true}; ///< update canvas at the end
29 bool fNeedUpdate{false}; ///<! is canvas update required
32public:
33 RChangeAttrRequest() = default; // for I/O
34 virtual ~RChangeAttrRequest() = default;
35 std::unique_ptr<RDrawableReply> Process() override;
36 bool NeedCanvasUpdate() const override { return fNeedUpdate; }
37};
38
39/** \class RCanvas
40\ingroup GpadROOT7
41\brief A window's topmost `RPad`.
42\author Axel Naumann <axel@cern.ch>
43\date 2015-07-08
44\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!
45*/
46
47class RCanvas: public RPadBase {
48friend class RPadBase; /// use for ID generation
49friend class RCanvasPainter; /// used for primitives drawing
50friend class RChangeAttrRequest; /// to apply attributes changes
51private:
52 /// Title of the canvas.
53 std::string fTitle;
54
55 /// Width of the canvas in pixels
56 int fWidth{0};
57
58 /// Height of the canvas in pixels
59 int fHeight{0};
60
61 /// Modify counter, incremented every time canvas is changed
63
64 /// The painter of this canvas, bootstrapping the graphics connection.
65 /// Unmapped canvases (those that never had `Draw()` invoked) might not have
66 /// a painter.
67 std::unique_ptr<Internal::RVirtualCanvasPainter> fPainter; ///<!
68
69 /// indicate if Show() method was called before
70 bool fShown{false}; ///<!
71
72 /// Disable copy construction for now.
73 RCanvas(const RCanvas &) = delete;
74
75 /// Disable assignment for now.
76 RCanvas &operator=(const RCanvas &) = delete;
77
78 // Increment modify counter
79 uint64_t IncModified() { return ++fModified; }
80
81public:
82 static std::shared_ptr<RCanvas> Create(const std::string &title);
83
84 /// Create a temporary RCanvas; for long-lived ones please use Create().
85 RCanvas() : RPadBase("canvas") {}
86
87 ~RCanvas() = default;
88
89 const RCanvas *GetCanvas() const override { return this; }
90
91 /// Access to the top-most canvas, if any (non-const version).
92 RCanvas *GetCanvas() override { return this; }
93
94 /// Set canvas pixel size - width and height
95 void SetSize(int width, int height)
96 {
97 fWidth = width;
98 fHeight = height;
99 }
100
101 /// Set canvas width
102 void SetWidth(int width) { fWidth = width; }
103
104 /// Set canvas height
105 void SetHeight(int height) { fHeight = height; }
106
107 /// Get canvas width
108 int GetWidth() const { return fWidth; }
109
110 /// Get canvas height
111 int GetHeight() const { return fHeight; }
112
113 /// Display the canvas.
114 void Show(const std::string &where = "");
115
116 bool IsShown() const { return fShown; }
117 void ClearShown() { fShown = false; }
118
119 /// Returns window name used to display canvas
120 std::string GetWindowAddr() const;
121
122 /// Hide all canvas displays
123 void Hide();
124
125 /// Remove canvas from global canvas lists, will be destroyed when shared_ptr will be removed
126 void Remove();
127
128 /// Insert panel into the canvas, canvas should be shown at this moment
129 template <class PANEL>
130 bool AddPanel(std::shared_ptr<PANEL> &panel)
131 {
132 if (!fPainter) return false;
133 return fPainter->AddPanel(panel->GetWindow());
134 }
135
136 /// Get modify counter
137 uint64_t GetModified() const { return fModified; }
138
139 // Set newest version to all primitives
141
142 /// Set newest version to specified drawable
143 void Modified(std::shared_ptr<RDrawable> drawable)
144 {
145 // TODO: may be check that drawable belong to the canvas
146 if (drawable)
147 drawable->SetDrawableVersion(IncModified());
148 }
149
150 // Return if canvas was modified and not yet updated
151 bool IsModified() const;
152
153 /// update drawing
154 void Update(bool async = false, CanvasCallback_t callback = nullptr);
155
156 /// Run canvas functionality for given time (in seconds)
157 void Run(double tm = 0.);
158
159 /// Save canvas in image file
160 bool SaveAs(const std::string &filename);
161
162 /// Provide JSON which can be used for offline display
163 std::string CreateJSON();
164
165 /// Get the canvas's title.
166 const std::string &GetTitle() const { return fTitle; }
167
168 /// Set the canvas's title.
169 RCanvas &SetTitle(const std::string &title)
170 {
171 fTitle = title;
172 return *this;
173 }
174
175 void ResolveSharedPtrs();
176
177 static const std::vector<std::shared_ptr<RCanvas>> GetCanvases();
178
179 static void ReleaseHeldCanvases();
180};
181
182} // namespace Experimental
183} // namespace ROOT
184
185#endif
include TDocParser_001 C image html pict1_TDocParser_001 png width
Definition: TDocParser.cxx:121
A window's topmost RPad.
Definition: RCanvas.hxx:47
static const std::vector< std::shared_ptr< RCanvas > > GetCanvases()
Returns list of created canvases.
Definition: RCanvas.cxx:44
RCanvas(const RCanvas &)=delete
Disable copy construction for now.
static void ReleaseHeldCanvases()
Release list of held canvases pointers If no other shared pointers exists on the canvas,...
Definition: RCanvas.cxx:55
RCanvas * GetCanvas() override
Access to the top-most canvas, if any (non-const version).
Definition: RCanvas.hxx:92
const std::string & GetTitle() const
Get the canvas's title.
Definition: RCanvas.hxx:166
bool SaveAs(const std::string &filename)
Save canvas in image file.
Definition: RCanvas.cxx:189
void SetSize(int width, int height)
Set canvas pixel size - width and height.
Definition: RCanvas.hxx:95
RCanvas & SetTitle(const std::string &title)
Set the canvas's title.
Definition: RCanvas.hxx:169
Version_t fModified
Modify counter, incremented every time canvas is changed.
Definition: RCanvas.hxx:62
int GetHeight() const
Get canvas height.
Definition: RCanvas.hxx:111
bool IsModified() const
Returns true is canvas was modified since last painting.
Definition: RCanvas.cxx:69
RCanvas & operator=(const RCanvas &)=delete
Disable assignment for now.
void Show(const std::string &where="")
Display the canvas.
Definition: RCanvas.cxx:136
bool fShown
indicate if Show() method was called before
Definition: RCanvas.hxx:70
std::string GetWindowAddr() const
Returns window name used to display canvas.
Definition: RCanvas.cxx:167
void Remove()
Remove canvas from global canvas lists, will be destroyed when shared_ptr will be removed.
Definition: RCanvas.cxx:221
void ResolveSharedPtrs()
To resolve problem with storing of shared pointers Call this method when reading canvas from the file...
Definition: RCanvas.cxx:286
void Run(double tm=0.)
Run canvas functionality for given time (in seconds)
Definition: RCanvas.cxx:272
uint64_t GetModified() const
Get modify counter.
Definition: RCanvas.hxx:137
int fHeight
Height of the canvas in pixels.
Definition: RCanvas.hxx:59
std::string fTitle
to apply attributes changes
Definition: RCanvas.hxx:53
std::string CreateJSON()
Provide JSON which can be used for offline display.
Definition: RCanvas.cxx:207
void SetHeight(int height)
Set canvas height.
Definition: RCanvas.hxx:105
std::unique_ptr< Internal::RVirtualCanvasPainter > fPainter
The painter of this canvas, bootstrapping the graphics connection.
Definition: RCanvas.hxx:67
int fWidth
Width of the canvas in pixels.
Definition: RCanvas.hxx:56
static std::shared_ptr< RCanvas > Create(const std::string &title)
Create new canvas instance.
Definition: RCanvas.cxx:103
void SetWidth(int width)
Set canvas width.
Definition: RCanvas.hxx:102
const RCanvas * GetCanvas() const override
Access to the top-most canvas, if any (const version).
Definition: RCanvas.hxx:89
void Update(bool async=false, CanvasCallback_t callback=nullptr)
update drawing
Definition: RCanvas.cxx:77
RCanvas()
Create a temporary RCanvas; for long-lived ones please use Create().
Definition: RCanvas.hxx:85
void Modified(std::shared_ptr< RDrawable > drawable)
Set newest version to specified drawable.
Definition: RCanvas.hxx:143
int GetWidth() const
Get canvas width.
Definition: RCanvas.hxx:108
bool AddPanel(std::shared_ptr< PANEL > &panel)
Insert panel into the canvas, canvas should be shown at this moment.
Definition: RCanvas.hxx:130
void Hide()
Hide all canvas displays.
Definition: RCanvas.cxx:179
std::vector< std::unique_ptr< RAttrMap::Value_t > > values
array of values
Definition: RCanvas.hxx:27
std::vector< std::string > names
array of attribute names
Definition: RCanvas.hxx:26
std::vector< std::string > ids
array of ids
Definition: RCanvas.hxx:25
bool NeedCanvasUpdate() const override
Definition: RCanvas.hxx:36
bool fNeedUpdate
! is canvas update required
Definition: RCanvas.hxx:29
RChangeAttrRequest & operator=(const RChangeAttrRequest &)=delete
bool update
update canvas at the end
Definition: RCanvas.hxx:28
std::unique_ptr< RDrawableReply > Process() override
Apply attributes changes to the drawable Return mask with actions which were really applied.
Definition: RCanvas.cxx:314
RChangeAttrRequest(const RChangeAttrRequest &)=delete
Base class for requests which can be submitted from the clients.
Base class for graphic containers for RDrawable-s.
Definition: RPadBase.hxx:37
void SetDrawableVersion(Version_t vers) override
Assign drawable version - for pad itself and all primitives.
Definition: RPadBase.cxx:238
std::function< void(bool)> CanvasCallback_t
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...