OSDLTrueTypeFont.h

Go to the documentation of this file.

#ifndef OSDL_TRUETYPE_FONT_H_
#define OSDL_TRUETYPE_FONT_H_


#include "OSDLFont.h"         // for inheritance

// for font primitives (no TTF_Font forward declaration possible)
#include "SDL_ttf.h"          

#include <string>





namespace OSDL
{


    namespace Video
    {


        // Fonts are rendered to surfaces.
        class Surface ;



        namespace TwoDimensional
        {
            
                        
            
            namespace Text
            {   
            


                class OSDL_DLL TrueTypeFont : public Font
                {
                
                
                    public:
                    
                    
                        
                        TrueTypeFont( 
                            const std::string & fontFilename, 
                            PointSize pointSize,
                            FontIndex index = 0, 
                            bool convertToDisplay = true,
                            RenderCache cacheSettings = GlyphCached ) 
                                throw( TextException ) ;
                        
                        
                        virtual ~TrueTypeFont() throw() ;
                        
                        
                        virtual PointSize getPointSize() const throw() ;
                        

                        virtual RenderingStyle getRenderingStyle() const 
                            throw() ;
                        
                        
                        virtual void setRenderingStyle( 
                            RenderingStyle newStyle ) throw( TextException ) ;



                        // Glyph-dependent methods.     
                        
                        
                        virtual Width getWidth( Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;
                                
                                
                        virtual SignedWidth getWidthOffset( 
                                Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;
                                
                                
                        virtual SignedHeight getHeightAboveBaseline(
                                Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;
                                
                         
                        virtual SignedLength getAdvance( 
                                Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;
                        
                        
                        
                        // Glyph-independent methods.       
                                                
                                                
                        virtual Height getHeight() const throw() ;
                                                
                        
                        virtual SignedHeight getAscent() const throw() ;
                         
                         
                        virtual SignedHeight getDescent() const throw() ;
                         
                         
                        virtual Height getLineSkip() const throw() ;
                        
                        
                        virtual Ceylan::Uint16 getFacesCount() const throw() ; 
                        
                        
                        virtual bool isFixedWidth() const throw() ;
                        
                          
                        virtual std::string getFaceFamilyName() const throw() ;
                        
                        
                        virtual std::string getFaceStyleName() const throw() ;
                        
                        
                        
                        
                        // Bounding boxes section.
                        
                        
                        
                        virtual UprightRectangle & getBoundingBoxFor(
                                Ceylan::Unicode glyph, SignedLength & advance )
                            const throw( TextException ) ;
                            
                            
                         
                        virtual UprightRectangle & getBoundingBoxFor( 
                                const std::string & text )
                            const throw( TextException ) ;
                             
                             
                             
                        virtual UprightRectangle & getBoundingBoxForUTF8( 
                                const std::string & text )
                            const throw( TextException ) ;
                             
                             
                             
                        virtual UprightRectangle & getBoundingBoxForUnicode( 
                                const Ceylan::Unicode * text ) 
                            const throw( TextException ) ;
                             
                             
                             
                        
                        // Render section.



                        virtual Surface & renderLatin1Glyph( 
                                Ceylan::Latin1Char character, 
                                RenderQuality quality = Solid, 
                                Pixels::ColorDefinition glyphColor 
                                    = Pixels::White ) 
                            throw( TextException ) ;
                             
                             

                        virtual void blitLatin1Glyph( 
                                Surface & targetSurface,
                                Coordinate x, Coordinate y, 
                                Ceylan::Latin1Char character, 
                                RenderQuality quality = Solid, 
                                Pixels::ColorDefinition glyphColor 
                                    = Pixels::White )  
                            throw( TextException ) ;
                             
                             
                             
                        virtual Surface & renderUnicodeGlyph( 
                                Ceylan::Unicode character, 
                                RenderQuality quality = Solid,
                                Pixels::ColorDefinition textColor 
                                    = Pixels::White ) 
                            throw( TextException ) ;
                        
                        
                        
                        virtual Surface & renderLatin1Text( 
                                const std::string & text, 
                                RenderQuality quality = Solid,
                                Pixels::ColorDefinition textColor 
                                    = Pixels::White ) 
                            throw( TextException ) ;
                            
                            
                        
                        virtual Surface & renderUTF8Text( 
                                const std::string & text, 
                                RenderQuality quality = Solid,
                                Pixels::ColorDefinition textColor 
                                    = Pixels::White ) 
                            throw( TextException ) ;
                            
                            
                        
                        virtual Surface & renderUnicodeText( 
                                const Ceylan::Unicode * text, 
                                RenderQuality quality = Solid,
                                Pixels::ColorDefinition textColor 
                                    = Pixels::Black ) 
                            throw( TextException ) ;
                            
                            
                                                        
                            
                        virtual const std::string toString( 
                                Ceylan::VerbosityLevels level = Ceylan::high ) 
                            const throw() ;



    
                        // Static section.
                        
                        
                        static RenderQuality GetObtainedQualityFor(
                                RenderQuality targetedQuality )
                            throw() ;

                        
                        void SetUnicodeSwapStatus( bool newStatus ) throw() ;
                
                
                
                        static std::string DescribeLastError() throw() ;
                        
    
                        static Ceylan::System::FileLocator
                            TrueTypeFontFileLocator ;


                        static std::string TrueTypeFontFileExtension ;
                        
                        
                        static const Ceylan::Float32 SpaceWidthFactor ;
                            
                                                
                                                
                        
                    protected:
                    


                        virtual Surface & basicRenderUnicodeGlyph(
                                Ceylan::Unicode character,
                                RenderQuality quality, 
                                Pixels::ColorDefinition glyphColor )
                            throw( TextException ) ;
    
    
                        
                        // Font filename is not kept currently.
                        
                        
                        PointSize _pointSize ;
                        
                        
                        TTF_Font * _actualFont ;
                        
                        
                        static Ceylan::Uint32 FontCounter ;
                    
                    
                    
                    
                    private:
                    
                
                                    
                        TrueTypeFont( const TrueTypeFont & source ) throw() ;
            
            
                        TrueTypeFont & operator = ( 
                            const TrueTypeFont & source ) throw() ;
                
                                    
                
                } ;
                
            } 
            
        }   
            
    }
    
}       


#endif // OSDL_TRUETYPE_FONT_H_

---