Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Vector.h
Go to the documentation of this file.
1 
2 /*******************************************************************************
3  * This file is part of the Zivid 3D Camera API
4  *
5  * Copyright 2015-2020 (C) Zivid AS
6  * All rights reserved.
7  *
8  * Zivid Software License, v1.0
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
21  * to endorse or promote products derived from this software without specific
22  * prior written permission.
23  *
24  * 4. This software, with or without modification, must not be used with any
25  * other 3D camera than from Zivid AS.
26  *
27  * 5. Any software provided in binary form under this license must not be
28  * reverse engineered, decompiled, modified and/or disassembled.
29  *
30  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
31  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
32  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
33  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
34  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
35  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
37  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Contact: Zivid Support <support@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 
47 #include <ostream>
48 #include <string>
49 
50 namespace Zivid
51 {
55  template<typename T>
56  struct Vector2
57  {
61  using ValueType = T;
62 
64  Vector2() = default;
65 
67  Vector2(T xCoord, T yCoord)
68  : x{ xCoord }
69  , y{ yCoord }
70  {}
71 
74  std::string toString() const
75  {
76  return "[" + std::to_string(x) + ", " + std::to_string(y) + "]";
77  }
78 
80  T x{};
81 
83  T y{};
84  };
85 
87  template<typename T>
88  std::ostream &operator<<(std::ostream &stream, const Vector2<T> &vector2)
89  {
90  return stream << vector2.toString();
91  }
92 
96  using Vector2f = Vector2<float>;
97 
101  using Vector2d = Vector2<double>;
102 
106  template<typename T>
107  struct Vector3
108  {
112  using ValueType = T;
113 
115  Vector3() = default;
116 
118  Vector3(T xCoord, T yCoord, T zCoord)
119  : x{ xCoord }
120  , y{ yCoord }
121  , z{ zCoord }
122  {}
123 
126  std::string toString() const
127  {
128  return "[" + std::to_string(x) + ", " + std::to_string(y) + ", " + std::to_string(z) + "]";
129  }
130 
132  T x{};
133 
135  T y{};
136 
138  T z{};
139  };
140 
142  template<typename T>
143  std::ostream &operator<<(std::ostream &stream, const Vector3<T> &vector3)
144  {
145  return stream << vector3.toString();
146  }
147 
152 
156  using Vector3d = Vector3<double>;
157 } // namespace Zivid
Zivid::Vector3::z
T z
The z element of the vector
Definition: Vector.h:177
Zivid::Vector3::ValueType
T ValueType
The type stored in the vector
Definition: Vector.h:151
Zivid::Vector2::y
T y
The y element of the vector
Definition: Vector.h:162
Zivid::Vector3::toString
std::string toString() const
Get string representation of the Vector3
Definition: Vector.h:165
Zivid::Vector2::toString
std::string toString() const
Get string representation of the Vector2
Definition: Vector.h:153
Zivid::Vector2::x
T x
The x element of the vector
Definition: Vector.h:159
Zivid::Vector3::x
T x
The x element of the vector
Definition: Vector.h:171
Zivid::Vector2::Vector2
Vector2()=default
Constructor
Zivid::Vector3::y
T y
The y element of the vector
Definition: Vector.h:174
Zivid::Vector2::ValueType
T ValueType
The type stored in the vector
Definition: Vector.h:140
Zivid
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:52
Zivid::Vector2d
Vector2< double > Vector2d
Vector of size 2 containing doubles
Definition: Vector.h:140
Zivid::Vector3
Vector of size 3
Definition: Vector.h:146
Zivid::Vector2f
Vector2< float > Vector2f
Vector of size 2 containing floats
Definition: Vector.h:135
Zivid::operator<<
ZIVID_API_EXPORT std::ostream & operator<<(std::ostream &stream, const Camera &camera)
Serialize the value to a stream
Zivid::Vector3::Vector3
Vector3()=default
Constructor