Zivid C++ API 2.13.1+18e79e79-1
Presets.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>
47#include <Zivid/Settings.h>
48
49#include <string>
50#include <vector>
51
52#ifdef _MSC_VER
53# pragma warning(push)
54# pragma warning(disable : 4251) // "X needs to have dll-interface to be used by clients of class Y."
55#endif
56
57namespace Zivid
58{
59 namespace Presets
60 {
70 template<typename SettingsType>
72 {
73 public:
75 PresetBase(std::string name, SettingsType settings) noexcept;
76
78 const std::string &name() const noexcept;
79
86 const SettingsType &settings() const noexcept;
87
89 std::string toString() const;
90
91 private:
92 std::string m_name;
93 SettingsType m_settings;
94 };
95
100 template<typename PresetType>
102 {
103 public:
105 CategoryBase(std::string name, std::vector<PresetType> presets) noexcept;
106
108 const std::string &name() const noexcept;
109
116 const std::vector<PresetType> &presets() const noexcept;
117
119 std::string toString() const;
120
121 private:
122 std::string m_name;
123 std::vector<PresetType> m_presets;
124 };
125
130
142 ZIVID_CORE_EXPORT std::vector<Category> categories(const CameraInfo::Model &model);
143
145 template<typename Settings>
146 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PresetBase<Settings> &preset);
147
149 template<typename Preset>
150 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const CategoryBase<Preset> &category);
151 } // namespace Presets
152} // namespace Zivid
153
154#ifdef _MSC_VER
155# pragma warning(pop)
156#endif
#define ZIVID_CORE_EXPORT
Definition CoreExport.h:56
Information about camera model, serial number etc.
Definition CameraInfo.h:79
Preset category. A preset category contains a collection of presets optimized for one scenario or use...
Definition Presets.h:102
CategoryBase(std::string name, std::vector< PresetType > presets) noexcept
Constructor.
const std::string & name() const noexcept
Get the name of the category.
Presets are pre-defined settings that are tuned for different camera models to perform optimally unde...
Definition Presets.h:72
PresetBase(std::string name, SettingsType settings) noexcept
Constructor.
const std::string & name() const noexcept
Get the name of the preset.
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