ScummVM API documentation
Ultima::Ultima8::ShapeFont Class Reference
Inheritance diagram for Ultima::Ultima8::ShapeFont:
Ultima::Ultima8::Font Ultima::Ultima8::Shape

Public Member Functions

 ShapeFont (const uint8 *data, uint32 size, const ConvertShapeFormat *format, const uint16 flexId, const uint32 shapenum)
 
int getHeight () override
 get the height of the font
 
int getBaseline () override
 get the baseline of the font (relative from the top)
 
int getBaselineSkip () override
 get the baselineskip of the font (distance between two baselines)
 
int getWidth (char c)
 
int getVlead () const
 
int getHlead () const
 
void setVLead (int vl)
 
void setHLead (int hl)
 
int charToFrameNum (char c) const
 
void getStringSize (const Std::string &text, int32 &width, int32 &height) override
 
RenderedTextrenderText (const Std::string &text, unsigned int &remaining, int32 width=0, int32 height=0, TextAlign align=TEXT_LEFT, bool u8specials=false, bool pagebreaks=false, Std::string::size_type cursor=Std::string::npos) override
 
- Public Member Functions inherited from Ultima::Ultima8::Font
virtual void getTextSize (const Std::string &text, int32 &resultwidth, int32 &resultheight, unsigned int &remaining, int32 width=0, int32 height=0, TextAlign align=TEXT_LEFT, bool u8specials=false, bool pagebreaks=false)
 
void setHighRes (bool hr)
 
bool isHighRes () const
 
- Public Member Functions inherited from Ultima::Ultima8::Shape
 Shape (const uint8 *data, uint32 size, const ConvertShapeFormat *format, const uint16 flexId, const uint32 shapenum)
 
 Shape (Common::SeekableReadStream *src, const ConvertShapeFormat *format)
 
void setPalette (const Palette *pal)
 
const PalettegetPalette () const
 
uint32 frameCount () const
 
void getTotalDimensions (int32 &w, int32 &h, int32 &x, int32 &y) const
 
const ShapeFramegetFrame (unsigned int frame) const
 
void getShapeId (uint16 &flexId, uint32 &shapenum) const
 

Additional Inherited Members

- Public Types inherited from Ultima::Ultima8::Font
enum  TextAlign { TEXT_LEFT, TEXT_CENTER, TEXT_RIGHT }
 
- Static Public Member Functions inherited from Ultima::Ultima8::Shape
static const ConvertShapeFormatDetectShapeFormat (const uint8 *data, uint32 size)
 
static const ConvertShapeFormatDetectShapeFormat (Common::SeekableReadStream &ds, uint32 size)
 
- Protected Attributes inherited from Ultima::Ultima8::Font
bool _highRes
 

Member Function Documentation

◆ getStringSize()

void Ultima::Ultima8::ShapeFont::getStringSize ( const Std::string text,
int32 &  width,
int32 &  height 
)
overridevirtual

get the dimensions of a string (not containing any newlines)

Parameters
textThe string
widthReturns the width
heightReturns the height

Implements Ultima::Ultima8::Font.

◆ renderText()

RenderedText* Ultima::Ultima8::ShapeFont::renderText ( const Std::string text,
unsigned int &  remaining,
int32  width = 0,
int32  height = 0,
TextAlign  align = TEXT_LEFT,
bool  u8specials = false,
bool  pagebreaks = false,
Std::string::size_type  cursor = Std::string::npos 
)
overridevirtual

render a string

Parameters
textThe text
remainingReturns index of the first character not printed
widthThe width of the target rectangle, or 0 for unlimited
heightThe height of the target rectangle, or 0 for unlimited
alignAlignment of the text (left, right, center)
u8specialsIf true, interpret the special characters U8 uses
pagebreaksIf true (and u8specials too), stop at U8 pagebreaks
Returns
the rendered text in a RenderedText object

Implements Ultima::Ultima8::Font.


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