関数 ¶
newBookmark(name, start_frame, end_frame)
→ hou.Bookmark
指定したオプションを使用して、新しいhou.Bookmarkオブジェクトを作成して返します。
新しいブックマークを作成するには、この関数を使用してください。
というのも、Bookmark
クラスは直接インスタンス化できないからです。
bookmarks()
→ tuple
of hou.Bookmarks
現在のhou.Bookmarkを開始時間順でソートされたタプルを返します。
getBookmark(session_id)
→ hou.Bookmark
このメソッドは廃止され、代わりにhou.anim.bookmarkを使用してください。
指定したセッションIDにマッチしたhou.Bookmarkを返します。該当するブックマークがなければNoneを返します。
bookmark(session_id)
→ hou.Bookmark
指定したセッションIDにマッチしたhou.Bookmarkを返します。該当するブックマークがなければNoneを返します。
saveBookmarks(filename, bookmarks=None, include_temporary=False)
→ bool
指定したhou.Bookmarkオブジェクトのリストを、指定したJSONファイルに保存します。 2番目の引数が空っぽのままの場合、代わりに現行ブックマークのリストが保存されます。 成功すればTrue、失敗すればFalseを返します。
filename
ブックマークのエクスポート先のファイルの名前。
そのファイルの拡張子は、.json
または.otio
のどちらかにしてください。
bookmarks
これを指定すると、すべてのブックマークが保存されず、その指定したブックマークのみが保存されます。
include_temporary
一時的とマークされたブックマークを保存ファイルに含めるかどうか。 デフォルトはFalseです。hou.Bookmark.setTemporaryを参照してください。
loadBookmarks(filename, remove_existing=True)
→ bool
指定したファイルからブックマークのリストを読み込み、成功すればTrue、失敗すればFalseを返します。
Note
既存のhou.Bookmarkオブジェクトが無効になります。
filename
ブックマークの読み込み元のファイルの名前。
そのファイルの拡張子は、.json
または.otio
のどちらかにしてください。
remove_existing
新しいブックマークを読み込む前に既存のブックマークを削除するかどうか。
saveBookmarksToString(bookmarks=None, include_temporary=False, binary=True)
→ bytes
binary
引数に応じて、ブックマークのデータをASCII形式またはバイナリ形式で返します。
bookmarks
これを指定すると、すべてのブックマークが保存されず、その指定したブックマークのみが保存されます。
include_temporary
一時的とマークされたブックマークを保存ファイルに含めるかどうか。 デフォルトはFalseです。hou.Bookmark.setTemporaryを参照してください。
binary
データ文字列をASCII形式またはバイナリ形式のどちらで返すかどうか。
loadBookmarksFromString(data, remove_existing=True)
指定した文字列から、指定したブックマークを読み込みます。
data
saveBookmarksToString
が返したASCII文字列またはバイナリ文字列。
remove_existing
新しいブックマークを読み込む前に既存のブックマークを削除するかどうか。
clearBookmarks()
すべてのブックマークをクリアします。
Note
既存のhou.Bookmarkオブジェクトが無効になります。
removeBookmarks(bookmarks)
指定したブックマークを削除し、アクティブなブックマークのリストからそれらのブックマークを除去します。
bookmarks
パラメータには、hou.Bookmarkオブジェクトのリストを指定してください。
addBookmarksChangedCallback(callback)
現行ブックマークが変更される度に実行されるコールバック関数を登録します。
removeBookmarksChangedCallback(callback)
既存のコールバックを除去します。
getGeometryChannels(collection_name, geometry, channel_names=None)
このメソッドは廃止され、代わりにhou.anim.mergeGeometryChannelsを使用してください。
以前にチャンネルリストに追加されていたジオメトリチャンネルを、指定したジオメトリにチャンネルプリミティブとして書き出します。
collection_name
ジオメトリチャンネルを取得するコレクションの名前。
geometry
チャンネルプリミティブが書き出される書き込み可能なジオメトリ。
channel_names
指定したコレクションから取得するチャンネルの名前のリスト。 指定しなかった場合、コレクション内のすべてのチャンネルが取得されます。
関連項目:
mergeGeometryChannels(collection_name, geometry, channel_names=None)
以前にチャンネルリストに追加されたジオメトリチャンネルを、指定したジオメトリにチャンネルプリミティブとして書き戻します。
collection_name
ジオメトリチャンネルを取得する対象のコレクション名。
geometry
チャンネルプリミティブが書き込まれる書き込み可能なジオメトリ。
channel_names
取得する対象となる、指定したコレクション内のチャンネル名のリスト。 これを指定しなかった場合、コレクション内のすべてのチャンネルが取得されます。
関連項目:
setGeometryChannels(collection_name, geometry, channel_names)
既存のスコープジオメトリチャンネルコレクションを、指定したジオメトリのチャンネルで更新します。 ジオメトリ内に既に存在する名前と干渉したチャンネルは、上書きされます。
collection_name
指定したチャンネルが追加されるコレクションの名前。
geometry
新しいチャンネルプリミティブを取得するジオメトリ。
channel_names
コレクションに追加するチャンネルの名前のリスト。 空っぽの場合、ジオメトリ内のすべてのチャンネルが追加されます。
setGeometryChannelsFromPattern(collection_name, geometry, pattern)
既存のスコープジオメトリチャンネルコレクションを、指定したジオメトリのチャンネルで更新します。 ジオメトリ内に既に存在する名前と干渉したチャンネルは、上書きされます。
collection_name
指定したチャンネルが追加されるコレクションの名前。
geometry
新しいチャンネルプリミティブを取得するジオメトリ。
pattern
コレクションに追加するチャンネルプリミティブのパターン文字列。
setGeometryChannelPending(collection_name, channel_name, value)
現行フレームでのスコープジオメトリチャンネルの値を設定し、そのジオメトリチャンネルを保留としてマークします。
collection_name
チャンネルが属しているコレクションの名前。
channel_name
修正するチャンネルの名前。
value
現行フレームで設定する保留値。 Noneの場合、そのチャンネルのすべての保留キーがクリアされます。
isGeometryChannelPending(collection_name, channel_name)
チャンネルに保留値があるかどうかを返します。
collection_name
チャンネルが属しているコレクションの名前。
channel_name
チャンネルの名前。
isGeometryChannelPinned(collection_name, channel_name=None)
→ bool
ジオメトリチャンネルがピン留めされているかどうかを返します。 2番目の引数が空っぽのままの場合、コレクション内のすべてのチャンネルがピン留めされているかどうかを返します。 pinned.
collection_name
チャンネルが属しているコレクションの名前。
channel_name
チャンネルの名前。
getPinnedGeometryChannels(collection_name)
このメソッドは廃止されました。代わりにhou.anim.pinnedGeometryChannelsを使用してください。
指定したコレクション内のすべてのピン留めされているジオメトリチャンネルのリストを返します。
collection_name
コレクションの名前。
pinnedGeometryChannels(collection_name)
指定したコレクション内のすべてのピン留めされているジオメトリチャンネルのリストを返します。
collection_name
コレクションの名前。
lockGeometryChannelCollection(collection_name, lock)
ジオメトリチャンネルコレクションのロックまたはロック解除をします。ロックすることで、そのチャンネルが編集できないようになります。
collection_name
修正するコレクションの名前。
lock
コレクションをロックまたはロック解除します。
addGeometryChannelsChangedCallback(collection_name, callback, on_mouse_up=True)
指定したコレクション内のジオメトリチャンネルが変更される度に実行されるコールバック関数を登録します。
このコレクションは、hou.playbar.setChannelList
を使用して、チャンネルリストに既に追加されている必要があります。
collection_name
変更の有無をリッスンするコレクションの名前。
callback
2つのパラメータ(変更されたジオメトリチャンネルの名前、コレクション名のタプル)を受け取るコールバック関数。
on_mouse_up
Channel Editorでジオメトリチャンネルを修正する時、このコールバックをマウスアップ時にのみ発動するのか、 それとも、チャンネルが変更される度に継続的に発動するのか指定します。 デフォルトはTrueで、マウスアップ時にのみ発動されます。
関連項目:
removeGeometryChannelsChangedCallback(collection_name, callback, on_mouse_up=True)
指定したジオメトリチャンネルコレクションから既存のコールバックを除去します。
collection_name
コールバックを除去するコレクションの名前。
callback
除去するコールバック関数。
on_mouse_up
除去するコールバックがマウスアップイベントに登録されていたかどうか。
これは、addGeometryChannelsChangedCallback
を使用して最初にコールバックを登録した時に渡した値と同じにしてください。
slopeMode()
→ hou.slopeMode
新しいキーを挿入する現行Slopeモード(AutoまたはManual)を返します。
setSlopeMode(mode)
デフォルトのSlopeモードを以下のどれかに設定します:
-
hou.slopeMode.Manual
: 新しく挿入されるキーが手動Slopeモードに設定されます。 -
hou.slopeMode.Automatic
: 新しく挿入されるキーが自動Slopeモードに設定されます。