PDFTool.NET  6.0
Public Types | Public Member Functions | Protected Attributes | List of all members
PdfTkNet::PtlParamDrawImage Class Reference

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

#include <NetParamDrawImage.h>

Public Types

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

Public Member Functions

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

Protected Attributes

PdfTk::PtlParamDrawImage * m_native
 

Detailed Description

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

Member Enumeration Documentation

◆ MASK_TYPE

マスクのタイプ

Enumerator
MASK_STENCIL 

ステンシルマスク

MASK_COLORKEY 

カラーキーマスク

MASK_EXPLICIT 

明示マスク

MASK_SOFT 

ソフトマスク

Constructor & Destructor Documentation

◆ PtlParamDrawImage() [1/2]

PdfTkNet::PtlParamDrawImage::PtlParamDrawImage ( )

コンストラクタ

Exceptions
PtlException

◆ PtlParamDrawImage() [2/2]

PdfTkNet::PtlParamDrawImage::PtlParamDrawImage ( PtlParamDrawImage obj)

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

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

Member Function Documentation

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setColorKeyMaskColor()

void PdfTkNet::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 PdfTkNet::PtlParamDrawImage::setDPI ( long  dpi)

DPIを設定

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

Parameters
dpiDPI。

◆ setImagePageNumber()

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

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

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

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

◆ setImageStream()

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

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

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

Parameters
imageStream入力画像ストリーム。
Exceptions
PtlException

◆ setMaskColor()

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

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

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

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

◆ setMaskImageStream()

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

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

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

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

◆ setOpacity()

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

画像の不透明度を設定。

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

Parameters
opacity0.0 〜 1.0。0.0が透明、1.0が不透明。
Exceptions
PtlException

◆ setRotate()

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

回転角度を設定。

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

Parameters
value回転角度(0, 90, 180, 270のみ有効)
Exceptions
PtlException

◆ setUseOriginalDPI()

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

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

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

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