Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Point.h
Go to the documentation of this file.
1
2
3/*******************************************************************************
4
5 * This file is part of the Zivid 3D Camera API
6
7 *
8
9 * Copyright 2015-2023 (C) Zivid AS
10
11 * All rights reserved.
12
13 *
14
15 * Zivid Software License, v1.0
16
17 *
18
19 * Redistribution and use in source and binary forms, with or without
20
21 * modification, are permitted provided that the following conditions are met:
22
23 *
24
25 * 1. Redistributions of source code must retain the above copyright notice,
26
27 * this list of conditions and the following disclaimer.
28
29 *
30
31 * 2. Redistributions in binary form must reproduce the above copyright notice,
32
33 * this list of conditions and the following disclaimer in the documentation
34
35 * and/or other materials provided with the distribution.
36
37 *
38
39 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
40
41 * to endorse or promote products derived from this software without specific
42
43 * prior written permission.
44
45 *
46
47 * 4. This software, with or without modification, must not be used with any
48
49 * other 3D camera than from Zivid AS.
50
51 *
52
53 * 5. Any software provided in binary form under this license must not be
54
55 * reverse engineered, decompiled, modified and/or disassembled.
56
57 *
58
59 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
60
61 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
62
63 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
64
65 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
66
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68
69 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70
71 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72
73 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
74
75 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76
77 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78
79 *
80
81 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
82
83 * Info: http://www.zivid.com
84
85 ******************************************************************************/
86
87
88
89#pragma once
90
93
94#include <cmath>
95#include <ostream>
96#include <string>
97#include <type_traits>
98
99namespace Zivid
100{
104 struct PointXYZ
105 {
107 PointXYZ() = default;
108
110 constexpr PointXYZ(float xCoord, float yCoord, float zCoord)
111 : x{ xCoord }
112 , y{ yCoord }
113 , z{ zCoord }
114 {}
115
118 bool isNaN() const
119 {
120 return std::isnan(z);
121 }
122
124 ZIVID_CORE_EXPORT std::string toString() const;
125
127 ZIVID_CORE_EXPORT bool operator==(const PointXYZ &rhs) const;
128
130 ZIVID_CORE_EXPORT bool operator!=(const PointXYZ &rhs) const;
131
133 float x;
134
136 float y;
137
139 float z;
140 };
141
143 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointXYZ &point);
144
146
156 {
158 PointXYZW() = default;
159
161 PointXYZW(float xCoord, float yCoord, float zCoord, float wCoord)
162 : x{ xCoord }
163 , y{ yCoord }
164 , z{ zCoord }
165 , w{ wCoord }
166 {}
167
170 bool isNaN() const
171 {
172 return std::isnan(z);
173 }
174
176 ZIVID_CORE_EXPORT std::string toString() const;
177
179 ZIVID_CORE_EXPORT bool operator==(const PointXYZW &rhs) const;
180
182 ZIVID_CORE_EXPORT bool operator!=(const PointXYZW &rhs) const;
183
185 float x;
186
188 float y;
189
191 float z;
192
194 float w;
195 };
196
198 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointXYZW &point);
199
201
205 struct PointZ
206 {
208 PointZ() = default;
209
211 PointZ(float zCoord)
212 : z{ zCoord }
213 {}
214
216 bool isNaN() const
217 {
218 return std::isnan(z);
219 }
220
222 ZIVID_CORE_EXPORT std::string toString() const;
223
225 ZIVID_CORE_EXPORT bool operator==(const PointZ &rhs) const;
226
228 ZIVID_CORE_EXPORT bool operator!=(const PointZ &rhs) const;
229
231 float z;
232 };
233
235 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PointZ &point);
236
238
239} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream
Definition: Array2D.h:243
ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorRGBA, 4)
Point with four coordinates as float
Definition: Point.h:156
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition: Point.h:170
PointXYZW(float xCoord, float yCoord, float zCoord, float wCoord)
Constructor
Definition: Point.h:161
float x
The x element of the point
Definition: Point.h:185
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
PointXYZW()=default
Constructor
float y
The y element of the point
Definition: Point.h:188
float z
The z element of the point
Definition: Point.h:191
float w
The w element of the point
Definition: Point.h:194
Point with three coordinates as float
Definition: Point.h:105
PointXYZ()=default
Constructor
ZIVID_CORE_EXPORT bool operator!=(const PointXYZ &rhs) const
Check for inequality
float y
The y element of the point
Definition: Point.h:136
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition: Point.h:118
constexpr PointXYZ(float xCoord, float yCoord, float zCoord)
Constructor
Definition: Point.h:110
ZIVID_CORE_EXPORT bool operator==(const PointXYZ &rhs) const
Check for equality
float z
The z element of the point
Definition: Point.h:139
float x
The x element of the point
Definition: Point.h:133
ZIVID_CORE_EXPORT std::string toString() const
Get string representation
Point with Z coordinate
Definition: Point.h:206
ZIVID_CORE_EXPORT bool operator==(const PointZ &rhs) const
Check for equality
float z
The z element of the point
Definition: Point.h:231
ZIVID_CORE_EXPORT bool operator!=(const PointZ &rhs) const
Check for inequality
PointZ()=default
Constructor
PointZ(float zCoord)
Constructor
Definition: Point.h:211
bool isNaN() const
Check if the point is Not-a-Number (invalid)
Definition: Point.h:216
ZIVID_CORE_EXPORT std::string toString() const
Get string representation