Antenna House PDF Tool API (.NET) 8.0
PdfTkNet::PtlParamSetMask クラス

#include <NetParamSetMask.h>

PdfTkNet::PtlParamSetMask の継承関係図
Inheritance graph
[凡例]
PdfTkNet::PtlParamSetMask 連携図
Collaboration graph
[凡例]

公開型

enum class  REMOVE_ELEMENT {
  REMOVE_NONE = 0x00000000 , REMOVE_TEXT = 0x00000001 , REMOVE_IMAGE = 0x00000002 , REMOVE_PATH = 0x00000004 ,
  REMOVE_SHADING = 0x00000008
}

公開メンバ関数

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

限定公開変数類

PdfTk::PtlParamSetMask * m_native

詳解

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

列挙型メンバ詳解

◆ REMOVE_ELEMENT

enum class PdfTkNet::PtlParamSetMask::REMOVE_ELEMENT
strong

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

列挙値
REMOVE_NONE 

削除しない。

REMOVE_TEXT 

テキストを削除対象とする。

REMOVE_IMAGE 

画像を削除対象とする。

REMOVE_PATH 

パスを削除対象とする。

REMOVE_SHADING 

シェイディングを削除対象とする。

構築子と解体子

◆ PtlParamSetMask() [1/2]

PdfTkNet::PtlParamSetMask::PtlParamSetMask ( )

コンストラクタ

例外
PtlException

◆ PtlParamSetMask() [2/2]

PdfTkNet::PtlParamSetMask::PtlParamSetMask ( PtlParamSetMask^ obj)

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

引数
objコピー元オブジェクト。
例外
PtlException

◆ ~PtlParamSetMask()

PdfTkNet::PtlParamSetMask::~PtlParamSetMask ( )

デストラクタ

◆ !PtlParamSetMask()

PdfTkNet::PtlParamSetMask::!PtlParamSetMask ( )

ファイナライザ。

メソッド詳解

◆ appendRect()

void PdfTkNet::PtlParamSetMask::appendRect ( PtlRect^ rectMM)

マスクする矩形を追加。

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

◆ getNative()

PdfTk::PtlParamSetMask * PdfTkNet::PtlParamSetMask::getNative ( )

◆ operator=()

PtlParamSetMask PdfTkNet::PtlParamSetMask::operator= ( PtlParamSetMask^ obj)

コピーオペレータ alias copy

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

◆ setMaskColor()

void PdfTkNet::PtlParamSetMask::setMaskColor ( PtlColor^ color)

マスクの色を設定。

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

引数
colorマスクの色指定。
例外
PtlException

◆ setOpacity()

void PdfTkNet::PtlParamSetMask::setOpacity ( float opacity)

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

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

引数
opacity0.0 〜 1.0。0.0が透明、1.0が不透明。
例外
PtlException

◆ setRemoveElement()

void PdfTkNet::PtlParamSetMask::setRemoveElement ( REMOVE_ELEMENT remove)

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

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

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

◆ setTextOverlapRatio()

void PdfTkNet::PtlParamSetMask::setTextOverlapRatio ( float overlapRatio)

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

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

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

メンバ詳解

◆ m_native

PdfTk::PtlParamSetMask* PdfTkNet::PtlParamSetMask::m_native
protected