Difference between revisions of "NetworkEditor Class"

From TouchDesigner Documentation
Jump to: navigation, search
(NetworkEditor Class Auto Create)
(NetworkEditor Class Auto Create)
Line 1: Line 1:
 
{{TDClassSummary|summary=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.}}
 
{{TDClassSummary|summary=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.}}
 +
<section begin=HELPBODY />
 
{{ClassMemberSection|empty=}}
 
{{ClassMemberSection|empty=}}
 
{{ClassMember
 
{{ClassMember
Line 128: Line 129:
 
  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.
 
}}
 
}}
 +
<section end=HELPBODY />
 
<taggedhistory/>
 
<taggedhistory/>
  
 
{{{{#invoke:Category|list|Python Reference}}}}
 
{{{{#invoke:Category|list|Python Reference}}}}

Revision as of 10:32, 9 August 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]

fitWidth(width):

:

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

width - The width to fit to.

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)

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:

{list}

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.