Difference between revisions of "NetworkEditor Class"

From TouchDesigner Documentation
Jump to: navigation, search
(NetworkEditor Class Auto Create)
(NetworkEditor Class Auto Create)
Line 8: Line 8:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showBackdropCHOPs
 
     |name=showBackdropCHOPs
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable CHOP viewers as backdrops.
 
     |text=Enable or disable CHOP viewers as backdrops.
Line 15: Line 15:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showBackdropGeometry
 
     |name=showBackdropGeometry
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable SOP and Geometry object viewers as backdrops.
 
     |text=Enable or disable SOP and Geometry object viewers as backdrops.
Line 22: Line 22:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showBackdropTOPs
 
     |name=showBackdropTOPs
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable TOP viewers as backdrops.
 
     |text=Enable or disable TOP viewers as backdrops.
Line 29: Line 29:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showColorPalette
 
     |name=showColorPalette
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable display of the operator color palette selector.
 
     |text=Enable or disable display of the operator color palette selector.
Line 36: Line 36:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showDataLinks
 
     |name=showDataLinks
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable disable of operator data links.
 
     |text=Enable or disable disable of operator data links.
Line 43: Line 43:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showList
 
     |name=showList
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Control display of operators as a list, or connected nodes.
 
     |text=Control display of operators as a list, or connected nodes.
Line 50: Line 50:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showNetworkOverview
 
     |name=showNetworkOverview
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable display of the network overview.
 
     |text=Enable or disable display of the network overview.
Line 57: Line 57:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=showParameters
 
     |name=showParameters
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable display of the currently selected operator parameters.
 
     |text=Enable or disable display of the currently selected operator parameters.
Line 64: Line 64:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=straightLinks
 
     |name=straightLinks
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Control display of operator links as straight or curved.
 
     |text=Control display of operator links as straight or curved.
Line 71: Line 71:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=x
 
     |name=x
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the x coordinate of the network editor area,  where 1 unit = 1 pixel when zoom = 1.
 
     |text=Get or set the x coordinate of the network editor area,  where 1 unit = 1 pixel when zoom = 1.
Line 78: Line 78:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=y
 
     |name=y
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the y coordinate of the network editor area, where 1 unit = 1 pixel when zoom = 1.
 
     |text=Get or set the y coordinate of the network editor area, where 1 unit = 1 pixel when zoom = 1.
Line 85: Line 85:
 
     |class=NetworkEditor
 
     |class=NetworkEditor
 
     |name=zoom
 
     |name=zoom
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the zoom factor of the network editor area, where a zoom factor of 1 draws each node at its unscaled resolution.
 
     |text=Get or set the zoom factor of the network editor area, where a zoom factor of 1 draws each node at its unscaled resolution.
Line 101: Line 101:
 
Fit the network area to specified height, specified in node units.  This affects the zoom factor.
 
Fit the network area to specified height, specified in node units.  This affects the zoom factor.
 
  height - The height to fit to.
 
  height - The height to fit to.
 +
}}
 +
{{ClassMethod
 +
    |class=NetworkEditor
 +
    |name=home
 +
    |call=home(zoom=True, op=None)
 +
    |returns=
 +
    |text=:
 +
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)
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 119: Line 134:
 
Home all selected operators in the network.
 
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.
 
  zoom - (Keyword, Optional) When true, the view will be scaled accordingly, otherwise the nodes will only be re-centered.
}}
 
{{ClassMethod
 
    |class=NetworkEditor
 
    |name=home
 
    |call=home(zoom=True, op=None)
 
    |returns=
 
    |text=:
 
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)
 
 
}}}}
 
}}}}
 
<section end=HELPBODY />
 
<section end=HELPBODY />
 
{{History}}
 
{{History}}
 
{{#invoke:Category|list|Python Reference}}
 
{{#invoke:Category|list|Python Reference}}

Revision as of 15:11, 15 September 2017

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[edit]

showBackdropCHOPs(Read Only):

Enable or disable CHOP viewers as backdrops.

showBackdropGeometry(Read Only):

Enable or disable SOP and Geometry object viewers as backdrops.

showBackdropTOPs(Read Only):

Enable or disable TOP viewers as backdrops.

showColorPalette(Read Only):

Enable or disable display of the operator color palette selector.

showDataLinks(Read Only):

Enable or disable disable of operator data links.

showList(Read Only):

Control display of operators as a list, or connected nodes.

showNetworkOverview(Read Only):

Enable or disable display of the network overview.

showParameters(Read Only):

Enable or disable display of the currently selected operator parameters.

straightLinks(Read Only):

Control display of operator links as straight or curved.

x(Read Only):

Get or set the x coordinate of the network editor area, where 1 unit = 1 pixel when zoom = 1.

y(Read Only):

Get or set the y coordinate of the network editor area, where 1 unit = 1 pixel when zoom = 1.

zoom(Read Only):

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[edit]

fitHeight(height):

:

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

height - The height 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)

fitWidth(width):

:

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

width - The width to fit to.

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.

TouchDesigner Build:

A pane type where networks of operators can be created and edited.

An Operator Family which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

An Operator Family that reads, creates and modifies 3D polygons, curves, NURBS surfaces, spheres, meatballs and other 3D surface data.

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.