Text.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: Design
File: Text
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#if NDEVR_TEXT_MODEL
#include <NDEVR/Model.h>
#include <NDEVR/TextConstructor.h>
#include <NDEVR/Font.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Logic for inlining certain changes to the display properties of a string of text.
    **/
    enum TextControlSequence
    {
          e_set_font = 'f'
        , e_set_color = 'c'
        , e_set_bold = 'b'
        , e_set_italic = 'i'
        , e_set_underline = '_'
        , e_set_overstrike = '-'
        , e_set_alignment = 'a'
        , e_set_font_size = 's'
        , e_set_fixed_width = 'w'
        , e_set_tab_advance = 't'
    };
    class TextConstructor;
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which contains text in the form of one or more blocks of text data with each block 
        sharing a Font.
    **/
    class NDEVR_DESIGN_API Text : public Model
    {
    public:
        Text();
        Text(const Model& model);
        Text(const Model& model, const Font& font);
        Text(const Model& model, const DynamicPointer<TextConstructor>& font);
        void setText(const TranslatedString& text, bool update_now = false);
        void setText(const String& text, bool update_now = false);
        void setText(const Buffer<TextBlock>& text, bool update_now = false);
        void setAlignment(uint01 alignment, bool update_now = false);
        void setInsertionAlignment(uint01 alignment, bool update_now = false);
        Model textLayer();
        Model textObject() const;
        void setCursor(uint04 cursor_position);
        void update();
        bool needsUpdate() const;
        void updateTranslation();
        void setConstrainedSize(const Vector<2, fltp08>& size);
        void setReferenceSize(const Vector<2, fltp08>& size);
        void setForwardBias(fltp08 forward_bias);
        const Material outlineMaterial() const;
        Material outlineMaterial();
        const Material fillMaterial() const;
        Material fillMaterial();
        void setLineSpaceFactor(fltp08 line_space);
        fltp08 lineSpaceFactor() const;
        void setFillMaterial(const Material& material);
        void setOutlineMaterial(const Material& material);
        String plainText() const;
        const Buffer<TextBlock>& blocks() const { return m_text_blocks; };
        Buffer<TextBlock> autoInsertNewLines() const;
        void setFont(const Font& font, bool update_now = false);
        Font font() const;
        void saveBlockMetaData();
        void readBlockMetaData();
        Model getLetterAt(uint04 string_position) const;
        static constexpr const char* TypeName() { return "text"; }
        void setFaceCamera(bool face_camera);
        void setScaleToCamera(bool face_camera);
        void setFillBackground(bool fill_background);
        static fltp04 DefaultScaler() { return .01f; }
    private:
        void init();
        bool setupLetter(const DynamicPointer<TextConstructor>& printer, Model& letter, char value, fltp08 hor_advance, fltp08 scale, const Font& font);
        bool setupLetter(const DynamicPointer<TextConstructor>& printer, Model& letter, wchar value, fltp08 hor_advance, fltp08 scale, const Font& font);
        void setupCursor(const Matrix<fltp08>& matrix, const Vector<2, fltp08>& cursor_location, const Font& font);
        void findCursor(bool create_if_not_exists);
        void updateBackground();
        void createCursor();
    private:
        mutable DynamicPointer<TextConstructor> m_printer;
        Buffer<TextBlock> m_text_blocks;
        Vector<2, fltp08> m_constrained_size;
        Vector<2, fltp08> m_reference_size;
        Model m_text_model;
        uint04 m_cursor_index;
        uint04 m_cursor_position;
        uint01 m_alignment;
        uint01 m_insertion_alignment;
        mutable fltp08 m_line_space_factor;
        fltp08 m_forward_bias = 0.0;
        bool m_has_background = false;
    };
}
#endif