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
|
/************************************************************************
*
* 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/app/config.hpp>
#include <service/object_parser.hpp>
namespace sight::app::parser
{
/**
* @brief Specific service for the construction of a transfer_function and its associated services from an XML-based
* description.
* @see service::object_parser
*/
class SIGHT_APP_CLASS_API transfer_function : public service::object_parser
{
public:
SIGHT_DECLARE_SERVICE(transfer_function, service::object_parser);
/// Destructor : does nothing.
~transfer_function() override = default;
/**
* @code{.xml}
<object type="data::transfer_function">
<name>Bones</name>
<colors isClamped="true">
<step color="#ffffff" value="0" />
<step color="#0000ff" value="1000" />
<step color="#00ff00" value="2000" />
<step color="#ffff00" value="3000" />
<step color="#ff0000" value="4000" />
<step color="#000000" value="5000" />
</colors>
</object>
@endcode
With:
* - \b name (optional, default: '') : the name of the TF.
* - \b step : defines a step in the legend given with the arguments color in hex-code and the max value.
* - \b isClamped(optional, default: true) : defines interpolation mode on extremities, if yes then after extremity
* point, the returned TF color is color_t(0,0,0,0), else it is the color value of the extremity.
*
* You can also define a default TF this way:
*
* @code{.xml}
<object type="data::transfer_function">
<colors default="true" />
</object>
@endcode
*
*/
SIGHT_APP_API virtual void parse(
const service::config_t& _cfg,
core::object::sptr _obj,
objects_t& _sub_objects
) override;
};
} // namespace sight::app::parser
|
