Presets.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2025 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <Zivid/CameraInfo.h>
#include <Zivid/Settings.h>
#include <Zivid/Settings2D.h>
 
#include <string>
#include <vector>
 
#ifdef _MSC_VER
#    pragma warning(push)
#    pragma warning(disable : 4251) // "X needs to have dll-interface to be used by clients of class Y."
#endif
 
namespace Zivid
{
    namespace Presets
    {
        template<typename SettingsType>
        class ZIVID_CORE_EXPORT PresetBase
        {
        public:
            PresetBase(std::string name, SettingsType settings) noexcept;

            const std::string &name() const noexcept;

            const SettingsType &settings() const noexcept;

            std::string toString() const;
 
        private:
            std::string m_name;
            SettingsType m_settings;
        };

        template<typename PresetType>
        class ZIVID_CORE_EXPORT CategoryBase
        {
        public:
            CategoryBase(std::string name, std::vector<PresetType> presets) noexcept;

            const std::string &name() const noexcept;

            const std::vector<PresetType> &presets() const noexcept;

            std::string toString() const;
 
        private:
            std::string m_name;
            std::vector<PresetType> m_presets;
        };

        using Preset = PresetBase<Zivid::Settings>;
        using Category = CategoryBase<Preset>;
        using Preset2D = PresetBase<Zivid::Settings2D>;
        using Category2D = CategoryBase<Preset2D>;

        ZIVID_CORE_EXPORT std::vector<Category> categories(const CameraInfo::Model &model);

        ZIVID_CORE_EXPORT std::vector<Category2D> categories2D(const CameraInfo::Model &model);

        template<typename Settings>
        ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const PresetBase<Settings> &preset);

        template<typename Preset>
        ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const CategoryBase<Preset> &category);
    } // namespace Presets
} // namespace Zivid
 
#ifdef _MSC_VER
#    pragma warning(pop)
#endif