メソッド ¶
clear()
チャンネルリストをクリアします。
parms()
→ tuple
of hou.Parm
チャンネルリスト内のすべてのチャンネルが含まれたhou.Parmのタプルを返します。
selected()
→ tuple
of hou.Parm
チャンネルリスト内の選択されたすべてのチャンネルが含まれたhou.Parmのタプルを返します。
deselected()
→ tuple
of hou.Parm
チャンネルリスト内の選択されていないすべてのチャンネルが含まれたhou.Parmのタプルを返します。
pinned()
→ tuple
of hou.Parm
チャンネルリスト内のピン留めされたすべてのチャンネルが含まれたhou.Parmのタプルを返します。
unpinned()
→ tuple
of hou.Parm
チャンネルリスト内のピン留めされていないすべてのチャンネルが含まれたhou.Parmのタプルを返します。
selectedValue()
→ tuple
of hou.Parm
チャンネルリスト内の選択された値の列のすべてのチャンネルが含まれたhou.Parmのタプルを返します。
deselectedValue()
→ tuple
of hou.Parm
チャンネルリスト内の選択されていない値の列のすべてのチャンネルが含まれたhou.Parmのタプルを返します。
addParm(parm, selected, pinned, valueselected)
チャンネルリストにパラメータを追加し、そのパラメータを選択状態、ピン留め状態、値選択状態に設定します。
parm
selected
チャンネルを選択します。デフォルトはTrueです。
pinned
チャンネルをピン留めします。デフォルトはFalseです。
valueselected
チャンネルの値の列を選択します。デフォルトはFalseです。
addParms(parms, selected, pinned, valueselected)
チャンネルリストにパラメータのリストを追加し、そのリストを選択状態、ピン留め状態、値選択状態に設定します。
parms
hou.Parmのタプル
。
selected
チャンネルを選択します。デフォルトはTrueです。
pinned
チャンネルをピン留めします。デフォルトはFalseです。
valueselected
チャンネルの値の列を選択します。デフォルトはFalseです。
addPath(path, selected, pinned, valueselected)
フルパスを使ってチャンネルリストにパラメータを追加し、そのパラメータを選択状態、ピン留め状態、値選択状態に設定します。
path
パラメータのフルパス文字列。
selected
チャンネルを選択します。デフォルトはTrueです。
pinned
チャンネルをピン留めします。デフォルトはFalseです。
valueselected
チャンネルの値の列を選択します。デフォルトはFalseです。
addPaths(paths, selected, pinned, valueselected)
フルパスを使ってチャンネルリストにパラメータのリストを追加し、そのリストを選択状態、ピン留め状態、値選択状態に設定します。
path
パラメータのフルパス文字列。
selected
チャンネルを選択します。デフォルトはTrueです。
pinned
チャンネルをピン留めします。デフォルトはFalseです。
valueselected
チャンネルの値の列を選択します。デフォルトはFalseです。
remove(parm)
select(parm)
deselect(parm)
pin(parm)
unpin(parm)
selectValue(parm)
deselectValue(parm)
isSelected(parm)
→ bool
チャンネルリスト内でパラメータが選択されていればTrueを返します。
parm
isPinned(parm)
→ bool
チャンネルリスト内でパラメータがピン留めされていればTrueを返します。
parm
isValueSelected(parm)
→ bool
チャンネルリスト内でパラメータの値の列が選択されていればTrueを返します。
parm
filter()
→ str
チャンネルリストのフィルタリング文字列を返します。
keepSelection()
→ bool
チャンネルリストのKeep Selectionフラグを返します。
enableFilter()
→ bool
チャンネルリストのフィルタリングがアクティブであればTrueを返します。
filterRotates()
→ bool
チャンネルリストの回転量のフィルタリングがアクティブであればTrueを返します。
filterTranslates()
→ bool
チャンネルリストの移動量のフィルタリングがアクティブであればTrueを返します。
filterScales()
→ bool
チャンネルリストのスケールのフィルタリングがアクティブであればTrueを返します。
setFilter(self,pattern)
`
チャンネルリストにフィルタリング文字列を設定します。
pattern
パターン文字列。
setKeepSelection(self,on)
チャンネルリストにKeep Selectionフラグを設定します。
setEnableFilter(self,on)
チャンネルリストのフィルタリングを有効化/無効化します。
setFilterRotates(self,on)
チャンネルリストの回転量のフィルタリングを有効化/無効化します。
setFilterTranslates(self,on)
チャンネルリストの移動量のフィルタリングを有効化/無効化します。
setFilterScales(self,on)
チャンネルリストのスケールのフィルタリングを有効化/無効化します。
addGeometryChannels(geometry, collection_name=None, pattern=None, selected=True, pinned=False, valueselected=False)
→ str
Adds a collection of geometry channels to the channel list, constructed from the channel primitives present in the provided geometry. Returns the name of the geometry channels collection. If no name is provided, a unique name will be created. Note that any modifications to the scoped channels are not immediately reflected in the channel primitives, but must be manually updated using hou.anim.getGeometryChannels.
The following shows an example workflow of adding geometry channels to the channel list, listening for updates, and setting modified channels back in to channel primitives:
channel_list = hou.ChannelList() collection_name = "test_collection" # g is any hou.Geometry with channel primitives. channel_list.addGeometryChannels(g, collection_name) hou.playbar.setChannelList(channel_list) # Mutable geometry in which to write modified channel primitives. output_geometry = hou.Geometry() def channels_changed(channel_names, collection_name): print(f"Channels in {collection_name} were modified: ", channel_names) # Write the changed channels back in to channel primitives. hou.anim.getGeometryChannels(collection_name, output_geometry, channel_names) # Called whenever geometry channels added to the channel list are modified, # such as when they are edited in the Animation Editor. hou.anim.addGeometryChannelsChangedCallback(collection_name, channels_changed)
geometry
collection_name
An optional name for the geometry channels collection. If not provided, a unique name will be created. If a collection with the same name already exists, it will be overwritten.
pattern
A pattern string, None by default. If provided, only channel primitives matching the pattern will be added to the collection.
selected
Select all channels in the collection, True by default.
pinned
Pin all channels in the collection, False by default.
valueselected
Select the value column of all channels in the collection, False by default.
See also:
addNodeGeometryChannels(node, pattern=None, selected=True, pinned=False, valueselected=False)
→ str
Adds a collection of geometry channels to the channel list, constructed from the channel primitives present in the provided node’s geometry. Returns the name of the geometry channels collection, which will be the same as the node’s path.
node
A hou.SopNode.
pattern
A pattern string, None by default. If provided, only channel primitives matching the pattern will be added to the collection.
selected
Select all channels in the collection, True by default.
pinned
Pin all channels in the collection, False by default.
valueselected
Select the value column of all channels in the collection, False by default.
removeGeometryChannels(collection_name=None)
Removes the geometry channels collection with the provided name from the channel list.
collection_name
Name of the geometry channels collection to remove.
geometryChannelCollectionNames()
→ tuple
of str
Returns a tuple of the names of geometry collections added to the channel list.
geometryChannels(collection_name)
→ tuple
of hou.ChannelPrim
Returns a tuple of channel primitives in a given geometry channels collection
selectGeometryChannel(collection_name, channel=None)
Selects a geometry channel. If no channel is provided, selects all channels within the collection.
collection_name
Name of the geometry channels collection.
channel
Name of the channel to select. None by default.
deselectGeometryChannel(collection_name, channel=None)
Deselects a geometry channel. If no channel is provided, deselects all channels within the collection.
collection_name
Name of the geometry channels collection.
channel
Name of the channel to deselect. None by default.
pinGeometryChannel(collection_name, channel=None)
Pins a geometry channel. If no channel is provided, pins all channels within the collection.
collection_name
Name of the geometry channels collection.
channel
Name of the channel to pin. None by default.
unpinGeometryChannel(collection_name, channel=None)
Unpins a geometry channel. If no channel is provided, unpins all channels within the collection.
collection_name
Name of the geometry channels collection.
channel
Name of the channel to unpin. None by default.
selectGeometryChannelValue(collection_name, channel=None)
Selects the value of column of a geometry channel. If no channel is provided, selects the values of all channels within the collection.
collection_name
Name of the geometry channels collection.
channel
Name of the channel to select. None by default.
deselectGeometryChannelValue(collection_name, channel=None)
Deselects the value of column of a geometry channel. If no channel is provided, deselects the values of all channels within the collection.
collection_name
Name of the geometry channels collection.
channel
Name of the channel to deselect. None by default.
containsGeometryChannel(collection_name, channel=None)
→ bool
Returns whether or not a geometry channel is present in the channel list. If a channel name is not provided, returns whether or not the collection is present.
collection_name
Name of the geometry channels collection.
channel
Name of the channel. None by default.
isGeometryChannelSelected(collection_name, channel)
→ bool
Returns whether or not a geometry channel is selected.
collection_name
Name of the geometry channels collection.
channel
Name of the channel.
isGeometryChannelPinned(collection_name, channel)
→ bool
Returns whether or not a geometry channel is pinned.
collection_name
Name of the geometry channels collection.
channel
Name of the channel.
isGeometryChannelValueSelected(collection_name, channel)
→ bool
Returns whether or not the value column geometry channel is selected.
collection_name
Name of the geometry channels collection.
channel
Name of the channel.
asCode(self,var_name)
→ str
現行オブジェクトと同じ内容でチャンネルリストを再現するPythonコード文字列を返します。
var_name
生成されるコードで使用されるチャンネルリストの変数名。
デフォルトはchanlist
です。