TextWriter.h

Go to the documentation of this file.

/*

License

Menge
Copyright © and trademark ™ 2012-14 University of North Carolina at Chapel Hill. 
All rights reserved.

Permission to use, copy, modify, and distribute this software and its documentation 
for educational, research, and non-profit purposes, without fee, and without a 
written agreement is hereby granted, provided that the above copyright notice, 
this paragraph, and the following four paragraphs appear in all copies.

This software program and documentation are copyrighted by the University of North 
Carolina at Chapel Hill. The software program and documentation are supplied "as is," 
without any accompanying services from the University of North Carolina at Chapel 
Hill or the authors. The University of North Carolina at Chapel Hill and the 
authors do not warrant that the operation of the program will be uninterrupted 
or error-free. The end-user understands that the program was developed for research 
purposes and is advised not to rely exclusively on the program for any reason.

IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS 
BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL 
DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS 
DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE 
AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY 
DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY 
OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND 
THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS 
TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu

*/

#ifndef __TEXT_WRITER_H__
#define __TEXT_WRITER_H__

#include "CoreConfig.h"
#include "image.h"
#include <string>
#include "SDL/SDL_ttf.h"
#include <map>

namespace Menge {

    namespace SceneGraph {
        typedef std::map< int, TTF_Font * > FontMap;
        
        typedef FontMap::iterator FontMapItr;
        
        typedef FontMap::const_iterator FontMapCItr;

        class MENGE_API TextWriter {
            static std::string DEFAULT_FONT;

            static const int DEFAULT_SIZE;
        public:
            static void setDefaultFont( const std::string & fontName );

            enum Alignment {
                NO_ALIGN = 0x0,         // 0
                VCENTER = 0x1,          // 1
                TOP = 0x2,              // 2
                BOTTOM = 0x4,           // 4
                LEFT = 0x8,             // 8
                LEFT_CENTER = 0x9,      // 9
                LEFT_TOP = 0xA,         // 10
                LEFT_BOTTOM = 0xC,      // 12
                RIGHT = 0x10,           // 16 
                RIGHT_CENTER = 0x11,    // 17
                RIGHT_TOP = 0x12,       // 18
                RIGHT_BOTTOM = 0x14,    // 20
                HCENTER = 0x20,         // 32
                CENTERED = 0x21,        // 33
                CENTER_TOP = 0x22,      // 34
                CENTER_BOTTOM = 0x24    // 36
            };

            static TextWriter * Instance();

            void newGLContext();

            void printText( const std::string & text, Alignment alignment, float anchorX, float anchorY, int fontSize, bool currColor=false, bool transparent=true );

            void printText( const std::string & text, float left, float bottom, int fontSize, bool currColor=false, bool transparent=true );
            
            void printAlignText( const std::string & text, Alignment alignment, int fontSize, float hpad, float vpad, bool currColor=false, bool transparent=true );

            void printAnchorText( const std::string & text, float anchorX, float anchorY, float xWeight, float yWeight, int fontSize, bool currColor=false, bool transparent=true );
            
            void textSize( const std::string & text, int fontSize, float & textWidth, float & textHeight ); 

            void resize( int w, int h );
            
            inline int getViewWidth() const { return _width; }
            
            inline int getViewHeight() const { return _height; }

            bool setFont( const std::string & fontName );

            void setDefaultColor( float r, float g, float b, float alpha=1.f );

            inline int  flipY( int y ) { return _height - y; }

            // TODO: Support multiple families of fonts

        protected:
            TTF_Font * getFont( int size );

            void closeFonts();

            TextWriter();

            ~TextWriter();

            static TextWriter* _instance;

            int _width;
            
            int _height;

            void makeTextDList();

            void makeGLTexture();

            void sdlSurfaceToGLTex( SDL_Surface * surf );

            void printLine( TTF_Font * font, const char * text, float left, float bottom, int lineNum );

            FontMap   _fonts;

            std::string _fontName;

            GLuint    _textID;

            GLuint    _textQuadID;

            float       _defColor[4];

        };
    }   // namespace SceneGraph
}   // namespace Menge
#endif  //__TEXT_WRITER_H__