hou.CompositorViewer class

コンポジットビューペインを表現した最小クラス。

Inheritance

hou.PaneTab

hou.PathBasedPaneTab

hou.CompositorViewer

現在のところ、このクラスは非常に単純で、コンポジットシェルフツールに対応するのに必要最低限のメソッドを実装しています。現在のところ、UIで利用可能なほとんどの機能をプラグラムで制御することができません。

なるべるこのオブジェクトを使用しないでください。コンポジットビュー用のカスタムツールを記述したいのであれば、cop2toolutilsモジュール内の高レベル関数の方が役立ちます。

メソッド ¶

currentState() → str

ビュー内で現在使用されているツールの名前を返します。これは、内部の公開されていない名前ですが、通常ではノードの名前に該当します。setCurrentStateを使用することで別のツールに変更することができます。

enterViewState(wait_for_exit=False)

ビューツールに切り替えます。

setCurrentState(state, wait_for_exit=False)

ビュー内の現在アクティブなツールを設定します。stateは、内部の公開されていない名前を含んだ文字列です。currentState()を参照してください。

ビュー内の現在アクティブなツールを設定します。stateは、内部の公開されていない名前を含んだ文字列です。currentState()を参照してください。

カラー補正 ¶

これらの関数は、ビューアのOpenColorIO設定を設定または照会します(OpenColorIO対応を参照)。

usingOCIO() → bool

ビューアのカラー補正にOpenColorIOが使用されているかどうかを照会します。

setUsingOCIO(enable)

ビューアのカラー補正でOpenColorIOを有効または無効にします。

setOCIODisplayView(display="", view="")

OpenColorIOの表示名、ビュー名、または両方を設定します。表示とビューはどちらもビューアの出力カラー空間を定義し、任意の数のカラー変換(Looks)が線形ビューポート画像に対して実行されます。

getOCIODisplay() → str

カラー補正で使用されている現在のOpenColorIO表示を返します。

getOCIOView() → str

カラー補正で使用されている現在のOpenColorIOビューを返します。

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のプロパティは、スクリーン座標におけるこのペインタブの左上コーナーを指します。