Frame.h

Go to the documentation of this file.

 
 
/*******************************************************************************
 
 * This file is part of the Zivid 3D Camera API
 
 *
 
 * Copyright 2015-2023 (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/CameraState.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Detail/Pimpl.h"
#include "Zivid/FrameInfo.h"
#include "Zivid/PointCloud.h"
#include "Zivid/Settings.h"
 
#include <memory>
 
namespace Zivid
{
    class Frame
    {
        ZIVID_PIMPL_REFERENCE_SEMANTICS(Frame, ZIVID_CORE_EXPORT);
 
    public:
        ZIVID_CORE_EXPORT Frame();
 
        ZIVID_CORE_EXPORT explicit Frame(const std::string &fileName);
 
        ZIVID_CORE_EXPORT PointCloud pointCloud() const;
 
        ZIVID_CORE_EXPORT CameraState state() const;
 
        ZIVID_CORE_EXPORT Settings settings() const;
 
        ZIVID_CORE_EXPORT FrameInfo info() const;
 
        ZIVID_CORE_EXPORT CameraInfo cameraInfo() const;
 
        ZIVID_CORE_EXPORT void save(const std::string &fileName) const;
 
        ZIVID_CORE_EXPORT void load(const std::string &fileName);
 
        ZIVID_CORE_EXPORT std::string toString() const;
    };
} // namespace Zivid