NetworkEditor Class

From TouchDesigner 099 Wiki

The NetworkEditor class describes an instance of a Network Editor. They are subclasses of the Pane Class, which can be accessed from the ui object.


Members

showBackdropCHOPs Enable or disable CHOP viewers as backdrops.
showBackdropGeometry Enable or disable SOP and Geometry object viewers as backdrops.
showBackdropTOPs Enable or disable TOP viewers as backdrops.
showColorPalette Enable or disable display of the operator color palette selector.
showDataLinks Enable or disable disable of operator data links.
showList Control display of operators as a list, or connected nodes.
showNetworkOverview Enable or disable display of the network overview.
showParameters Enable or disable display of the currently selected operator parameters.
straightLinks Control display of operator links as straight or curved.
x Get or set the x coordinate of the network editor area, where 1 unit = 1 pixel when zoom = 1.
y Get or set the y coordinate of the network editor area, where 1 unit = 1 pixel when zoom = 1.
zoom Get or set the zoom factor of the network editor area, where a zoom factor of 1 draws each node at its unscaled resolution.

Methods

fitHeight(height)

Fit the network area to specified height, specified in node units. This affects the zoom factor.
  • height - The height to fit to.

fitWidth(width)

Fit the network area to specified width, specified in node units. This affects the zoom factor.
  • width - The width to fit to.

home(zoom=True, op=None)

Home all operators in the network.
  • zoom - (Keyword, Optional) When true, the view will be scaled accordingly, otherwise the nodes will only be re-centered.
  • op - (Keyword, Optional) If an operator is specified, the network will be homed around its location.
   p = ui.panes['pane1']
   n = op('/project1')
   p.home(op=n)
   p = ui.panes[2]
   p.home(zoom=True)

homeSelected(zoom=True)

Home all selected operators in the network.
  • zoom - (Keyword, Optional) When true, the view will be scaled accordingly, otherwise the nodes will only be re-centered.


Pane 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.