Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlEditImage クラス

#include <PtlEditImage.h>

PdfTk::PtlEditImage の継承関係図
PdfTk::PtlEditImage 連携図

公開型

enum  MASK_TYPE {
  MASK_NONE = 0 , MASK_STENCIL = 1 , MASK_COLORKEY = 2 , MASK_EXPLICIT = 3 ,
  MASK_SOFT = 4
}
enum  OUTPUT_FORMAT { FORMAT_AUTO = 0 , FORMAT_BMP = 1 , FORMAT_JPEG = 2 , FORMAT_PNG = 3 }
基底クラス PdfTk::PtlEditElement に属する継承公開型
enum  ELEMENT_TYPE {
  TYPE_TEXT = 1 , TYPE_IMAGE = 2 , TYPE_PATH = 3 , TYPE_SHADING = 4 ,
  TYPE_MCCONTAINER = 5 , TYPE_MCPLACE = 6 , TYPE_FORMXOBJECT = 7 , TYPE_UNKNOWN = 100
}

公開メンバ関数

 PtlEditImage ()
 コンストラクタ
 PtlEditImage (const PtlParamEditImage &paramEditImage)
 コンストラクタ
 PtlEditImage (const PtlEditImage &obj)
 コピーコンストラクタ
 ~PtlEditImage ()
 デストラクタ
PtlEditImageoperator= (const PtlEditImage &obj)
 コピーオペレータ
int getWidth () const
 幅(Pixel)を取得。
int getHeight () const
 高さ(Pixel)を取得。
int getPPI () const
 解像度を取得。
int getBPC () const
 Bit Per Compornentを取得。
int getGrad () const
 階調を取得。
MASK_TYPE getMaskType () const
 画像が持っているマスクのタイプを取得。
void setPassThrough (bool passThrough)
 パススルー設定。
void writeFile (PtlParamStream &output, OUTPUT_FORMAT format)
 画像の書き出し。
void setImage (const PtlParamEditImage &paramEditImage)
 画像設定。
基底クラス PdfTk::PtlEditElement に属する継承公開メンバ関数
int getHandle () const
 PtlEditElement (ELEMENT_TYPE type)
 コンストラクタ
 PtlEditElement (const PtlEditElement &obj)
 コピーコンストラクタ alias copy
virtual ~PtlEditElement ()
 デストラクタ
PtlEditElementoperator= (const PtlEditElement &obj)
 コピーオペレータ alias copy
ELEMENT_TYPE getType () const
 エレメントタイプを取得。
PtlTransMatrix getMatrix () const
 ページ/FormXObjectそれぞれの座標系でのMatrixを取得。
void setMatrix (const PtlTransMatrix &matrix)
 ページ/FormXObjectそれぞれの座標系でのMatrixを設定。
PtlTransMatrix getMatrixAtPage () const
 ページ座標系のMatrixを取得。
void setMatrixAtPage (const PtlTransMatrix &matrix)
 ページ座標系のMatrixを設定。
PtlRect getBBox ()
 ページ座標系のBBoxを取得。
PtlRect getClippedBBox ()
 クリッピングされたBBoxを取得。
PtlQuadPoint getQuadPoint ()
 ページ座標系のQuadPointを取得。
bool hasClip () const
 クリッピングがあるかどうかを取得。
PtlEditClip getClip ()
 クリッピングを取得。
void setClip (const PtlEditClip &clip)
 クリッピングを設定。

詳解

コンテントにDoオペレータで描画される画像及びコンテントにインラインで描画される画像を表現したクラスです。

PtlEditImage.h20 行目に定義があります。

列挙型メンバ詳解

◆ MASK_TYPE

マスクのタイプ

列挙値
MASK_NONE 

マスク無し

MASK_STENCIL 

ステンシルマスク

MASK_COLORKEY 

カラーキーマスク

MASK_EXPLICIT 

明示マスク

MASK_SOFT 

ソフトマスク

PtlEditImage.h26 行目に定義があります。

◆ OUTPUT_FORMAT

出力フォーマットタイプ

列挙値
FORMAT_AUTO 

自動

FORMAT_BMP 

BMP

FORMAT_JPEG 

JPEG

FORMAT_PNG 

PNG

PtlEditImage.h37 行目に定義があります。

構築子と解体子

◆ PtlEditImage() [1/3]

PdfTk::PtlEditImage::PtlEditImage ( )

コンストラクタ

例外
PtlException

◆ PtlEditImage() [2/3]

PdfTk::PtlEditImage::PtlEditImage ( const PtlParamEditImage & paramEditImage)

コンストラクタ

画像ファイルからPtlEditImageを作成するときに使います。

引数
paramEditImage描画パラメータ。
例外
PtlException

◆ PtlEditImage() [3/3]

PdfTk::PtlEditImage::PtlEditImage ( const PtlEditImage & obj)

コピーコンストラクタ

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

関数詳解

◆ getBPC()

int PdfTk::PtlEditImage::getBPC ( ) const

Bit Per Compornentを取得。

戻り値
BPI(Bit Per Compornent)
例外
PtlException

◆ getGrad()

int PdfTk::PtlEditImage::getGrad ( ) const

階調を取得。

戻り値
階調
例外
PtlException

◆ getHeight()

int PdfTk::PtlEditImage::getHeight ( ) const

高さ(Pixel)を取得。

この幅は描画されている高さではなく、画像データ自体の高さとなります。

戻り値
高さ(Pixel)
例外
PtlException

◆ getMaskType()

MASK_TYPE PdfTk::PtlEditImage::getMaskType ( ) const

画像が持っているマスクのタイプを取得。

戻り値
MASK_TYPE
例外
PtlException

◆ getPPI()

int PdfTk::PtlEditImage::getPPI ( ) const

解像度を取得。

戻り値
解像度(Pixel Per Inch)
例外
PtlException

◆ getWidth()

int PdfTk::PtlEditImage::getWidth ( ) const

幅(Pixel)を取得。

この幅は描画されている幅ではなく、画像データ自体の幅となります。

戻り値
幅(Pixel)
例外
PtlException

◆ operator=()

PtlEditImage & PdfTk::PtlEditImage::operator= ( const PtlEditImage & obj)

コピーオペレータ

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

◆ setImage()

void PdfTk::PtlEditImage::setImage ( const PtlParamEditImage & paramEditImage)

画像設定。

画像を置き換えます。
この関数のパラメータPtlParamEditImageのsetUseOriginalDPIとsetDPIで設定された値は無視されます。

引数
paramEditImage描画パラメータ。
例外
PtlException

◆ setPassThrough()

void PdfTk::PtlEditImage::setPassThrough ( bool passThrough)

パススルー設定。

画像の出力フォーマットにFORMAT_JPEGを指定した場合、JPEGは加工せずにそのまま出力するどうかを指定します。
設定しない場合はデフォルト値としてfalseが設定されます。

引数
passThrough画像の書き出し時にJPEGは加工せずにそのまま出力するか
例外
PtlException

◆ writeFile()

void PdfTk::PtlEditImage::writeFile ( PtlParamStream & output,
OUTPUT_FORMAT format )

画像の書き出し。

引数
outputPtlParamOutput
format出力フォーマット
FORMAT_XXXを指定します。
FORMAT_AUTOを指定した場合、出力フォーマットはBMP,JPEG,PNGのいずれかになり、
それぞれのフォーマットにしたがって拡張子として".bmp",".jpg",".png"がファイル名に付与されます。
FORMAT_AUTO以外の場合は拡張子は付与されません。
例外
PtlException