jp.co.antenna.ptl

クラス PtlParamDrawImage

java.lang.Object

jp.co.antenna.ptl.PtlParamDrawImage

すべての実装されたインタフェース:

java.lang.AutoCloseable

public class PtlParamDrawImage
extends java.lang.Object
implements java.lang.AutoCloseable

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

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	PtlParamDrawImage.MASK_TYPE マスクのタイプ

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PtlParamDrawImage() コンストラクタ
PtlParamDrawImage(PtlParamDrawImage obj) コピーコンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	close() 終了処理。
void	setAngle(float angle) 任意の傾きを設定。
void	setColorKeyMaskColor(float minR, float maxR, float minG, float maxG, float minB, float maxB) カラーキーマスクの色を範囲設定。
void	setDPI(int dpi) DPIを設定 ※ 画像がDPIを持っている場合、setUseOriginalDPIでtrueを設定されると画像の持っているDPIが優先されます。
void	setImagePageNumber(int imagePageNumber) マルチTiffのページ番号を設定。
void	setImageStream(PtlParamInput imageStream) 入力画像ストリームを設定。
void	setMaskColor(PtlColor maskColor, PtlParamDrawImage.MASK_TYPE maskType) マスク画像の色指定を設定。
void	setMaskImageStream(PtlParamInput maskStream, PtlParamDrawImage.MASK_TYPE maskType) マスク画像ストリームを設定。
void	setOpacity(float opacity) 画像の不透明度を設定。
void	setRotate(int value) 回転角度を設定。
void	setUseOriginalDPI(boolean useOriginal) 画像の持っているDPIを使うかどうかを設定 ※ この関数は画像がDPIを持っている場合に限り意味を持ちます。

クラスから継承されたメソッド java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PtlParamDrawImage

public PtlParamDrawImage()
                  throws PtlException

コンストラクタ

例外:

PtlException - 例外

PtlParamDrawImage

public PtlParamDrawImage(PtlParamDrawImage obj)
                  throws PtlException

コピーコンストラクタ

パラメータ:

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

例外:

PtlException - 例外

メソッドの詳細

close

public void close()

終了処理。
このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
このオブジェクトを使い終わったら必ず呼ばなければなりません。

定義:

close インタフェース内 java.lang.AutoCloseable

setImageStream

public void setImageStream(PtlParamInput imageStream)
                    throws PtlException

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

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

パラメータ:

imageStream - 入力画像ストリーム。

例外:

PtlException - 例外

setImagePageNumber

public void setImagePageNumber(int imagePageNumber)
                        throws PtlException

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

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

パラメータ:

imagePageNumber - ページ番号。ページ番号は0オリジンです。

例外:

PtlException - 例外

setOpacity

public void setOpacity(float opacity)
                throws PtlException

画像の不透明度を設定。

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

パラメータ:

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

例外:

PtlException - 例外

setMaskColor

public void setMaskColor(PtlColor maskColor,
                         PtlParamDrawImage.MASK_TYPE maskType)
                  throws PtlException

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

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

パラメータ:

maskColor - マスク画像の色指定。

maskType - マスクタイプ。MASK_STENCIL,MASK_COLORKEYのいずれか。

例外:

PtlException - 例外

setColorKeyMaskColor

public void setColorKeyMaskColor(float minR,
                                 float maxR,
                                 float minG,
                                 float maxG,
                                 float minB,
                                 float maxB)
                          throws PtlException

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

カラーキーマスクの色を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 - 例外

setMaskImageStream

public void setMaskImageStream(PtlParamInput maskStream,
                               PtlParamDrawImage.MASK_TYPE maskType)
                        throws PtlException

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

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

パラメータ:

maskStream - マスク画像ストリーム。

maskType - マスクタイプ。MASK_EXPLICIT,MASK_SOFTのいずれか。

例外:

PtlException - 例外

setUseOriginalDPI

public void setUseOriginalDPI(boolean useOriginal)
                       throws PtlException

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

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

パラメータ:

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

例外:

PtlException - 例外

setDPI

public void setDPI(int dpi)
            throws PtlException

DPIを設定

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

パラメータ:

dpi - DPI。

例外:

PtlException - 例外

setRotate

public void setRotate(int value)
               throws PtlException

回転角度を設定。

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

パラメータ:

value - 回転角度（0, 90, 180, 270のみ有効）

例外:

PtlException - 例外

setAngle

public void setAngle(float angle)
              throws PtlException

任意の傾きを設定。

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

パラメータ:

angle - 任意の角度。反時計回りが正の値。

例外:

PtlException - 例外