Classes | Typedefs | Enumerations | Functions

osgText Namespace Reference

Classes

class  FadeText
class  Font
class  Font3D
class  VectorUInt
class  String
class  Text
class  Text3D
class  TextBase

Typedefs

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

Enumerations

enum  KerningType { KERNING_DEFAULT, KERNING_UNFITTED, KERNING_NONE }

Functions

OSGTEXT_EXPORT FontreadFontFile (const std::string &filename, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT FontreadFontStream (std::istream &stream, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT osg::ref_ptr< FontreadRefFontFile (const std::string &filename, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT osg::ref_ptr< FontreadRefFontStream (std::istream &stream, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT std::string findFontFile (const std::string &str)
OSGTEXT_EXPORT Font3DreadFont3DFile (const std::string &filename, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT Font3DreadFont3DStream (std::istream &stream, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT osg::ref_ptr
< Font3D
readRefFont3DFile (const std::string &filename, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT osg::ref_ptr
< Font3D
readRefFont3DStream (std::istream &stream, const osgDB::ReaderWriter::Options *userOptions=0)
OSGTEXT_EXPORT 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 std::pair< unsigned int, unsigned int > osgText::FontResolution

Enumeration Type Documentation

Enumerator:
KERNING_DEFAULT 
KERNING_UNFITTED 
KERNING_NONE 

Function Documentation

OSGTEXT_EXPORT std::string osgText::findFont3DFile ( const std::string &  str )
OSGTEXT_EXPORT std::string osgText::findFontFile ( const std::string &  str )
OSGTEXT_EXPORT Font3D* osgText::readFont3DFile ( const std::string &  filename,
const osgDB::ReaderWriter::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.

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

read a font from specified stream.

OSGTEXT_EXPORT Font* osgText::readFontFile ( const std::string &  filename,
const osgDB::ReaderWriter::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.

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

read a font from specified stream.

OSGTEXT_EXPORT osg::ref_ptr<Font3D> osgText::readRefFont3DFile ( const std::string &  filename,
const osgDB::ReaderWriter::Options userOptions = 0 
)
OSGTEXT_EXPORT osg::ref_ptr<Font3D> osgText::readRefFont3DStream ( std::istream &  stream,
const osgDB::ReaderWriter::Options userOptions = 0 
)
OSGTEXT_EXPORT osg::ref_ptr<Font> osgText::readRefFontFile ( const std::string &  filename,
const osgDB::ReaderWriter::Options userOptions = 0 
)
OSGTEXT_EXPORT osg::ref_ptr<Font> osgText::readRefFontStream ( std::istream &  stream,
const osgDB::ReaderWriter::Options userOptions = 0 
)