PdfTkNet::PtlParamSetMask Class Reference

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

#include <NetParamSetMask.h>

Inheritance diagram for PdfTkNet::PtlParamSetMask:

Collaboration diagram for PdfTkNet::PtlParamSetMask:

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

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

Protected Attributes
PdfTk::PtlParamSetMask *	m_native

Detailed Description

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

Member Enumeration Documentation

REMOVE_ELEMENT

enum PdfTkNet::PtlParamSetMask::REMOVE_ELEMENT

strong

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

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

Constructor & Destructor Documentation

PtlParamSetMask() [1/2]

PdfTkNet::PtlParamSetMask::PtlParamSetMask

(

)

コンストラクタ

Exceptions

PtlException

PtlParamSetMask() [2/2]

PdfTkNet::PtlParamSetMask::PtlParamSetMask

(

PtlParamSetMask^

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

appendRect()

void PdfTkNet::PtlParamSetMask::appendRect

(

PtlRect^

rectMM

)

マスクする矩形を追加。

Parameters

rectMM

マスク矩形。 表示矩形（ViewBox）上の座標値をmm単位で指定してください。

Exceptions

PtlException

operator=()

PtlParamSetMask PdfTkNet::PtlParamSetMask::operator=

(

PtlParamSetMask^

obj

)

コピーオペレータ alias copy

Parameters

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

setMaskColor()

void PdfTkNet::PtlParamSetMask::setMaskColor

(

PtlColor^

color

)

マスクの色を設定。

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

Parameters

color

マスクの色指定。

Exceptions

PtlException

setOpacity()

void PdfTkNet::PtlParamSetMask::setOpacity

(

float

opacity

)

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

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

Parameters

opacity

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

Exceptions

PtlException

setRemoveElement()

void PdfTkNet::PtlParamSetMask::setRemoveElement

(

REMOVE_ELEMENT

remove

)

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

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

Parameters

remove

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

Exceptions

PtlException

setTextOverlapRatio()

void PdfTkNet::PtlParamSetMask::setTextOverlapRatio

(

float

overlapRatio

)

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

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

Parameters

overlapRatio

[in] テキストが矩形とどれくらい重なっていたら削除対象とするかをセットします。(0<overlapRatio<=1)