クラス SGFontData

フォント属性(種類、サイズ)を保持するクラス [詳細]

#include <sgfont.h>

Public メソッド
	SGFontData ()
	コンストラクタ
virtual	~SGFontData ()
	デストラクタ
int	GetId ()
	フォントIDを取得する。
int	GetFreeTypeId ()
	FreeType用のIDを取得する.
void	SetFreeTypeId (int id)
	FreeType用のIDを設定する.
void	SetFont (int id, const char *file, int size, int effect=FONT_EFFECT_NORMAL, int bold=TRUE, int boldeffect=TRUE, int vertical=FALSE)
	フォントを生成する
void	SetSize (int size)
	フォントサイズを設定する
int	GetEffect ()
	装飾効果を取得する
void	SetEffect (int effect)
	装飾効果を設定する
int	IsBold ()
	書体属性がボールドかどうか調べる
void	SetBold (int bold=TRUE)
	書体属性にボールド情報を付加する
int	IsBoldEffect ()
	書体効果の属性がボールドかどうか調べる
void	SetBoldEffect (int bold=TRUE)
	書体効果の属性にボールド情報を付加する
unsigned int	GetColor ()
	書体の色を取得する。
void	SetColor (unsigned int col)
	書体の効果色を設定する。
unsigned int	GetColorEffect ()
	書体の効果色を取得する。
void	SetColorEffect (unsigned int col)
	書体の効果色を設定する。
int	IsAntialias ()
	書体のアンチエリアス属性が有効かどうか調べる
void	SetAntialias (int enable=TRUE)
	書体のアンチエリアス属性を設定する
int	GetBoldStrength ()
	書体の太さを決定する値を取得する
void	SetBoldStrength (int strength)
	書体の太さを決定する値を設定する
int	IsStroke ()
	書体効果タイプが STROKE げ有効かどうか調べる
void	SetStroke (int stroke)
	書体効果タイプを STROKE とする
int	IsEnableMatrix ()
	書体の変換パラメータが設定されているかどうか調べる
void	GetMatrix (double &xx, double &yx, double &xy, double &yy)
	書体の変換パラメータを取得する
void	SetMatrix (double xx, double yx, double xy, double yy)
	書体の変換パラメータを設定する
void	ResetMatrix ()
	書体の変換パラメータをリセットする
void	SetVertical (int flag)
	書体の表示方向（縦書/横書）を設定する
int	IsVertical ()
	書体の表示方向が縦書かどうか調べる
int	GetSize ()
	フォントサイズを取得する。
SGString &	GetFilename ()
	フォントファイル名を取得する。
void	SetFilename (SGString filename)
	フォントファイル名を設定する。

説明

フォント属性(種類、サイズ)を保持するクラス

フォントを展開するフォントクラス SGFont 本体とその属性(種類、サイズ)を保持します。
このクラスは
int SGApplication::SetFont()
で生成され、SGCore のメンバとして登録されている SGFontData の集合クラスである SGFontList で管理、保持されています。
このクラスを直接生成することはありません。

参照:: SGApplication::SetFont(int id,const char* file,int size); SGFontList::SGFontList()

コンストラクタとデストラクタ

SGFontData ( )

コンストラクタ

フォント属性(種類、サイズ)を保持するクラスフォントを展開するフォントクラス SGFont 本体とその属性(種類、サイズ)を保持します。
このクラスは
int SGApplication::SetFont()
で生成され、SGCore のメンバとして保持されます。そのときのメンバの型は SGFontData の集合クラスである SGFontList で管理、保持されています。
このクラスを直接生成することはありません。

参照:: SGApplication::SetFont(int id,const char* file,int size,int effect,int bold,int boldeffect); SGFontList::SGFontList()

~SGFontData ( ) [virtual]

デストラクタ

確保したリソースメモリを解放します。

関数

int GetId ( )

フォントIDを取得する。

フォント生成時に与えた識別用IDを取得します。

戻り値:: フォントID

int GetFreeTypeId ( )

FreeType用のIDを取得する.

FreeType用のIDを取得します。このIDはフォント生成時にPlusGライブラリによって自動的に割り当てられ、PlusGライブラリが内部で使用します。ユーザがこの関数を直接使用することは有りません。

戻り値:: FreeType用ID

void SetFreeTypeId ( int id )

FreeType用のIDを設定する.

FreeType用のIDを設定します。この関数はフォント生成時にPlusGライブラリが使用します。ユーザがこの関数を直接使用することは有りません。

引数:

id

FreeType用ID

void SetFont	(	int	id,
		const char *	file,
		int	size,
		int	effect = `FONT_EFFECT_NORMAL`,
		int	bold = `TRUE`,
		int	boldeffect = `TRUE`,
		int	vertical = `FALSE`
	)

フォントを生成する

与えられたフォント情報を元にフォントを生成し、情報と共に管理します。

引数:

	file	フォントファイル名
	size	フォントサイズ
	effect	装飾効果の設定 FONT_EFFECT_NORMAL(0) 効果なし FONT_EFFECT_SHADOW(1) 影（文字と影の２色使用） FONT_EFFECT_OUTLINE(2) 輪郭（塗りと輪郭２色使用） FONT_EFFECT_SHADOW_OUTLINE(3) 輪郭＋影（塗りと輪郭＋影２色使用） FONT_EFFECT_STROKE(4) 袋文字（輪郭のみ、塗りつぶしなし） FONT_EFFECT_CUSTOM(5) font.SetStroke(TRUE/FALSE); と font.SetBoldStrength();だけに反応します。
	bold	書体属性のボールドのON/OFFをTRUE/FALSEで設定（省略時ON）
	boldeffect	効果のボールドのON/OFFをTRUE/FALSEで設定（省略時ON）
	vertical	TRUE を指定すると縦書きになります

void SetSize ( int size )

フォントサイズを設定する

フォントサイズを設定します。

引数:

size

フォントサイズ

int GetEffect ( )

装飾効果を取得する

装飾効果を取得します。

戻り値:

装飾効果の設定

FONT_EFFECT_NORMAL(0)         効果なし
FONT_EFFECT_SHADOW(1)         影（文字と影の２色使用）
FONT_EFFECT_OUTLINE(2)        輪郭（塗りと輪郭２色使用）
FONT_EFFECT_SHADOW_OUTLINE(3) 輪郭＋影（塗りと輪郭＋影２色使用）
FONT_EFFECT_STROKE(4)         袋文字（輪郭のみ、塗りつぶしなし）
FONT_EFFECT_CUSTOM(5)         font.SetStroke(TRUE/FALSE); と font.SetBoldStrength();だけに反応します。

void SetEffect ( int effect )

装飾効果を設定する

装飾効果を設定します。

引数:

effect

装飾効果の設定

FONT_EFFECT_NORMAL(0)         効果なし
FONT_EFFECT_SHADOW(1)         影（文字と影の２色使用）
FONT_EFFECT_OUTLINE(2)        輪郭（塗りと輪郭２色使用）
FONT_EFFECT_SHADOW_OUTLINE(3) 輪郭＋影（塗りと輪郭＋影２色使用）
FONT_EFFECT_STROKE(4)         袋文字（輪郭のみ、塗りつぶしなし）
FONT_EFFECT_CUSTOM(5)         font.SetStroke(TRUE/FALSE); と font.SetBoldStrength();だけに反応します。

int IsBold ( )

書体属性がボールドかどうか調べる

書体属性がボールドかどうか調べます。書体がボールド属性を持っている場合はTRUEを返します。

戻り値:

	TRUE	書体属性にボールドが含まれています
	FALSE	書体属性にボールドは含まれていません。

void SetBold ( int bold = TRUE )

書体属性にボールド情報を付加する

書体属性にボールド情報を付加します。

引数:

bold

書体属性のボールドのON/OFFをTRUE/FALSEで設定（省略時ON）

int IsBoldEffect ( )

書体効果の属性がボールドかどうか調べる

書体効果の属性がボールドかどうか調べます。書体効果がボールド属性を持っている場合はTRUEを返します。

戻り値:

	TRUE	書体効果属性にボールドが含まれています
	FALSE	書体効果属性にボールドは含まれていません。

void SetBoldEffect ( int bold = TRUE )

書体効果の属性にボールド情報を付加する

書体効果の属性にボールド情報を付加します。

引数:

bold

書体効果のボールドのON/OFFをTRUE/FALSEで設定（省略時ON）

unsigned int GetColor ( )

書体の色を取得する。

書体の色を取得します。

戻り値:: 色

void SetColor ( unsigned int col )

書体の効果色を設定する。

書体の効果色を設定します。

引数:

col

色

unsigned int GetColorEffect ( )

書体の効果色を取得する。

書体の効果色を取得します。

戻り値:: 色

void SetColorEffect ( unsigned int col )

書体の効果色を設定する。

書体の効果色を設定します。

引数:

col

色

int IsAntialias ( )

書体のアンチエリアス属性が有効かどうか調べる

書体のアンチエリアス属性が有効かどうか調べます。有効な場合はTRUEを返します。

戻り値:: 書体のアンチエリアス属性の有効/無効をTRUE/FALSEで返す

void SetAntialias ( int enable = TRUE )

書体のアンチエリアス属性を設定する

書体のアンチエリアス属性を設定します。

引数:

enable

書体のアンチエリアス属性の有効/無効をTRUE/FALSEで設定（省略時有効）

int GetBoldStrength ( )

書体の太さを決定する値を取得する

書体の太さを決定する値を取得します。

戻り値:: 書体の太さを決定する値

void SetBoldStrength ( int strength )

書体の太さを決定する値を設定する

書体の太さを決定する値を設定します。負の値を設定すると標準の太さからさらに細くすることも可能です。

引数:

strength

書体の太さを決定する値

int IsStroke ( )

書体効果タイプが STROKE げ有効かどうか調べる

書体効果タイプが STROKE げ有効かどうか調べます。有効な場合はTRUEを返します。

戻り値:: 書体効果タイプが STROKE の場合 TRUE を返します。

void SetStroke ( int stroke )

書体効果タイプを STROKE とする

書体効果タイプを STROKE とします。

int IsEnableMatrix ( )

書体の変換パラメータが設定されているかどうか調べる

書体の変換パラメータ（縮小・拡大・回転など）が設定されているかどうか調べます。

戻り値:: 変換パラメータが設定されている場合は TRUE を返します。

void GetMatrix	(	double &	xx,
		double &	yx,
		double &	xy,
		double &	yy
	)

書体の変換パラメータを取得する

書体の変換パラメータ（縮小・拡大・回転など）を取得します。

変換式：: outX = xx×inX ＋ xy×inY ＋ tx;
outY = yx×inX ＋ yy×inY ＋ ty;

引数:

	xx	係数ｘｘ取得用変数
	yx	係数ｙｘ取得用変数
	xy	係数ｘｙ取得用変数
	yy	係数ｙｙ取得用変数

void SetMatrix	(	double	xx,
		double	yx,
		double	xy,
		double	yy
	)

書体の変換パラメータを設定する

書体の変換パラメータ（縮小・拡大・回転など）を設定します。

変換式：: outX = xx×inX ＋ xy×inY ＋ tx;
outY = yx×inX ＋ yy×inY ＋ ty;

引数:

	xx	係数ｘｘ
	yx	係数ｙｘ
	xy	係数ｘｙ
	yy	係数ｙｙ

void ResetMatrix ( )

書体の変換パラメータをリセットする

書体の変換パラメータ（縮小・拡大・回転など）をリセットします。

変換式：: outX = xx×inX ＋ xy×inY ＋ tx;
outY = yx×inX ＋ yy×inY ＋ ty;

係数ｘｘ、ｙｙを１に、ｙｘ、ｘｙをゼロにします。

void SetVertical ( int flag )

書体の表示方向（縦書/横書）を設定する

縦書体の表示方向（縦書/横書）を設定します。

引数:

flag

0:横書 1:縦書

int IsVertical ( )

書体の表示方向が縦書かどうか調べる

書体の表示方向が縦書かどうか調べます。

戻り値:: 縦書の場合は TRUE を返します。

int GetSize ( )

フォントサイズを取得する。

フォント生成時に与えたフォントサイズを取得します。

戻り値:: フォントサイズ

SGString & GetFilename ( )

フォントファイル名を取得する。

クラスで保持しているフォントファイル名を取得します。

戻り値:: フォントファイル名

void SetFilename ( SGString filename )

フォントファイル名を設定する。

クラスで保持しているフォントファイル名を設定します。

引数:

filename

フォントファイル名

このクラスの説明は次のファイルから生成されました:

sgfont.h
sgfont.cpp

クラス SGFontData

Public メソッド

説明

コンストラクタとデストラクタ

関数