annotate Framework/Layers/ILayerSource.h @ 378:814fa32e2fcc

refactoring
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 06 Nov 2018 14:21:02 +0100
parents 3a4ca166fafa
children 2308fe0b0b05
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
135
e2fe9352f240 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 121
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
16 *
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "ILayerRenderer.h"
77
f5f54ed8d307 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 66
diff changeset
25 #include "../Toolbox/Slice.h"
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
26 #include "../../Framework/Messages/IObservable.h"
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
27 #include "../../Framework/Messages/IMessage.h"
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
28 #include "Core/Images/Image.h"
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
29 #include <boost/shared_ptr.hpp>
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace OrthancStone
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
33 class ILayerSource : public IObservable
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 public:
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
36
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
37 typedef OriginMessage<MessageType_LayerSource_GeometryReady, ILayerSource> GeometryReadyMessage;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
38 typedef OriginMessage<MessageType_LayerSource_GeometryError, ILayerSource> GeometryErrorMessage;
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
39 typedef OriginMessage<MessageType_LayerSource_ContentChanged, ILayerSource> ContentChangedMessage;
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
40
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
41 struct SliceChangedMessage : public OriginMessage<MessageType_LayerSource_SliceChanged, ILayerSource>
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
42 {
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
43 const Slice& slice_;
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
44 SliceChangedMessage(ILayerSource& origin, const Slice& slice)
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
45 : OriginMessage(origin),
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
46 slice_(slice)
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
47 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
48 }
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
49 };
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
50
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
51 struct LayerReadyMessage : public OriginMessage<MessageType_LayerSource_LayerReady, ILayerSource>
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 {
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
53 std::auto_ptr<ILayerRenderer>& renderer_;
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
54 const CoordinateSystem3D& slice_;
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
55 bool isError_;
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
56
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
57 LayerReadyMessage(ILayerSource& origin,
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
58 std::auto_ptr<ILayerRenderer>& layer,
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
59 const CoordinateSystem3D& slice,
300
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
60 bool isError // TODO Shouldn't this be separate as NotifyLayerError?
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
61 )
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
62 : OriginMessage(origin),
b4abaeb783b1 messaging refactoring almost complete: works fine in native
am@osimis.io
parents: 299
diff changeset
63 renderer_(layer),
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
64 slice_(slice),
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
65 isError_(isError)
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 {
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 }
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
68 };
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
69
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
70
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
71 // TODO: Rename "ImageReadyMessage" as "SliceReadyMessage"
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
72 class ImageReadyMessage : public OriginMessage<MessageType_LayerSource_ImageReady, ILayerSource>
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
73 {
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
74 private:
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
75 const Orthanc::ImageAccessor& image_;
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
76 SliceImageQuality imageQuality_;
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
77 const Slice& slice_;
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
78
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
79 public:
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
80 ImageReadyMessage(ILayerSource& origin,
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
81 const Orthanc::ImageAccessor& image,
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
82 SliceImageQuality imageQuality,
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
83 const Slice& slice) :
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
84 OriginMessage(origin),
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
85 image_(image),
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
86 imageQuality_(imageQuality),
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
87 slice_(slice)
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
88 {
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
89 }
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
90
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
91 const Orthanc::ImageAccessor& GetImage() const
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
92 {
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
93 return image_;
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
94 }
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
95
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
96 SliceImageQuality GetImageQuality() const
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
97 {
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
98 return imageQuality_;
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
99 }
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
100
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
101 const Slice& GetSlice() const
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
102 {
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
103 return slice_;
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
104 }
318
3a4ca166fafa ImageAccessor refactoring + implemented Image Cache in SmartLoader
am@osimis.io
parents: 300
diff changeset
105 };
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
106
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
378
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
108 ILayerSource(MessageBroker& broker) :
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
109 IObservable(broker)
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
110 {
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
111 }
814fa32e2fcc refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 318
diff changeset
112
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 virtual ~ILayerSource()
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 {
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 }
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
97
d18dcc963930 separation of the renderers vs. viewport slice
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
117 virtual bool GetExtent(std::vector<Vector>& points,
110
53025eecbc95 renamed SliceGeometry as CoordinateSystem3D
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 97
diff changeset
118 const CoordinateSystem3D& viewportSlice) = 0;
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
110
53025eecbc95 renamed SliceGeometry as CoordinateSystem3D
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 97
diff changeset
120 virtual void ScheduleLayerCreation(const CoordinateSystem3D& viewportSlice) = 0;
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 };
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 }