QModelViewCapture.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: QModelViewCapture
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#if NDEVR_VIEWPORT
#include <NDEVR/SnapLocation.h>
#include <NDEVR/UUID.h>
#include <NDEVR/RGBColor.h>
#include <NDEVR/Angle.h>
#include <NDEVR/Buffer.h>
#include <QImage>
#include <functional>
namespace NDEVR
{
    class Renderer;
    class GraphicsDevice;
    class QTModelManager;
    class BasicThread;
    /**--------------------------------------------------------------------------------------------------
    \brief Information relating to capturing a 3D view into a 2D raster image.
    **/
    struct CaptureInfo
    {
        Vector<2, uint04> size = { 128, 128 };
        fltp08 reference_size = 128.0;
        Vector<3, Angle<fltp08>> angle_offsets;
        SnapLocation snap = SnapLocation::e_no_snap;
        UUID target_object = Constant<UUID>::Invalid;
        Buffer<UUID> included_objects;
        RGBColor background = { 255, 255, 255, 0};
        bool orthographic = false;
        bool auto_crop = false;
        bool operator==(const CaptureInfo& info) const
        {
            return (snap == info.snap)
                && (target_object == info.target_object)
                && (included_objects == info.included_objects)
                && (orthographic == info.orthographic)
                && (background == info.background)
                && (reference_size == info.reference_size)
                && (size == info.size)
                && (auto_crop == info.auto_crop);
        }
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A request to capture the 3D view as a 2D image.
    **/
    struct CaptureRequest : public CaptureInfo
    {
        CaptureRequest(UUID id)
            : m_id(id)
        {}
        CaptureRequest(UUID id, const CaptureInfo& info, const std::function<void(const QImage& image)>& n_callback)
            : CaptureInfo(info)
            , m_id(id)
            , callback(n_callback)
        {}
        UUID uuid() const { return m_id; }
        bool operator==(const CaptureInfo& info) const
        {
            return (snap == info.snap)
                && (target_object == info.target_object)
                && (included_objects == info.included_objects)
                && (orthographic == info.orthographic)
                && (background == info.background)
                && (auto_crop == info.auto_crop)
                && (reference_size == info.reference_size)
                && (size == info.size);
        }
        UUID m_id;
        std::function<void(const QImage& image)> callback = nullptr;
    };
    
}
#endif