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

Pure virtual base class for fonts. More...

Inheritance diagram for osgText::Font:
Inheritance graph
[legend]

Classes

class  FontImplementation
 

Public Types

typedef std::vector< osg::ref_ptr< osg::StateSet > > StateSets
 
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
 Clone the type of an object, with Object* return type. More...
 
virtual osg::Objectclone (const osg::CopyOp &) const
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual const char * className () const
 return the name of the object's class type. More...
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual std::string getFileName () const
 
StateSetsgetCachedStateSets ()
 
const StateSetsgetCachedStateSets () const
 
virtual osg::Vec2 getKerning (const FontResolution &fontRes, unsigned int leftcharcode, unsigned int rightcharcode, KerningType kerningType)
 Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes and a font resolution. More...
 
virtual GlyphgetGlyph (const FontResolution &fontSize, unsigned int charcode)
 Get a Glyph for specified charcode, and the font size nearest to the current font size hint. More...
 
virtual Glyph3DgetGlyph3D (const FontResolution &fontSize, unsigned int charcode)
 Get a Glyph3D for specified charcode and a font size. More...
 
virtual bool hasVertical () const
 Return true if this font provides vertical alignments and spacing or glyphs. More...
 
virtual bool getVerticalSize (float &ascender, float &descender) const
 Get the ascender and descender sizes of the font where supported by the FontImplementation, return true on success, return false when not supported. More...
 
void setTextureSizeHint (unsigned int width, unsigned int height)
 Set the size of texture to create to store the glyph images when rendering. More...
 
unsigned int getTextureWidthHint () const
 
unsigned int getTextureHeightHint () const
 
void setMinFilterHint (osg::Texture::FilterMode mode)
 Set the minification texture filter to use when creating the texture to store the glyph images when rendering. More...
 
osg::Texture::FilterMode getMinFilterHint () const
 
void setMagFilterHint (osg::Texture::FilterMode mode)
 Set the magnification texture filter to use when creating the texture to store the glyph images when rendering. More...
 
osg::Texture::FilterMode getMagFilterHint () const
 
void setMaxAnisotropy (float anis)
 
float getMaxAnisotropy () 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)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context. More...
 
GlyphTextureListgetGlyphTextureList ()
 
void assignGlyphToGlyphTexture (Glyph *glyph, ShaderTechnique shaderTechnique)
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Static Public Member Functions

static osg::ref_ptr< FontgetDefaultFont ()
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Protected Types

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
 
typedef std::map< FontResolution, Glyph3DMapFontSizeGlyph3DMap
 

Protected Member Functions

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

Protected Attributes

OpenThreads::Mutex _glyphMapMutex
 
StateSets _statesets
 
FontSizeGlyphMap _sizeGlyphMap
 
GlyphTextureList _glyphTextureList
 
FontSizeGlyph3DMap _sizeGlyph3DMap
 
FontResolution _fontSize
 
unsigned int _textureWidthHint
 
unsigned int _textureHeightHint
 
osg::Texture::FilterMode _minFilterHint
 
osg::Texture::FilterMode _magFilterHint
 
float _maxAnisotropy
 
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

◆ FontMutex

◆ FontSizeGlyph3DMap

◆ FontSizeGlyphMap

◆ Glyph3DMap

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

◆ GlyphMap

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

◆ GlyphTextureList

◆ StateSets

Constructor & Destructor Documentation

◆ Font()

osgText::Font::Font ( FontImplementation implementation = 0)

◆ ~Font()

virtual osgText::Font::~Font ( )
protectedvirtual

Member Function Documentation

◆ addGlyph()

void osgText::Font::addGlyph ( const FontResolution fontRes,
unsigned int  charcode,
Glyph glyph 
)
protected

◆ assignGlyphToGlyphTexture()

void osgText::Font::assignGlyphToGlyphTexture ( Glyph glyph,
ShaderTechnique  shaderTechnique 
)

◆ className()

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.

◆ clone()

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.

◆ cloneType()

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.

◆ getCachedStateSets() [1/2]

StateSets& osgText::Font::getCachedStateSets ( )
inline

◆ getCachedStateSets() [2/2]

const StateSets& osgText::Font::getCachedStateSets ( ) const
inline

◆ getDefaultFont()

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

◆ getFileName()

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

◆ getFontDepth()

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

◆ getGlyph()

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.

◆ getGlyph3D()

virtual Glyph3D* osgText::Font::getGlyph3D ( const FontResolution fontSize,
unsigned int  charcode 
)
virtual

Get a Glyph3D for specified charcode and a font size.

◆ getGlyphTextureList()

GlyphTextureList& osgText::Font::getGlyphTextureList ( )
inline

◆ getImplementation() [1/2]

FontImplementation* osgText::Font::getImplementation ( )

◆ getImplementation() [2/2]

const FontImplementation* osgText::Font::getImplementation ( ) const

◆ getKerning()

virtual osg::Vec2 osgText::Font::getKerning ( const FontResolution fontRes,
unsigned int  leftcharcode,
unsigned int  rightcharcode,
KerningType  kerningType 
)
virtual

Get a kerning (adjustment of spacing of two adjacent character) for specified charcodes and a font resolution.

◆ getMagFilterHint()

osg::Texture::FilterMode osgText::Font::getMagFilterHint ( ) const

◆ getMaxAnisotropy()

float osgText::Font::getMaxAnisotropy ( ) const
inline

◆ getMinFilterHint()

osg::Texture::FilterMode osgText::Font::getMinFilterHint ( ) const

◆ getNumberCurveSamples()

unsigned int osgText::Font::getNumberCurveSamples ( ) const
inline

◆ getTextureHeightHint()

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

◆ getTextureWidthHint()

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

◆ getVerticalSize()

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.

◆ hasVertical()

virtual bool osgText::Font::hasVertical ( ) const
virtual

Return true if this font provides vertical alignments and spacing or glyphs.

◆ isSameKindAs()

virtual bool osgText::Font::isSameKindAs ( const osg::Object obj) const
inlinevirtual

Reimplemented from osg::Object.

References NULL.

◆ libraryName()

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.

◆ releaseGLObjects()

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.

◆ resizeGLObjectBuffers()

virtual void osgText::Font::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

◆ setImplementation()

void osgText::Font::setImplementation ( FontImplementation implementation)

◆ setMagFilterHint()

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.

◆ setMaxAnisotropy()

void osgText::Font::setMaxAnisotropy ( float  anis)
inline

◆ setMinFilterHint()

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.

◆ setNumberCurveSamples()

void osgText::Font::setNumberCurveSamples ( unsigned int  numSamples)
inline

◆ setTextureSizeHint()

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.

◆ setThreadSafeRefUnref()

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

◆ FontImplementation

friend class FontImplementation
friend

Member Data Documentation

◆ _depth

unsigned int osgText::Font::_depth
protected

◆ _fontSize

FontResolution osgText::Font::_fontSize
protected

◆ _glyphMapMutex

OpenThreads::Mutex osgText::Font::_glyphMapMutex
mutableprotected

◆ _glyphTextureList

GlyphTextureList osgText::Font::_glyphTextureList
protected

◆ _implementation

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

◆ _magFilterHint

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

◆ _maxAnisotropy

float osgText::Font::_maxAnisotropy
protected

◆ _minFilterHint

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

◆ _numCurveSamples

unsigned int osgText::Font::_numCurveSamples
protected

◆ _sizeGlyph3DMap

FontSizeGlyph3DMap osgText::Font::_sizeGlyph3DMap
protected

◆ _sizeGlyphMap

FontSizeGlyphMap osgText::Font::_sizeGlyphMap
protected

◆ _statesets

StateSets osgText::Font::_statesets
protected

◆ _textureHeightHint

unsigned int osgText::Font::_textureHeightHint
protected

◆ _textureWidthHint

unsigned int osgText::Font::_textureWidthHint
protected

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