osg::TextFaceFactory Class Reference

#include <OSGTextFaceFactory.h>

List of all members.

Public Member Functions
	~TextFaceFactory ()
TextVectorFace *	createVectorFace (const std::string &family, TextFace::Style style=TextFace::STYLE_PLAIN)
TextPixmapFace *	createPixmapFace (const std::string &family, TextFace::Style style=TextFace::STYLE_PLAIN, UInt32 size=32)
TextTXFFace *	createTXFFace (const std::string &family, TextFace::Style style=TextFace::STYLE_PLAIN, const TextTXFParam &param=TextTXFParam())
void	clearCache ()
void	getFontFamilies (std::vector< std::string > &families) const
Static Public Member Functions
static bool	isValid (void)
static TextFaceFactory &	the ()
Private Types
typedef std::multimap < std::string, TextVectorFace * >	VectorFaceMap
typedef std::multimap < std::string, TextPixmapFace * >	PixmapFaceMap
typedef std::multimap < std::string, TextTXFFace * >	TXFFaceMap
Private Member Functions
	TextFaceFactory ()
	TextFaceFactory (const TextFaceFactory &)
const TextFaceFactory &	operator= (const TextFaceFactory &)
Private Attributes
TextBackend *	_backend
VectorFaceMap	_vectorFaceMap
PixmapFaceMap	_pixmapFaceMap
TXFFaceMap	_txfFaceMap
Static Private Attributes
static bool	_valid = false
static TextFaceFactory	_the

---

Detailed Description

A singleton used to create new faces. The TextFaceFactory keeps a cache of all currently created faces. When creating a new face, the factory first searches in the cache if the face already exists. If yes, it returns that face. If no, it creates a new face, adds it to the cache, and returns it. Usually you do not use the TextFaceFactory singleton directly, instead you use the create method of the TextFace classes.

Author:

Patrick Dähne

Definition at line 78 of file OSGTextFaceFactory.h.

---

Member Typedef Documentation

typedef std::multimap<std::string, TextVectorFace*> osg::TextFaceFactory::VectorFaceMap [private]

Defines the map that contains the vector faces

Definition at line 156 of file OSGTextFaceFactory.h.

typedef std::multimap<std::string, TextPixmapFace*> osg::TextFaceFactory::PixmapFaceMap [private]

Defines the map that contains the pixmap faces

Definition at line 162 of file OSGTextFaceFactory.h.

typedef std::multimap<std::string, TextTXFFace*> osg::TextFaceFactory::TXFFaceMap [private]

Defines the map that contains the TXF faces

Definition at line 168 of file OSGTextFaceFactory.h.

---

Constructor & Destructor Documentation

osg::TextFaceFactory::~TextFaceFactory

(

)

Destroys the TextFaceFactory object.

Definition at line 118 of file OSGTextFaceFactory.cpp.

References _backend, _valid, and clearCache().

{
    _valid = false;
    clearCache();
    delete _backend;
}

osg::TextFaceFactory::TextFaceFactory

(

)

[private]

Default Constructor

Definition at line 95 of file OSGTextFaceFactory.cpp.

References _backend, _valid, osg::addSystemExitFunction(), and osg::terminateFaceFactory().

: _backend(), _vectorFaceMap(), _pixmapFaceMap(), _txfFaceMap()
{
    _valid = true;
#if defined(_WIN32)
    _backend = new TextWIN32Backend();
#elif defined(__APPLE__)
    _backend = new TextMacBackend();
    //_backend = new TextFT2Backend();
#elif defined(FT2_LIB)
    _backend = new TextFT2Backend();
#else
    _backend = 0;
#endif

    addSystemExitFunction(&terminateFaceFactory);
}

osg::TextFaceFactory::TextFaceFactory

(

const TextFaceFactory &

)

[private]

Copy constructor (not implemented!)

---

Member Function Documentation

TextVectorFace* osg::TextFaceFactory::createVectorFace	(	const std::string &	family,
		TextFace::Style	style = TextFace::STYLE_PLAIN
	)

Tries to create a vector face.

Parameters:

	family	The font family of the face (Arial, Courier etc.)
	style	The style of the face (bold, italic etc.)

Returns:

The vector face object or 0 in case of an error.

Referenced by osg::TextVectorFace::create().

TextPixmapFace* osg::TextFaceFactory::createPixmapFace	(	const std::string &	family,
		TextFace::Style	style = TextFace::STYLE_PLAIN,
		UInt32	size = 32
	)

Tries to create a pixmap face.

Parameters:

	family	The font family of the face (Arial, Courier etc.)
	style	The style of the face (bold, italic etc.)
	size	The size of the pixmap font in pixels.

Returns:

The pixmap face object or 0 in case of an error.

Referenced by osg::TextPixmapFace::create().

TextTXFFace* osg::TextFaceFactory::createTXFFace	(	const std::string &	family,
		TextFace::Style	style = TextFace::STYLE_PLAIN,
		const TextTXFParam &	param = TextTXFParam()
	)

Tries to create a TXF face.

Parameters:

	family	The font family of the face (Arial, Courier etc.)
	style	The style of the face (bold, italic etc.)
	param	Parameters that affect the creation of the TXF face.

Returns:

The TXF face object or 0 in case of an error.

void osg::TextFaceFactory::clearCache

(

)

Removes all faces from the face cache.

Definition at line 219 of file OSGTextFaceFactory.cpp.

References _pixmapFaceMap, _txfFaceMap, _vectorFaceMap, and osg::subRefP().

Referenced by ~TextFaceFactory().

{
    // Vector faces
    VectorFaceMap::iterator vIt;
    for (vIt = _vectorFaceMap.begin(); vIt != _vectorFaceMap.end(); ++vIt)
    {
        assert(vIt->second != 0);
        subRefP(vIt->second);
    }
    _vectorFaceMap.clear();

    // Pixmap faces
    PixmapFaceMap::iterator pIt;
    for (pIt = _pixmapFaceMap.begin(); pIt != _pixmapFaceMap.end(); ++pIt)
    {
        assert(pIt->second != 0);
        subRefP(pIt->second);
    }
    _pixmapFaceMap.clear();

    // TXF faces
    TXFFaceMap::iterator tIt;
    for (tIt = _txfFaceMap.begin(); tIt != _txfFaceMap.end(); ++tIt)
    {
        assert(tIt->second != 0);
        subRefP(tIt->second);
    }
    _txfFaceMap.clear();
}

void osg::TextFaceFactory::getFontFamilies

(

std::vector< std::string > &

families

)

const

Returns the names of all font families available.

Parameters:

families

A vector that gets filled with the names of all font families.

bool osg::TextFaceFactory::isValid

(

void

)

[static]

Definition at line 261 of file OSGTextFaceFactory.cpp.

References _valid.

{
    return _valid;
}

TextFaceFactory & osg::TextFaceFactory::the

(

void

)

[inline, static]

Returns the single instance of the FaceFactory singleton.

Returns:

The single instance.

Definition at line 43 of file OSGTextFaceFactory.inl.

References _the.

Referenced by osg::TextVectorFace::create(), and osg::TextPixmapFace::create().

{ return _the; } 

const TextFaceFactory& osg::TextFaceFactory::operator=

(

const TextFaceFactory &

)

[private]

Copy operator (not implemented!)

---

Member Data Documentation

bool osg::TextFaceFactory::_valid = false [static, private]

The single instance of the TextFaceFactory singleton

Definition at line 149 of file OSGTextFaceFactory.h.

Referenced by isValid(), TextFaceFactory(), and ~TextFaceFactory().

TextFaceFactory osg::TextFaceFactory::_the [static, private]

Definition at line 150 of file OSGTextFaceFactory.h.

Referenced by the().

TextBackend* osg::TextFaceFactory::_backend [private]

The backend that creates all faces

Definition at line 153 of file OSGTextFaceFactory.h.

Referenced by TextFaceFactory(), and ~TextFaceFactory().

VectorFaceMap osg::TextFaceFactory::_vectorFaceMap [private]

The map of vector faces currently instantiated (face cache)

Definition at line 159 of file OSGTextFaceFactory.h.

Referenced by clearCache().

PixmapFaceMap osg::TextFaceFactory::_pixmapFaceMap [private]

The map of pixmap faces currently instanciated (face cache)

Definition at line 165 of file OSGTextFaceFactory.h.

Referenced by clearCache().

TXFFaceMap osg::TextFaceFactory::_txfFaceMap [private]

The map of TXF faces currently instantiated (face cache)

Definition at line 171 of file OSGTextFaceFactory.h.

Referenced by clearCache().

---

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

• OSGTextFaceFactory.h
• OSGTextFaceFactory.cpp
• OSGTextFaceFactory.inl