Difference between revisions of "Pane Class"

From TouchDesigner Documentation
Jump to: navigation, search
(Pane Class Auto Create)
(Pane Class Auto Create)
Line 8: Line 8:
 
     |class=Pane
 
     |class=Pane
 
     |name=bottomLeft
 
     |name=bottomLeft
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=The coordinates of the bottom left corner, expressed in both pixels and uv offsets, in a named tuple.
 
     |text=The coordinates of the bottom left corner, expressed in both pixels and uv offsets, in a named tuple.
Line 15: Line 15:
 
     |class=Pane
 
     |class=Pane
 
     |name=link
 
     |name=link
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the numeric link index.
 
     |text=Get or set the numeric link index.
Line 22: Line 22:
 
     |class=Pane
 
     |class=Pane
 
     |name=maximize
 
     |name=maximize
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Enable or disable the pane maximize state.
 
     |text=Enable or disable the pane maximize state.
Line 29: Line 29:
 
     |class=Pane
 
     |class=Pane
 
     |name=name
 
     |name=name
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the pane name.
 
     |text=Get or set the pane name.
Line 36: Line 36:
 
     |class=Pane
 
     |class=Pane
 
     |name=owner
 
     |name=owner
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the component this pane points to.
 
     |text=Get or set the component this pane points to.
Line 43: Line 43:
 
     |class=Pane
 
     |class=Pane
 
     |name=ratio
 
     |name=ratio
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=Get or set the split proportion of the pane, if the pane was previously split.
 
     |text=Get or set the split proportion of the pane, if the pane was previously split.
Line 50: Line 50:
 
     |class=Pane
 
     |class=Pane
 
     |name=topRight
 
     |name=topRight
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=The coordinates of the top right corner, expressed in both pixels and uv offsets, in a named tuple.
 
     |text=The coordinates of the top right corner, expressed in both pixels and uv offsets, in a named tuple.
Line 57: Line 57:
 
     |class=Pane
 
     |class=Pane
 
     |name=type
 
     |name=type
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=The enumerated type of the pane. Example: NetworkEditor.
 
     |text=The enumerated type of the pane. Example: NetworkEditor.
Line 73: Line 73:
 
     |class=Pane
 
     |class=Pane
 
     |name=id
 
     |name=id
     |returns=
+
     |type=
 
     |set=0
 
     |set=0
 
     |text=A unique numeric identifier.
 
     |text=A unique numeric identifier.
Line 88: Line 88:
 
     |text=: -> Pane
 
     |text=: -> Pane
 
Return a floating copy of the pane.
 
Return a floating copy of the pane.
 +
}}
 +
{{ClassMethod
 +
    |class=Pane
 +
    |name=close
 +
    |call=close()
 +
    |returns=
 +
    |text=:
 +
Close the pane.
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 99: Line 107:
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=splitTop
+
     |name=splitRight
     |call=splitTop()
+
     |call=splitRight()
 
     |returns=
 
     |returns=
 
     |text=: -> Pane
 
     |text=: -> Pane
Split the top portion of the pane into a new pane.
+
Split the right portion of the pane into a new pane.
}}
 
{{ClassMethod
 
    |class=Pane
 
    |name=close
 
    |call=close()
 
    |returns=
 
    |text=:
 
Close the pane.
 
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 131: Line 131:
 
p = ui.panes[0]
 
p = ui.panes[0]
 
p = p.changeType(PaneType.TOPVIEWER)  #note: must re-assign p to new object.
 
p = p.changeType(PaneType.TOPVIEWER)  #note: must re-assign p to new object.
 +
}}
 +
{{ClassMethod
 +
    |class=Pane
 +
    |name=splitTop
 +
    |call=splitTop()
 +
    |returns=
 +
    |text=: -> Pane
 +
Split the top portion of the pane into a new pane.
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 139: Line 147:
 
     |text=: -> boolean
 
     |text=: -> boolean
 
Detach the pane into a floating window. Returns True if successful.
 
Detach the pane into a floating window. Returns True if successful.
}}
 
{{ClassMethod
 
    |class=Pane
 
    |name=splitRight
 
    |call=splitRight()
 
    |returns=
 
    |text=: -> Pane
 
Split the right portion of the pane into a new pane.
 
 
}}}}
 
}}}}
 
<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 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[edit]

bottomLeft(Read Only):

The coordinates of the bottom left corner, expressed in both pixels and uv offsets, in a named tuple.

link(Read Only):

Get or set the numeric link index.

maximize(Read Only):

Enable or disable the pane maximize state.

name(Read Only):

Get or set the pane name.

owner(Read Only):

Get or set the component this pane points to.

ratio(Read Only):

Get or set the split proportion of the pane, if the pane was previously split.

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

id(Read Only):

A unique numeric identifier.

Methods[edit]

floatingCopy():

: -> Pane Return a floating copy of the pane.

close():

: Close the pane.

splitBottom():

: -> Pane Split the bottom portion of the pane into a new pane.

splitRight():

: -> Pane Split the right portion of the pane into a new pane.

splitLeft():

: -> Pane Split the left portion of the pane into a new pane.

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.

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.

TouchDesigner Build:

A work area in TouchDesigner's layout that includes the Network Editor and 7 other pane types used for different tasks. The TouchDesigner interface can consist of a single pane, or be split into multiple panes.