File: plane_list.hpp

package info (click to toggle)
sight 25.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,180 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (135 lines) | stat: -rw-r--r-- 4,011 bytes parent folder | download | duplicates (2)
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
/************************************************************************
 *
 * 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/data/config.hpp>

#include "data/factory/new.hpp"
#include "data/object.hpp"
#include "data/plane.hpp"

#include <core/com/signal.hpp>
#include <core/com/signals.hpp>

#include <vector>

namespace sight::data
{

/**
 * @brief   This class defines a list of planes.
 * @see     Point
 */
class SIGHT_DATA_CLASS_API plane_list final : public object
{
public:

    SIGHT_DECLARE_CLASS(plane_list, object);

    using plane_list_t = std::vector<plane::sptr>;

    /**
     * @brief Constructor
     */
    SIGHT_DATA_API plane_list();

    /// Destructor
    SIGHT_DATA_API ~plane_list() noexcept override = default;

    /** @{
     *  @brief get/set container of all planes
     */
    plane_list_t& get_planes();
    const plane_list_t& get_planes() const;
    void set_planes(const plane_list_t& _v_planes);
    /// @}

    /**
     * @name Signals
     * @{
     */
    /// Signal emitted when a plane is added
    using plane_added_signal_t = core::com::signal<void (plane::sptr)>;
    SIGHT_DATA_API static const core::com::signals::key_t PLANE_ADDED_SIG;

    /// Signal emitted when a plane is removed
    using plane_removed_signal_t = core::com::signal<void (plane::sptr)>;
    SIGHT_DATA_API static const core::com::signals::key_t PLANE_REMOVED_SIG;

    /// Signal emitted when the visibility changed
    using visibility_modified_signal_t = core::com::signal<void (bool)>;
    SIGHT_DATA_API static const core::com::signals::key_t VISIBILITY_MODIFIED_SIG;
/**
 * @}
 */

    /// Equality comparison operators
    /// @{
    SIGHT_DATA_API bool operator==(const plane_list& _other) const noexcept;
    SIGHT_DATA_API bool operator!=(const plane_list& _other) const noexcept;
    /// @}

    /// Defines shallow copy
    /// @throws data::exception if an errors occurs during copy
    /// @param[in] _source the source object to copy
    SIGHT_DATA_API void shallow_copy(const object::csptr& _source) override;

    /// Defines deep copy
    /// @throws data::exception if an errors occurs during copy
    /// @param _source source object to copy
    /// @param _cache cache used to deduplicate pointers
    SIGHT_DATA_API void deep_copy(
        const object::csptr& _source,
        const std::unique_ptr<deep_copy_cache_t>& _cache = std::make_unique<deep_copy_cache_t>()
    ) override;

protected:

    //! Planes container
    plane_list_t m_v_planes;
}; // end class plane_list

//-----------------------------------------------------------------------------

inline plane_list::plane_list_t& plane_list::get_planes()
{
    return this->m_v_planes;
}

//-----------------------------------------------------------------------------

inline const plane_list::plane_list_t& plane_list::get_planes() const
{
    return this->m_v_planes;
}

//-----------------------------------------------------------------------------

inline void plane_list::set_planes(const plane_list::plane_list_t& _v_planes)
{
    this->m_v_planes = _v_planes;
}

//-----------------------------------------------------------------------------

} // end namespace sight::data