GraphicsCameraManager.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: Graphics
File: GraphicsCameraManager
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "NDEVRGraphics/Headers/DLLInfo.h"
#include "Base/Headers/Matrix.hpp"
#include "Base/Headers/Vector.hpp"
#include "Base/Headers/UUID.h"
#include "Base/Headers/RGBColor.h"
#include "Base/Headers/Time.h"
namespace NDEVR
{
    class GraphicsUpdateArguments;
    class Camera;
    /**--------------------------------------------------------------------------------------------------
    \brief A structure containing common information pushed to the video card for NDEVR Rendering 
        Engine operations.
    **/
    struct CameraUniformObject
    {
        Matrix<fltp04> transform = Matrix<fltp04>(1);
        Vector<4, sint04> origin = Constant<Vector<4, sint04>>::Invalid;
        Vector<4, fltp04> sun_pos = Constant<Vector<4, fltp04>>::Invalid;
        Vector<4, fltp04> camera_pos = Constant<Vector<4, fltp04>>::Invalid;
        fltp04 dpi = 1.0f;
        RGBColor background_color;
 
        bool operator!=(const CameraUniformObject& object) const
        {
            return transform != object.transform
                || origin != object.origin
                || sun_pos != object.sun_pos
                || camera_pos != object.camera_pos
                || dpi != object.dpi
                || background_color != object.background_color;
        }
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A structure for managing Viewport interactions with an NDEVR Rendering Engine.
    **/
    class NDEVR_GRAPHICS_API GraphicsCameraManager
    {
    public:
        GraphicsCameraManager();
        GraphicsCameraManager(const GraphicsCameraManager& m_pipeline);
        virtual ~GraphicsCameraManager();
        void setCamera(const UUID& camera) { m_camera = camera; };
        void updateUniformBuffer(GraphicsUpdateArguments& args);
        bool useCameraMaterial() const;
        UUID overrideMaterial() const { return m_override_material; }
        const CameraUniformObject& uniformObject() const { return m_camera_uniform; }
    protected:
        CameraUniformObject getCameraUniformObject(const Camera& camera, GraphicsUpdateArguments& args) const;
    protected:
        bool m_uses_origin;
        bool m_needs_pipeline_update;
        bool m_use_anisotropy;
        bool m_use_camera_material;
        mutable bool m_needs_uniform_commit;
 
        CameraUniformObject m_camera_uniform;
        UUID m_camera;
        UUID m_override_material;
        Time m_last_updated_time;
    };
}