Mercurial > hg > orthanc-stone

comparison OrthancStone/Sources/Viewport/IViewport.h @ 1512:244ad1e4e76a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reorganization of folders
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Jul 2020 16:21:02 +0200
parents Framework/Viewport/IViewport.h@fef1ec42a7db
children 314b6dc507d9
comparison
equal deleted inserted replaced
1511:9dfeee74c1e6 1512:244ad1e4e76a
1 /**
2 * Stone of Orthanc
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU Affero General Public License
9 * as published by the Free Software Foundation, either version 3 of
10 * the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Affero General Public License for more details.
16 *
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 **/
20
21 #pragma once
22
23 #include "../Scene2D/ICompositor.h"
24 #include "../Scene2DViewport/ViewportController.h"
25
26 namespace OrthancStone
27 {
28 /**
29 * Class that combines a Scene2D with a canvas where to draw the
30 * scene. A call to "Refresh()" will update the content of the
31 * canvas. A "IViewport" can possibly be accessed from several
32 * threads depending on the rendering back-end (e.g. in SDL or Qt):
33 * The "ILock" subclass implements the locking mechanism to modify
34 * the content of the scene.
35 *
36 * NB: The lock must be a "recursive_mutex", as the viewport
37 * controller can lock it a second time (TODO - Why so?).
38 **/
39 class IViewport : public boost::noncopyable
40 {
41 public:
42 class ILock : public boost::noncopyable
43 {
44 public:
45 virtual ~ILock()
46 {
47 }
48
49 virtual bool HasCompositor() const = 0;
50
51 /**
52 Do not store the result! Only access the compositor interface through
53 the lock.
54 */
55 virtual ICompositor& GetCompositor() = 0;
56
57 /**
58 Do not store the result! Only access the compositor interface through
59 the lock.
60 */
61 virtual ViewportController& GetController() = 0;
62
63 virtual void Invalidate() = 0;
64 };
65
66 virtual ~IViewport()
67 {
68 }
69
70 virtual ILock* Lock() = 0;
71 };
72 }