PaperView.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2020, 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: Design
File: PaperView
Included in API: True
Author(s): tyler.parke
 *-----------------------------------------------------------------------------------------**/
 
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Model.h>
#include <NDEVR/Camera.h>
#include <NDEVR/TranslatedString.h>
#include <NDEVR/Vector.h>
#include <NDEVR/StringEnum.h>
namespace NDEVR
{
    class NDEVR_DESIGN_API PaperView : public Model
    {
    public:
        PaperView(const Model& model);

        static constexpr StringView TypeName() { return "Paper_View"; }

        void setPaperSize(Vector<2, fltp04> size);

        void setInnerPaperSize(Vector<2, fltp04> size);

        Vector<2, fltp04> paperSize() const;

        Vector<2, fltp04> innerPaperSize() const;

        Vector<4, fltp04> margins() const;

        void setMargins(Vector<4, fltp04> margin);

        static const Buffer<std::pair<TranslatedString, Vector<2, fltp04>>>& PaperSizes();

        static Vector<4, fltp04> DefaultMarginsFor(const Vector<2, fltp04>& page_size);

        void setupViewportForCapture(const DynamicPointer<Camera>& camera);

        void setupViewportForUser(const DynamicPointer<Camera>& camera);

        Matrix<fltp08> captureViewMatrix() const;

        void setWorldBounds(Bounds<3, fltp08> bounds);

        Bounds<3, fltp08> worldBounds() const;

        Model innerPage() const;

        Model outerPage() const;

        Bounds<3, fltp08> captureBounds() const;

        fltp04 dotsPerMeter() const;

        void setDotsPerMeter(fltp04 weight);
 
    private:
        void init();

        void setupDisplay(Model model, RGBColor color);

        Vector<2, fltp04> adjustPaperSizeIn(Vector<2, fltp04> size) const;

        Bounds<2, fltp04> adjustBoundsIn(Bounds<2, fltp04> size) const;

        Vector<2, fltp04> adjustPaperSizeOut(Vector<2, fltp04> size) const;

        Bounds<2, fltp04> adjustBoundsOut(Bounds<2, fltp04> size) const;

        fltp04 yScaleFactor() const;
    };

    #define PAPERVIEW_PARAMS(X) \
        X(e_page_size) \
        X(e_margins) \
        X(e_world_bounds) \
        X(e_dots_per_meter)

    NDEVR_DEFINE_STRING_STREAM(PaperViewProperty, PAPERVIEW_PARAMS)
    template class NDEVR_DESIGN_API StringStream<PaperViewProperty>;

    template<> struct PropertySpec<PaperViewProperty::e_page_size> { using type = Vector<2, fltp04>; };
    template<> struct PropertySpec<PaperViewProperty::e_margins> { using type = Vector<4, fltp04>; };
    template<> struct PropertySpec<PaperViewProperty::e_world_bounds> { using type = Bounds<3, fltp08>; };
    template<> struct PropertySpec<PaperViewProperty::e_dots_per_meter> { using type = fltp04; };

    template<>
    class PropertyInterface<PaperViewProperty>
    {
    public:
        template<PaperViewProperty t_property, class t_value_type>
        static void Set(DesignInfo* object, const t_value_type& value)
        {
            if constexpr (t_property == PaperViewProperty::e_margins)
                PaperView(Model(*object)).setMargins(value);
            else if constexpr (t_property == PaperViewProperty::e_page_size)
                PaperView(Model(*object)).setPaperSize(value);
            else if constexpr (t_property == PaperViewProperty::e_world_bounds)
                PaperView(Model(*object)).setWorldBounds(value);
            else if constexpr (t_property == PaperViewProperty::e_dots_per_meter)
                PaperView(Model(*object)).setDotsPerMeter(value);
        }

        template<PaperViewProperty t_property>
        static decltype(auto) Get(const DesignInfo* object)
        {
            if constexpr (t_property == PaperViewProperty::e_margins)
                return PaperView(Model(*object)).margins();
            else if constexpr (t_property == PaperViewProperty::e_page_size)
                return PaperView(Model(*object)).paperSize();
            else if constexpr (t_property == PaperViewProperty::e_world_bounds)
                return PaperView(Model(*object)).worldBounds();
            else if constexpr (t_property == PaperViewProperty::e_dots_per_meter)
                return PaperView(Model(*object)).dotsPerMeter();
        }

        template<PaperViewProperty t_property, class t_value_type>
        static decltype(auto) Get(const DesignInfo* object)
        {
            return Get<t_property>(object);
        }
    };
}