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
|
/************************************************************************
*
* Copyright (C) 2022-2024 IRCAD France
*
* 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 <data/mesh.hpp>
#include <data/model_series.hpp>
#include <service/controller.hpp>
namespace sight::module::data
{
/**
* @brief This service is used to extracts mesh in the models series
*
* The output objects must be marked as "deferred" in the XML configuration.
*
* @section XML XML Configuration
*
* @code{.xml}
<service uid="..." type="sight::module::data::get_mesh" >
<in key="modelSeries" uid="..." />
<out group="mesh">
<key index="3" uid="..."/>
<key type="organ1" uid="..."/>
<key type="organ2" matching="(.*)surface(.*)" uid="..."/>
</out>
</service>
@endcode
* @subsection Input Input
* - \b modelSeries [sight::data::model_series]: model series from which the mesh is extracted.
*
* @subsection Output Output
* - \b mesh [sight::data::mesh]: output mesh extracted from the model series.
* *
* @subsection Configuration Configuration
* Regarding the ouput configuration, either index or type is required. It is possible to mix both of them and their
* order are not relevant.
* Both index and type specify which mesh will be found from the reconstructionDB. The given mesh will then be put in
* the associated output var.
* - \b index (mandatory) : index in the modelSeries of the mesh to extract. Note that the index starts at 0 for the
* first element in the modelSeries.
* - \b type (mandatory) : structure type of the mesh to extract from the source model.
* - \b matching (optional) : regex to match the organ name, that can be used for instance when you have several
* organs with the same structure type. type cannot be applied to an index constraint.
*/
class get_mesh : public service::controller
{
public:
SIGHT_DECLARE_SERVICE(get_mesh, service::controller);
/// Constructor
get_mesh() = default;
/// Destructor
~get_mesh() override = default;
protected:
/// Does nothing
void starting() override;
/// Configure the service
void configuring() override;
/// Does nothing
void stopping() override;
/// Extract the object(s)
void updating() override;
private:
/// structure which contains the element of an index configuration:
/// inputIndex: index of the mesh in the modelSeries
/// outputIndex: index of the output variable
struct index_config
{
std::size_t input_index;
std::size_t output_index;
};
/// structure which contains the element of a type configuration:
/// type: the mesh type requested
/// matching: regex for the mesh name
/// outputIndex: index of the output variable
struct type_config
{
std::string type;
std::string matching;
std::size_t output_index;
};
/// The list of index oriented configurations.
std::vector<index_config> m_index_configurations;
/// The list of type-name configurations.
std::vector<type_config> m_type_configuration;
/// The in/out variables
sight::data::ptr<sight::data::model_series, sight::data::access::in> m_model_series {this, "modelSeries"};
sight::data::ptr_vector<sight::data::mesh, sight::data::access::out> m_mesh {this, "mesh"};
};
} // namespace sight::module::data
|