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
|
/************************************************************************
*
* Copyright (C) 2014-2024 IRCAD France
* Copyright (C) 2014-2021 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 "viz/scene3d/render.hpp"
#include <OgreSceneNode.h>
namespace sight::viz::scene3d
{
/**
* @brief Must be inherited by all classes containing a transformation matrix
*/
class SIGHT_VIZ_SCENE3D_CLASS_API transformable
{
public:
/**
* @brief Get the Ogre identifier of the transform in the scene manager.
* @return This transform service Id.
*/
[[nodiscard]] SIGHT_VIZ_SCENE3D_API viz::scene3d::render::ogre_object_id_t get_transform_id() const;
/**
* @brief Set the Ogre identifier of the transform in the scene manager.
* @param _id The new transform service Id.
*/
SIGHT_VIZ_SCENE3D_API void set_transform_id(viz::scene3d::render::ogre_object_id_t _id);
/**
* @brief Retrieve the node matching m_transformId or create it.
* @param _parent_node The parent node, used if transform node doesn't exists.
* @return The node matching m_transformId. (cannot be nullptr)
*/
SIGHT_VIZ_SCENE3D_API Ogre::SceneNode* get_or_create_transform_node(Ogre::SceneNode* _parent_node);
/**
* @brief Retrieve the transform node matching m_transformId.
* @return The node matching m_transformId (can be nullptr if node doesn't exists)
*/
[[nodiscard]] SIGHT_VIZ_SCENE3D_API Ogre::SceneNode* get_transform_node() const;
/// The xml attribute to retrieve the transform's id.
SIGHT_VIZ_SCENE3D_API static const std::string TRANSFORM_CONFIG;
private:
/// Ogre transform node.
Ogre::SceneNode* m_transform_node {nullptr};
/// This transform identifier
viz::scene3d::render::ogre_object_id_t m_transform_id;
};
} //namespace sight::viz::scene3d
|
