File: point.hpp

package info (click to toggle)
sight 25.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,184 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (177 lines) | stat: -rw-r--r-- 5,624 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
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
/************************************************************************
 *
 * Copyright (C) 2009-2025 IRCAD France
 * Copyright (C) 2012-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/data/config.hpp>

#include "container.hpp"

#include <array>

namespace sight::data
{

/**
 * @brief   This class define a 3D point.
 */
class SIGHT_DATA_CLASS_API point final : public container<std::array<double,
                                                                     3> >
{
public:

    /// This will enable common collection constructors / assignment operators
    using container<point::container_t>::container;
    using container<point::container_t>::operator=;

    using point_coord_t       = double;
    using point_coord_array_t = point::container_t; // For backwards compatibility

    SIGHT_DECLARE_CLASS(point, container<point::container_t>);

    /// point factory
    point();
    point(std::initializer_list<value_type> _init_list);
    point(float _x, float _y   = 0.F, float _z = 0.F);
    point(double _x, double _y = 0., double _z = 0.);
    SIGHT_DATA_API point(const point_coord_array_t& _coord);
    SIGHT_DATA_API point(const point::sptr& _p);

    /// Destructor
    SIGHT_DATA_API ~point() noexcept final = default;

    /// @brief get/set point coordinates
    /// @{
    [[deprecated("Use operator[] instead")]] point_coord_array_t get_coord();
    [[deprecated("Use operator[] instead")]] const point_coord_array_t get_coord() const;
    [[deprecated("Use operator[] instead")]] void set_coord(const point_coord_array_t& _v_coord);
    /// @}

    SIGHT_DATA_API std::string get_label() const;
    SIGHT_DATA_API void set_label(const std::string& _label);

    /// Assignment operator
    /// @{
    inline point& operator=(std::initializer_list<value_type> _init_list);

    template<typename T>
    inline point& operator=(const T& _data);
    /// @}

    /// Equality comparison operators
    /// @{
    SIGHT_DATA_API bool operator==(const point& _other) const noexcept;
    SIGHT_DATA_API bool operator!=(const point& _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;
}; // end class point

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

inline point::point() :
    point({0.0, 0.0, 0.0})
{
}

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

inline point::point(float _x, float _y, float _z) :
    point({_x, _y, _z})
{
}

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

inline point::point(double _x, double _y, double _z) :
    point({_x, _y, _z})
{
}

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

inline point::point(std::initializer_list<value_type> _init_list)
{
    this->operator=<std::initializer_list<value_type> >(_init_list);
}

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

template<typename T>
inline point& point::operator=(const T& _data)
{
    ///@todo make this functions constexpr once we support C++23 which will support SIGHT_ASSERT
    SIGHT_ASSERT(
        std::string(__func__) + " need 3 elements: " + std::to_string(_data.size()) + " given.",
        _data.size() == this->size()
    );

    std::copy(_data.begin(), _data.end(), this->begin());
    return *this;
}

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

inline point& point::operator=(std::initializer_list<value_type> _init_list)
{
    this->operator=<std::initializer_list<value_type> >(_init_list);
    return *this;
}

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

inline point::point_coord_array_t point::get_coord()
{
    return this->get_content();
}

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

inline const point::point_coord_array_t point::get_coord() const
{
    return this->get_content();
}

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

inline void point::set_coord(const point_coord_array_t& _v_coord)
{
    *this = _v_coord;
}

SIGHT_DATA_API std::ostream& operator<<(std::ostream& _out, const point& _p);

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

} // end namespace sight::data