IWaxGlyphs.h

//========================================================================================
// 
// $File$
// 
// Owner: ?
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IWaxGlyphs__
#define __IWaxGlyphs__

#include "IPMUnknown.h"
#include "CTextEnum.h"
#include "TextID.h"
#include "PMRect.h"
#include "IWaxRun.h"

class PMMatrix;
class PMRealGlyphPoint;

class IWaxGlyphs : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWAXGLYPHS };

 virtual int32 GetGlyphCount() const = 0;
 virtual int32 GetCharCount() const = 0;

 virtual bool16 IsMapped() const = 0;

 virtual int32 GetWaxSpan() const = 0;

 virtual PMReal GetWidth(bool16 ignoreAllTrailing = kFalse) const = 0;
 virtual PMReal GetCharWidth() const = 0;

 virtual PMReal GetHeight() const = 0;
 virtual void SetHeight(const PMReal& height) = 0;

 // ***************************************************************************
 // Conversion methods.

 virtual PMReal GetGlyphIndexFor(PMReal position) const = 0;

 virtual void MapCharsToGlyphs(int32 offset, int32 length, int32* pRangeStart, int32* pRangeLength) const = 0;

 virtual void MapGlyphsToChars(int32 rangeStart, int32 rangeLength, int32* pOffset, int32* pLength) const = 0;

 // ***************************************************************************
 // Access to particular glyph data.

 virtual Text::GlyphID GetGlyphAt(int32 glyphIndex) const = 0;

 virtual PMReal GetWidthAt(int32 glyphIndex) const = 0;
 virtual PMReal GetEscapementAt(int32 glyphIndex) const = 0;

 virtual PMReal GetCharWidthAt(int32 charIndex) const = 0;
 virtual PMReal GetCharEscapementAt(int32 charIndex) const = 0;

 // ***************************************************************************
 // Access to various set data.

 virtual const Text::GlyphID* PeekGlyphArray() const = 0;
 virtual const float* PeekWidthsArray() const = 0;

 // ***************************************************************************

 virtual float* QueryDrawWidthsArray(float& initialGlyphXOffset) const = 0;
 virtual float GetXOffsetAt(int32 glyphIndex) const = 0;

 // ***************************************************************************
 // Add or replace the set of glyphs

 virtual void AddGlyph(Text::GlyphID glyph, float width, float glyphXOffset = 0) = 0;
 virtual void ReplaceGlyphAt(int32 glyphIndex, Text::GlyphID glyph) = 0;

 virtual void AddGlyphs(const Text::GlyphID* glyphs, const float* widths, int32 count, const float* glyphXOffsets = nil) = 0;

 virtual void AddGlyphs(const PMRealGlyphPoint *points, int32 count, const float* glyphXOffsets = nil) = 0;

 virtual void AddMappingWidth(const PMReal& width) = 0;

 // ***************************************************************************
 // These provide a mapping between this char (& width) and the glyphs that will fill it (e.g. associates the leader glyphs to the tab char).

 virtual void AddMappingRange(int32 offset, int32 rangeStart, int32 rangeLength) = 0;

 virtual void AdjustWidthAt(int32 glyphIndex, float deltaWidth, float glyphOffset = 0) = 0;

 // ***************************************************************************
 // Transform related methods.

 virtual PMRect GetStrokeBoundingBox(const PMMatrix* pMatrix = nil) const = 0;

 virtual bool16 GetGlyphMatrix(int32 glyphIndex, PMMatrix* glyphMatrix, PMPoint* penCorrection) const = 0;

 virtual PMMatrix GetGlyphDrawPosition(int32 glyphIndex) const = 0;

 virtual bool16 HasGlyphMatrix() const = 0;

 virtual PMMatrix GetPerGlyphMatrix(int32 glyphIndex, PMPoint * penCorrection) const = 0;
 virtual void SetPerGlyphMatrix( int32 glyphIndex, const PMMatrix& glyphMatrix, const PMPoint& penCorrection ) = 0 ;
 virtual bool16 HasPerGlyphMatrix() const = 0;

 virtual PMMatrix GetAllGlyphsMatrix(PMPoint * penCorrection) const = 0;
 virtual void SetAllGlyphsMatrix( const PMMatrix& matrix, const PMPoint& penCorrection ) = 0 ;

 virtual bool16 SplitInto(IWaxGlyphs* other, int32 charOffsetInRun) = 0;
};

#endif