IFont.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_GRAPHICS_FONTS_IFONT_HPP
#define NOMLIB_GRAPHICS_FONTS_IFONT_HPP
 
#include <iostream>
#include <memory>
 
#include "nomlib/config.hpp"
 
namespace nom {
 
// Forward declarations
class Image;
struct Glyph;
struct FontMetrics;

class IFont
{
  public:
    typedef IFont self_type;
 
    typedef self_type* raw_ptr;
    typedef std::shared_ptr<self_type> shared_ptr;
    typedef std::unique_ptr<self_type> unique_ptr;
 
    enum FontType
    {
      NotDefined = 0,
      BitmapFont,
      TrueTypeFont,
      BMFont
    };
 
    IFont( void )
    {
      // NOM_LOG_TRACE( NOM );
    }
 
    virtual ~IFont( void )
    {
      // NOM_LOG_TRACE( NOM );
    }
 
    virtual IFont::raw_ptr clone( void ) const = 0;
    virtual bool valid ( void ) const = 0;
 
    virtual const Image* image(uint32) const = 0;
    virtual enum IFont::FontType type ( void ) const = 0;
 
    virtual const Glyph& glyph ( uint32, uint32 ) const = 0;
    virtual int newline( uint32 ) const = 0;
    virtual sint spacing ( uint32 ) const = 0;
    virtual int kerning( uint32, uint32, uint32 ) const = 0;
    virtual int hinting( void ) const = 0;
    virtual uint32 font_style( void ) const = 0;
    virtual const FontMetrics& metrics( void ) const = 0;
 
    virtual bool set_point_size( int ) = 0;

    virtual bool set_hinting( int ) = 0;

    virtual bool set_outline( int ) = 0;
 
    virtual void set_font_style( uint32 style ) = 0;
    virtual void set_font_kerning( bool state ) = 0;

    virtual bool load( const std::string& filename ) = 0;
};
 
} // namespace nom
 
#endif // include guard defined