PdfTk::PtlParamSetMask Class Reference

マスク処理(墨消し)のパラメータを表現したクラスです。 More...

#include <PtlParamSetMask.h>

Public Types
enum	REMOVE_ELEMENT {   REMOVE_NONE = 0x00000000, REMOVE_TEXT = 0x00000001, REMOVE_IMAGE = 0x00000002, REMOVE_PATH = 0x00000004,   REMOVE_SHADING = 0x00000008 }
	削除するエレメントの種類。 More...

Public Member Functions
int	getHandle () const
	PtlParamSetMask ()
	コンストラクタ More...
	PtlParamSetMask (const PtlParamSetMask &obj)
	コピーコンストラクタ More...
	‾PtlParamSetMask ()
	デストラクタ
PtlParamSetMask &	operator= (const PtlParamSetMask &obj)
	コピーオペレータ More...
void	appendRect (const PtlRect &rectMM)
	マスクする矩形を追加。 More...
void	setMaskColor (const PtlColor &color)
	マスクの色を設定。 More...
void	setOpacity (float opacity)
	マスク色の不透明度を設定。 More...
void	setRemoveElement (int remove)
	マスクの削除対象とするエレメントを設定。 More...
void	setTextOverlapRatio (float overlapRatio)
	テキストがマスク矩形とどれくらい重なっていたら削除対象とするかを設定。 More...

Detailed Description

マスク処理(墨消し)のパラメータを表現したクラスです。

Member Enumeration Documentation

REMOVE_ELEMENT

enum PdfTk::PtlParamSetMask::REMOVE_ELEMENT

削除するエレメントの種類。

Enumerator
REMOVE_NONE	削除しない。
REMOVE_TEXT	テキストを削除対象とする。
REMOVE_IMAGE	画像を削除対象とする。
REMOVE_PATH	パスを削除対象とする。
REMOVE_SHADING	シェイディングを削除対象とする。

Constructor & Destructor Documentation

PtlParamSetMask() [1/2]

PdfTk::PtlParamSetMask::PtlParamSetMask

(

)

コンストラクタ

Exceptions

PtlException

PtlParamSetMask() [2/2]

PdfTk::PtlParamSetMask::PtlParamSetMask

(

const PtlParamSetMask &

obj

)

コピーコンストラクタ

Parameters

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

Exceptions

PtlException

Member Function Documentation

appendRect()

void PdfTk::PtlParamSetMask::appendRect

(

const PtlRect &

rectMM

)

マスクする矩形を追加。

Parameters

rectMM

マスク矩形。 表示矩形（ViewBox）上の座標値をmm単位で指定してください。 ViewBoxの詳細については PtlPage#getViewBoxを参照してください。

Exceptions

PtlException

operator=()

PtlParamSetMask& PdfTk::PtlParamSetMask::operator=

(

const PtlParamSetMask &

obj

)

コピーオペレータ

Parameters

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

setMaskColor()

void PdfTk::PtlParamSetMask::setMaskColor

(

const PtlColor &

color

)

マスクの色を設定。

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

Parameters

color

マスクの色指定。

Exceptions

PtlException

setOpacity()

void PdfTk::PtlParamSetMask::setOpacity

(

float

opacity

)

マスク色の不透明度を設定。

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

Parameters

opacity

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

Exceptions

PtlException

setRemoveElement()

void PdfTk::PtlParamSetMask::setRemoveElement

(

int

remove

)

マスクの削除対象とするエレメントを設定。

マスク処理ではマスク矩形内のコンテントに描画されるエレメントを全削除するのが基本動作ですが、
この関数を用いることにより動作を変更することができます。
※ 設定しない場合は全てのエレメントが削除対象となります。

Parameters

remove

削除対象とするエレメント。REMOVE_XXXのフラグを論理和で指定します。 REMOVE_NONEのみを指定すると矩形の描画のみとなります。

Exceptions

PtlException

setTextOverlapRatio()

void PdfTk::PtlParamSetMask::setTextOverlapRatio

(

float

overlapRatio

)

テキストがマスク矩形とどれくらい重なっていたら削除対象とするかを設定。

テキストがマスク矩形とどれくらいの面積が重なっていたら削除対象とするかを割合でセットします。
設定しない場合は、0.3が設定されたとみなされます。

Parameters

overlapRatio

[in] テキストとマスク矩形が重なる面積の割合をセットします。(0<overlapRatio<=1)