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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/************************************************************************
*
* Copyright (C) 2014-2025 IRCAD France
* Copyright (C) 2014-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/scene3d/config.hpp>
#include <data/color.hpp>
#include <data/image.hpp>
#include <data/matrix4.hpp>
#include <OGRE/OgreColourValue.h>
#include <OGRE/OgreImage.h>
#include <OGRE/OgrePixelFormat.h>
#include <OGRE/OgreRoot.h>
#include <OGRE/OgreTexture.h>
#include <optional>
namespace sight::viz::scene3d
{
namespace factory
{
class r2vb_renderable;
class Text;
} // namespace factory
namespace vr
{
class grid_proxy_geometry_factory;
} // namespace vr
namespace compositor::manager
{
class oit;
} // namespace compositor
} // namespace sight::viz::scene3d
namespace sight::viz::scene3d
{
/**
* @brief Provide some Ogre general functions for Sight
*/
class SIGHT_VIZ_SCENE3D_CLASS_API utils
{
public:
/**
* @brief Registers Ogre Plugins to load upon root creation.
*/
SIGHT_VIZ_SCENE3D_API static void add_plugins(const std::vector<std::string>& _plugins);
/**
* @brief utils::add_resources_path
* Add a path to load Ogre resources from a specific module.
* You must edit the resource.cfg file for each module containing specific resources
* In this case, you can call this method in the plugin.cpp file of this module
* @param _path Relative path to the resource.cfg file from a specific module
*/
SIGHT_VIZ_SCENE3D_API static void add_resources_path(const std::string& _path);
/**
* @brief getOgreRoot
* @return OgreRoot, if it doesn't exist initialise Ogre Root and default Ogre behavior
*/
SIGHT_VIZ_SCENE3D_API static Ogre::Root* get_ogre_root();
/**
* @brief destroy the OgreRoot
*/
SIGHT_VIZ_SCENE3D_API static void destroy_ogre_root();
/**
* @brief Convert an Ogre texture into a Sight image data
*/
SIGHT_VIZ_SCENE3D_API static void convert_from_ogre_texture(
Ogre::TexturePtr _texture,
const data::image::sptr _image_fw,
bool _flip = false
);
/**
* @brief getPixelFormatOgre
* @param _image_fw The Sight image
* @return Pixel format of a data::image
*/
SIGHT_VIZ_SCENE3D_API static Ogre::PixelFormat get_pixel_format_ogre(const data::image& _image_fw);
/**
* @brief get the image pixel format from an Ogre pixel format
* @param _format Pixel format of Ogre
*/
SIGHT_VIZ_SCENE3D_API static std::pair<core::type, enum data::image::pixel_format_t> get_pixel_format_from_ogre(
Ogre::PixelFormat _format
);
/**
* @brief get the texture window that should be used to shift the pixel values in the GLSL
* @param _format Pixel format
* @return The window that should be used to scale pixel values
*/
SIGHT_VIZ_SCENE3D_API static Ogre::Vector2 get_texture_window(core::type _format);
/**
* @brief allocateTexture
*
* @param[out] _texture The target texture
* @param[in] _width width of the texture
* @param[in] _height height of the texture
* @param[in] _depth depth of the texture
* @param[in] _format pixel format
* @param[in] _tex_type texture type (Ogre::TEX_TYPE_2D, TEX_TYPE_3D, ...)
* @param[in] _dynamic true if the image has to be modified frequently
* @return
*/
SIGHT_VIZ_SCENE3D_API static void allocate_texture(
Ogre::Texture* _texture,
std::size_t _width,
std::size_t _height,
std::size_t _depth,
Ogre::PixelFormat _format,
Ogre::TextureType _tex_type,
bool _dynamic
);
/**
* @brief convert an OgreColor into a sight::data::color
* @param[in] _ogre_color Color to convert into a Sight color
* @return The converted Sight color
*/
SIGHT_VIZ_SCENE3D_API static data::color::sptr from_ogre_color(const Ogre::ColourValue& _ogre_color);
/// Creates an ogre matrix from a Sight matrix.
SIGHT_VIZ_SCENE3D_API static Ogre::Matrix4 to_ogre_matrix(const data::matrix4::csptr& _tm3d);
/// Copies an ogre matrix to a Sight matrix.
SIGHT_VIZ_SCENE3D_API static void from_ogre_matrix(const Ogre::Matrix4& _mx, const data::matrix4::sptr& _tm3d);
/**
* @brief Returns image spacing, origin and orientation to Ogre types.
*
* @param _image
* @return image spacing, origin and orientation
*
* @{
*/
SIGHT_VIZ_SCENE3D_API static Ogre::Vector3 get_ogre_spacing(const data::image& _image);
SIGHT_VIZ_SCENE3D_API static Ogre::Vector3 get_ogre_origin(const data::image& _image);
SIGHT_VIZ_SCENE3D_API static Ogre::Quaternion get_ogre_orientation(const data::image& _image);
/// @}
/// Converts world coordinates to slices indexes of _image if possible, thrown an exception if not.
SIGHT_VIZ_SCENE3D_API static Ogre::Vector3i world_to_slices(const data::image& _image, const Ogre::Vector3& _world);
/**
* @brief Pick an object from a screen-space position.
* @param _x screen width position.
* @param _y screen height position.
* @param _query_mask Mask used to query entities with matching flags.
* @param _layer scene manager where to pick objects from.
* @return Object and intersection.
*/
SIGHT_VIZ_SCENE3D_API static std::optional<std::pair<Ogre::MovableObject*, Ogre::Vector3> > pick_object(
int _x,
int _y,
std::uint32_t _query_mask,
Ogre::SceneManager& _layer,
bool _shift_toward_camera = false
);
/**
* @brief Pick a voxel in a 3D image at a world-space position.
* @param _image source image.
* @param _position 3D world-space position.
* @return True if an object has been selected.
*/
SIGHT_VIZ_SCENE3D_API static std::string pick_image(const data::image& _image, const Ogre::Vector3& _position);
private:
/// Parses all resources.cfg files and adds resource locations to the resource group manager.
static void load_resources();
/**
* @brief Copies an ogre config stream and turns paths absolute.
*
* @param[in] _key Path parameter name whose value needs to be absolute.
* @param[in] _input Input stream, must be from an ogre configuration file.
* @param[out] _output Output stream, where the new config is copied to.
* @return whether or not the key was found in the input.
*/
static bool make_paths_absolute(
const std::string& _key,
std::istream& _input,
std::ostream& _output,
const std::filesystem::path& _module_path
);
static viz::scene3d::factory::r2vb_renderable* s_r2vb_renderable_factory;
static viz::scene3d::factory::Text* s_text_factory;
static viz::scene3d::vr::grid_proxy_geometry_factory* s_grid_proxy_geometry_factory;
static viz::scene3d::compositor::manager::oit* s_oit_manager;
};
} // namespace sight::viz::scene3d
|
