Zivid C++ API 2.13.1+18e79e79-1
Application.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/Camera.h"
47#include "Zivid/ComputeDevice.h"
50#include "Zivid/Detail/Pimpl.h"
52#include "Zivid/Version.h"
53
55namespace Zivid
56{
57 class SerialNumber;
58
71 {
73
74 private:
75 ZIVID_CORE_EXPORT Application(const std::string &headerVersion);
77 const std::string &headerVersion,
80
82
84 : Application(ZIVID_CORE_VERSION, Detail::detectToolchain(), wrapper)
85 {}
86
87 public:
90 : Application{ Detail::EnvironmentInfo::Wrapper{ Detail::EnvironmentInfo::Wrapper::ValueType::none } }
91 {}
92
99
104
111 ZIVID_CORE_EXPORT Camera createFileCamera(const std::string &cameraFile);
112
121 ZIVID_CORE_EXPORT std::vector<Camera> cameras();
122
126
129 ZIVID_CORE_EXPORT std::string toString() const;
130 };
131} // namespace Zivid
132
134
135// Warning: Enabling ZIVID_ALLOW_UNSAFE_MT is very likely to cause problems such as crashes and is not recommended.
136#ifndef ZIVID_ALLOW_UNSAFE_MT
137# if defined _WIN32 && !defined _DLL
138# error "Zivid SDK only supports the DLL version of the Visual Studio runtime library. \
139To switch from static runtime linkage to dynamic, use the /MD or /MDd flags \
140instead of /MT or /MTd in your project's C/C++ Code Generation settings."
141# endif
142#endif
143
144// Warning: Enabling ZIVID_ALLOW_UNSUPPORTED_MSVC_COMPILER is very likely to cause problems such as crashes and is not
145// recommended.
146#ifndef ZIVID_ALLOW_UNSUPPORTED_MSVC_COMPILER
147# if defined _MSC_VER && _MSC_VER < 1920
148# error "Zivid SDK only supports compiling with Visual Studio 2019 and later versions. \
149Please upgrade your local build tools accordingly."
150# endif
151#endif
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
#define ZIVID_PIMPL_MOVE_ONLY(ClassName, Attributes)
Definition Pimpl.h:104
#define ZIVID_CORE_VERSION
Zivid version string.
Definition VersionConstants.h:59
Manager class for Zivid.
Definition Application.h:71
ZIVID_CORE_EXPORT Camera createFileCamera(const std::string &cameraFile)
Create a virtual camera to simulate Zivid measurements by reading data from a file.
ZIVID_CORE_EXPORT Camera connectCamera()
Connect to the next available Zivid camera.
friend Application Detail::createApplicationForWrapper(Zivid::Detail::EnvironmentInfo::Wrapper wrapper)
ZIVID_CORE_EXPORT ComputeDevice computeDevice() const
The default compute device, used when connecting to new cameras.
ZIVID_CORE_EXPORT Camera connectCamera(const CameraInfo::SerialNumber &serialNumber)
Connect to the Zivid camera with the specified serial number.
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the application.
Application()
Constructor.
Definition Application.h:89
ZIVID_CORE_EXPORT std::vector< Camera > cameras()
Get a list of all cameras.
The serial number of the camera.
Definition CameraInfo.h:940
Interface to one Zivid camera.
Definition Camera.h:69
Contains information about the compute device used by Zivid::Application.
Definition ComputeDevice.h:58
Information about the current toolchain.
Definition EnvironmentInfo.h:1290
The wrapper being used, if any.
Definition EnvironmentInfo.h:2634
The main Zivid namespace. All Zivid code is found here.
Definition Application.h:56