Difference between revisions of "Pane Class"

From TouchDesigner Documentation
Jump to: navigation, search
(Pane Class Auto Create)
(Pane Class Auto Create)
Line 1: Line 1:
 
{{TDClassSummary|summary=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.}}
 
{{TDClassSummary|summary=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.}}
<section begin=HELPBODY />
+
{{HelpbodyBegin}}
{{ClassMemberSection|empty=}}
+
{{ClassMemberSection|empty=
 +
|Sectionsummary=
 +
|items=
 +
 
{{ClassMember
 
{{ClassMember
 
     |class=Pane
 
     |class=Pane
Line 73: Line 76:
 
     |set=0
 
     |set=0
 
     |text=A unique numeric identifier.
 
     |text=A unique numeric identifier.
}}
+
}}}}
{{ClassMethodSection|empty=}}
+
{{ClassMethodSection|empty=
 +
|Sectionsummary=
 +
|items=
 +
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
Line 85: Line 91:
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=tearAway
+
     |name=close
     |call=tearAway()
+
     |call=close()
 
     |returns=
 
     |returns=
     |text=: -> boolean
+
     |text=:
Detach the pane into a floating window. Returns True if successful.
+
Close the pane.
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=changeType
+
     |name=floatingCopy
     |call=changeType(paneType)
+
     |call=floatingCopy()
 
     |returns=
 
     |returns=
 
     |text=: -> Pane
 
     |text=: -> 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.
+
Return a floating copy of the pane.
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.
 
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=floatingCopy
+
     |name=splitTop
     |call=floatingCopy()
+
     |call=splitTop()
 
     |returns=
 
     |returns=
 
     |text=: -> Pane
 
     |text=: -> Pane
Return a floating copy of the pane.
+
Split the top portion of the pane into a new pane.
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 120: Line 123:
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=close
+
     |name=splitRight
     |call=close()
+
     |call=splitRight()
 
     |returns=
 
     |returns=
     |text=:
+
     |text=: -> Pane
Close the pane.
+
Split the right portion of the pane into a new pane.
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=splitTop
+
     |name=changeType
     |call=splitTop()
+
     |call=changeType(paneType)
 
     |returns=
 
     |returns=
 
     |text=: -> Pane
 
     |text=: -> Pane
Split the top portion of the pane into a new 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.
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Pane
 
     |class=Pane
     |name=splitRight
+
     |name=tearAway
     |call=splitRight()
+
     |call=tearAway()
 
     |returns=
 
     |returns=
     |text=: -> Pane
+
     |text=: -> boolean
Split the right portion of the pane into a new pane.
+
Detach the pane into a floating window. Returns True if successful.
}}
+
}}}}
<section end=HELPBODY />
+
{{{{HelpbodyEnd}}}}
<taggedhistory/>
+
{{{{History}}}}
 
 
 
{{{{#invoke:Category|list|Python Reference}}}}
 
{{{{#invoke:Category|list|Python Reference}}}}

Revision as of 14:51, 14 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]

splitLeft():

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

close():

: Close the pane.

floatingCopy():

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

splitTop():

: -> Pane Split the top portion of the pane into a new 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.

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.

tearAway():

: -> boolean Detach the pane into a floating window. Returns True if successful.

{{{{HelpbodyEnd}}}} {{{{History}}}} {list}

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.