hou.ParameterEditor class

Parameter Editorペインタブを表現します。

Inheritance

hou.PaneTab

hou.PathBasedPaneTab

hou.ParameterEditor

メソッド ¶

filterEnabled() → bool

Parameter Editorのフィルタリングが有効になっていればTrueを返します。

setFilterEnabled(self,on)

Parameter Editorのフィルタリングを有効にします。 hou.parmFilterCriteriaを参照してください。

filterMode() → hou.parmFilterMode

Parameter Editor hou.parmFilterModeを返します。

setFilterMode(self,mode)

Parameter Editorのフィルタモードを設定します。 hou.parmFilterModeは、フィルタパターンの適用先となるパラメータを定義します。

filterCriteria() → hou.parmFilterCriteria

Parameter Editor hou.parmFilterCriteriaを返します。

setFilterCriteria(self,criteria)

Parameter Editorのフィルタ基準を設定します。 hou.parmFilterCriteriaは、フィルタパターンをパラメータに適用する方法を定義します。

filterPattern() → str

Parameter Editorのフィルタパターンを返します。

setFilterPattern(self,pattern)

Parameter Editorのフィルタパターンを設定します。このフィルタパターンは、hou.parmFilterModeに合致したパラメータのhou.parmFilterCriteria文字列に適用されます。このパターンマッチングは、文字通りの名前のマッチングを使用したり、その文字列内でパターンを検索することもできます。フィルタパターンには、カンマで区切ったパターンのリストを指定することができ、さらにワイルドカードの'*'文字を含めることもできます。

filterExactMatch() → bool

Parameter Editorのフィルタリングが文字通りのパターンマッチングを使用していればTrueを返します。

setFilterExactMatch(self,on)

Parameter Editorのフィルタリングが文字通りのパターンマッチングを使用するように設定します。

scrollPosition() → hou.Vector2

Parameter Editorのスクロールバーの位置をパーセンテージで返します。

setScrollPosition(self,pos)

Parameter Editorのスクロールバーの位置をhou.Vector2パーセンテージで設定します。

scrollTo(parms, scroll_pos)

hou.scrollPositionモードを使用して、Parameter Editorの垂直スクロールバーが1つ以上のパラメータに整列するように調整します。

parms引数には、listまたは単一str、hou.Parmまたはhou.ParmTupleを指定することができます。リスト内にこれらのタイプを混在させることができます。エントリーがstrの場合、パラメータ名をカンマで区切ったリストを渡すことができますが、ワイルドカードには対応していません。

scroll_pos引数では、影響を受けるパラメータの垂直境界ボックスの整列方法を定義します。 hou.scrollPositionを参照してください。

hou.scrollPositionモードを使用して、Parameter Editorの垂直スクロールバーが1つ以上のパラメータに整列するように調整します。

moveFocusTo(parm)

Parameter Editor内の指定したパラメータにキーボードフォーカスが当たるように試みます。

isShowingParmDialog() → bool

Parameter Editorが現在(例えば、Python Panelとは対照的に)パラメータダイアログを表示していればTrueを返します。

setShowParmDialog(self,show)

showがTrueの場合、Parameter Editorがパラメータダイアログを表示するように設定されます。 showがFalseの場合、Python Panelに切り替わります。

Parameter Editorの現行ノードがそれに呼応するPython Panelインターフェースを持っていない、且つ、showがFalseに設定されている場合、hou.OperationFailedを引き起こします。

showがTrueの場合、Parameter Editorがパラメータダイアログを表示するように設定されます。 showがFalseの場合、Python Panelに切り替わります。

setMultiParmTab(self,parm, tab_index)

パラメータ名を使用して、Multi Parameterタブを、指定したタブに切り替えます。

multiParmTab(self,parm) → int

パラメータ名を使用して、現在可視のタブインデックスを返します。

visibleParms() → tuple of hou.ParmTuple

現在可視のパラメータを返します。

Methods from hou.PaneTab ¶

name() → str

このタブの名前を返します。

setName(name)

このペインタブの名前を設定します。ペインタブの名前にはスペースを含めることができます。

この名前は、そのタブの内部名で、インターフェースで表示される名前とは異なることに注意してください。

このペインタブの名前を設定します。ペインタブの名前にはスペースを含めることができます。

type() → hou.paneTabType列挙値

このタブのタイプ(つまり、scene viewer, parameter editor, network editorなど)を返します。

setType(type) → hou.PaneTab

指定したタイプの新しいペインタブを作成し、このタブをその新しいタブに置換し、その新しいペインタブを返します。このタブの参照が無効になるので、それ以降は、返されたペインタブを使用してください。

close()

ペインタブを閉じます。

pane() → hou.Pane or None

このペインタブを含んだデスクトップ内のペインを返します。通常のフローティングパネルには1個以上のペインを含むので、通常のフローティングパネル内のペインタブは、常にペイン内にあります。

とはいえ、いくつかのフローティングパネルでは、特定のペインタブタイプだけを含むように、それ以外の内容が取り除かれており、複数のペインタブを追加したり、ペインを分割するといったユーザインターフェースを表示しません。このメソッドは、そのような余計なものが取り除かれたパネルに対してはNoneを返します。

floatingPanel() → hou.FloatingPanel or None

このペインタブが含まれたフローティングパネルを返します。このペインタブがフローティングパネル内になければNoneを返します。

isCurrentTab() → bool

このタブが、それが含まれているペイン内で選択されたタブかどうか返します。

setIsCurrentTab()

このタブを、それが含まれているペイン内で選択されたタブとして設定します。

isFloating() → bool

このペインタブがフローティングパネル内にあるかどうか返します。

このメソッドはほぼ以下のように実装されています:

def isFloating(self):
    return self.pane() is None or self.pane().floatingPanel() is not None

このペインタブがフローティングパネル内にあるかどうか返します。

clone() → hou.PaneTab

ペインタブから複製されたフローティングパネルを作成し、そのクローンペインタブを返します。その新しいペインタブは、新しいフローティングパネル内にあります。

linkGroup() → hou.paneLinkType列挙値

このペインタブが属するリンクグループを返します。

hou.PaneTab.isPinも参照してください。

このペインタブが属するリンクグループを返します。

setLinkGroup(group)

このペインタブのリンクグループメンバーシップを設定します。

isPin() → bool

このペインタブがピン留めされているかどうか返します。このメソッドは、(self.linkGroup() == hou.paneLinkType.Pinned)と等価です。

hou.PaneTab.linkGroupも参照してください。

このペインタブがピン留めされているかどうか返します。このメソッドは、(self.linkGroup() == hou.paneLinkType.Pinned)と等価です。

setPin(pin)

pinがTrueなら、リンクグループメンバーシップをhou.paneLinkType.Pinnedに設定します。それ以外の場合、それをhou.paneLinkType.FollowSelectionに設定します。このメソッドは、以下のようにhou.PaneTab.setLinkGroupを使用して実装することができます:

def setPin(self, pin):
    if pin:
        self.setLinkGroup(hou.paneLinkType.Pinned)
    else:
        self.setLinkGroup(hou.paneLinkType.FollowSelection)

hou.PaneTab.setLinkGroupも参照してください。

pinがTrueなら、リンクグループメンバーシップをhou.paneLinkType.Pinnedに設定します。それ以外の場合、それをhou.paneLinkType.FollowSelectionに設定します。このメソッドは、以下のようにhou.PaneTab.setLinkGroupを使用して実装することができます:

size() → tuple of int

ペインタブの幅と高さを含んだ2タプルを返します。

この幅と高さは、その中身の領域、(もしあれば)ネットワークナビゲーションコントロールの領域、境界を含みます。

この幅と高さは、ペインタブのタブ領域を含みません。

ペインタブの幅と高さを含んだ2タプルを返します。

contentSize() → tuple of int

ペインタブの中身の領域の幅と高さを含んだ2タプルを返します。

この幅と高さは、(もしあれば)ネットワークナビゲーションコントロールの領域、ペインタブの境界、ペインタブの領域を含みません。

ペインタブの中身の領域の幅と高さを含んだ2タプルを返します。

hasNetworkControls() → bool

このペインタブタイプがネットワークコントロールに対応していればTrueを返します。

isShowingNetworkControls() → bool

このペインタブがネットワークコントロールバーを表示しているかどうかを返します。ペインタブがネットワークコントロールを持っていない場合はFalseを返します。 hou.PaneTab.hasNetworkControlsも参照してください。

setShowNetworkControls(pin)

ネットワークコントロールバーを表示/非表示します。ペインタブがネットワークコントロールを持っていない場合は何の効果もありません。 hou.PaneTab.hasNetworkControlsも参照してください。

このメソッドは廃止されました。代わりにshowNetworkControlsを使用してください。

showNetworkControls(pin)

ネットワークコントロールバーを表示/非表示します。ペインタブにネットワークコントロールがない場合は何の効果もありません。 hou.PaneTab.hasNetworkControlsも参照してください。

displayRadialMenu(menu)

指定したRadialメニューをペインタブ内で起動します。

qtParentWindow() → QWidget

このペインタブを含んだウィンドウを表現したPySide2.QtWidgets.QWidgetインスタンスを返します。

このペインタブを含んだウィンドウを表現したPySide2.QtWidgets.QWidgetインスタンスを返します。

qtScreenGeometry() → QRect

このペインタブのジオメトリをPySide2.QtCore.QRectオブジェクトとして返します。返されるQRectオブジェクトのxとyのプロパティは、スクリーン座標におけるこのペインタブの左上コーナーを指します。

このペインタブのジオメトリをPySide2.QtCore.QRectオブジェクトとして返します。返されるQRectオブジェクトのxとyのプロパティは、スクリーン座標におけるこのペインタブの左上コーナーを指します。