FVGImage

FVGImage　(ネイティブクラス)

このクラスはFVGファイルを扱うクラスです。
このクラスを使用してFVGオブジェクトをクラス化したり、
FVGオブジェクトを描画したビットマップを取得することができます。

FVGの描画はメモリ消費が大きく、処理時間が長く掛かります。
処理時間が問題になる場合は事前にPNG画像等にラスタライズしてください。

現在、FVGの詳細仕様は外部公開資料になっていないため、
詳細仕様を必要とする一部メソッドの一般利用は難しい状態になっています。

●継承

このクラスは継承をしていません。

●インターフェイスとインターフェイスメソッド

このクラスはインターフェイスの実装宣言をしていません。

●クラスメソッド

名前	概要
`IsValidFVGObjectName`	指定した名前がFVGオブジェクトとして使用できるか判定します

●クラスメンバメソッド

名前	概要
`FromFile`	指定したFVGファイルを読み込みます
`ToFile`	保持している内容をFVGファイルとして保存します
`FromFVGStr`	FVGファイルデータを読み込みます
`ToFVGStr`	保持している内容をFVGファイルデータとして取得します
`LoadFromPicDir`	picフォルダ以下のFVGファイルを読み込みます
`Reset`	保持しているFVGリソースを解放し、初期化します
`DrawObject`	FVGオブジェクトを描画します
`DrawFactor`	FVGファクターを描画します
`GenerateFVGClass`	FVGオブジェクトからFVGクラスソースを生成します
`GetFVGObjectNameList`	FVGオブジェクトの名前リストを取得します
`InstallFVGClass`	FVGオブジェクトからFVGクラスを生成し、FGES VMにインストールします
`CompileFVGClass`	FVGオブジェクトからFVGクラスオブジェクトを生成します
`GetPaletteString`	保持しているパレット文字列を取得します
`SetPaletteString`	パレット文字列を設定します
`GetMetaData`	保持しているメタデータを取得します
`SetMetaData`	メタデータを設定します
`GetExtOption`	保持している拡張オプションを取得します
`SetExtOption`	拡張オプションを設定します
`GetFVGObjectType`	FVGオブジェクトの種類を取得します
`NewFVGObject`	FVGオブジェクトを新規作成します
`NewFVGObjectBitmap`	FVGビットマップオブジェクトを新規作成します
`SetFVGObjectBitmap`	既存FVGオブジェクトをFVGビットマップオブジェクトを書き換えます。
`DeleteFVGObject`	FVGオブジェクトを削除します
`RenameFVGObject`	FVGオブジェクトの名前を変更します
`GetFVGObjectString`	FVGオブジェクトのソースを取得します
`SetFVGObjectString`	FVGオブジェクトのソースを設定します
`GetFVGFactorCount`	FVGオブジェクトが持つファクターの数を取得します
`GetFVGObjectSize`	FVGオブジェクトの画像サイズを取得します
`GetFVGFactorString`	FVGファクターのソースを取得します
`SetFVGFactorString`	FVGファクターのソースを設定します
`InsertFVGFactor`	FVGオブジェクトにFVGファクターを挿入します
`PushFVGFactor`	FVGオブジェクトの末尾にFVGファクターを追加します
`PopFVGFactor`	FVGオブジェクトの末尾FVGファクターを削除します
`DeleteFVGFactor`	FVGオブジェクトの指定したFVGファクターを削除します
`MoveFVGFactor`	FVGオブジェクトの指定したFVGファクターの順序を変更します

●クラス共有変数

このクラスはクラス共有変数を持っていません。

●インスタンス変数

このクラスはインスタンス変数を持っていません。

●C++レベル追加情報

クラスID： FGES_CLASSID_FVGIMAGE
クラス名： FGESFVGImage

FVGImage::IsValidFVGObjectName

public static Bool IsValidFVGObjectName( INativeString fvgobjname)

指定した名前がFVGオブジェクトとして利用できる名前か判定します。
この判定が偽になる名前ではFVGオブジェクトを作成できません。

戻り値：指定した名前がFVGオブジェクトとして利用できる場合、真を返します。

INativeString fvgobjname ：判定する名前。

先頭へ

FVGImage::FromFile

public Bool FromFile( INativeString filename)

   指定したFVGファイルを読み込み、必要なリソースを確保します。
   このメソッドで展開しただけではFVGオブジェクトの描画処理は実行されません。
   このメソッドを呼び出すと現在保持しているデータは破棄されます。

   FGES VM が Protected Mode で動作している場合、ファイル名にパスは使用できません。

戻り値：ファイルからのロードに成功した場合、真を返します。

INativeString filename ：展開するFVGファイル名(拡張子まで含む)。

先頭へ

FVGImage::ToFile

public Bool ToFile( INativeString filename)const

   保持している内容を指定したファイルに保存します。
   指定したファイルが既に存在する場合上書きされます。

   FGES VM が Protected Mode で動作している場合、ファイル名にパスは使用できません。

戻り値：ファイルへの保存に成功した場合、真を返します。

INativeString filename ：保存するFVGファイル名(拡張子まで含む)。

先頭へ

FVGImage::FromFVGStr

public Bool FromFVGStr( INativeString fvgstr)

   指定したFVGファイルデータを読み込み、必要なリソースを確保します。
   このメソッドで展開しただけではFVGオブジェクトの描画処理は実行されません。
   このメソッドを呼び出すと現在保持しているデータは破棄されます。

戻り値：FVGファイルデータからのロードに成功した場合、真を返します。

INativeString fvgstr ：展開するFVGファイルデータ。

先頭へ

FVGImage::ToFVGStr

public Bool ToFVGStr(editable INativeString out)const

保持している内容をFVGファイルデータとして取得します。

戻り値：FVGファイルデータの生成に成功した場合、真を返します。

editable INativeString out ：[出力]FVGファイルデータを出力するオブジェクト。

先頭へ

FVGImage::LoadFromPicDir

public Bool LoadFromPicDir( INativeString fvgfilename)

   指定したFVGファイルを展開し、必要なリソースを確保します。
   このメソッドで展開しただけではFVGオブジェクトの描画処理は実行されません。

   このメソッドはpicフォルダ以下のFVGファイルを読み込みます。
   この時、サブフォルダのパスは含むことができます。

戻り値：展開に成功した場合、真を返します。

INativeString fvgfilename ：展開するFVGファイル名(拡張子まで含む)。

先頭へ

FVGImage::Reset

public Bool Reset()

このオブジェクトに確保されているFVGリソースを解放します。

戻り値：処理に成功した場合、真を返します。

先頭へ

FVGImage::DrawObject

public Bool DrawObject( INativeString fvgobjname,             editable Bitmap bitmap, INativeBool? fitsize=NULL)

   指定したFVGオブジェクトの描画結果を指定したビットマップにコピーします。

戻り値：描画に成功した場合、真を返します。

INativeString fvgobjname ：描画するFVGオブジェクト名。
editable Bitmap bitmap ：[出力]コピー先のビットマップオブジェクト。
INativeBool? fitsize=NULL ：出力先をFVGオブジェクトの大きさでリサイズするか。
      空参照を指定した場合は真として扱います。

先頭へ

FVGImage::DrawFactor

public Bool DrawFactor( INativeString fvgobjname, INativeInteger factorid,             editable Bitmap bitmap, INativeFloat? pos_scale=NULL, INativeFloat? weight_scale=NULL,              INativeBool? fastdraw=NULL)

   指定したFVGオブジェクトの指定したファクターを指定したビットマップに描画します。

戻り値：描画に成功した場合、真を返します。

INativeString fvgobjname ：描画するFVGオブジェクト名。
INativeInteger factorid ：描画するFVGファクターID。
editable Bitmap bitmap ：[入出力]描画先のビットマップオブジェクト。
INativeFloat? pos_scale=NULL ：座標倍率。
      空参照を指定した場合はFVGオブジェクトの設定値を使用します。
INativeFloat? weight_scale=NULL ：太さ倍率。
      空参照を指定した場合はFVGオブジェクトの設定値を使用します。
INativeBool? fastdraw=NULL ：低品質な高速描画処理を行うか。
      空参照を指定した場合は偽として扱います。

先頭へ

FVGImage::GenerateFVGClass

public String GenerateFVGClass( INativeString fvgobjname, INativeString fvgclassname)

   指定したFVGオブジェクトの記述からFVGクラスのFGESソースを生成します。

   このメソッドで生成したFGESソースではFVGオブジェクトの描画結果は展開されません。
   このメソッドが生成するFGESソースは継承用の抽象クラスとなります。

戻り値：処理に成功した場合、生成したFGESソースを返します。
      処理に失敗した場合、空文字列を返します。

INativeString fvgobjname ：生成元のFVGオブジェクト名。
INativeString fvgclassname ：生成するFVGクラス名。
      生成するソースをそのままコンパイルした場合、この名前に _Proto を付与した名前でコンパイルされます。

先頭へ

FVGImage::GetFVGObjectNameList

public Bool GetFVGObjectNameList(editable PStringArray out_namelist)const

保持しているFVGオブジェクト名を全て取得します。

戻り値：取得に成功した場合、真を返します。

editable PStringArray out_namelist ：[出力]FVGオブジェクト名のリストを出力するオブジェクト。

先頭へ

FVGImage::InstallFVGClass

public Bool InstallFVGClass( INativeString fvgobjname, INativeString fvgclassname,             editable String? error_mes)

   指定したFVGオブジェクトの記述からFVGクラスを生成しFGES VMにインストールします。

   このメソッドが生成するクラスオブジェクトは継承用の抽象クラスとなります。

戻り値：インストールに成功した場合、真を返します。

INativeString fvgobjname ：生成元のFVGオブジェクト名。
INativeString fvgclassname ：生成するFVGクラス名。
      この名前に _Proto を付与した名前でインストールされます。
editable String? error_mes ：[出力]エラーメッセージを出力するオブジェクト。
      空参照を指定した場合、無視します。

先頭へ

FVGImage::CompileFVGClass

public FGESClass?@ CompileFVGClass( INativeString fvgobjname, INativeString fvgclassname,             editable INativeMemoryHost memhost,editable String? error_mes)

   指定したFVGオブジェクトの記述からFVGクラスオブジェクトを生成します。

   このメソッドが生成するクラスオブジェクトは継承用の抽象クラスとなります。

戻り値：コンパイルに成功した場合、生成したクラスオブジェクトを返します。
   コンパイルに失敗した場合、空参照を返します。

INativeString fvgobjname ：生成元のFVGオブジェクト名。
INativeString fvgclassname ：生成するFVGクラス名。
      この名前に _Proto を付与した名前で生成されます。
editable INativeMemoryHost memhost ：作成したクラスオブジェクトを接続するメモリ管理オブジェクト。
editable String? error_mes ：[出力]エラーメッセージを出力するオブジェクト。
      空参照を指定した場合、無視します。

先頭へ

FVGImage::GetPaletteString

public Bool GetPaletteString(editable String out_palettestr)const

保持しているパレットを全てまとめて文字列化したパレット文字列を取得します。
(パレット文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

editable String out_palettestr ：[出力]パレット文字列を出力するオブジェクト。

先頭へ

FVGImage::SetPaletteString

public Bool SetPaletteString( INativeString palettestr)

パレット文字列からこのオブジェクトのパレットデータを設定します。
(パレット文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString palettestr ：設定するパレット文字列。

先頭へ

FVGImage::GetMetaData

public String GetMetaData()const

保持しているメタデータを取得します。

戻り値：保持しているメタデータを返します。

先頭へ

FVGImage::SetMetaData

public Bool SetMetaData( INativeString metadata)

メタデータを設定します。

戻り値：処理に成功した場合、真を返します。

INativeString metadata ：設定するメタデータ。

先頭へ

FVGImage::GetExtOption

public String GetExtOption()const

保持している拡張オプションを取得します。

戻り値：保持している拡張オプションを返します。

先頭へ

FVGImage::SetExtOption

public Bool SetExtOption(INativeString optiondata)

拡張オプションを設定します。

戻り値：処理に成功した場合、真を返します。

INativeString metadata ：設定する拡張オプション。

先頭へ

FVGImage::GetFVGObjectType

public Integer GetFVGObjectType( INativeString fvgobjname)const

   指定したFVGオブジェクトの種類を取得します。
   (種類IDの定義はFVG詳細仕様に依存します)

戻り値：指定したFVGオブジェクトの種類IDを返します。
      取得に失敗した場合は-1を返します。

INativeString fvgobjname ：種類IDを取得するFVGオブジェクト名。

先頭へ

FVGImage::NewFVGObject

public Bool NewFVGObject( INativeString fvgobjname, INativeString objstr)

   FVGオブジェクトを新規作成します。
   このメソッドは指定した名前のFVGオブジェクトが既にある場合失敗します。
   (FVGオブジェクト文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功すると真を返します。

INativeString fvgobjname ：新規作成するFVGオブジェクト名。
INativeString objstr ：作成するFVGオブジェクトの内容になるFVGオブジェクト文字列。

先頭へ

FVGImage::NewFVGObjectBitmap

public Bool NewFVGObjectBitmap( INativeString fvgobjname, INativeBitmap bitmap,              INativeBool? complete_save=NULL)

   ビットマップタイプのFVGオブジェクトを新規作成します。
   このメソッドは指定した名前のFVGオブジェクトが既にある場合失敗します。

戻り値：処理に成功すると真を返します。

INativeString fvgobjname ：新規作成するFVGオブジェクト名。
INativeBitmap bitmap ：作成するFVGオブジェクトの内容になる画像。
INativeBool? complete_save=NULL ：透明ピクセルも含めて完全保存するか。
      偽を指定した場合は透明ピクセルの情報はFVGファイルに保存されません。
      空参照を指定した場合、真を指定したものとして扱います。

先頭へ

FVGImage::SetFVGObjectBitmap

public Bool SetFVGObjectBitmap( INativeString fvgobjname, INativeBitmap bitmap,              INativeBool? complete_save=NULL)

   既存FVGオブジェクトをビットマップタイプのFVGオブジェクトに書き換えます。
   このメソッドは指定した名前のFVGオブジェクトがない場合失敗します。

戻り値：処理に成功すると真を返します。

INativeString fvgobjname ：書き換えるFVGオブジェクト名。
INativeBitmap bitmap ：書き換えるFVGオブジェクトの内容になる画像。
INativeBool? complete_save=NULL ：透明ピクセルも含めて完全保存するか。
      偽を指定した場合は透明ピクセルの情報はFVGファイルに保存されません。
      空参照を指定した場合、真を指定したものとして扱います。

先頭へ

FVGImage::DeleteFVGObject

public Bool DeleteFVGObject( INativeString fvgobjname)

FVGオブジェクトを削除します。
このメソッドは指定した名前のFVGオブジェクトがない場合失敗します。

戻り値：処理に成功すると真を返します。

INativeString fvgobjname ：削除するFVGオブジェクト名。

先頭へ

FVGImage::RenameFVGObject

public Bool RenameFVGObject( INativeString old_name, INativeString new_name,              INativeBool? linktracking=NULL)

   既存FVGオブジェクトの名前を変更します。

戻り値：処理に成功すると真を返します。

INativeString old_name ：名前を変更する既存FVGオブジェクト名。
INativeString new_name ：新しいFVGオブジェクト名。
INativeBool? linktracking=NULL ：名前を変更するFVGオブジェクトへの参照を追従させるか。
      真を指定した場合、全てのFVGオブジェクトから
      名前を変更するFVGオブジェクトへの参照を検索し、新しい名前に書き換えます。
      空参照を指定した場合、偽を指定したものとして扱います。

先頭へ

FVGImage::GetFVGObjectString

public Bool GetFVGObjectString( INativeString fvgobjname,editable String out_objstr)const

指定したFVGオブジェクトの内容であるFVGオブジェクト文字列を取得します。
(FVGオブジェクト文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGオブジェクト文字列を取得するFVGオブジェクト名。
editable String out_objstr ：[出力]FVGオブジェクト文字列を出力するオブジェクト。

先頭へ

FVGImage::SetFVGObjectString

public Bool SetFVGObjectString( INativeString fvgobjname, INativeString objstr)

   指定したFVGオブジェクトの内容をFVGオブジェクト文字列で設定します。
   このメソッドは指定した名前のFVGオブジェクトがない場合失敗します。
   (FVGオブジェクト文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGオブジェクト文字列を設定するFVGオブジェクト名。
INativeString objstr ：設定するFVGオブジェクト文字列。

先頭へ

FVGImage::GetFVGFactorCount

public Integer GetFVGFactorCount( INativeString fvgobjname)const

指定したFVGオブジェクトが持つFVGファクターの数を取得します。

戻り値：指定したFVGオブジェクトが持つFVGファクターの数を返します。

INativeString fvgobjname ：FVGファクターの数を取得するFVGオブジェクト名。

先頭へ

FVGImage::GetFVGObjectSize

public Bool GetFVGObjectSize( INativeString fvgobjname,              editable INativeInteger? width,editable INativeInteger? height)const

   FVGオブジェクトの画像サイズを取得します。

戻り値：取得に成功すると真を返します。

INativeString fvgobjname ：画像サイズを取得するFVGオブジェクト名。
editable INativeInteger? width ：[出力]画像の横幅を出力するオブジェクト。
      空参照を指定した場合、無視します。
editable INativeInteger? height ：[出力]画像の縦幅を出力するオブジェクト。
      空参照を指定した場合、無視します。

先頭へ

FVGImage::GetFVGFactorString

public Bool GetFVGFactorString( INativeString fvgobjname, INativeInteger factorid,              editable String out_factorstr)const

   指定したFVGファクターの内容であるFVGファクター文字列を取得します。
   (FVGファクター文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクター文字列を取得するファクターのあるFVGオブジェクト名。
INativeInteger factorid ：FVGファクター文字列を取得するFVGファクターID。
editable String out_factorstr ：[出力]FVGファクター文字列を出力するオブジェクト。

先頭へ

FVGImage::SetFVGFactorString

public Bool SetFVGFactorString( INativeString fvgobjname, INativeInteger factorid,              INativeString factorstr)

   指定したFVGファクターの内容をFVGファクター文字列で設定します。
   このメソッドは指定したFVGファクターがない場合失敗します。
   (FVGファクター文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクター文字列を設定するファクターのあるFVGオブジェクト名。
INativeInteger factorid ：FVGファクター文字列を設定するFVGファクターID。
INativeString factorstr ：設定するFVGファクター文字列。

先頭へ

FVGImage::InsertFVGFactor

public Bool InsertFVGFactor( INativeString fvgobjname, INativeInteger factorid,              INativeString factorstr)

   指定したFVGオブジェクトのFVGファクターIDに新規ファクターを挿入し、
   その内容をFVGファクター文字列で設定します。
   挿入されたFVGファクターは指定したFVGファクターIDになります。
   このメソッドは指定したFVGファクターIDに挿入できない場合失敗します。
   (FVGファクター文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクターを挿入するFVGオブジェクト名。
INativeInteger factorid ：FVGファクターを挿入するFVGファクターID。
INativeString factorstr ：設定するFVGファクター文字列。

先頭へ

FVGImage::PushFVGFactor

public Bool PushFVGFactor( INativeString fvgobjname, INativeString factorstr)

   指定したFVGオブジェクトの最後に新規ファクターを追加し、
   その内容をFVGファクター文字列で設定します。
   (FVGファクター文字列の定義はFVG詳細仕様に依存します)

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクターを追加するFVGオブジェクト名。
INativeString factorstr ：設定するFVGファクター文字列。

先頭へ

FVGImage::PopFVGFactor

public Bool PopFVGFactor( INativeString fvgobjname)

指定したFVGオブジェクトの最後のファクターを削除します。

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクターを削除するFVGオブジェクト名。

先頭へ

FVGImage::DeleteFVGFactor

public Bool DeleteFVGFactor( INativeString fvgobjname, INativeInteger factorid)

指定したFVGオブジェクトの指定したFVGファクターIDのファクターを削除します。

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクターを削除するFVGオブジェクト名。
INativeInteger factorid ：FVGファクターを削除するFVGファクターID。

先頭へ

FVGImage::MoveFVGFactor

public Bool MoveFVGFactor( INativeString fvgobjname,              INativeInteger factorid, INativeInteger dst_id)

   指定したFVGオブジェクトの指定したFVGファクターIDのファクターを
   指定したFVGファクターIDになるように移動します。

戻り値：処理に成功した場合、真を返します。

INativeString fvgobjname ：FVGファクターを移動するFVGオブジェクト名。
INativeInteger factorid ：FVGファクターを移動するFVGファクターID。
INativeInteger dst_id ：FVGファクターの移動先FVGファクターID。

先頭へ

[前へ] [目次へ] [次へ]

最終更新 2022/05/31

FVGImage (ネイティブクラス)