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

#include <NetParamDrawImage.h>

公開型

enum class  MASK_TYPE { MASK_STENCIL = 1 , MASK_COLORKEY = 2 , MASK_EXPLICIT = 3 , MASK_SOFT = 4 }

公開メンバ関数

PdfTk::PtlParamDrawImage * getNative ()
 PtlParamDrawImage ()
 コンストラクタ
 PtlParamDrawImage (PtlParamDrawImage^ obj)
 コピーコンストラクタ alias copy
 ~PtlParamDrawImage ()
 デストラクタ
 !PtlParamDrawImage ()
 ファイナライザ。
PtlParamDrawImage operator= (PtlParamDrawImage^ obj)
 コピーオペレータ alias copy
void setImageStream (PtlParamInput^ imageStream)
 入力画像ストリームを設定。
void setImagePageNumber (int imagePageNumber)
 マルチTiffのページ番号を設定。
void setOpacity (float opacity)
 画像の不透明度を設定。
void setMaskColor (PtlColor^ maskColor, MASK_TYPE maskType)
 マスク画像の色指定を設定。
void setColorKeyMaskColor (float minR, float maxR, float minG, float maxG, float minB, float maxB)
 カラーキーマスクの色を範囲設定。
void setMaskImageStream (PtlParamInput^ maskStream, MASK_TYPE maskType)
 マスク画像ストリームを設定。
void setUseOriginalDPI (bool useOriginal)
 画像の持っているDPIを使うかどうかを設定
void setDPI (long dpi)
 DPIを設定
void setRotate (int value)
 回転角度を設定。
void setAngle (float angle)
 任意の傾きを設定。

限定公開変数類

PdfTk::PtlParamDrawImage * m_native

詳解

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

列挙型メンバ詳解

◆ MASK_TYPE

マスクのタイプ

列挙値
MASK_STENCIL 

ステンシルマスク

MASK_COLORKEY 

カラーキーマスク

MASK_EXPLICIT 

明示マスク

MASK_SOFT 

ソフトマスク

構築子と解体子

◆ PtlParamDrawImage() [1/2]

PdfTkNet::PtlParamDrawImage::PtlParamDrawImage ( )

コンストラクタ

例外
PtlException

◆ PtlParamDrawImage() [2/2]

PdfTkNet::PtlParamDrawImage::PtlParamDrawImage ( PtlParamDrawImage^ obj)

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

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

◆ ~PtlParamDrawImage()

PdfTkNet::PtlParamDrawImage::~PtlParamDrawImage ( )

デストラクタ

◆ !PtlParamDrawImage()

PdfTkNet::PtlParamDrawImage::!PtlParamDrawImage ( )

ファイナライザ。

メソッド詳解

◆ getNative()

PdfTk::PtlParamDrawImage * PdfTkNet::PtlParamDrawImage::getNative ( )

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setAngle()

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

任意の傾きを設定。

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

引数
angle任意の角度。反時計回りが正の値。
例外
PtlException

◆ setColorKeyMaskColor()

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

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

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

引数
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。
例外
PtlException

◆ setDPI()

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

DPIを設定

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

引数
dpiDPI。

◆ setImagePageNumber()

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

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

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

引数
imagePageNumberページ番号。ページ番号は0オリジンです。
例外
PtlException

◆ setImageStream()

void PdfTkNet::PtlParamDrawImage::setImageStream ( PtlParamInput^ imageStream)

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

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

引数
imageStream入力画像ストリーム。
例外
PtlException

◆ setMaskColor()

void PdfTkNet::PtlParamDrawImage::setMaskColor ( PtlColor^ maskColor,
MASK_TYPE maskType )

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

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

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

◆ setMaskImageStream()

void PdfTkNet::PtlParamDrawImage::setMaskImageStream ( PtlParamInput^ maskStream,
MASK_TYPE maskType )

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

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

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

◆ setOpacity()

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

画像の不透明度を設定。

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

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

◆ setRotate()

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

回転角度を設定。

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

引数
value回転角度(0, 90, 180, 270)
例外
PtlException

◆ setUseOriginalDPI()

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

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

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

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

メンバ詳解

◆ m_native

PdfTk::PtlParamDrawImage* PdfTkNet::PtlParamDrawImage::m_native
protected