Pane Class

From TouchDesigner 099 Wiki

The Pane class describes an instance of a pane interface. It can be accessed through the ui.panes object. It is the parent class of the NetworkEditor Class.

Members

owner Get or set the component this pane points to.
id (Read Only) A unique numeric identifier.
link Get or set the numeric link index.
maximize Enable or disable the pane maximize state.
name Get or set the pane name.
ratio Get or set the split proportion of the pane, if the pane was previously split.
bottomLeft (Read Only) The coordinates of the bottom left corner, expressed in both pixels and uv offsets, in a named tuple. For example, ui.panes[0].bottomLeft
topRight (Read Only) The coordinates of the top right corner, expressed in both pixels and uv offsets, in a named tuple.
type (Read Only) The enumerated type of the pane. Example: NetworkEditor.

The enumeration is called PaneType and consists of:

 PaneType.NETWORKEDITOR
 PaneType.PANEL
 PaneType.GEOMETRYVIEWER
 PaneType.TOPVIEWER
 PaneType.CHOPVIEWER
 PaneType.ANIMATIONEDITOR
 PaneType.PARAMETERS
 PaneType.TEXTPORT


Methods

changeType(paneType)Pane

Change the pane to the specified type. Will return a new Pane object that represents the Pane. After being called, the current Pane instance will no longer be valid.
  • paneType - The type of pane to change this pane to.
   p = ui.panes[0]
   p = p.changeType(PaneType.TOPVIEWER)  #note: must re-assign p to new object.


close()

Close the pane.

floatingCopy()Pane

Return a floating copy of the pane.

splitBottom()Pane

Split the bottom portion of the pane into a new pane.

splitLeft()Pane

Split the left portion of the pane into a new pane.

splitRight()Pane

Split the right portion of the pane into a new pane.

splitTop()Pane

Split the top portion of the pane into a new pane.

tearAway()boolean

Detach the pane into a floating window. Returns True if successful.

uniqueName(name)string

Returns a unique and legal name for a pane.


Accessing Panes

See ui.panes for examples on how to access individual panes.