Cortex  10.0.0-a4
Public Member Functions | List of all members
IECore::Font Class Reference

#include <Font.h>

+ Inheritance diagram for IECore::Font:

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPED (Font, RunTimeTyped)
 
 Font (const std::string &fontFile)
 
const std::string & fileName () const
 
void setKerning (float kerning)
 
float getKerning () const
 
void setCurveTolerance (float tolerance)
 
float getCurveTolerance () const
 
const MeshPrimitivemesh (char c) const
 
MeshPrimitivePtr mesh (const std::string &text) const
 
GroupPtr meshGroup (const std::string &text) const
 
Imath::V2f advance (char first, char second) const
 
Imath::Box2f bound () const
 
Imath::Box2f bound (char c) const
 
Imath::Box2f bound (const std::string &text) const
 
- Public Member Functions inherited from IECore::RunTimeTyped
 IE_CORE_DECLAREMEMBERPTR (RunTimeTyped)
 
virtual TypeId typeId () const
 
virtual const char * typeName () const
 
virtual bool isInstanceOf (TypeId typeId) const
 
virtual bool isInstanceOf (const char *typeName) const
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Additional Inherited Members

- Public Types inherited from IECore::RunTimeTyped
typedef RefCounted BaseClass
 A typedef for the class this class derives from. All RunTimeTyped classes define this typedef.
 
- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 
- Static Public Member Functions inherited from IECore::RunTimeTyped
static TypeId staticTypeId ()
 Returns the TypeId for this class, without needing an instance.
 
static const char * staticTypeName ()
 Returns the type name for this class, without needing an instance.
 
static TypeId baseTypeId ()
 
static const char * baseTypeName ()
 
static bool inheritsFrom (TypeId typeId)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (const char *typeName)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (TypeId type, TypeId baseType)
 Returns true if type inherits from baseType.
 
static bool inheritsFrom (const char *typeName, const char *baseTypeName)
 Returns true if typeName inherits from baseTypeName.
 
static TypeId baseTypeId (TypeId typeId)
 Returns the base type of the given type, or InvalidTypeId if no such base exists.
 
static const std::vector< TypeId > & baseTypeIds (TypeId typeId)
 
static const std::set< TypeId > & derivedTypeIds (TypeId typeId)
 
static TypeId typeIdFromTypeName (const char *typeName)
 
static const char * typeNameFromTypeId (TypeId typeId)
 
static void registerType (TypeId derivedTypeId, const char *derivedTypeName, TypeId baseTypeId)
 Allows external modules to register their own type ids.
 
- Protected Types inherited from IECore::RunTimeTyped
typedef std::map< TypeId, TypeIdBaseTypeRegistryMap
 
typedef std::map< TypeId, std::vector< TypeId > > BaseTypesRegistryMap
 
typedef std::map< TypeId, std::set< TypeId > > DerivedTypesRegistryMap
 
typedef tbb::spin_rw_mutex Mutex
 
typedef std::map< TypeId, std::string > TypeIdsToTypeNamesMap
 
typedef std::map< std::string, TypeIdTypeNamesToTypeIdsMap
 
- Static Protected Member Functions inherited from IECore::RunTimeTyped
static BaseTypeRegistryMap & baseTypeRegistry ()
 
static DerivedTypesRegistryMap & derivedTypesRegistry ()
 
static BaseTypesRegistryMap & completeBaseTypesRegistry ()
 
static DerivedTypesRegistryMap & completeDerivedTypesRegistry ()
 
static void derivedTypeIdsWalk (TypeId typeId, std::set< TypeId > &)
 
static TypeIdsToTypeNamesMap & typeIdsToTypeNames ()
 
static TypeNamesToTypeIdsMap & typeNamesToTypeIds ()
 
- Static Protected Attributes inherited from IECore::RunTimeTyped
static Mutex g_baseTypeIdsMutex
 
static Mutex g_derivedTypeIdsMutex
 

Detailed Description

The Font class allows the loading of fonts and their conversion to MeshPrimitives.

Member Function Documentation

Imath::V2f IECore::Font::advance ( char  first,
char  second 
) const

Returns the necessary appropriate offset between the origins of the first and second characters, taking into account the current kerning.

Imath::Box2f IECore::Font::bound ( ) const

Returns a bounding box guaranteed to be large enough to contain all characters from the font. 1 unit in this bound is equal to 1 em.

Imath::Box2f IECore::Font::bound ( char  c) const

Returns the bounding box for the specified character - units are as above.

Imath::Box2f IECore::Font::bound ( const std::string &  text) const

Returns the bounding box for the specified string taking into account the current kerning settings - units are as above.

const MeshPrimitive* IECore::Font::mesh ( char  c) const

Returns a mesh for the specified character, using the current curve tolerance. This returns a reference into an internal cache and hence the resulting mesh is const.

MeshPrimitivePtr IECore::Font::mesh ( const std::string &  text) const

Returns a mesh representing the specified string, using the current curve tolerance and kerning.

GroupPtr IECore::Font::meshGroup ( const std::string &  text) const

Returns a group representing the specified string, using the current curve tolerance and kerning.

void IECore::Font::setCurveTolerance ( float  tolerance)

Sets the tolerance used when converting curved segments of glyphs into triangle meshes. Smaller values produce denser meshes. Tolerance is specified in the same coordinate system as the resulting mesh - that is one unit in the mesh is equal to one em.


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