IGlyphsClusters Class Reference

#include <edl/iglyphsclusters.h>

Inheritance diagram for IGlyphsClusters:

Public Member Functions
virtual	~IGlyphsClusters ()
virtual IGlyphsClustersPtr	clone () const =0
	Clone this clusters object.
virtual void	populateUnicodeAndIndices (EDLString &unicodeString, EDLSysString &indices)=0
	Populate a unicode string and indices from this set of clusters.
virtual void	clear ()=0
	Clear the clusters.
virtual uint32	getNumClusters () const =0
	Clear the number of clusters.
virtual CGlyphsCluster &	getCluster (uint32 index)=0
	Obtain a reference to the cluster at the given index.
virtual void	deleteCluster (uint32 index)=0
	Remove a cluster at the given index.
virtual void	insertCluster (uint32 index, const CGlyphsCluster &cluster)=0
	Insert a cluster before the item at the given index.
virtual void	appendCluster (const CGlyphsCluster &cluster)=0
	Append a cluster to the set.
virtual CGlyphsCluster &	newCluster ()=0
	Allocate a new cluster at the end of the set and return a reference to it.
virtual bool	similar (const IGlyphsClustersPtr &other, float eps) const =0
	Check to see if these clusters are similar to another with regard to metrics. Non-metrics information (such as glyph ids and unicode) must be equivalent for two sets of clusters to be considered similar.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static EDL_API IGlyphsClustersPtr	create ()
	Create a new set of glyphs clusters.
static EDL_API IGlyphsClustersPtr	create (const EDLString &unicodeString, const EDLSysString &indices)
	Create a set of glyphs clusters based on the given unicode and indices strings.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Constructor & Destructor Documentation

~IGlyphsClusters()

virtual IGlyphsClusters::~IGlyphsClusters ( )

inlinevirtual

Member Function Documentation

appendCluster()

virtual void IGlyphsClusters::appendCluster ( const CGlyphsCluster & cluster )

pure virtual

Append a cluster to the set.

Parameters

cluster

The cluster to append

clear()

virtual void IGlyphsClusters::clear ( )

pure virtual

Clear the clusters.

clone()

virtual IGlyphsClustersPtr IGlyphsClusters::clone ( ) const

pure virtual

Clone this clusters object.

Returns

IGlyphsClustersPtr the cloned clusters

create() [1/2]

EDL_API IGlyphsClustersPtr IGlyphsClusters::create ( )

static

Create a new set of glyphs clusters.

Returns

IGlyphsClustersPtr The new glyphs clusters object

create() [2/2]

EDL_API IGlyphsClustersPtr IGlyphsClusters::create ( const EDLString & unicodeString, const EDLSysString & indices )

static

Create a set of glyphs clusters based on the given unicode and indices strings.

deleteCluster()

virtual void IGlyphsClusters::deleteCluster ( uint32 index )

pure virtual

Remove a cluster at the given index.

Parameters

index

The index of the cluster ro remove

getCluster()

virtual CGlyphsCluster & IGlyphsClusters::getCluster ( uint32 index )

pure virtual

Obtain a reference to the cluster at the given index.

Parameters

index

The index of the desired cluster

Returns

CGlyphsCluster Reference to the cluster

getNumClusters()

virtual uint32 IGlyphsClusters::getNumClusters ( ) const

pure virtual

Clear the number of clusters.

Returns

uint32 The number of clusters

insertCluster()

virtual void IGlyphsClusters::insertCluster ( uint32 index, const CGlyphsCluster & cluster )

pure virtual

Insert a cluster before the item at the given index.

Parameters

index	The index to insert the cluster
cluster	The cluster to insert

newCluster()

virtual CGlyphsCluster & IGlyphsClusters::newCluster ( )

pure virtual

Allocate a new cluster at the end of the set and return a reference to it.

Returns

CGlyphsCluster Reference to the new cluster

populateUnicodeAndIndices()

virtual void IGlyphsClusters::populateUnicodeAndIndices ( EDLString & unicodeString, EDLSysString & indices )

pure virtual

Populate a unicode string and indices from this set of clusters.

similar()

virtual bool IGlyphsClusters::similar ( const IGlyphsClustersPtr & other, float eps ) const

pure virtual

Check to see if these clusters are similar to another with regard to metrics. Non-metrics information (such as glyph ids and unicode) must be equivalent for two sets of clusters to be considered similar.

Parameters

other	The glyphs clusters to compare.
eps	The epsilon limit for metrics similarity, in hundredths of an em.

Returns

bool True if similar, false otherwise.

---

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

• edl/iglyphsclusters.h