Note
このメソッドをコールするには、まず最初にhapi.renderTextureToImageをコールしないと意味がありません。
使用方法 ¶
extractImageToFile(session: hapi.Session, material_node_id: int, image_file_format_name: str, image_planes: str, destination_folder_path: str, destination_file_name: str) → int
レンダリングした画像をファイルに抽出します。
session
あなたが操作しているHoudiniのセッション。 セッションの詳細はhapi.Sessionを参照してください。 単にデフォルトのインプロセスのセッションを使用するのであれば、Noneを渡してください。
material_node_id
マテリアルノードのノードID。
image_file_format_name
抽出したい画像のファイルフォーマット名。 このパラメータをNoneのままにすることで、その画像が他のテクスチャファイルから派生したものだった場合や デフォルトのHAPIフォーマットだった場合(画像が生成された時にhapi.DEFAULT_IMAGE_FORMAT_NAMEだった場合)には、 そのオリジナルのフォーマットで画像を抽出することができます。
非常によく使用される標準画像ファイルフォーマット名は、“Defines”セクション下のHAPI_Common.hからいくつか取得することができます。
hapi.getSupportedImageFileFormatsを使用すれば、対応しているすべてのファイルフォーマット(とこのパラメータで必要となる実際の名前)のリストも取得することができます。 このリストには、カスタムDSO(HDKドキュメントのIMG_Formatを参照)を介して作成されたカスタムファイルフォーマットも含まれ、 hapi.ImageFileFormatのリストが取得されます。 このパラメータには、指定した画像ファイルフォーマットのhapi.ImageFileFormat.nameSHが必要です。
image_planes
ファイルに抽出したい画像平面。 複数の画像平面はスペースで区切って指定してください。
destination_folder_path
画像ファイルが作成されるフォルダ。
destination_file_name
抽出されたテクスチャファイルの名前を上書きするためのオプションパラメータ。
ファイルタイプはhapi.setImageInfoを使って設定可能なhapi.ImageInfoによって決定されるので、ここには拡張子を入れないでください。
さらに、destination_file_pathを使用して最終ファイルパスを取得する必要があります。
ここにNoneを渡すと、マテリアルのSHOPノードの名前、(画像がテクスチャからレンダリングされた場合には)テクスチャマップパラメータの名前、指定した画像平面の名前から自動的にファイル名が生成されます。
出力ファイルパスをintで返します。