OSDLFixedFont.h

Go to the documentation of this file.

#ifndef OSDL_FIXED_FONT_H_
#define OSDL_FIXED_FONT_H_



#include "OSDLFont.h"         // for inheritance

#include "Ceylan.h"           // for Ceylan::Byte, Height

#include <string>





namespace OSDL
{


    namespace Video
    {


        // Fonts are rendered to surfaces.
        class Surface ;



        namespace TwoDimensional
        {
            
                        
            
            namespace Text
            {   
            

                extern OSDL_DLL const Length BasicFontCharacterWidth ;
                
                extern OSDL_DLL const Length BasicFontCharacterHeight ;
                
                
                OSDL_DLL bool printBasic( const std::string & text, 
                    Surface & targetSurface, Coordinate x, Coordinate y,
                    Pixels::ColorElement red, Pixels::ColorElement blue,
                    Pixels::ColorElement green, 
                    Pixels::ColorElement alpha = Pixels::AlphaOpaque )
                        throw() ; 
                
                
                OSDL_DLL bool printBasic( const std::string & text, 
                    Surface & targetSurface,
                    Coordinate x, Coordinate y, 
                    Pixels::ColorDefinition colorDef ) throw() ; 
                    


                class OSDL_DLL FixedFont : public Font
                {
                
                
                    public:
                                            
                        
                        FixedFont( 
                            Length characterWidth, 
                            Length characterHeight, 
                            RenderingStyle renderingStyle = Normal,
                            bool convertToDisplay = true,
                            RenderCache cacheSettings = GlyphCached,
                            AllowedCachePolicy cachePolicy
                                = DropLessRequestedFirst,
                            Ceylan::System::Size quota = 0 ) 
                                throw( TextException ) ;
                         
                         
                         
                        explicit FixedFont( 
                            const std::string & fontFilename, 
                            bool convertToDisplay = true,
                            RenderCache cacheSettings = GlyphCached,
                            AllowedCachePolicy cachePolicy 
                                = DropLessRequestedFirst,
                            Ceylan::System::Size quota = 0 ) 
                                throw( TextException ) ;
                        
                        
                        virtual ~FixedFont() throw() ;
                                
                                                
                                     
                        virtual Width getWidth() const throw() ;


                        virtual Width getWidth( Ceylan::Latin1Char character )
                            const throw() ;


                        virtual SignedWidth getWidthOffset( 
                                Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;


                        virtual SignedHeight getHeightAboveBaseline(
                                Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;


                        virtual SignedLength getAdvance() const 
                            throw( TextException ) ;
                        
                        
                        virtual SignedLength getAdvance( 
                                Ceylan::Latin1Char character ) 
                            const throw( TextException ) ;


                        virtual Width getInterGlyphWidth() const throw() ;
                
                         
                         
                        virtual Text::Height getHeight() const throw() ;
                                                 
                         
                        virtual SignedHeight getAscent() const throw() ;
                         
                         
                        virtual SignedHeight getDescent() const throw() ;
                         
                         
                        virtual Text::Height getLineSkip() const throw() ;
                        
                        
                        
                        
                        // Bounding boxes section.
                        
                        
                        virtual UprightRectangle & getBoundingBox() 
                            const throw( TextException ) ;
                            
                         
                        virtual UprightRectangle & getBoundingBoxFor( 
                                const std::string & word )
                            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 & renderLatin1GlyphAlpha(
                                Ceylan::Latin1Char character, 
                                RenderQuality quality = Solid,
                                Pixels::ColorDefinition glyphColor 
                                    = Pixels::White ) 
                            throw( TextException ) ;
                        
                        
                            
                        /*
                         * Rendering and blitting of whole texts are inherited
                         * from Font mother class.
                         *
                         */
                        
                            
                        virtual const std::string toString( 
                                Ceylan::VerbosityLevels level = Ceylan::high ) 
                            const throw() ;


                        
                        // Static section.
    
    
                        static RenderQuality GetObtainedQualityFor(
                                RenderQuality targetedQuality )
                            throw() ;
                         
    
                        static void SetFontSettings( 
                            const Ceylan::Byte * fontData, 
                            Length characterWidth, 
                            Length characterHeight ) throw() ;

                         
                        static Ceylan::System::FileLocator 
                            FixedFontFileLocator ;


                        static std::string FontFileExtension ;
                        
                        
                        static const Ceylan::Float32 SpaceWidthFactor ;
                        
                        
                        
                    protected:
                                                
                        
                        static const RenderQuality DefaultQuality = Solid ;
                        
                            
                        virtual void loadFontFrom( 
                                const std::string & fontFilename ) 
                            throw( TextException ) ;
                            
                        
                        virtual const Surface & submitLatin1GlyphToCache( 
                                Ceylan::Latin1Char character,
                                Pixels::ColorDefinition glyphColor )
                            throw( TextException ) ;
                            
                        
                        virtual Surface & basicRenderLatin1Glyph(
                                Ceylan::Latin1Char character,
                                Pixels::ColorDefinition glyphColor ) 
                            throw( TextException ) ;
                            
                            
                        virtual void basicBlitLatin1Glyph( 
                                Surface & targetSurface, 
                                Coordinate x, Coordinate y, 
                                Ceylan::Latin1Char character,
                                Pixels::ColorDefinition glyphColor ) 
                            throw( TextException ) ;
                        
                        
                                                        
                        Length _width ;
                        
                        Length _height ;
                                                
                            
                        char * _fontData ;
                        
                                                                        
                        static std::string BuildFontFilenameFor( 
                                Length characterWidth, 
                                Length characterHeight, 
                                RenderingStyle renderingStyle ) 
                            throw( TextException ) ;
                            
                            
                        
                        // Static section.
                        
                        
                        static void GetFontAttributesFrom( 
                                const std::string & filename, 
                                Length & characterWidth, 
                                Length & characterHeight, 
                                RenderingStyle & renderingStyle ) 
                            throw( TextException ) ;
                    
                    
                        static const Ceylan::Uint16 FontCharacterCount ;
                    
                    
                    
                    
                    private:
                                
                                    
                        FixedFont( const FixedFont & source ) throw() ;
            
            
                        FixedFont & operator = ( const FixedFont & source )
                            throw() ;
                
                                    
                
                } ;
                
            } 
            
        }   
            
    }
    
}       


#endif // OSDL_FIXED_FONT_H_

---