#include <Font.h>

Inheritance diagram for osgText::Font:

Collaboration diagram for osgText::Font:

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::Object *	cloneType () const

virtual osg::Object *	clone (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::TexEnv *	getTexEnv ()

const osg::TexEnv *	getTexEnv () const

void	setStateSet (osg::StateSet *stateset)

osg::StateSet *	getStateSet ()

const osg::StateSet *	getStateSet () const

virtual osg::Vec2	getKerning (unsigned int leftcharcode, unsigned int rightcharcode, KerningType kerningType)

virtual Glyph *	getGlyph (const FontResolution &fontSize, unsigned int charcode)

virtual Glyph3D *	getGlyph3D (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)

FontImplementation *	getImplementation ()

const FontImplementation *	getImplementation () const

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	resizeGLObjectBuffers (unsigned int maxSize)

virtual void	releaseGLObjects (osg::State *state=0) const

GlyphTextureList &	getGlyphTextureList ()

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 Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () 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::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () 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 &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () 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::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

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, GlyphMap >	FontSizeGlyphMap

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

Definition at line 64 of file Font.h.

Member Typedef Documentation

typedef OpenThreads::Mutex osgText::Font::FontMutex

Definition at line 166 of file Font.h.

typedef std::map< FontResolution, GlyphMap > osgText::Font::FontSizeGlyphMap

protected

Definition at line 181 of file Font.h.

typedef std::map< unsigned int, osg::ref_ptr<Glyph3D> > osgText::Font::Glyph3DMap

protected

Definition at line 179 of file Font.h.

typedef std::map< unsigned int, osg::ref_ptr<Glyph> > osgText::Font::GlyphMap

protected

Definition at line 178 of file Font.h.

typedef std::vector< osg::ref_ptr<GlyphTexture> > osgText::Font::GlyphTextureList

Definition at line 168 of file Font.h.

typedef std::vector< osg::ref_ptr<osg::StateSet> > osgText::Font::StateSetList

protected

Definition at line 177 of file Font.h.

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.

Definition at line 78 of file Font.h.

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.

Definition at line 76 of file Font.h.

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.

Definition at line 75 of file Font.h.

static osg::ref_ptr<Font>& osgText::Font::getDefaultFont ( )

static

virtual std::string osgText::Font::getFileName ( ) const

virtual

unsigned int osgText::Font::getFontDepth ( ) const

inline

Definition at line 141 of file Font.h.

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

Definition at line 169 of file Font.h.

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

Definition at line 144 of file Font.h.

osg::StateSet* osgText::Font::getStateSet ( )

inline

Definition at line 90 of file Font.h.

const osg::StateSet* osgText::Font::getStateSet ( ) const

inline

Definition at line 91 of file Font.h.

osg::TexEnv* osgText::Font::getTexEnv ( )

inline

Definition at line 86 of file Font.h.

const osg::TexEnv* osgText::Font::getTexEnv ( ) const

inline

Definition at line 87 of file Font.h.

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.

Definition at line 109 of file Font.h.

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.

Definition at line 77 of file Font.h.

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.

Definition at line 79 of file Font.h.

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

Definition at line 143 of file Font.h.

void osgText::Font::setStateSet ( osg::StateSet * stateset )

inline

Definition at line 89 of file Font.h.

void osgText::Font::setTexEnv ( osg::TexEnv * texenv )

inline

Definition at line 85 of file Font.h.

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

Definition at line 148 of file Font.h.

Member Data Documentation

unsigned int osgText::Font::_depth

protected

Definition at line 203 of file Font.h.

FontResolution osgText::Font::_fontSize

protected

Definition at line 194 of file Font.h.

Glyph3DMap osgText::Font::_glyph3DMap

protected

Definition at line 191 of file Font.h.

OpenThreads::Mutex osgText::Font::_glyphMapMutex

mutableprotected

Definition at line 183 of file Font.h.

GlyphTextureList osgText::Font::_glyphTextureList

protected

Definition at line 188 of file Font.h.

osg::ref_ptr<FontImplementation> osgText::Font::_implementation

protected

Definition at line 207 of file Font.h.

osg::Texture::FilterMode osgText::Font::_magFilterHint

protected

Definition at line 201 of file Font.h.

unsigned int osgText::Font::_margin

protected

Definition at line 195 of file Font.h.

float osgText::Font::_marginRatio

protected

Definition at line 196 of file Font.h.

osg::Texture::FilterMode osgText::Font::_minFilterHint

protected

Definition at line 200 of file Font.h.

unsigned int osgText::Font::_numCurveSamples

protected

Definition at line 204 of file Font.h.

FontSizeGlyphMap osgText::Font::_sizeGlyphMap

protected

Definition at line 187 of file Font.h.

osg::ref_ptr<osg::StateSet> osgText::Font::_stateset

protected

Definition at line 186 of file Font.h.

osg::ref_ptr<osg::TexEnv> osgText::Font::_texenv

protected

Definition at line 185 of file Font.h.

unsigned int osgText::Font::_textureHeightHint

protected

Definition at line 199 of file Font.h.

unsigned int osgText::Font::_textureWidthHint

protected

Definition at line 198 of file Font.h.

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

osg_head/include/osgText/Font.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation