Zivid C++ API 2.13.1+18e79e79-1
Point.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of the Zivid API
3 *
4 * Copyright 2015-2024 (C) Zivid AS
5 * All rights reserved.
6 *
7 * Zivid Software License, v1.0
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
20 * to endorse or promote products derived from this software without specific
21 * prior written permission.
22 *
23 * 4. This software, with or without modification, must not be used with any
24 * other 3D camera than from Zivid AS.
25 *
26 * 5. Any software provided in binary form under this license must not be
27 * reverse engineered, decompiled, modified and/or disassembled.
28 *
29 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
30 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
32 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
33 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
36 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
41 * Info: http://www.zivid.com
42 ******************************************************************************/
43
44#pragma once
45
48
49#include <cmath>
50#include <ostream>
51#include <string>
52#include <type_traits>
53
54namespace Zivid
55{
59 struct PointXYZ
60 {
62 using ValueType = float;
63
65 PointXYZ() = default;
66
68 constexpr PointXYZ(float xCoord, float yCoord, float zCoord)
69 : x{ xCoord }
70 , y{ yCoord }
71 , z{ zCoord }
72 {}
73
76 bool isNaN() const
77 {
78 return std::isnan(z);
79 }
80
82 ZIVID_CORE_EXPORT std::string toString() const;
83
85 ZIVID_CORE_EXPORT bool operator==(const PointXYZ &rhs) const;
86
88 ZIVID_CORE_EXPORT bool operator!=(const PointXYZ &rhs) const;
89
92
95
98 };
99
101 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointXYZ &point);
102
104
114 {
116 using ValueType = float;
117
119 PointXYZW() = default;
120
122 PointXYZW(float xCoord, float yCoord, float zCoord, float wCoord)
123 : x{ xCoord }
124 , y{ yCoord }
125 , z{ zCoord }
126 , w{ wCoord }
127 {}
128
131 bool isNaN() const
132 {
133 return std::isnan(z);
134 }
135
137 ZIVID_CORE_EXPORT std::string toString() const;
138
140 ZIVID_CORE_EXPORT bool operator==(const PointXYZW &rhs) const;
141
143 ZIVID_CORE_EXPORT bool operator!=(const PointXYZW &rhs) const;
144
147
150
153
156 };
157
159 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointXYZW &point);
160
162
166 struct PointZ
167 {
169 using ValueType = float;
170
172 PointZ() = default;
173
175 PointZ(float zCoord)
176 : z{ zCoord }
177 {}
178
180 bool isNaN() const
181 {
182 return std::isnan(z);
183 }
184
186 ZIVID_CORE_EXPORT std::string toString() const;
187
189 ZIVID_CORE_EXPORT bool operator==(const PointZ &rhs) const;
190
192 ZIVID_CORE_EXPORT bool operator!=(const PointZ &rhs) const;
193
196 };
197
199 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointZ &point);
200
202
206 struct PointXY
207 {
209 using ValueType = float;
210
212 PointXY() = default;
213
215 constexpr PointXY(float xCoord, float yCoord)
216 : x{ xCoord }
217 , y{ yCoord }
218 {}
219
222 bool isNaN() const
223 {
224 return std::isnan(y);
225 }
226
228 ZIVID_CORE_EXPORT std::string toString() const;
229
231 ZIVID_CORE_EXPORT bool operator==(const PointXY &rhs) const;
232
234 ZIVID_CORE_EXPORT bool operator!=(const PointXY &rhs) const;
235
238
241 };
242
244 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointXY &point);
245
247
248} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
#define ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(Type, size)
Definition DataFormatUtils.h:48
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:56
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream.
Definition Array2D.h:285
Point with four coordinates as float.
Definition Point.h:114
ValueType y
The y element of the point.
Definition Point.h:149
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition Point.h:131
PointXYZW(float xCoord, float yCoord, float zCoord, float wCoord)
Constructor.
Definition Point.h:122
ValueType w
The w element of the point.
Definition Point.h:155
float ValueType
The type of the coordinate values.
Definition Point.h:116
ZIVID_CORE_EXPORT bool operator!=(const PointXYZW &rhs) const
Check for inequality.
ZIVID_CORE_EXPORT bool operator==(const PointXYZW &rhs) const
Check for equality.
ZIVID_CORE_EXPORT std::string toString() const
Get string representation.
ValueType z
The z element of the point.
Definition Point.h:152
ValueType x
The x element of the point.
Definition Point.h:146
PointXYZW()=default
Constructor.
Point with three coordinates as float.
Definition Point.h:60
PointXYZ()=default
Constructor.
ZIVID_CORE_EXPORT bool operator!=(const PointXYZ &rhs) const
Check for inequality.
ValueType z
The z element of the point.
Definition Point.h:97
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition Point.h:76
constexpr PointXYZ(float xCoord, float yCoord, float zCoord)
Constructor.
Definition Point.h:68
ZIVID_CORE_EXPORT bool operator==(const PointXYZ &rhs) const
Check for equality.
ValueType y
The y element of the point.
Definition Point.h:94
ValueType x
The x element of the point.
Definition Point.h:91
float ValueType
The type of the coordinate values.
Definition Point.h:62
ZIVID_CORE_EXPORT std::string toString() const
Get string representation.
Point with two coordinates as float.
Definition Point.h:207
constexpr PointXY(float xCoord, float yCoord)
Constructor.
Definition Point.h:215
ValueType y
The y element of the point.
Definition Point.h:240
PointXY()=default
Constructor.
ZIVID_CORE_EXPORT bool operator==(const PointXY &rhs) const
Check for equality.
float ValueType
The type of the coordinate values.
Definition Point.h:209
ZIVID_CORE_EXPORT std::string toString() const
Get string representation.
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition Point.h:222
ZIVID_CORE_EXPORT bool operator!=(const PointXY &rhs) const
Check for inequality.
ValueType x
The x element of the point.
Definition Point.h:237
Point with Z coordinate.
Definition Point.h:167
ZIVID_CORE_EXPORT bool operator==(const PointZ &rhs) const
Check for equality.
ValueType z
The z element of the point.
Definition Point.h:195
ZIVID_CORE_EXPORT bool operator!=(const PointZ &rhs) const
Check for inequality.
PointZ()=default
Constructor.
PointZ(float zCoord)
Constructor.
Definition Point.h:175
float ValueType
The type of the coordinate values.
Definition Point.h:169
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition Point.h:180
ZIVID_CORE_EXPORT std::string toString() const
Get string representation.