OgreFont.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
This source file is a part of OGRE
(Object-oriented Graphics Rendering Engine)

For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE
-------------------------------------------------------------------------*/

#ifndef _Font_H__
#define _Font_H__

#include "OgrePrerequisites.h"
#include "OgreResource.h"
#include "OgreTexture.h"
#include "OgreMaterial.h"
#include "OgreCommon.h"

namespace Ogre
{
    enum FontType
    {
        FT_TRUETYPE = 1,
        FT_IMAGE = 2
    };


    class _OgreExport Font : public Resource, public ManualResourceLoader
    {
    protected:
        class _OgreExport CmdType : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdSource : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdCharSpacer : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdSize : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdResolution : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreExport CmdCodePoints : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };

        // Command object for setting / getting parameters
        static CmdType msTypeCmd;
        static CmdSource msSourceCmd;
        static CmdCharSpacer msCharacterSpacerCmd;
        static CmdSize msSizeCmd;
        static CmdResolution msResolutionCmd;
        static CmdCodePoints msCodePointsCmd;

        FontType mType;

        String mSource;

        uint mCharacterSpacer;

        Real mTtfSize;
        uint mTtfResolution;
        int mTtfMaxBearingY;


    public:
        typedef Ogre::uint32 CodePoint;
        typedef Ogre::FloatRect UVRect;
        struct GlyphInfo 
        {
            CodePoint codePoint;
            UVRect uvRect;
            Real aspectRatio;

            GlyphInfo(CodePoint id, const UVRect& rect, Real aspect)
                : codePoint(id), uvRect(rect), aspectRatio(aspect)
            {

            }
        };
        typedef std::pair<CodePoint, CodePoint> CodePointRange;
        typedef vector<CodePointRange>::type CodePointRangeList;
    protected:
        typedef map<CodePoint, GlyphInfo>::type CodePointMap;
        CodePointMap mCodePointMap;

        MaterialPtr mMaterial;

        TexturePtr mTexture;

        bool mAntialiasColour;

        CodePointRangeList mCodePointRangeList;

        void createTextureFromFont(void);

        virtual void loadImpl();
        virtual void unloadImpl();
        size_t calculateSize(void) const { return 0; } // permanent resource is in the texture 
    public:

        Font(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
        virtual ~Font();

        void setType(FontType ftype);

        FontType getType(void) const;

        void setSource(const String& source);

        const String& getSource(void) const;

        void setCharacterSpacer(uint charSpacer);
 
        uint getCharacterSpacer(void) const;

        void setTrueTypeSize(Real ttfSize);
        void setTrueTypeResolution(uint ttfResolution);

        Real getTrueTypeSize(void) const;
        uint getTrueTypeResolution(void) const;
        int getTrueTypeMaxBearingY() const;


        inline const UVRect& getGlyphTexCoords(CodePoint id) const
        {
            CodePointMap::const_iterator i = mCodePointMap.find(id);
            if (i != mCodePointMap.end())
            {
                return i->second.uvRect;
            }
            else
            {
                static UVRect nullRect(0.0, 0.0, 0.0, 0.0);
                return nullRect;
            }
        }

        inline void setGlyphTexCoords(CodePoint id, Real u1, Real v1, Real u2, Real v2, Real textureAspect)
        {
            CodePointMap::iterator i = mCodePointMap.find(id);
            if (i != mCodePointMap.end())
            {
                i->second.uvRect.left = u1;
                i->second.uvRect.top = v1;
                i->second.uvRect.right = u2;
                i->second.uvRect.bottom = v2;
                i->second.aspectRatio = textureAspect * (u2 - u1)  / (v2 - v1);
            }
            else
            {
                mCodePointMap.insert(
                    CodePointMap::value_type(id, 
                        GlyphInfo(id, UVRect(u1, v1, u2, v2), 
                            textureAspect * (u2 - u1)  / (v2 - v1))));
            }

        }
        inline Real getGlyphAspectRatio(CodePoint id) const
        {
            CodePointMap::const_iterator i = mCodePointMap.find(id);
            if (i != mCodePointMap.end())
            {
                return i->second.aspectRatio;
            }
            else
            {
                return 1.0;
            }
        }
        inline void setGlyphAspectRatio(CodePoint id, Real ratio)
        {
            CodePointMap::iterator i = mCodePointMap.find(id);
            if (i != mCodePointMap.end())
            {
                i->second.aspectRatio = ratio;
            }
        }

        const GlyphInfo& getGlyphInfo(CodePoint id) const;

        void addCodePointRange(const CodePointRange& range)
        {
            mCodePointRangeList.push_back(range);
        }

        void clearCodePointRanges()
        {
            mCodePointRangeList.clear();
        }
        const CodePointRangeList& getCodePointRangeList() const
        {
            return mCodePointRangeList;
        }
        inline const MaterialPtr& getMaterial() const
        {
            return mMaterial;
        }
        inline const MaterialPtr& getMaterial()
        {
            return mMaterial;
        }
        inline void setAntialiasColour(bool enabled)
        {
            mAntialiasColour = enabled;
        }

        inline bool getAntialiasColour(void) const
        {
            return mAntialiasColour;
        }

        void loadResource(Resource* resource);
    };
    class _OgreExport FontPtr : public SharedPtr<Font> 
    {
    public:
        FontPtr() : SharedPtr<Font>() {}
        explicit FontPtr(Font* rep) : SharedPtr<Font>(rep) {}
        FontPtr(const FontPtr& r) : SharedPtr<Font>(r) {} 
        FontPtr(const ResourcePtr& r) : SharedPtr<Font>()
        {
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<Font*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
        }

        FontPtr& operator=(const ResourcePtr& r)
        {
            if (pRep == static_cast<Font*>(r.getPointer()))
                return *this;
            release();
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<Font*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
            else
            {
                // RHS must be a null pointer
                assert(r.isNull() && "RHS must be null if it has no mutex!");
                setNull();
            }
            return *this;
        }
    };
}

#endif