Zivid C++ API 2.13.1+18e79e79-1
Camera.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
46#include "Zivid/CameraInfo.h"
48#include "Zivid/CameraState.h"
50#include "Zivid/Frame.h"
51#include "Zivid/Frame2D.h"
53#include "Zivid/Settings.h"
54#include "Zivid/Settings2D.h"
55
56#include <functional>
57#include <memory>
58
59namespace Zivid
60{
61 class Frame2D;
62
68 class Camera
69 {
70 public:
73
76
78 ZIVID_CORE_EXPORT Camera(const Camera &other) noexcept;
79
81 ZIVID_CORE_EXPORT Camera &operator=(const Camera &other) noexcept;
82
84 ZIVID_CORE_EXPORT Camera(Camera &&other) noexcept;
85
88
91
94
100
104
145
155
156#ifndef NO_DOC
157 ZIVID_CORE_EXPORT explicit Camera(std::shared_ptr<class CameraImpl> &&other);
158 ZIVID_CORE_EXPORT const CameraImpl &getImpl() const;
159 ZIVID_CORE_EXPORT CameraImpl &getImpl();
160#endif
163
168 ZIVID_CORE_EXPORT void writeUserData(const std::vector<uint8_t> &data);
169
171 ZIVID_CORE_EXPORT std::vector<uint8_t> userData() const;
172
175
199
202 ZIVID_CORE_EXPORT std::string toString() const;
203
205 ZIVID_CORE_EXPORT bool operator==(const Camera &other) const;
206
208 ZIVID_CORE_EXPORT bool operator!=(const Camera &other) const;
209
210 private:
211 std::shared_ptr<class CameraImpl> m_impl;
212 };
213
215 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const Camera &camera);
216
217} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
Information about camera model, serial number etc.
Definition CameraInfo.h:79
Information about camera connection state, temperatures, etc.
Definition CameraState.h:79
Interface to one Zivid camera.
Definition Camera.h:69
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 NetworkConfiguration networkConfiguration() const
Get the network configuration from the camera.
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 void applyNetworkConfiguration(const NetworkConfiguration &networkConfiguration)
Applies the specified network configuration to the camera.
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:69
A frame captured by a Zivid camera.
Definition Frame.h:70
Network configuration of a camera.
Definition NetworkConfiguration.h:81
Settings used when capturing 2D images with a Zivid camera.
Definition Settings2D.h:79
Settings used when capturing with a Zivid camera.
Definition Settings.h:80
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