OpenSceneGraph 2.8.3

osgText::Font Class Reference

Pure virtual base class for fonts. More...

Inheritance diagram for osgText::Font:

List of all members.

Classes

class  FontImplementation
class  Glyph
class  GlyphTexture

Public Types

typedef OpenThreads::Mutex FontMutex

Public Member Functions

 Font (FontImplementation *implementation=0)
virtual osg::ObjectcloneType () const
 Clone the type of an object, with Object* return type.
virtual osg::Objectclone (const osg::CopyOp &) const
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * className () const
 return the name of the object's class type.
virtual const char * libraryName () const
 return the name of the object's library.
virtual std::string getFileName () const
void setTexEnv (osg::TexEnv *texenv)
osg::TexEnvgetTexEnv ()
const osg::TexEnvgetTexEnv () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
virtual osg::Vec2 getKerning (const FontResolution &fontSize, unsigned int leftcharcode, unsigned int rightcharcode, KerningType kerningType)
 Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, w.r.t the current font size hint.
virtual GlyphgetGlyph (const FontResolution &fontSize, unsigned int charcode)
 Get a Glyph for specified charcode, and the font size nearest to the current font size hint.
virtual bool hasVertical () const
 Return true if this font provides vertical alignments and spacing or glyphs.
void setGlyphImageMargin (unsigned int margin)
 Set the margin around each glyph, to ensure that texture filtering doesn't bleed adjacent glyph's into each other.
unsigned int getGlyphImageMargin () const
void setGlyphImageMarginRatio (float margin)
 Set the margin ratio around each glyph, relative to the glyph's size.
float getGlyphImageMarginRatio () const
void setTextureSizeHint (unsigned int width, unsigned int height)
 Set the size of texture to create to store the glyph images when rendering.
unsigned int getTextureWidthHint () const
unsigned int getTextureHeightHint () const
void setMinFilterHint (osg::Texture::FilterMode mode)
 Set the minification texture filter to use when creating the texture to store the glyph images when rendering.
osg::Texture::FilterMode getMinFilterHint () const
void setMagFilterHint (osg::Texture::FilterMode mode)
 Set the magnification texture filter to use when creating the texture to store the glyph images when rendering.
osg::Texture::FilterMode getMagFilterHint () const
void setImplementation (FontImplementation *implementation)
FontImplementationgetImplementation ()
const FontImplementationgetImplementation () const
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.

Protected Types

typedef std::vector
< osg::ref_ptr< GlyphTexture > > 
GlyphTextureList
typedef std::vector
< osg::ref_ptr< osg::StateSet > > 
StateSetList
typedef std::map< unsigned int,
osg::ref_ptr< Glyph > > 
GlyphMap
typedef std::map
< FontResolution, GlyphMap
FontSizeGlyphMap

Protected Member Functions

virtual ~Font ()
void addGlyph (const FontResolution &fontRes, unsigned int charcode, Glyph *glyph)

Protected Attributes

OpenThreads::Mutex _glyphMapMutex
osg::ref_ptr< osg::TexEnv_texenv
osg::ref_ptr< osg::StateSet_stateset
FontSizeGlyphMap _sizeGlyphMap
GlyphTextureList _glyphTextureList
FontResolution _fontSize
unsigned int _margin
float _marginRatio
unsigned int _textureWidthHint
unsigned int _textureHeightHint
osg::Texture::FilterMode _minFilterHint
osg::Texture::FilterMode _magFilterHint
osg::ref_ptr< FontImplementation_implementation

Friends

class FontImplementation

Detailed Description

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


Member Typedef Documentation

typedef OpenThreads::Mutex osgText::Font::FontMutex
typedef std::map< FontResolution, GlyphMap > osgText::Font::FontSizeGlyphMap [protected]
typedef std::map< unsigned int, osg::ref_ptr<Glyph> > osgText::Font::GlyphMap [protected]
typedef std::vector< osg::ref_ptr<GlyphTexture> > osgText::Font::GlyphTextureList [protected]
typedef std::vector< osg::ref_ptr<osg::StateSet> > osgText::Font::StateSetList [protected]

Constructor & Destructor Documentation

osgText::Font::Font ( FontImplementation implementation = 0)
virtual osgText::Font::~Font ( ) [protected, virtual]

Member Function Documentation

void osgText::Font::addGlyph ( const FontResolution fontRes,
unsigned int  charcode,
Glyph glyph 
) [protected]
virtual const char* osgText::Font::className ( ) const [inline, virtual]

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

virtual osg::Object* osgText::Font::clone ( const osg::CopyOp ) const [inline, virtual]

Clone an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

virtual osg::Object* osgText::Font::cloneType ( ) const [inline, virtual]

Clone the type of an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

virtual std::string osgText::Font::getFileName ( ) const [virtual]
virtual Glyph* osgText::Font::getGlyph ( const FontResolution fontSize,
unsigned int  charcode 
) [virtual]

Get a Glyph for specified charcode, and the font size nearest to the current font size hint.

unsigned int osgText::Font::getGlyphImageMargin ( ) const
float osgText::Font::getGlyphImageMarginRatio ( ) const
FontImplementation* osgText::Font::getImplementation ( )
const FontImplementation* osgText::Font::getImplementation ( ) const
virtual osg::Vec2 osgText::Font::getKerning ( const FontResolution fontSize,
unsigned int  leftcharcode,
unsigned int  rightcharcode,
KerningType  kerningType 
) [virtual]

Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes, w.r.t the current font size hint.

osg::Texture::FilterMode osgText::Font::getMagFilterHint ( ) const
osg::Texture::FilterMode osgText::Font::getMinFilterHint ( ) const
osg::StateSet* osgText::Font::getStateSet ( ) [inline]
const osg::StateSet* osgText::Font::getStateSet ( ) const [inline]
osg::TexEnv* osgText::Font::getTexEnv ( ) [inline]
const osg::TexEnv* osgText::Font::getTexEnv ( ) const [inline]
unsigned int osgText::Font::getTextureHeightHint ( ) const
unsigned int osgText::Font::getTextureWidthHint ( ) const
virtual bool osgText::Font::hasVertical ( ) const [virtual]

Return true if this font provides vertical alignments and spacing or glyphs.

virtual bool osgText::Font::isSameKindAs ( const osg::Object obj) const [inline, virtual]

Reimplemented from osg::Object.

References NULL.

virtual const char* osgText::Font::libraryName ( ) const [inline, virtual]

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

virtual void osgText::Font::releaseGLObjects ( osg::State state = 0) const [virtual]

If State is non-zero, this function releases OpenGL objects for the specified graphics context.

Otherwise, releases OpenGL objexts for all graphics contexts.

Reimplemented from osg::Object.

virtual void osgText::Font::resizeGLObjectBuffers ( unsigned int  maxSize) [virtual]

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

void osgText::Font::setGlyphImageMargin ( unsigned int  margin)

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 osgText::Font::setGlyphImageMarginRatio ( float  margin)

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 osgText::Font::setImplementation ( FontImplementation implementation)
void osgText::Font::setMagFilterHint ( osg::Texture::FilterMode  mode)

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 osgText::Font::setMinFilterHint ( osg::Texture::FilterMode  mode)

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 osgText::Font::setStateSet ( osg::StateSet stateset) [inline]
void osgText::Font::setTexEnv ( osg::TexEnv texenv) [inline]
void osgText::Font::setTextureSizeHint ( unsigned int  width,
unsigned int  height 
)

Set the size of texture to create to store the glyph images when rendering.

Note, this doesn't affect already created Texture Glhph's.

virtual void osgText::Font::setThreadSafeRefUnref ( bool  threadSafe) [virtual]

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Referenced.


Friends And Related Function Documentation

friend class FontImplementation [friend]

Member Data Documentation

OpenThreads::Mutex osgText::Font::_glyphMapMutex [mutable, protected]
unsigned int osgText::Font::_margin [protected]
float osgText::Font::_marginRatio [protected]
unsigned int osgText::Font::_textureHeightHint [protected]
unsigned int osgText::Font::_textureWidthHint [protected]

The documentation for this class was generated from the following file:

osg logo
Generated at Tue Mar 22 2011 13:20:29 for the OpenSceneGraph by doxygen 1.7.3.