1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-2020 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/viz/scene2d/config.hpp>
#include "viz/scene2d/data/axis.hpp"
#include "viz/scene2d/data/event.hpp"
#include "viz/scene2d/data/viewport.hpp"
#include "viz/scene2d/vec2d.hpp"
#include <viz/__/render.hpp>
#include <QGraphicsScene>
#include <QGraphicsView>
#include <QResizeEvent>
#include <Qt>
#include <map>
namespace sight::viz::scene2d
{
// Not declared in the #include because of mutual inclusion.
class graphics_view;
// Not declared in the #include because of mutual inclusion.
class adaptor;
/**
* @brief Qt scene rendering class.
*
* @section XML XML Configuration
*
* @code{.xml}
<service uid="GENERIC_UID_Scene2D" type="sight::viz::scene2d::render" >
<scene>
<scene x="-1100" y="-1.1" width="2500" height="1.2" background="#FFFFFF" QSSClass="my_class" />
<axis id="xAxis" origin="0.0" scale="1.0" scaleType="LINEAR" />
<axis id="yAxis" origin="0.0" scale="-1.0" scaleType="LINEAR" />
<axis id="axeHistogramY" origin="0.0" scale="-0.000005" scaleType="LINEAR" />
<adaptor uid="grid" />
</scene>
</service>
@endcode
*
* @subsection Configuration Configuration
*
* - \<scene x="-1100" y="-1.1" width="2500" height="1.2" /\> : Set the scene coordinates
* - \b x: set the x coordinate of the top left scene corner
* - \b y: set the y coordinate of the top left scene corner
* - \b width: set the width of the scene
* - \b height: set the height of the scene
* - \b antialiasing (optional, default: false): activate scene antialiasing if attribute's value set to 'true'
* - \b aspectRatioMode (optional, default: IgnoreAspectRatio): defines what happens to the aspect ratio
* when scaling an rectangle (See https://doc.qt.io/qt-5/qt.html#AspectRatioMode-enum).
* - \b background (optional, default: #000000): the background color of the rendering screen.
* The color value must be defined as a hexadecimal value (ex : \#ffffff for white).
* - \b QSSClass (optional): specify a QSS class to configure the scene.
* - \<axis id="xAxis" origin="0.0" scale="1.0" scaleType="LINEAR" /\> : Set an axis specifications
* - \b id: set the axis id
* - \b origin: set the axis origin
* - \b scale: set the axis scale
* - \b scaleType: set the axis scaleType
* - \<adaptor uid="grid" /\> : Set an adaptor
* - \b uid: set the adaptor uid
*
*/
class SIGHT_VIZ_SCENE2D_CLASS_API render : public viz::render
{
public:
SIGHT_DECLARE_SERVICE(render, viz::render);
/// Constructor, set coordinates m_sceneStart to (-100, -100), m_sceneWidth to (200, 200) and add new handle events
/// ADDED_KEYS, REMOVED_KEYS and CHANGED_KEYS.
SIGHT_VIZ_SCENE2D_API render() noexcept;
/// Basic destructor, do nothing.
SIGHT_VIZ_SCENE2D_API ~render() noexcept override;
/// Get the scene.
SIGHT_VIZ_SCENE2D_API QGraphicsScene* get_scene() const;
/// Get the view.
SIGHT_VIZ_SCENE2D_API graphics_view* get_view() const;
/// Get the axis.
SIGHT_VIZ_SCENE2D_API scene2d::data::axis::sptr get_axis(const std::string& _id) const;
/// If the event hasn't been accepted yet, call the adaptor processInteraction function.
SIGHT_VIZ_SCENE2D_API void dispatch_interaction(scene2d::data::event& _event);
/// Returns true if given coordinates are contained in the view of the scene
SIGHT_VIZ_SCENE2D_API bool contains(const scene2d::vec2d_t& _coord) const;
/** @brief Compute the viewport coordinates mapped to scene coordinates.
* @param _coord input viewport coordinates
* @param _clip clip the returned coordinates to the size of the scene
* @return scene coordinates
*/
SIGHT_VIZ_SCENE2D_API scene2d::vec2d_t map_to_scene(const scene2d::vec2d_t& _coord, bool _clip = false) const;
/// Returns what happens to scene's aspect ratio on view resize events
SIGHT_VIZ_SCENE2D_API Qt::AspectRatioMode get_aspect_ratio_mode() const;
/// Update scene size from items bounding rect, this bounding can be enlarged with ratioPercent parameter
SIGHT_VIZ_SCENE2D_API void update_scene_size(float _ratio_percent = 0);
protected:
/// Get configuration options from XML
SIGHT_VIZ_SCENE2D_API void configuring() override;
/// Call startContext to set the scene, the viewport and the view,
/// and add'em to the widget and start the adaptors
/// contained in the adaptors id vector of the ObjectsID2AdaptorIDVector map.
SIGHT_VIZ_SCENE2D_API void starting() override;
/// Do nothing.
SIGHT_VIZ_SCENE2D_API void updating() override;
/// Stop all the adaptors attached to the render related map,
/// stop all those attached to the objects contained
/// by the render related map, clear the maps and call stopContext().
SIGHT_VIZ_SCENE2D_API void stopping() override;
private:
/// Create the widget, the scene, the viewport, the view.
void start_context();
/// Delete m_scene and m_view;
void stop_context();
/// Get the axis configuration specifications
void configure_axis(const config_t& _conf);
/// Get the scene configuration specifications and set them to m_sceneStart and m_sceneWidth.
void configure_scene(const config_t& _conf);
/// Get the adaptor configuration specifications, push back the id attribute in the m_objectsID2AdaptorIDVector map,
/// create a SceneAdaptor2D,
/// set its attributes and push it back in the m_adaptorID2SceneAdaptor2D map.
void configure_adaptor(const config_t& _conf);
std::map<std::string, scene2d::data::axis::sptr> m_axis_map;
/// Coordinates of the scene top left corner.
scene2d::vec2d_t m_scene_start;
/// Width and height of the scene.
scene2d::vec2d_t m_scene_width;
/// The scene.
QGraphicsScene* m_scene {nullptr};
/// The view.
graphics_view* m_view {nullptr};
/// If antialiasing is requested (deactivated by default because of a potential lack of performance)
bool m_antialiasing {false};
/// Background color of the scene.
std::string m_background;
/// QSS class of the widget.
std::string m_qss_class;
/// How the scene should behave on view resize events
Qt::AspectRatioMode m_aspect_ratio_mode {Qt::IgnoreAspectRatio};
};
} // namespace sight::viz::scene2d
|
