DtFont.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2014 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once

#include <vrvGraphics/vrvGraphics.h>
#include <vector>
#include <string>
#include <vrvGraphics/DtBoundingBox.h>
#include <vrvUtil/DtUnicode.h>

namespace makVrv
{
   class DtUnicode;
   class DtPen;
   class DtGlyph;
   class DtGlyphRenderer;
   class DtFontManager;
   class DtFreeTypeFace;

   class DT_DLL_VRVGRAPHICS DtFont
   {      
   public:

      enum TextAlignement
      {
         AlignLeft,
         AlignCenter,
         AlignRight,
         AlignJustify
      };

      ~DtFont();

      const std::string& fontName() const;

      bool attachFile(const char* fontFilePath);

      void setFreeTypeLoadFlags(unsigned int flags);

      bool setCharacterMap(unsigned int encoding);   

      const unsigned int* characterMaps();

      unsigned int characterMapCount() const;

      // Returns the free type face object
      const DtFreeTypeFace& freeTypeFace() const;

      // Set the Character face size.
      bool setFaceSize(const unsigned int size);

      // Get the character face size.
      unsigned int faceSize() const;

      // Get the global ascender height for the face.
      float globalAscender() const;

      // Gets the global descender height for the face.
      float globalDescender() const;

      // Gets the line spacing for the font.
      float lineHeight() const;

      DtBoundingBox calculateBoundingBox(const DtPen& pen, 
         const DtUnicode& string, unsigned int pos = 0, int len = -1);

      Dt2dPoint calculateGlyphSize(const DtPen& pen, 
         const DtUnicode& string, unsigned int pos = 0, int len = -1);

      // Get the advance for a string.
      float calculateAdvance(const DtPen& pen, const DtUnicode& string, 
         unsigned int pos = 0, int len = -1);

      // Release any font resources.
      void releaseResources();

      bool isValid() const;

      bool checkError() const;

      DtGlyph* findOrLoadGlyphForRendering(DtGlyphRenderer& renderer,const unsigned int characterCode,
         bool characterCodeIsIndex = false);

      DtGlyph* findOrLoadGlyph(const unsigned int chr);

      unsigned int indexInFont(const unsigned int characterCode) const;

      // Calculate the kerning vector between two glyphs
      Dt2dPoint calculateKerning(unsigned int index1, unsigned int index2);

      class FontPrivate;

   protected:

      friend class DtFontManager;

      DtFont(DtFontManager& fm, const std::string& fontFilePath);

   protected:

      FontPrivate* myImpl;
   };
}