gls_runtime_font_base.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsRuntimeFontBase class and related classes.

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef INCLUDE_GLS_RUNTIME_FONT_BASE_H
#define INCLUDE_GLS_RUNTIME_FONT_BASE_H

#include "gls_font_base.h"
#include "scoped_ptr.h"

namespace disti
{
// Forward Declaration
class RuntimeGlyphGenerationFont;

//===========================================================================
/**
* The GlsRuntimeFontBase class provides a specific font face for use within the GL 
* Studio.  The font face is determined at construction time by the 
* parameters passed in by the creator of the GlsFontBase instance.  Specific
* instances should be wrapped in a singleton object wrapper, as there is
* no reason to have more than one instance of the exact same face (meaning
* font family, style, and point size.)
*
* Once instanced, a GlsFontRenderer object can be used to render characters in
* Open GL at specific locations and with several different text effects.
* 
* \sa GlsFontRenderer
*/
//===========================================================================
class GlsRuntimeFontBase : public GlsFontBase
{
public:
    /** char index associated with absent glyph */
    static const unsigned short NO_GLYPH;

    //-----------------------------------------------------------------------
    /// Attributes of the specific font
    //-----------------------------------------------------------------------
    typedef GlsFontBase::FontAttr_t FontAttrRuntime_t;

    //-----------------------------------------------------------------------
    /// Character attributes. One item for each character in the set.
    //-----------------------------------------------------------------------
    typedef GlsFontBase::CharAttr_t CharAttrRuntime_t;

    typedef std::vector<CharAttrRuntime_t> AttrContRuntime_t;

    /** Class Constructor
      * \param family the family name of the font.
      * \param style the style name of the font.
      * \param ptSize the point size of the font.
      * \param fontPath the path and filename of the font file to load.
      * \param maxCharWidth the maximum width of the largest character.
      * \param maxCharHeight the maximum height of the largest character.
      * \param descender the maximum descender of the largest character.
      */
    GLS_EXPORT GlsRuntimeFontBase( const char* family, const char* style, const unsigned int ptSize, const char* fontPath,
        const unsigned int maxCharWidth, const unsigned int maxCharHeight, const unsigned int descender );

    /** Determine if font was instantiated correctly
      * \return true if valid else false
      */
    GLS_EXPORT bool IsValid( void ) const;

    /** Gets the runtime character attribute for the given char
      * \param c The character to retrieve attributes for.
      * \returns The attributes for the character else char attributes for first character
      *         in font if char is not in range for this font
      */
    GLS_EXPORT const CharAttrRuntime_t& CharAttrRuntime( Char_t c ) const;

    /** Gets a pointer to the internal data needed for runtime glyph generation.
      * \return A pointer to the internal data needed for runtime glyph generation.
      */
    GLS_EXPORT RuntimeGlyphGenerationFont* GetRuntimeGlyphGenerationFont();

protected:
    /** 
    * Class Destructor. This is protected so that no one can delete a font
    * except via the font manager GlsFontMan.
    * It is not virtual because we want to avoid calling destructors on unloaded font code, 
    * and it is not needed.
    */
    GLS_EXPORT ~GlsRuntimeFontBase();

    friend class GlsFontMan;

    FontAttrRuntime_t _fontAttrRuntime; /**< runtime font attributes */

    mutable CharAttrRuntime_t _charAttrRuntime; /**< runtime char attributes */

    bool _isValid; /**< true if font is valid else false */

    /** Pointer to the internal data needed for runtime glyph generation. */
    ScopedPtr<RuntimeGlyphGenerationFont> _runtimeGlyphGenerationFont;

private:
    //-----------------------------------------------------------------------
    // Prevent copies
    //-----------------------------------------------------------------------
    GlsRuntimeFontBase( const GlsRuntimeFontBase& );
    GlsRuntimeFontBase& operator=( const GlsRuntimeFontBase& );

}; // end class GlsRuntimeFontBase

} // end namespace disti

#endif