Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Vector.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{
105 {
107 VectorXYZ() = default;
108
110 VectorXYZ(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 VectorXYZ &rhs) const;
128
130 ZIVID_CORE_EXPORT bool operator!=(const VectorXYZ &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 VectorXYZ &point);
144
146
147} // 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)
Vector with three coordinates as float
Definition: Vector.h:105
ZIVID_CORE_EXPORT std::string toString() const
Get string representation
float x
The x element of the vector
Definition: Vector.h:133
bool isNaN() const
Check if the vector is Not-a-Number (invalid)
Definition: Vector.h:118
ZIVID_CORE_EXPORT bool operator==(const VectorXYZ &rhs) const
Check for equality
VectorXYZ(float xCoord, float yCoord, float zCoord)
Constructor
Definition: Vector.h:110
float z
The z element of the vector
Definition: Vector.h:139
VectorXYZ()=default
Constructor
ZIVID_CORE_EXPORT bool operator!=(const VectorXYZ &rhs) const
Check for inequality
float y
The y element of the vector
Definition: Vector.h:136