osgText Namespace Reference

Classes
class	Bevel
class	FadeText
class	Font
class	Glyph
class	Glyph3D
class	GlyphGeometry
class	GlyphTexture
class	String
class	Style
class	Text
class	Text3D
class	TextBase
class	VectorUInt

Typedefs
typedef Font	Font3D
typedef std::pair< unsigned int, unsigned int >	FontResolution

Enumerations
enum	KerningType { KERNING_DEFAULT, KERNING_UNFITTED, KERNING_NONE }

Functions
OSGTEXT_EXPORT Font *	readFontFile (const std::string &filename, const osgDB::Options *userOptions=0)
OSGTEXT_EXPORT Font *	readFontStream (std::istream &stream, const osgDB::Options *userOptions=0)
OSGTEXT_EXPORT osg::ref_ptr< Font >	readRefFontFile (const std::string &filename, const osgDB::Options *userOptions=0)
OSGTEXT_EXPORT osg::ref_ptr< Font >	readRefFontStream (std::istream &stream, const osgDB::Options *userOptions=0)
OSGTEXT_EXPORT std::string	findFontFile (const std::string &str)
Font *	readFont3DFile (const std::string &filename, const osgDB::ReaderWriter::Options *userOptions=0)
Font *	readFont3DStream (std::istream &stream, const osgDB::ReaderWriter::Options *userOptions=0)
osg::ref_ptr< Font >	readRefFont3DFile (const std::string &filename, const osgDB::ReaderWriter::Options *userOptions=0)
osg::ref_ptr< Font >	readRefFont3DStream (std::istream &stream, const osgDB::ReaderWriter::Options *userOptions=0)
std::string	findFont3DFile (const std::string &str)

Detailed Description

The osgText library is a NodeKit that extends the core scene graph to support high quality text.

Typedef Documentation

typedef Font osgText::Font3D

Definition at line 21 of file Font3D.h.

typedef std::pair< unsigned int, unsigned int > osgText::FontResolution

Definition at line 20 of file KerningType.h.

Enumeration Type Documentation

enum osgText::KerningType

Enumerator
KERNING_DEFAULT
KERNING_UNFITTED
KERNING_NONE

Definition at line 22 of file KerningType.h.

Function Documentation

std::string osgText::findFont3DFile ( const std::string &  str )

inline

deprecated, use findFontFile() instead.

Definition at line 48 of file Font3D.h.

Here is the call graph for this function:

OSGTEXT_EXPORT std::string osgText::findFontFile

(

const std::string &

str

)

Here is the caller graph for this function:

Font* osgText::readFont3DFile ( const std::string &  filename, const osgDB::ReaderWriter::Options *  userOptions = 0  )

inline

deprecated, use readFontFile() instead.

Definition at line 24 of file Font3D.h.

Here is the call graph for this function:

Font* osgText::readFont3DStream ( std::istream &  stream, const osgDB::ReaderWriter::Options *  userOptions = 0  )

inline

deprecated, use readFontStream() instead.

Definition at line 30 of file Font3D.h.

Here is the call graph for this function:

OSGTEXT_EXPORT Font* osgText::readFontFile	(	const std::string &	filename,
		const osgDB::Options *	userOptions = 0
	)

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.

Here is the caller graph for this function:

OSGTEXT_EXPORT Font* osgText::readFontStream	(	std::istream &	stream,
		const osgDB::Options *	userOptions = 0
	)

read a font from specified stream.

Here is the caller graph for this function:

osg::ref_ptr<Font> osgText::readRefFont3DFile ( const std::string &  filename, const osgDB::ReaderWriter::Options *  userOptions = 0  )

inline

deprecated, use readRefFontFile() instead.

Definition at line 36 of file Font3D.h.

Here is the call graph for this function:

osg::ref_ptr<Font> osgText::readRefFont3DStream ( std::istream &  stream, const osgDB::ReaderWriter::Options *  userOptions = 0  )

inline

deprecated, use readRefFontStream() instead.

Definition at line 42 of file Font3D.h.

Here is the call graph for this function:

OSGTEXT_EXPORT osg::ref_ptr<Font> osgText::readRefFontFile	(	const std::string &	filename,
		const osgDB::Options *	userOptions = 0
	)

Here is the caller graph for this function:

OSGTEXT_EXPORT osg::ref_ptr<Font> osgText::readRefFontStream	(	std::istream &	stream,
		const osgDB::Options *	userOptions = 0
	)

Here is the caller graph for this function: