GraphicsUpdateArguments.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: UpdateArguments
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include "NDEVRGraphics/Headers/GraphicsPipeline.h"
#include "Design/Headers/DesignObjectLookup.h"
namespace NDEVR
{
    class Image;
    /**--------------------------------------------------------------------------------------------------
    \brief Options that are used for performing an update on a Graphics Engine call. 
    **/
    class NDEVR_GRAPHICS_API GraphicsUpdateArguments
    {
    public:
        GraphicsUpdateArguments();
        ~GraphicsUpdateArguments();
        bool needsPipelineRecreation() const { return m_needs_model_recreation || m_needs_pipeline_recreation; }
        bool isDrawing() const;
        void setPipelineRecreationNeeded();
        void finishPipelineRecreation();
        bool needsModelRecreation() const { return m_needs_model_recreation; }
        void setModelRecreation(bool needed);
        void setScreenDrawAll(bool screen_draw)
        {
            for (auto it = needs_screen_draw.begin(); it != needs_screen_draw.end(); ++it)
                it.value() = screen_draw;
        }
        bool shouldDraw(const UUID& id) const
        {
            if (visible_items.isNull())
                return true;
            auto value = visible_items->find(id);
            if (value == visible_items->end())
                return false;
            return value.value();//only return for visible items
        }
        ProgressInfo* log;
        DesignObjectLookup* lookup;
        GraphicsDevice* device;
        UUID camera;
        Time frame_time;
        RGBColor background_color = RGBColor(255, 255, 255, 255);
        Time refresh_command_time;
        Dictionary<UUID, bool> needs_screen_draw;
        ConstPointer<Dictionary<UUID, bool>> visible_items;
        uint04 multisample_count;
        Vector<2, uint04> window_size;
        void* frame_image_resource = nullptr;
        Material override_material;
        fltp04 depth_bias;
        uint04 frame_index = Constant<uint04>::Invalid;
        uint04 frame_count = 0U;
        uint04 current_khr_index = Constant<uint04>::Invalid;
        Image* grab_image = nullptr;
        bool is_grab_image;
    protected:
        bool m_needs_pipeline_recreation;
        bool m_needs_model_recreation;
    };
}