Frame.h

Go to the documentation of this file.

/*[
 * This file is part of the Zivid 3D Camera API
 *
 * Copyright 2015-2018 (C) Zivid Labs. All rights reserved.
 * Contact info@zividlabs.com or see http://www.zividlabs.com
 * 
 * This code is proprietary and confidential.
 * Unauthorized copying of this file, via any medium is strictly prohibited.
]*/

#pragma once


#include "APIExport.h"
#include "PointCloud.h"
#include "DeviceCloud.h"
#include "Settings.h"
#include "CameraState.h"
#include "FrameInfo.h"
#include "ComputeDevice.h"

#include <vector>
#include <memory>

namespace Zivid
{
    class FrameImpl;

    class Frame
    {
    public:
        ZIVID_API Frame();

        ZIVID_API explicit Frame(const std::string &fileName);

        ZIVID_API explicit Frame(const std::string &fileName, ComputeDevice computeDevice);

        ZIVID_API Frame clone() const;

        ZIVID_API PointCloud getPointCloud() const;

        ZIVID_API DeviceCloud deviceCloud() const;

        ZIVID_API CameraState state() const;

        ZIVID_API Settings settings() const;

        ZIVID_API FrameInfo info() const;

        ZIVID_API void save(const std::string& fileName) const;

        ZIVID_API void load(const std::string& fileName);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
        ZIVID_API explicit Frame(FrameImpl && other);
        ZIVID_API FrameImpl &getImpl();
        ZIVID_API const FrameImpl &getImpl() const;
#endif

    private:
        std::shared_ptr<FrameImpl> m_impl;
    };
}