DeviceCloud.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 "PointCloud.h"
#include "ComputeDevice.h"
#include "APIExport.h"

#include <memory>
#include <utility>
#include <chrono>

namespace Zivid
{
    class DeviceCloudImpl;
    class DeviceCloud;
    class PointCloud;

    class DeviceCloud
    {
    public:
        ZIVID_COMMON_COMPUTE DeviceCloud();
      
        ZIVID_COMMON_COMPUTE explicit DeviceCloud(const PointCloud& cloud);

        ZIVID_COMMON_COMPUTE explicit DeviceCloud(const PointCloud& cloud, ComputeDevice device);

        ZIVID_COMMON_COMPUTE bool isEmpty() const;

        ZIVID_COMMON_COMPUTE DeviceCloud clone() const;

        ZIVID_COMMON_COMPUTE PointCloud copyToCPU();

        ZIVID_COMMON_COMPUTE void lock();

        ZIVID_COMMON_COMPUTE size_t rows() const;

        ZIVID_COMMON_COMPUTE size_t cols() const;

        ZIVID_COMMON_COMPUTE void unlock();

        ZIVID_COMMON_COMPUTE bool tryLock();

        ZIVID_COMMON_COMPUTE bool tryLockFor(const std::chrono::milliseconds &duration);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
        ZIVID_COMMON_COMPUTE DeviceCloudImpl &getImpl();
        ZIVID_COMMON_COMPUTE const DeviceCloudImpl &getImpl() const;
        ZIVID_COMMON_COMPUTE explicit DeviceCloud(const DeviceCloudImpl &other);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

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