annotate Framework/Layers/ILayerSource.h @ 299:3897f9f28cfa am-callable-and-promise

backup work in progress: updated messaging framework with ICallable
author am@osimis.io
date Fri, 14 Sep 2018 16:44:01 +0200
parents 89d02de83c03
children b4abaeb783b1
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"
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace OrthancStone
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
31 class ILayerSource : public IObservable
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 public:
299
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
34
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
35 typedef NoPayloadMessage<MessageType_LayerSource_GeometryReady> GeometryReadyMessage;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
36 typedef NoPayloadMessage<MessageType_LayerSource_GeometryError> GeometryErrorMessage;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
37 typedef NoPayloadMessage<MessageType_LayerSource_ContentChanged> ContentChangedMessage;
3897f9f28cfa backup work in progress: updated messaging framework with ICallable
am@osimis.io
parents: 267
diff changeset
38
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
39 struct SliceChangedMessage : public IMessage
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
40 {
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
41 const Slice& slice_;
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
42 SliceChangedMessage(const Slice& slice)
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 252
diff changeset
43 : IMessage(MessageType_LayerSource_SliceChanged),
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
44 slice_(slice)
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
45 {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
46 }
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 struct LayerReadyMessage : public IMessage
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 {
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
51 std::auto_ptr<ILayerRenderer>& layer_;
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
52 const CoordinateSystem3D& slice_;
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
53 bool isError_;
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
54
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
55 LayerReadyMessage(std::auto_ptr<ILayerRenderer>& layer,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
56 const CoordinateSystem3D& slice,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
57 bool isError) // TODO Shouldn't this be separate as NotifyLayerError?
267
89d02de83c03 added declaretion of messages handled/emitted
am@osimis.io
parents: 252
diff changeset
58 : IMessage(MessageType_LayerSource_LayerReady),
252
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
59 layer_(layer),
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
60 slice_(slice),
40b21c1f8b8d more usage of IObservable/IObserver
am@osimis.io
parents: 251
diff changeset
61 isError_(isError)
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 }
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
64 };
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
66 // class IObserver : public boost::noncopyable
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
67 // {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
68 // public:
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
69 // virtual ~IObserver()
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
70 // {
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
71 // }
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
72
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
73 // // Triggered as soon as the source has enough information to
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
74 // // answer to "GetExtent()"
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
75 // virtual void NotifyGeometryReady(const ILayerSource& source) = 0;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
76
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
77 // virtual void NotifyGeometryError(const ILayerSource& source) = 0;
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
79 // // Triggered if the content of several slices in the source
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
80 // // volume has changed
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
81 // virtual void NotifyContentChange(const ILayerSource& source) = 0;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
82
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
83 // // Triggered if the content of some individual slice in the
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
84 // // source volume has changed
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
85 // virtual void NotifySliceChange(const ILayerSource& source,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
86 // const Slice& slice) = 0;
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
87
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
88 // // The layer must be deleted by the observer that releases the
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
89 // // std::auto_ptr
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
90 // virtual void NotifyLayerReady(std::auto_ptr<ILayerRenderer>& layer,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
91 // const ILayerSource& source,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
92 // const CoordinateSystem3D& slice,
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
93 // bool isError) = 0; // TODO Shouldn't this be separate as NotifyLayerError?
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
94 // };
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
96 ILayerSource(MessageBroker& broker)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
97 : IObservable(broker)
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
98 {}
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
99
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 virtual ~ILayerSource()
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 {
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 }
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
251
192e6e349e69 first usage of new message system (in SDL only)
am@osimis.io
parents: 135
diff changeset
104 // virtual void Register(IObserver& observer) = 0;
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
97
d18dcc963930 separation of the renderers vs. viewport slice
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
106 virtual bool GetExtent(std::vector<Vector>& points,
110
53025eecbc95 renamed SliceGeometry as CoordinateSystem3D
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 97
diff changeset
107 const CoordinateSystem3D& viewportSlice) = 0;
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108
110
53025eecbc95 renamed SliceGeometry as CoordinateSystem3D
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 97
diff changeset
109 virtual void ScheduleLayerCreation(const CoordinateSystem3D& viewportSlice) = 0;
65
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 };
885932a893de OrthancFrameLayerSource
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 }