Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Camera.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
91#include "Zivid/CameraInfo.h"
93#include "Zivid/CameraState.h"
95#include "Zivid/Frame.h"
96#include "Zivid/Frame2D.h"
97#include "Zivid/Settings.h"
98#include "Zivid/Settings2D.h"
99
100#include <functional>
101#include <memory>
102
103namespace Zivid
104{
105 class Frame2D;
106
112 class Camera
113 {
114 public:
117
120
122 ZIVID_CORE_EXPORT Camera(const Camera &other) noexcept;
123
125 ZIVID_CORE_EXPORT Camera &operator=(const Camera &other) noexcept;
126
128 ZIVID_CORE_EXPORT Camera(Camera &&other) noexcept;
129
132
135
138
144
148
173
183
184#ifndef NO_DOC
185 ZIVID_CORE_EXPORT explicit Camera(class CameraImpl &&other);
186 ZIVID_CORE_EXPORT const CameraImpl &getImpl() const;
187 ZIVID_CORE_EXPORT CameraImpl &getImpl();
188#endif
191
196 ZIVID_CORE_EXPORT void writeUserData(const std::vector<uint8_t> &data);
197
199 ZIVID_CORE_EXPORT std::vector<uint8_t> userData() const;
200
203 ZIVID_CORE_EXPORT std::string toString() const;
204
206 ZIVID_CORE_EXPORT bool operator==(const Camera &other) const;
207
209 ZIVID_CORE_EXPORT bool operator!=(const Camera &other) const;
210
211 private:
212 std::shared_ptr<class CameraImpl> m_impl;
213 };
214
216 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const Camera &camera);
217
218} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
Information about camera model, serial number etc.
Definition: CameraInfo.h:123
Information about camera connection state, temperatures, etc.
Definition: CameraState.h:123
Interface to one Zivid camera
Definition: Camera.h:113
ZIVID_CORE_EXPORT Camera()
Constructor
ZIVID_CORE_EXPORT void closeAperture()
Close the camera's aperture
ZIVID_CORE_EXPORT Camera(const Camera &other) noexcept
Copy constructor
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the camera info
ZIVID_CORE_EXPORT Camera & operator=(Camera &&other) noexcept
Move assignment operator
ZIVID_CORE_EXPORT Frame2D capture(const Settings2D &settings2D)
Capture a single 2D frame
ZIVID_CORE_EXPORT Camera & operator=(const Camera &other) noexcept
Copy assignment
ZIVID_CORE_EXPORT bool operator==(const Camera &other) const
Check if two camera instances represent the same device
ZIVID_CORE_EXPORT void writeUserData(const std::vector< uint8_t > &data)
Write user data to camera. The total number of writes supported depends on camera model and size of d...
ZIVID_CORE_EXPORT std::vector< uint8_t > userData() const
Read user data from camera
ZIVID_CORE_EXPORT void disconnect()
Disconnect from the camera and free all resources associated with it
ZIVID_CORE_EXPORT Frame capture(const Settings &settings)
Capture a single frame
ZIVID_CORE_EXPORT bool operator!=(const Camera &other) const
Check if two camera instances represent different devices
ZIVID_CORE_EXPORT Camera(Camera &&other) noexcept
Move constructor
ZIVID_CORE_EXPORT Camera & connect()
Connect to the camera
ZIVID_CORE_EXPORT ~Camera()
Destructor
ZIVID_CORE_EXPORT CameraInfo info() const
Get information about camera model, serial number etc.
ZIVID_CORE_EXPORT CameraState state() const
Get the current camera state
A 2D frame captured by a Zivid camera
Definition: Frame2D.h:117
A frame captured by a Zivid camera
Definition: Frame.h:115
Settings used when capturing 2D images with a Zivid camera
Definition: Settings2D.h:123
Settings used when capturing with a Zivid camera
Definition: Settings.h:124
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