/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield * * This library is open source and may be redistributed and/or modified under * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or * (at your option) any later version. The full license is in LICENSE file * included with this distribution, and on the openscenegraph.org website. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * OpenSceneGraph Public License for more details. */ #ifndef OSGTEXT_FONT #define OSGTEXT_FONT 1 #include #include #include #include #include #include #include #include #include #include #include #include #include namespace osgText { class Font; class Text; class Glyph3D; class GlyphTexture; class OSGTEXT_EXPORT Glyph : public osg::Image { public: Glyph(unsigned int glyphCode); unsigned int getGlyphCode() const { return _glyphCode; } void setHorizontalBearing(const osg::Vec2& bearing); const osg::Vec2& getHorizontalBearing() const; void setHorizontalAdvance(float advance); float getHorizontalAdvance() const; void setVerticalBearing(const osg::Vec2& bearing); const osg::Vec2& getVerticalBearing() const; void setVerticalAdvance(float advance); float getVerticalAdvance() const; void setTexture(GlyphTexture* texture); GlyphTexture* getTexture(); const GlyphTexture* getTexture() const; void setTexturePosition(int posX,int posY); int getTexturePositionX() const; int getTexturePositionY() const; void setMinTexCoord(const osg::Vec2& coord); const osg::Vec2& getMinTexCoord() const; void setMaxTexCoord(const osg::Vec2& coord); const osg::Vec2& getMaxTexCoord() const; void subload() const; protected: virtual ~Glyph(); Font* _font; unsigned int _glyphCode; osg::Vec2 _horizontalBearing; float _horizontalAdvance; osg::Vec2 _verticalBearing; float _verticalAdvance; GlyphTexture* _texture; int _texturePosX; int _texturePosY; osg::Vec2 _minTexCoord; osg::Vec2 _maxTexCoord; typedef osg::buffered_value GLObjectList; mutable GLObjectList _globjList; }; class OSGTEXT_EXPORT Glyph3D : public osg::Referenced { public: Glyph3D(unsigned int glyphCode): osg::Referenced(true), _glyphCode(glyphCode), _horizontalBearing(0,0), _horizontalAdvance(0), _verticalBearing(0,0), _verticalAdvance(0) {} unsigned int getGlyphCode() const { return _glyphCode; } void setHorizontalBearing(const osg::Vec2& bearing) { _horizontalBearing=bearing; } const osg::Vec2 & getHorizontalBearing() const { return _horizontalBearing; } void setHorizontalAdvance(float advance) { _horizontalAdvance=advance; } float getHorizontalAdvance() const { return _horizontalAdvance; } void setVerticalBearing(const osg::Vec2& bearing) { _verticalBearing=bearing; } const osg::Vec2& getVerticalBearing() const { return _verticalBearing; } void setVerticalAdvance(float advance) { _verticalAdvance=advance; } float getVerticalAdvance() const { return _verticalAdvance; } void setBoundingBox(osg::BoundingBox & bb) { _bb=bb; } const osg::BoundingBox & getBoundingBox() const { return _bb; } /** Set whether to use a mutex to ensure ref() and unref() are thread safe.*/ virtual void setThreadSafeRefUnref(bool threadSafe); void setRawVertexArray(osg::Vec3Array* vertices) { _rawVertexArray = vertices; } osg::Vec3Array* getRawVertexArray() { return _rawVertexArray.get(); } /** Get the PrimitiveSetList for the raw face which hasn't been tessellated. */ osg::Geometry::PrimitiveSetList & getRawFacePrimitiveSetList() { return _rawFacePrimitiveSetList; } /** Get the PrimitiveSetList for the front face. */ osg::Geometry::PrimitiveSetList & getFrontPrimitiveSetList() { return _frontPrimitiveSetList; } /** Get the PrimitiveSetList for the wall face. */ osg::Geometry::PrimitiveSetList & getWallPrimitiveSetList() { return _wallPrimitiveSetList; } /** Get et the PrimitiveSetList for the back face. */ osg::Geometry::PrimitiveSetList & getBackPrimitiveSetList() { return _backPrimitiveSetList; } /** Set the VertexArray of the glyph. */ void setVertexArray(osg::Vec3Array * va) { _vertexArray = va; } /** Get the VertexArray of the glyph. */ osg::Vec3Array * getVertexArray() { return _vertexArray.get(); } /** Set the VertexArray of the glyph. */ void setNormalArray(osg::Vec3Array * na) { _normalArray = na; } /** Get the NormalArray for the wall face. */ osg::Vec3Array * getNormalArray() { return _normalArray.get(); } float getHorizontalWidth() { return (-_horizontalBearing.x() + _horizontalAdvance); } float getHorizontalHeight() { return (-_horizontalBearing.y() + _bb.yMax()); } float getVerticalWidth() { return (-_verticalBearing.x() + _bb.xMax()); } float getVerticalHeight() { return (-_verticalBearing.y() + _verticalAdvance); } void setWidth(float width) { _width = width; } float getWidth() { return _width; } void setHeight(float height) { _height = height; } float getHeight() { return _height; } protected: virtual ~Glyph3D() {} unsigned int _glyphCode; osg::Vec2 _horizontalBearing; float _horizontalAdvance; osg::Vec2 _verticalBearing; float _verticalAdvance; osg::BoundingBox _bb; // osg::Vec2 _advance; float _width; float _height; osg::ref_ptr _vertexArray; osg::ref_ptr _normalArray; osg::Geometry::PrimitiveSetList _frontPrimitiveSetList; osg::Geometry::PrimitiveSetList _wallPrimitiveSetList; osg::Geometry::PrimitiveSetList _backPrimitiveSetList; osg::ref_ptr _rawVertexArray; osg::Geometry::PrimitiveSetList _rawFacePrimitiveSetList; }; class OSGTEXT_EXPORT GlyphTexture : public osg::Texture2D { public: GlyphTexture(); const char* className() const { return "GlyphTexture"; } /** return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.*/ virtual int compare(const osg::StateAttribute& rhs) const; /** Set the margin around each glyph, to ensure that texture filtering doesn't bleed adjacent glyph's into each other.*/ void setGlyphImageMargin(unsigned int margin) { _margin = margin; } unsigned int getGlyphImageMargin() const { return _margin; } void setGlyphImageMarginRatio(float margin) { _marginRatio = margin; } float getGlyphImageMarginRatio() const { return _marginRatio; } bool getSpaceForGlyph(Glyph* glyph, int& posX, int& posY); void addGlyph(Glyph* glyph,int posX, int posY); virtual void apply(osg::State& state) const; /** Set whether to use a mutex to ensure ref() and unref() are thread safe.*/ virtual void setThreadSafeRefUnref(bool threadSafe); /** Resize any per context GLObject buffers to specified size. */ virtual void resizeGLObjectBuffers(unsigned int maxSize); protected: virtual ~GlyphTexture(); // parameter used to compute the size and position of empty space // in the texture which could accommodate new glyphs. int _margin; float _marginRatio; int _usedY; int _partUsedX; int _partUsedY; typedef std::vector< osg::ref_ptr > GlyphRefList; typedef std::vector< const Glyph* > GlyphPtrList; typedef osg::buffered_object< GlyphPtrList > GlyphBuffer; GlyphRefList _glyphs; mutable GlyphBuffer _glyphsToSubload; mutable OpenThreads::Mutex _mutex; }; /** Read a font from specified file. The filename may contain a path. * It will search for the font file in the following places in this order: * - In the current directory * - All paths defined in OSG_FILE_PATH or OSGFILEPATH environment variable * - Filename with path stripped: In the current directory * - Filename with path stripped: All paths defined in OSG_FILE_PATH or OSGFILEPATH * * Then the file will be searched in OS specific directories in the following order: * - Again in the current directory * - Windows: In C:/winnt/fonts * - Windows: In C:/windows/fonts * - Windows: In the fonts directory of the windows install directory * - Other OS: In /usr/share/fonts/ttf * - Other OS: In /usr/share/fonts/ttf/western * - Other OS: In /usr/share/fonts/ttf/decoratives * * If the given file could not be found, the path part will be stripped and * the file will be searched again in the OS specific directories. */ extern OSGTEXT_EXPORT Font* readFontFile(const std::string& filename, const osgDB::ReaderWriter::Options* userOptions = 0); /** read a font from specified stream.*/ extern OSGTEXT_EXPORT Font* readFontStream(std::istream& stream, const osgDB::ReaderWriter::Options* userOptions = 0); extern OSGTEXT_EXPORT osg::ref_ptr readRefFontFile(const std::string& filename, const osgDB::ReaderWriter::Options* userOptions = 0); extern OSGTEXT_EXPORT osg::ref_ptr readRefFontStream(std::istream& stream, const osgDB::ReaderWriter::Options* userOptions = 0); extern OSGTEXT_EXPORT std::string findFontFile(const std::string& str); /** Pure virtual base class for fonts. * Concrete implementation are the DefaultFont found in src/osgText/DefaultFont.cpp * and FreeTypeFont found in src/osgPlugins/freetype/FreeTypeFont.cpp*/ class OSGTEXT_EXPORT Font : public osg::Object { // declare the interface to a font. public: // forward declare nested classes. class FontImplementation; public: Font(FontImplementation* implementation=0); virtual osg::Object* cloneType() const { return 0; } // cloneType() not appropriate virtual osg::Object* clone(const osg::CopyOp&) const { return 0; } // clone() not appropriate virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast(obj)!=NULL; } virtual const char* className() const { return "Font"; } virtual const char* libraryName() const { return "osgText"; } virtual std::string getFileName() const; static osg::ref_ptr& getDefaultFont(); void setTexEnv(osg::TexEnv* texenv) { if (texenv) _texenv = texenv; } inline osg::TexEnv* getTexEnv() { return _texenv.get(); } inline const osg::TexEnv* getTexEnv() const { return _texenv.get(); } void setStateSet(osg::StateSet* stateset) { _stateset = stateset; } osg::StateSet* getStateSet() { return _stateset.get(); } const osg::StateSet* getStateSet() const { return _stateset.get(); } /** Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, w.r.t the current font size hint.*/ virtual osg::Vec2 getKerning(const FontResolution& fontSize, unsigned int leftcharcode,unsigned int rightcharcode, KerningType kerningType); /** Get a Glyph for specified charcode, and the font size nearest to the current font size hint.*/ virtual Glyph* getGlyph(const FontResolution& fontSize, unsigned int charcode); /** Get a Glyph3D for specified charcode.*/ virtual Glyph3D* getGlyph3D(unsigned int charcode); /** Return true if this font provides vertical alignments and spacing or glyphs.*/ virtual bool hasVertical() const; /** Return the scale to apply on the glyph to have a charactere size equal to 1 */ virtual float getScale() const { return _implementation->getScale(); }; /** Set the margin around each glyph, * to ensure that texture filtering doesn't bleed adjacent glyph's into each other. * Default margin is 1 texels.*/ void setGlyphImageMargin(unsigned int margin); unsigned int getGlyphImageMargin() const; /** Set the margin ratio around each glyph, relative to the glyph's size. * to ensure that texture filtering doesn't bleed adjacent glyph's into each other. * Default margin is 0.05.*/ void setGlyphImageMarginRatio(float margin); float getGlyphImageMarginRatio() const; /** Set the size of texture to create to store the glyph images when rendering. * Note, this doesn't affect already created Texture Glhph's.*/ void setTextureSizeHint(unsigned int width,unsigned int height); unsigned int getTextureWidthHint() const; unsigned int getTextureHeightHint() const; /** Set the minification texture filter to use when creating the texture to store the glyph images when rendering. * Note, this doesn't affect already created Texture Glhph's.*/ void setMinFilterHint(osg::Texture::FilterMode mode); osg::Texture::FilterMode getMinFilterHint() const; /** Set the magnification texture filter to use when creating the texture to store the glyph images when rendering. * Note, this doesn't affect already created Texture Glhph's.*/ void setMagFilterHint(osg::Texture::FilterMode mode); osg::Texture::FilterMode getMagFilterHint() const; unsigned int getFontDepth() const { return _depth; } void setNumberCurveSamples(unsigned int numSamples) { _numCurveSamples = numSamples; } unsigned int getNumberCurveSamples() const { return _numCurveSamples; } // make Text a friend to allow it add and remove its entry in the Font's _textList. friend class FontImplementation; void setImplementation(FontImplementation* implementation); FontImplementation* getImplementation(); const FontImplementation* getImplementation() const; /** Set whether to use a mutex to ensure ref() and unref() are thread safe.*/ virtual void setThreadSafeRefUnref(bool threadSafe); /** Resize any per context GLObject buffers to specified size. */ virtual void resizeGLObjectBuffers(unsigned int maxSize); /** If State is non-zero, this function releases OpenGL objects for * the specified graphics context. Otherwise, releases OpenGL objexts * for all graphics contexts. */ virtual void releaseGLObjects(osg::State* state=0) const; typedef OpenThreads::Mutex FontMutex; protected: virtual ~Font(); void addGlyph(const FontResolution& fontRes, unsigned int charcode, Glyph* glyph); typedef std::vector< osg::ref_ptr > GlyphTextureList; typedef std::vector< osg::ref_ptr > StateSetList; typedef std::map< unsigned int, osg::ref_ptr > GlyphMap; typedef std::map< unsigned int, osg::ref_ptr > Glyph3DMap; typedef std::map< FontResolution, GlyphMap > FontSizeGlyphMap; mutable OpenThreads::Mutex _glyphMapMutex; osg::ref_ptr _texenv; osg::ref_ptr _stateset; FontSizeGlyphMap _sizeGlyphMap; GlyphTextureList _glyphTextureList; Glyph3DMap _glyph3DMap; // current active size of font FontResolution _fontSize; unsigned int _margin; float _marginRatio; unsigned int _textureWidthHint; unsigned int _textureHeightHint; osg::Texture::FilterMode _minFilterHint; osg::Texture::FilterMode _magFilterHint; unsigned int _depth; unsigned int _numCurveSamples; osg::ref_ptr _implementation; // declare the nested classes. public: class FontImplementation : public osg::Referenced { public: FontImplementation(): osg::Referenced(true), _facade(0) {} virtual std::string getFileName() const = 0; /** Get a Glyph for specified charcode, and the font size nearest to the current font size hint.*/ virtual Glyph* getGlyph(const FontResolution& fontRes, unsigned int charcode) = 0; /** Get a Glyph3D for specified charcode.*/ virtual Glyph3D* getGlyph3D(unsigned int charcode) = 0; /** Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, w.r.t the current font size hint.*/ virtual osg::Vec2 getKerning(const FontResolution& fontRes, unsigned int leftcharcode,unsigned int rightcharcode, KerningType kerningType) = 0; /** Return true if this font provides vertical alignments and spacing or glyphs.*/ virtual bool hasVertical() const = 0; /** Return scale of font, used by 3D text.*/ virtual float getScale() const = 0; void addGlyph(const FontResolution& fontRes, unsigned int charcode, Glyph* glyph) { _facade->addGlyph(fontRes, charcode, glyph); } Font* _facade; }; }; } #endif