src/OpenGl/OpenGl_TextBuilder.hxx

   1 // Created on: 2015-06-18
   2 // Created by: Ilya SEVRIKOV
   3 // Copyright (c) 2015 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef OpenGl_TextBuilder_Header
  17 #define OpenGl_TextBuilder_Header
  18
  19 #include <OpenGl_Context.hxx>
  20 #include <OpenGl_Font.hxx>
  21 #include <OpenGl_VertexBuffer.hxx>
  22 #include <OpenGl_VertexBufferEditor.hxx>
  23 #include <OpenGl_Vec.hxx>
  24
  25 #include <NCollection_Vector.hxx>
  26 #include <NCollection_Handle.hxx>
  27
  28 class Font_TextFormatter;
  29
  30 //! This class generates primitive array required for rendering textured text using OpenGl_Font instance.
  31 class OpenGl_TextBuilder
  32 {
  33 public:
  34
  35   //! Creates empty object.
  36   Standard_EXPORT OpenGl_TextBuilder();
  37
  38   //! Creates texture quads for the given text.
  39   Standard_EXPORT void Perform (const Handle(Font_TextFormatter)&                theFormatter,
  40                                 const Handle(OpenGl_Context)&                    theContext,
  41                                 OpenGl_Font&                                     theFont,
  42                                 NCollection_Vector<GLuint>&                      theTextures,
  43                                 NCollection_Vector<Handle(OpenGl_VertexBuffer)>& theVertsPerTexture,
  44                                 NCollection_Vector<Handle(OpenGl_VertexBuffer)>& theTCrdsPerTexture);
  45
  46 protected: //! @name class auxillary methods
  47
  48   Standard_EXPORT void createGlyphs (const Handle(Font_TextFormatter)&                                              theFormatter,
  49                                      const Handle(OpenGl_Context)&                                                  theCtx,
  50                                      OpenGl_Font&                                                                   theFont,
  51                                      NCollection_Vector<GLuint>&                                                    theTextures,
  52                                      NCollection_Vector< NCollection_Handle < NCollection_Vector <OpenGl_Vec2> > >& theVertsPerTexture,
  53                                      NCollection_Vector< NCollection_Handle < NCollection_Vector <OpenGl_Vec2> > >& theTCrdsPerTexture);
  54
  55 protected: //! @name class auxillary fields
  56
  57   NCollection_Vector<OpenGl_Font::Tile>  myTileRects;
  58   OpenGl_VertexBufferEditor<OpenGl_Vec2> myVboEditor;
  59 };
  60
  61 #endif // OpenGl_TextBuilder_Header