openscenegraph
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
osgText::Font Class Reference
Inheritance diagram for osgText::Font:
osg::Object osg::Referenced

Classes

class  FontImplementation
 

Public Types

typedef OpenThreads::Mutex FontMutex
 
typedef std::vector< osg::ref_ptr< GlyphTexture > > GlyphTextureList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Font (FontImplementation *implementation=0)
 
virtual osg::ObjectcloneType () const
 
virtual osg::Objectclone (const osg::CopyOp &) const
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual const char * className () const
 
virtual const char * libraryName () const
 
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 (unsigned int leftcharcode, unsigned int rightcharcode, KerningType kerningType)
 
virtual GlyphgetGlyph (const FontResolution &fontSize, unsigned int charcode)
 
virtual Glyph3DgetGlyph3D (unsigned int charcode)
 
virtual bool hasVertical () const
 
virtual bool getVerticalSize (float &ascender, float &descender) const
 
void setGlyphImageMargin (unsigned int margin)
 
unsigned int getGlyphImageMargin () const
 
void setGlyphImageMarginRatio (float margin)
 
float getGlyphImageMarginRatio () const
 
void setTextureSizeHint (unsigned int width, unsigned int height)
 
unsigned int getTextureWidthHint () const
 
unsigned int getTextureHeightHint () const
 
void setMinFilterHint (osg::Texture::FilterMode mode)
 
osg::Texture::FilterMode getMinFilterHint () const
 
void setMagFilterHint (osg::Texture::FilterMode mode)
 
osg::Texture::FilterMode getMagFilterHint () const
 
unsigned int getFontDepth () const
 
void setNumberCurveSamples (unsigned int numSamples)
 
unsigned int getNumberCurveSamples () const
 
void setImplementation (FontImplementation *implementation)
 
FontImplementationgetImplementation ()
 
const FontImplementationgetImplementation () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *state=0) const
 
GlyphTextureListgetGlyphTextureList ()
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Static Public Member Functions

static osg::ref_ptr< Font > & getDefaultFont ()
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Protected Types

typedef std::vector< osg::ref_ptr< osg::StateSet > > StateSetList
 
typedef std::map< unsigned int, osg::ref_ptr< Glyph > > GlyphMap
 
typedef std::map< unsigned int, osg::ref_ptr< Glyph3D > > Glyph3DMap
 
typedef std::map< FontResolution, GlyphMapFontSizeGlyphMap
 

Protected Member Functions

virtual ~Font ()
 
void addGlyph (const FontResolution &fontRes, unsigned int charcode, Glyph *glyph)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

OpenThreads::Mutex _glyphMapMutex
 
osg::ref_ptr< osg::TexEnv_texenv
 
osg::ref_ptr< osg::StateSet_stateset
 
FontSizeGlyphMap _sizeGlyphMap
 
GlyphTextureList _glyphTextureList
 
Glyph3DMap _glyph3DMap
 
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< FontImplementation_implementation
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

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 std::map< unsigned int, osg::ref_ptr<Glyph3D> > osgText::Font::Glyph3DMap
protected
typedef std::map< unsigned int, osg::ref_ptr<Glyph> > osgText::Font::GlyphMap
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 ( )
protectedvirtual

Member Function Documentation

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

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
inlinevirtual

Clone an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

virtual osg::Object* osgText::Font::cloneType ( ) const
inlinevirtual

Clone the type of an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

static osg::ref_ptr<Font>& osgText::Font::getDefaultFont ( )
static
virtual std::string osgText::Font::getFileName ( ) const
virtual
unsigned int osgText::Font::getFontDepth ( ) const
inline
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.

virtual Glyph3D* osgText::Font::getGlyph3D ( unsigned int  charcode)
virtual

Get a Glyph3D for specified charcode.

unsigned int osgText::Font::getGlyphImageMargin ( ) const
float osgText::Font::getGlyphImageMarginRatio ( ) const
GlyphTextureList& osgText::Font::getGlyphTextureList ( )
inline
FontImplementation* osgText::Font::getImplementation ( )
const FontImplementation* osgText::Font::getImplementation ( ) const
virtual osg::Vec2 osgText::Font::getKerning ( 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
unsigned int osgText::Font::getNumberCurveSamples ( ) const
inline
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::getVerticalSize ( float &  ascender,
float &  descender 
) const
inlinevirtual

Get the ascender and descender sizes of the font where supported by the FontImplementation, return true on success, return false when not supported.

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
inlinevirtual

Reimplemented from osg::Object.

virtual const char* osgText::Font::libraryName ( ) const
inlinevirtual

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::setNumberCurveSamples ( unsigned int  numSamples)
inline
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::Object.

Friends And Related Function Documentation

friend class FontImplementation
friend

Member Data Documentation

unsigned int osgText::Font::_depth
protected
FontResolution osgText::Font::_fontSize
protected
Glyph3DMap osgText::Font::_glyph3DMap
protected
OpenThreads::Mutex osgText::Font::_glyphMapMutex
mutableprotected
GlyphTextureList osgText::Font::_glyphTextureList
protected
osg::ref_ptr<FontImplementation> osgText::Font::_implementation
protected
osg::Texture::FilterMode osgText::Font::_magFilterHint
protected
unsigned int osgText::Font::_margin
protected
float osgText::Font::_marginRatio
protected
osg::Texture::FilterMode osgText::Font::_minFilterHint
protected
unsigned int osgText::Font::_numCurveSamples
protected
FontSizeGlyphMap osgText::Font::_sizeGlyphMap
protected
osg::ref_ptr<osg::StateSet> osgText::Font::_stateset
protected
osg::ref_ptr<osg::TexEnv> osgText::Font::_texenv
protected
unsigned int osgText::Font::_textureHeightHint
protected
unsigned int osgText::Font::_textureWidthHint
protected

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