関数
basename()
→ str
現行HIPファイルのファイル名の部分だけを返します。
name()
→ str
現行HIPファイルの名前を返します。
この関数は、フルパスを返したり、返さなかったりします。
そのパスが相対パスだった場合は、それはos.getcwd()
が基準になっています。
常にフルパスが必要であれば、代わりにhou.hipFile.path()を使用してください。
path()
→ str
現行HIPファイルのフルパスを返します。
hasUnsavedChanges()
→ bool
現行Houdiniセッションが最後保存時刻以降で変更されているかどうか返します。 この関数は、グラフィカルセッションでのみ動作します。 非グラフィカルセッションでは、これは常にTrueを返します。
load(file_name, suppress_save_prompt=False, ignore_load_warnings=False)
HIPファイルを読み込みます。
suppress_save_promptがFalse
の場合、この関数は File ▸ Open… からファイルを読み込むのと同じ挙動をします。
これは、新しくファイルを読み込む前に現行ファイルを保存するかどうか確認し、ポップアップウィンドウに読み込みエラーを表示します。
また、メインウィンドウ上部の現行ファイル名を変更し、最近使用したファイルのリストにそのファイル名を追加します。
UIが利用できない場合(例えば、Hythonからこの関数を実行した場合)、そのsuppress_save_promptパラメータが無視され、非インタラクティブな読み込みが常に実行されます。
読み込むファイルが存在しなかったり、開くことができなかった場合は、hou.OperationFailedを引き起こします。 シャットダウン中に、またはHIPファイルの読み込み/保存中に、このメソッドがコールされても、同じ例外が発生します。 それぞれの状況において、その例外インスタンスメッセージがその失敗の原因を反映します。
読み込み中に警告が発生し、ignore_load_warnings
がFalse
の時、hou.LoadWarningを引き起こします。
このインスタンスメッセージには、警告テキストが含まれます。
save(file_name=None, save_to_recent_files=True)
現行セッションをHIPファイルに保存します。
file_name
書き込まれるファイルの名前またはパス。
存在しないディレクトリにファイルを保存しようとすると、そのディレクトリが作成されます。
このパラメータがNone
の場合、Houdiniは現行HIPファイルのパスを使用します。
save_to_recent_files
Houdiniが File ▸ Open Recent Files リストの内容にこのファイルを追加するかどうか。 この関数が非グラフィカルセッションからコールされた時は、このパラメータは無視されます。
ターゲットのファイルやディレクトリを作成できなかった場合や、保存中に他のエラーが起きた場合は、hou.OperationFailedを引き起こします。 シャットダウン中に、またはHIPファイルの読み込み/保存中に、このメソッドがコールされても、同じ例外が発生します。 それぞれの状況において、その例外インスタンスメッセージがその失敗の原因を反映します。
setName(file_name)
次回にHIPファイルを保存する時のため用に、現行セッションの名前を変更します。
file_name
には、絶対または相対ファイルパスのどちらかを指定することができます。
相対パスの場合、そのパスはos.getcwd()
を基準に解釈されます。
ユーザーが後で File ▸ Save を選択すると、Houdiniは、この名前でHIPファイルを保存します。 この関数は実際にはHIPファイルを保存するわけではありません。 現行セッションの名前を設定し、且つ、それをHIPファイルに保存するようにするには、hou.hipFile.save()を使用します。
saveAndIncrementFileName()
自動的にファイル名の番号を上げて現行セッションをHIPファイルに保存します。
ターゲットのファイルやディレクトリを作成できなかった場合や、保存中に他のエラーが起きた場合は、hou.OperationFailedを引き起こします。 シャットダウン中に、またはHIPファイルの読み込み/保存中に、このメソッドがコールされても、同じ例外が発生します。 それぞれの状況において、その例外インスタンスメッセージがその失敗の原因を反映します。
saveAsBackup()
現行セッションから番号付きのバックアップを作成します。
現行バックアップと同じ名前のファイルが既に存在すれば、そのバックアップの名前は、保存前に連番ファイル内で次の番号を含むように変更されます。
バックアップファイルは、HOUDINI_BACKUP_DIR
環境変数に設定されたディレクトリに保存されます。
HOUDINI_BACKUP_DIR
を設定しなかった場合、"backup"という名前の相対ディレクトリが使用されます。
ターゲットのファイルやディレクトリを作成できなかった場合や、保存中に他のエラーが起きた場合は、hou.OperationFailedを引き起こします。 シャットダウン中に、またはHIPファイルの読み込み/保存中に、このメソッドがコールされても、同じ例外が発生します。 それぞれの状況において、その例外インスタンスメッセージがその失敗の原因を反映します
clear(suppress_save_prompt=False)
この関数は、現行セッションを空っぽのセッションに置換します。
suppress_save_prompt
をFalse
に設定すると、このメソッドは、インタラクティブセッションでの File ▸ New と同じ挙動をします。
これは、クリアする前に現行ファイルを保存するように促します。
True
に設定すると、セッションは非インタラクティブにクリアされます。つまり、何もメッセージが表示されず、変更が破棄されます。
UIが利用できない場合(例えば、Hythonからこの関数を実行した場合)、そのsuppress_save_promptパラメータが無視され、非インタラクティブなクリアが常に実行されます。
merge(file_name, node_pattern="*", overwrite_on_conflict=False, ignore_load_warnings=False)
指定したファイルを現行HIPファイルに取り込みます。取り込むノードは、node_patternパラメータで指定します。
overwrite_on_conflict
がTrue
の場合、このメソッドは、取り込むファイル内のノードと同じ名前のノードを上書きします。
このメソッドは、現行ファイルに取り込まれるファイルが存在しなかったり、開くことができなかった場合にhou.OperationFailed例外を引き起こします。 シャットダウン中に、またはHIPファイルの読み込み/保存中に、このメソッドがコールされても、同じ例外が発生します。 それぞれの状況において、その例外インスタンスメッセージがその失敗の原因を反映します。
このメソッドは、取り込み中に警告が発生し、ignore_load_warnings
がFalse
の時、hou.LoadWarning例外を引き起こします。
このインスタンスメッセージには、警告テキストが含まれます。
collisionNodesIfMerged(file_name, node_pattern="*")
→ tuple of hou.Node
指定したnode_patternでmergeを実行した場合に干渉するノードを返します。
その結果は、取り込むファイル内でnode_patternを満たし、既存ノードと同じ名前であるすべてのノードのタプルです。
干渉チェックで使用するファイルが存在しなかったり、開くことができなかったり、無効なHIPファイルだった場合は、hou.OperationFailedを引き起こします。 シャットダウン中に、またはHIPファイルの読み込み/保存中に、このメソッドがコールされても、同じ例外が発生します。 それぞれの状況において、その例外インスタンスメッセージがその失敗の原因を反映します。
isLoadingHipFile()
→ bool
メインアプリケーションがHIPファイルを読み込み中かどうか返します。
isShuttingDown()
→ bool
メインアプリケーションがシャットダウン中かどうか返します。
setOnSaveCallback(callback)
groupColorTable()
→ dict
of str
to hou.Color
ビューポートグループリスト用のカラーオーバーライドの辞書を返します。 ビューポートグループリストは、グループ名のハッシュに基づいて自動的にカラーをグループに割り当てます。 グループカラーテーブルは、デフォルトのカラー割り当てのオーバーライドの辞書です。 これによって、特定の重要なグループに目立ったカラーを割り当てることができます。 グループカラーテーブルは、HIPファイルに保存されます。 このカラーテーブルは、hou.hipFile.setGroupColorTable()を使って修正することができます。
setGroupColorTable(color_table)
ビューポートグループリストのカラーオーバーライドの辞書を設定します。 ビューポートグループリストは、グループ名のハッシュに基づいて自動的にカラーをグループに割り当てます。 グループカラーテーブルは、デフォルトのカラー割り当てのオーバーライドの辞書です。 これによって、特定の重要なグループに目立ったカラーを割り当てることができます。 グループカラーテーブルは、HIPファイルに保存されます。 現行のカラーテーブルは、hou.hipFile.groupColorTable()を使って照会することができます。
指定するcolor_table
は、str
とhou.Colorをマッピングしたdict
でなければなりません。
以下の例は、グループ名’special_group'を赤のオーバーレイで表示させます:
color_table = { 'special_group' : hou.Color([1,0,0]) } hou.hipFile.setGroupColorTable(color_table)
saveMode()
→ /hom/hou/hou.saveMode
現行シーンの保存モード/hom/hou/hou.saveMode.Binaryまたは/hom/hou/hou.saveMode.Textのどちらかを返します。
setSaveMode(save_mode)
現行シーンの保存モードを/hom/hou/hou.saveMode.Binaryまたは/hom/hou/hou.saveMode.Textのどちらかに設定します。
importFBX(file_name, suppress_save_prompt=False, merge_into_scene=True, import_cameras=True, import_joints_and_skin=True, import_geometry=True, import_lights=True, import_animation=True, import_materials=True, resample_animation=False, resample_interval=1.0, override_framerate=False,framerate=-1, hide_joints_attached_to_skin=True, convert_joints_to_zyx_rotation_order=False, material_mode=hou.fbxMaterialMode.FBXShaderNodes, compatibility_mode=hou.fbxCompatibilityMode.Maya, single_precision_vertex_caches=False, triangulate_nurbs=False, triangulate_patches=False, import_global_ambient_light=False, import_blend_deformers_as_blend_sops=False, segment_scale_already_baked_in=True, convert_file_paths_to_relative=True, unlock_geometry=False, unlock_deformations=False, import_nulls_as_subnets=False, import_into_object_subnet=True, convert_into_y_up_coordinate_system=False, create_sibling_bones=True, override_scene_frame_range=False)
→ (hou.ObjNode, str
)
色々なオプションでFBXファイルをインポートします。この関数は、常にキーワード引数を使ってコールすることを推奨します。 オプションの説明に関しては、File > Import > Filmbox FBXダイアログのヘルプを参照してください。
suppress_save_promptがFalse
なら、この関数は、 File ▸ Open… でファイルを読み込んだような挙動をします。
新しいファイルを読み込む前に現在のファイルを保存するかどうか尋ね、ポップアップウィンドウで読み込みエラーを表示します。
さらに、メインウィンドウの上部の現行ファイルの名前を変更し、そのファイル名を最近使用したファイルのリストに追加します。
UIが利用不可(例えば、Hythonから関数を実行した場合)なら、suppress_save_promptパラメータは無視され、非インタラクティブな読み込みが常に実行されます。
読み込むファイルが存在しなかったり、開けなかった場合は、hou.OperationFailedを引き起こします。 また、シャットダウン中やHIPファイルを読み込み中/保存中の時にメソッドがコールされると、同じ例外が引き起こされます。 それぞれの場合に、その例外インスタンスメッセージにその失敗の原因が反映されます。
この関数は、読み込まれたFBXノードの親サブネットノード(import_into_object_subnet
がFalse
ならhou.node('/obj')
)と生成される読み込みメッセージを含んだ文字列で構成したタプルを返します。
addEventCallback(callback)
.hipファイルイベント(例えば、ファイルの読み込みやファイルの保存)が発生した時にコールされるPythonコールバックを登録します。
callback
1つの引数を必要とするコール可能なPythonオブジェクト。 この引数は、hou.hipFileEventType列挙値です。
詳細は、シーンイベントコールバックを記述する方法を参照してください。
def scene_event_callback(event_type): hou.ui.displayMessage("An event of type {} occured".format(event_type)) hou.hipFile.addEventCallback(scene_event_callback)
removeEventCallback(callback)
hou.hipFile.addEventCallback()を使って以前に登録したPythonコールバックを削除します。 詳細は、hou.hipFile.addEventCallback()を参照してください。
以前にコールバックが登録されていなかった場合は、hou.OperationFailedを引き起こします。
clearEventCallbacks()
hou.hipFile.addEventCallback()を使って登録されたすべてのPythonコールバックを削除します。
eventCallbacks()
→ tuple
of callback
hou.hipFile.addEventCallback()を使って登録されたすべてのPythonコールバックのタプルを返します。