画像の描画に使うパラメータクラスです。 More...

#include <PtlParamDrawImage.h>

Public Types
enum	MASK_TYPE { MASK_STENCIL = 1, MASK_COLORKEY = 2, MASK_EXPLICIT = 3, MASK_SOFT = 4 }
	マスクのタイプ More...

Public Member Functions
int	getHandle () const

	PtlParamDrawImage ()
	コンストラクタ More...

	PtlParamDrawImage (const PtlParamDrawImage &obj)
	コピーコンストラクタ alias copy More...

	‾PtlParamDrawImage ()
	デストラクタ

PtlParamDrawImage &	operator= (const PtlParamDrawImage &obj)
	コピーオペレータ alias copy More...

void	setImageStream (PtlParamStream &imageStream)
	入力画像ストリームを設定。 More...

void	setImagePageNumber (int imagePageNumber)
	マルチTiffのページ番号を設定。 More...

void	setOpacity (float opacity)
	画像の不透明度を設定。 More...

void	setMaskColor (const PtlColor &maskColor, MASK_TYPE maskType)
	マスク画像の色指定を設定。 More...

void	setColorKeyMaskColor (float minR, float maxR, float minG, float maxG, float minB, float maxB)
	カラーキーマスクの色を範囲設定。 More...

void	setMaskImageStream (PtlParamStream &maskStream, MASK_TYPE maskType)
	マスク画像ストリームを設定。 More...

void	setUseOriginalDPI (bool useOriginal)
	画像の持っているDPIを使うかどうかを設定 More...

void	setDPI (long dpi)
	DPIを設定 More...

void	setRotate (int value)
	回転角度を設定。 More...

void	setAngle (float angle)
	任意の傾きを設定。 More...

Detailed Description

画像の描画に使うパラメータクラスです。

Member Enumeration Documentation

◆ MASK_TYPE

enum PdfTk::PtlParamDrawImage::MASK_TYPE

マスクのタイプ

Enumerator
MASK_STENCIL	ステンシルマスク
MASK_COLORKEY	カラーキーマスク
MASK_EXPLICIT	明示マスク
MASK_SOFT	ソフトマスク

Constructor & Destructor Documentation

◆ PtlParamDrawImage() [1/2]

PdfTk::PtlParamDrawImage::PtlParamDrawImage ( )

コンストラクタ

Exceptions

PtlException

◆ PtlParamDrawImage() [2/2]

PdfTk::PtlParamDrawImage::PtlParamDrawImage ( const PtlParamDrawImage & obj )

コピーコンストラクタ alias copy

Parameters

obj	コピー元オブジェクト。

Exceptions

PtlException

Member Function Documentation

◆ operator=()

PtlParamDrawImage& PdfTk::PtlParamDrawImage::operator= ( const PtlParamDrawImage & obj )

コピーオペレータ alias copy

Parameters

obj	コピー元オブジェクト。

◆ setAngle()

void PdfTk::PtlParamDrawImage::setAngle ( float angle )

任意の傾きを設定。

傾きの角度は反時計回りで設定します。
傾きを設定する場合は他の関数より先に設定してください。

Parameters

angle 任意の角度。反時計回りが正の値。

Exceptions

PtlException

◆ setColorKeyMaskColor()

void PdfTk::PtlParamDrawImage::setColorKeyMaskColor	(	float	minR,
		float	maxR,
		float	minG,
		float	maxG,
		float	minB,
		float	maxB
	)

カラーキーマスクの色を範囲設定。

カラーキーマスクの色をRGBの範囲指定で設定します。
範囲指定しない場合は、setMaskColorも使用可能です。

Parameters

minR	赤の最小値 0.0 〜 1.0。
maxR	赤の最大値 0.0 〜 1.0。
minG	緑の最小値 0.0 〜 1.0。
maxG	緑の最大値 0.0 〜 1.0。
minB	青の最小値 0.0 〜 1.0。
maxB	青の最大値 0.0 〜 1.0。

Exceptions

PtlException

◆ setDPI()

void PdfTk::PtlParamDrawImage::setDPI ( long dpi )

DPIを設定

※ 画像がDPIを持っている場合、setUseOriginalDPIでtrueを設定されると画像の持っているDPIが優先されます。
常にsetDPIの値を有効にしたい場合はsetUseOriginalDPIでfalseを設定してください。 ※ 設定しない場合はデフォルト値として72が設定されます。

Parameters

dpi DPI。

◆ setImagePageNumber()

void PdfTk::PtlParamDrawImage::setImagePageNumber ( int imagePageNumber )

マルチTiffのページ番号を設定。

この設定はマルチTiffにのみ有効です。
PtlParamDrawImageをページ追加用のパラメータPtlParamImagePageに設定する場合に限り、
-1を設定するとTiffの全ページがページ追加に使われます。

Parameters

imagePageNumber ページ番号。ページ番号は0オリジンです。

Exceptions

PtlException

◆ setImageStream()

void PdfTk::PtlParamDrawImage::setImageStream ( PtlParamStream & imageStream )

入力画像ストリームを設定。

ステンシルマスクとする場合はモノクロ画像を指定してください。
カラーキーマスクとする場合はBMPでカラースペースがRGBのものを指定してください。

Parameters

imageStream 入力画像ストリーム。

Exceptions

PtlException

◆ setMaskColor()

void PdfTk::PtlParamDrawImage::setMaskColor	(	const PtlColor &	maskColor,
		MASK_TYPE	maskType
	)

マスク画像の色指定を設定。

ステンシルマスクとする場合、setImageStreamで設定する画像がモノクロの場合にのみ有効です。
カラーキーマスクとする場合、setImageStreamで設定する画像がBMPでカラースペースがRGB場合にのみ有効です。
但し、32bitアルファチャネル付きのものは対象となりません。
カラーキーマスクの色で範囲を指定したい場合はsetColorKeyMaskColorを使用して下さい。

Parameters

maskColor	マスク画像の色指定。
maskType	マスクタイプ。MASK_STENCIL,MASK_COLORKEYのいずれか。

Exceptions

PtlException

◆ setMaskImageStream()

void PdfTk::PtlParamDrawImage::setMaskImageStream	(	PtlParamStream &	maskStream,
		MASK_TYPE	maskType
	)

マスク画像ストリームを設定。

明示マスクとする場合はモノクロ画像を指定してください。
ソフトマスクとする場合はカラー画像はグレー画像に変換されマスクとなります。変換を望まない場合はグレー画像を指定してください。

Parameters

maskStream	マスク画像ストリーム。
maskType	マスクタイプ。MASK_EXPLICIT,MASK_SOFTのいずれか。

Exceptions

PtlException

◆ setOpacity()

void PdfTk::PtlParamDrawImage::setOpacity ( float opacity )

画像の不透明度を設定。

設定しない場合はデフォルト値として1.0が設定されます。

Parameters

opacity 0.0 〜 1.0。0.0が透明、1.0が不透明。

Exceptions

PtlException

◆ setRotate()

void PdfTk::PtlParamDrawImage::setRotate ( int value )

回転角度を設定。

回転角度は時計回りに90度単位になります。
回転角度を設定する場合は他の関数より先に設定してください。

Parameters

value 回転角度（0, 90, 180, 270）

Exceptions

PtlException

◆ setUseOriginalDPI()

void PdfTk::PtlParamDrawImage::setUseOriginalDPI ( bool useOriginal )

画像の持っているDPIを使うかどうかを設定

※ この関数は画像がDPIを持っている場合に限り意味を持ちます。画像がDPIを持っていない場合はこの設定は無視されます。
trueを設定しても画像がDPIを持っていない場合、setDPIで設定されたDPIが使用されます。
※ 設定しない場合はデフォルト値としてtrueが設定されます。常にsetDPIの値を有効にしたい場合はfalseを設定してください。

Parameters

useOriginal 画像の持っているDPIを使うかどうか。

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ MASK_TYPE

Constructor & Destructor Documentation

◆ PtlParamDrawImage() [1/2]

◆ PtlParamDrawImage() [2/2]

Member Function Documentation

◆ operator=()

◆ setAngle()

◆ setColorKeyMaskColor()

◆ setDPI()

◆ setImagePageNumber()

◆ setImageStream()

◆ setMaskColor()

◆ setMaskImageStream()

◆ setOpacity()

◆ setRotate()

◆ setUseOriginalDPI()