This class inherits from the DAT class. It references a specific MQTT Client DAT.

For information see MQTT.

Members

isConnected → bool (Read Only):

Return True if connected to a broker, and False if not.

Methods

publish(topic, payload, qos=0, retain=False)→ None:

Publish content to a specific topic.
topic - The topic to publish to.

payload - The actual message to send.

qos - (Keyword, Optional) The quality of service level to use.

retain - (Keyword, Optional) If set to True, the message will be set as the "last known good"retained message for the topic.
n.publish('temperature', b'23')

subscribe(topic, qos=0)→ None:

Subscribe to a specific topic from the broker.
topic - The topic to subscribe to. Multiple topics can be subscribed to at once by providing a list.

qos - (Keyword, Optional) Quality of Service for delivery: At most once (0), At least once (1) or Exactly once (2).
n.subscribe('weather')

unsubscribe(topic)→ None:

Unsubscribe from a previously subscribed topic.
topic - The topic to unsubscribe from. Multiple topics can be unsubscribed from at once by providing a list.
n.unsubscribe('weather')

Callbacks[edit]

The following python callbacks are associated with this operator.

# me - this DAT
# 

# Called when connection established
# dat - the OP which is cooking
def onConnect(dat):
	return

# Called when connection failed
# dat - the OP which is cooking
# msg - reason for failure
def onConnectFailure(dat, msg):
	return

# Called when current connection lost
# dat - the OP which is cooking
# msg - reason for failure
def onConnectionLost(dat, msg):
	return

# Called when server receives subscription request
# dat - the OP which is cooking
def onSubscribe(dat):
	return

# Called when subscription request fails.
# dat - the OP which is cooking
# msg - reason for failure
def onSubscribeFailure(dat, msg):
	return

# Called when server receives unsubscription request
# dat - the OP which is cooking
def onUnsubscribe(dat):
	return

# Called when unsubscription request fails.
# dat - the OP which is cooking
# msg - reason for failure
def onUnsubscribeFailure(dat, msg):
	return

# Called when server receives publish request
# dat - the OP which is cooking
def onPublish(dat):
	return

# Called when new content received from server
# dat - the OP which is cooking
# topic - topic name of the incoming message
# payload - payload of the incoming message
# qos - qos flag for of the incoming message
# retained - retained flag of the incoming message
# dup - dup flag of the incoming message
def onMessage(dat, topic, payload, qos, retained, dup):
	return

DAT Class[edit]

Members

export → bool :

Get or set Export Flag

module → 'module' (Read Only):

Retrieve the contents of the DAT as a module. This allows for functions in the module to be called directly. E.g n.module.function(arg1, arg2)

numRows → int (Read Only):

Number of rows in the DAT table.

numCols → int (Read Only):

Number of columns in the DAT table.

text → str :

Get or set contents. Tables are treated as tab delimited columns, newline delimited rows.

editingFile → str (Read Only):

The path to the current file used by external editors.

isTable → bool (Read Only):

True if the DAT contains table formatted data.

isText → bool (Read Only):

True if the DAT contains text formatted data. (ie, not table formatted).

isEditable → bool (Read Only):

True if the DAT contents can be edited (Text DATs, Table DATs, locked DATs etc).

isDAT → bool (Read Only):

True if the operator is a DAT.

locals → dict (Read Only):

Local dictionary used during python execution of scripts in this DAT. The dictionary attribute is read only, but not its contents. Its contents may be manipulated directly with scripts, or with an Examine DAT.

jsonObject → dict (Read Only):

Parses the DAT as json and returns a python object.

flush()→ None:

Dummy function required to redirect stdout to DATs.

isatty()→ False:

Required to redirect stdout to DATs.

Methods

run(arg1, arg2..., endFrame=False, fromOP=None, asParameter=False, group=None, delayFrames=0, delayMilliSeconds=0, delayRef=me)→ td.Run:

Run the contents of the DAT as a script, returning a Run object which can be used to optionally modify its execution.
arg - (Optional) Arguments that will be made available to the script in a local tuple named args.

endFrame - (Keyword, Optional) If set to True, the execution will be delayed until the end of the current frame.

fromOP - (Keyword, Optional) Specifies an optional operator from which the execution will be run relative to.

asParameter - (Keyword, Optional) When fromOP used, run relative to a parameter of fromOP.

group - (Keyword, Optional) Can be used to specify a group label string. This label can then be used with the td.runs object to modify its execution.

delayFrames - (Keyword, Optional) Can be used to delay the execution a specific amount of frames.

delayMilliSeconds - (Keyword, Optional) Can be used to delay the execution a specific amount of milliseconds. This value is rounded to the nearest frame.

delayRef - (Keyword, Optional) Specifies an optional operator which is controlled by a different Time Component. If your own local timeline is paused, you can point to another timeline to ensure this script will still execute for example.

grab DAT

n = op('text1')

run the DAT

n.run()

run the data with some arguments

r.run('firstArgIsString', secondArgIsVariable) </syntaxhighlight>

save(filepath, append=False, createFolders=False)→ str:

Saves the content of the DAT to the file system. Returns the file path that it was saved to.
filepath - (Optional) The path and filename to save the file to. If this is not given then a default named file will be saved to project.folder

append - (Keyword, Optional) If set to True and the format is txt, then the contents are appended to the existing file.

createFolders - (Keyword, Optional) If True, it creates the not existent directories provided by the filepath.
<syntaxhighlight lang=python> name = n.save() #save in native format with default name n.save('output.txt') #human readable format without channel names n.save('C:/Desktop/myFolder/output.txt', createFolders=True) # supply file path and createFolder flag
</syntaxhighlight>

write(args)→ str:

Append content to this DAT. Can also be used to implement DAT printing functions.
<syntaxhighlight lang=python>

grab DAT
n = op('text1')

append message directly to DAT
n.write('Hello World')

use print method
print('Hello World', file=n)
</syntaxhighlight>

detectLanguage(setLanguage=False)→ str:

Returns the result of attempting to auto-detect the programming language in the DAT based on the contained text.
setLanguage - (Keyword, Optional) If True sets the language parameters on the DAT appropriately

Modifying Content[edit]

The following methods can be used to modify the contents of a DAT. This can be done when the DAT is a Text DAT, or Script DAT for example, or a DAT that is Locked.

clear(keepSize=False, keepFirstRow=False, keepFirstCol=False)→ None:

Remove all rows and columns from the table.
keepSize - (Keyword, Optional) If set to True, size is unchanged, but entries will be set to blank, dependent on other options below.

keepFirstRow - (Keyword, Optional) If set to True, the first row of cells are retained.

keepFirstCol - (Keyword, Optional) If set to True, the first column of cells are retained.
<syntaxhighlight lang=python> n.clear() #remove all rows and columns n.clear(keepSize=True) #set all table cells to blank n.clear(keepFirstRow=True) #remove all rows, but keep the first n.clear(keepFirstRow=True, keepFirstCol=True) #keep the first row, first column, and set remaining cells to blank
</syntaxhighlight>

copy(DAT)→ None:

Copy the text or table from the specified DAT operator.
OP - The DAT operator whose contents should be copied into the DAT.

Modifying Text Content[edit]

When the DAT is not a table, but a block of text, its contents can be simply accessed through its text member. t = op('merge1').text op('text2').text = 'merge1 contains:' + t

op('text3').text = "Hello there!"

Modifying a Single Cell of a Table[edit]

Using DAT[row, column] where row, column specifies which cell to modify. The row and column may be integer numbers starting at 0, or strings which are the column names or row names (in row 0 or column 0 respectively): op('table1')['Monday',1] = 'day1'

tab = op('table1') tab[0,0] = 'corner' tab[1,'select'] = 'yes' tab['Monday',1] = 'day1'

Modifying Table Content[edit]

The following methods can be used to modify the contents of a table type DAT containing rows and columns. This can be done when the DAT is a basic Table DAT, or Script DAT. It can also be used to append rows to FIFO-style DATs such as the Serial DAT.

appendRow(vals, nameOrIndex, sort=None)→ int:

Append a row to the end of the table, or after the specified row name/index. Returns the integer index of the new row.
vals - (Optional) If specified, will fill the row with the given values. It should be a list of items that can be expressed as strings. Each item will be copied to one cell.

nameOrIndex - (Optional) If specified will determine where the new row will be appended. If it's a numeric value it represents the numeric index of the row. If it is a string it represents a row label.

sort - (Keyword, Optional) If specified will determine the column to keep sorted after the insertion. If it's a numeric value it represents the numeric index of the column. If it is a string it represents a column label.
<syntaxhighlight lang=python> n.appendRow() n.appendRow( [1,2,3], 'January' ) #append with values (1,2,3) after the row labelled 'January' n.appendRow( [1,2,3], 5 ) #append row with values (1,2,3) after the row 5. n.appendRow( [1,2,3], sort='Month' ) #append row with values (1,2,3) keeping column 'Month' sorted.
</syntaxhighlight>

appendRows(vals, nameOrIndex, sort=None)→ int:

Append rows to the end of the table, or after the specified row name/index. Returns the integer of the last row appended.
vals - (Optional) If specified, will fill the rows with the given values. It should be a list of lists of items that can be expressed as strings. Each item will be copied to one cell.

nameOrIndex - (Optional) If specified will determine where the new row will be appended. If it's a numeric value it represents the numeric index of the row. If it is a string it represents a row label.

sort - (Keyword, Optional) If specified will determine the column to keep sorted after the insertion. If it's a numeric value it represents the numeric index of the column. If it is a string it represents a column label.
<syntaxhighlight lang=python>n.appendRows() n.appendRows( [[1,2,3],[4,5,6,7]], 'January' ) #after the row labelled 'January append 2 rows: first one with values (1,2,3), then one with values (4,5,6,7) n.appendRows( 1,2,3, 5 ) # after row 5 append one row with values (1,2,3).
n.appendRows( [1,2,3] ) # append 3 rows with values 1, 2, 3 respectively.</syntaxhighlight>

appendCol(vals, nameOrIndex, sort=None)→ int:

Append a column to the end of the table. See appendRow for similar usage.

appendCols(vals, nameOrIndex, sort=None)→ int:

Append columns to the end of the table. See appendRows for similar usage.

insertRow(vals, nameOrIndex, sort=None)→ int:

Insert a row to the beginning of the table or before the specified row name/index. See DAT.appendRow() for similar usage.

insertCol(vals, nameOrIndex, sort=None)→ int:

Insert a column to the beginning of the table or before the specified row name/index. See DAT.appendRow() for similar usage.

replaceRow(nameOrIndex, vals, entireRow=True)→ int:

Replaces the contents of an existing row.
nameOrIndex - Specifies the row that will be replaced. If it's a numeric value it represents the numeric index of the row. If it is a string it represents a row label.

vals - (Optional) If specified, will overwrite the row with the given values. It should be a list of lists of items that can be expressed as strings. Each item will be copied to one cell.

entireRow - (Keyword, Optional) If True, overwrites every cell in the specified row. If False, will only overwrite as many cells in the row as there are items in vals.
<syntaxhighlight lang=python> n.replaceRow(0) # will empty all the cells in row 0 (ie. replaced with nothing) n.replaceRow('January', ['January', 1,2,3]) # the row 'January' will be replaced with the list of 4 items.
n.replaceRow(2, [1,2,3], entireRow=False) # at row 2 the 3 items will replace the first 3 items in the row.</syntaxhighlight>

replaceCol(nameOrIndex, vals, entireCol=True)→ int:

Replaces the contents of an existing column. See DAT.replaceRow for similar usage.

deleteRow(nameOrIndex)→ None:

Delete a single row at the specified row name or index.
nameOrIndex - May be a string for a row name, or numeric index for rowindex.

deleteRows(vals)→ None:

Deletes multiple rows at the row names or indices specified in vals.
vals - If specified, will delete each row given. It should be a list of items that can be expressed as strings. If no vals is provided deleteRows does nothing.

deleteCol(nameOrIndex)→ None:

Delete a single column at the specified column name or index.
nameOrIndex - May be a string for a column name, or numeric index for column index.

deleteCols(vals)→ None:

Deletes multiple columns at the column names or indices specified in vals.
vals - If specified, will delete each column given. It should be a list of items that can be expressed as strings. If no vals is provided deleteCols does nothing.

setSize(numrows, numcols)→ None:

Set the exact size of the table.
numrows - The number of rows the table should have.

numcols - The number of columns the table should have.

scroll(row, col)→ None:

Bring current DAT viewers to the specified row and column
row - Row to scroll to.

col - (Optional) Column to scroll to for tables.

Accessing Table Content[edit]

[rowNameOrIndex, colNameOrIndex]→ td.Cell:

cells in a table may be accessed with the [] subscript operator.
The NameOrIndex may be an exact string name, or it may be a numeric index value. Pattern Matching is not supported.

rowNameOrIndex - If a string it specifies a row name, if it's numeric it specifies a row index.

colNameOrIndex - If a string it specifies a column name, if it's numeric it specifies a column index.
<syntaxhighlight lang=python> c = n[4, 'June'] c = n[3, 4]
</syntaxhighlight>

cell(rowNameOrIndex, colNameOrIndex, caseSensitive=True, val=False)→ td.Cell | str | None:

Find a single cell in the table, or None if none are found.
rowNameOrIndex/colNameOrIndex - If a string it specifies a row/column name. If it's numeric it specifies a row/column index. Pattern Matching is supported for strings.

caseSensitive - (Optional) Specifies whether or not case sensitivity is used.

val - (Keyword, Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.
<syntaxhighlight lang=python> c = n.cell(5, 'June') #Return a cell under row 5, column 'June'. c = n.cell('A*', 2) #Find a cell under any row beginning with an A, in column 2. c = n.cell('A*', 2, val=True) #Return the str type of the found cell
</syntaxhighlight>

cells(rowNameOrIndex, colNameOrIndex, caseSensitive=True, val=False)→ list:

Returns a (possibly empty) list of cells that match the given row/column names or indices. See DAT.cell method for similar usage.

findCell(pattern, rows=None, cols=None, valuePattern=True, rowPattern=True, colPattern=True, caseSensitive=False, val=False)→ Cell | str | None:

Returns a cell that matches the given pattern and row/column names or indices or None if no match is found.
pattern - The pattern to match a cell.

rows (Keyword, Optional) - If specified, looks for cell only in the specified rows. Must be specified as a list.

cols (Keyword, Optional) - If specified, looks for cell only in the specified columns. Must be specified as a list.

valuePattern, rowPattern, colPattern(Keyword, Optional) - If specified and set to False, disables pattern matching for a cell, rows or columns.

caseSensitive(Keyword, Optional) - Cell matching is case sensitive if set to true.

val - (Keyword, Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.
<syntaxhighlight lang=python>

given a table "table1":

# id # fruit # color #

# 0 # Strawberry # Red #

# 1 # Banana # Yellow #

# 2 # Cucumber # Green #

# 3 # Blueberry # Blue #

# 4 # Clementine # Orange #

# 5 # *Fruit # Green #
t is the reference to a table DAT
t = op('/project1/table1')

search for any cell with the value 'Red'

will return type:Cell cell:(1, 2) owner:/project1/table1 value:Red
t.findCell('Red')

search for any cell in the column 'fruit' with a value starting with 'blue'

will return type:Cell cell:(4, 1) owner:/project1/table1 value:Blueberry
t.findCell('blue*',cols=['fruit'])

search for any cell in the column 'fruit' with a value starting with 'blue'

with case-sensitive search enabled

will return None
t.findCell('blue*',cols=['fruit'], caseSensitive=True)

will return type:Cell cell:(0, 1) owner:/project1/table1 value:fruit

as the '*' in the search pattern will be used to pattern match, the

first row of the second column is matched
t.findCell('*Fruit')

will return type:Cell cell:(6, 1) owner:/project1/table1 value:*Fruit

as pattern matching for the search pattern is disabled

hence the '*' is not interpreted as a pattern but a string to look for
t.findCell('*Fruit', valuePattern=False)

search for any cell with the pattern '*Fruit'

will return the str of the found cell, say 'SweetFruit'
t.findCell('*Fruit', val=True)
</syntaxhighlight>

findCells(pattern, rows=None, cols=None, valuePattern=True, rowPattern=True, colPattern=True, val=False)→ list:

Returns a (possibly empty) list of cells that match the given patterns and row/column names or indices.
pattern - The pattern to match cells.

rows (Keyword, Optional) - If specified, looks for cells only in the specified rows.

cols (Keyword, Optional) - If specified, looks for cells only in the specified columns.

valuePattern, rowPattern, colPattern(Keyword, Optional) - If specified, overrides pattern matching for cells, rows or columns.

caseSensitive(Keyword, Optional) - Cell matching is case sensitive if set to true.

val - (Keyword, Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.

row(*nameOrIndexes, caseSensitive=True, val=False)→ List[Cell]:

Returns a list of cells from the first row matching the name/index, or None if nothing is found.
nameOrIndexes - Include any number of these. If a string it specifies a row name, if it's numeric it specifies a row index. Pattern Matching is supported.

caseSensitive - (Optional) Specifies whether or not case sensitivity is used.

val - (Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.
See DAT.col() for similar usage. <syntaxhighlight lang=python> r = op('table1').row(3, caseSensitive=False) r = op('table1').row('June') r = op('table1').row('A*', 'B*') #returns first row beginning with A or B r = op('table1').row('June', val=True) #returns list of all strings stored under the row 'June'
</syntaxhighlight>

rows(*nameOrIndexes, caseSensitive=True, val=False)→ List[List[Cell]]:

Returns a (possibly empty) list of rows (each row being a list of cells). If no arguments are given it returns all rows in the table.
nameOrIndexes - (Optional) Include any number of these. If a string it specifies a row name, if it's numeric it specifies a row index. Pattern Matching is supported.

caseSensitive - (Optional) Specifies whether or not case sensitivity is used.

val - (Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.
See DAT.rows() for similar usage. <syntaxhighlight lang=python> for r in op('table1').rows(): # do something with row 'r'
for r in op('table1').rows(val=True): # do something with the strings values of the row 'r'
</syntaxhighlight>

col(*nameOrIndexes, caseSensitive=True, val=False)→ list:

Returns a list of cells from the first col matching the name/index, or None if nothing is found.
nameOrIndexes - Include any number of these. If a string it specifies a column name, if it's numeric it specifies a column index. Pattern Matching is supported.

caseSensitive - (Optional) Specifies whether or not case sensitivity is used.

val - (Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.
<syntaxhighlight lang=python> r = op('table1').col(3, caseSensitive=False) r = op('table1').col('June') r = op('table1').col('A*', 'B*') #returns first column beginning with A or B r = op('table1').col('June', val=True) #returns list of all strings stored under the column 'June'
</syntaxhighlight>

cols(*nameOrIndexes, caseSensitive=True, val=False)→ List[List[Cell]]:

Returns a (possibly empty) list of columns (each being a list themselves). If no arguments are given then all columns in the table are returned.
nameOrIndexes - (Optional) Include any number of these. If a string it specifies a column name, if it's numeric it specifies a column index. Pattern Matching is supported.

caseSensitive - (Optional) Specifies whether or not case sensitivity is used.

val - (Optional) If set to true, returns list of cell item strings instead of list of Cell Class items.
<syntaxhighlight lang=python> for c in op('table1').cols(): # do something with each column 'c'
for c in op('table1').cols(val=True): # do something with the string values in each column 'c'
</syntaxhighlight>

OP Class[edit]

Members

General[edit]

valid → bool (Read Only):

True if the referenced operator currently exists, False if it has been deleted.

id → int (Read Only):

Unique id for the operator. This id can also be passed to the op() and ops() methods. Id's are not consistent when a file is re-opened, and will change if the OP is copied/pasted, changes OP types, deleted/undone. The id will not change if the OP is renamed though. Its data type is integer.

name → str :

Get or set the operator name.

path → str (Read Only):

Full path to the operator.

digits → int (Read Only):

Returns the numeric value of the last consecutive group of digits in the name, or None if not found. The digits can be in the middle of the name if there are none at the end of the name.

base → str (Read Only):

Returns the beginning portion of the name occurring before any digits.

passive → bool (Read Only):

If true, operator will not cook before its access methods are called. To use a passive version of an operator n, use passive(n).

curPar → td.Par (Read Only):

The parameter currently being evaluated. Can be used in a parameter expression to reference itself. An easy way to see this is to put the expression curPar.name in any string parameter.

curBlock → (Read Only):

The SequenceBlock of the parameter currently being evaluated. Can be used in a parameter expression to reference itself.

curSeq → Sequence (Read Only):

The Sequence of the parameter currently being evaluated. Can be used in a parameter expression to reference itself.

time → OP (Read Only):

Time Component that defines the operator's time reference.

ext → class (Read Only):

The object to search for parent extensions.
me.ext.MyClass

fileFolder → str (Read Only):

Returns the folder where this node is saved.

filePath → str (Read Only):

Returns the file location of this node.

mod → mod (Read Only):

Get a module on demand object that searches for DAT modules relative to this operator.

pages → list (Read Only):

A list of all built-in pages.

parGroup → tuple (Read Only):

An intermediate parameter collection object, from which a specific parameter group can be found.
n.parGroup.t
# or
n.parGroup['t']

par → td.Par (Read Only):

An intermediate parameter collection object, from which a specific parameter can be found.
n.par.tx
# or
n.par['tx']

builtinPars → list or par (Read Only):

A list of all built-in parameters.

customParGroups → list of parGroups (Read Only):

A list of all ParGroups, where a ParGroup is a set of parameters all drawn on the same line of a dialog, sharing the same label.

customPars → list of par (Read Only):

A list of all custom parameters.

customPages → list (Read Only):

A list of all custom pages.

replicator → OP or None (Read Only):

The replicatorCOMP that created this operator, if any.

storage → dict (Read Only):

Storage is dictionary associated with this operator. Values stored in this dictionary are persistent, and saved with the operator. The dictionary attribute is read only, but not its contents. Its contents may be manipulated directly with methods such as OP.fetch() or OP.store() described below, or examined with an Examine DAT.

tags → list :

Get or set a set of user defined strings. Tags can be searched using OP.findChildren() and the OP Find DAT.
The set is a regular python set, and can be accessed accordingly:
n.tags = ['effect', 'image filter']
n.tags.add('darken')

children → list (Read Only):

A list of operators contained within this operator. Only component operators have children, otherwise an empty list is returned.

numChildren → int (Read Only):

Returns the number of children contained within the operator. Only component operators have children.

numChildrenRecursive → int (Read Only):

Returns the number of operators contained recursively within this operator. Only component operators have children.

op → OP or None (Read Only):

The operator finder object, for accessing operators through paths or shortcuts. Note: a version of this method that searches relative to '/' is also in the global td module.
op(pattern1, pattern2..., includeUtility=False) → OP or None
Returns the first OP whose path matches the given pattern, relative to the inside of this operator. Will return None if nothing is found. Multiple patterns may be specified which are all added to the search. Numeric OP ids may also be used.

pattern - Can be string following the Pattern Matching rules, specifying which OP to return, or an integer, which must be an OP Id. Multiple patterns can be given, the first matching OP will be returned.

includeUtility (Optional) - if True, allow Utility nodes to be returned. If False, Utility nodes will be ignored.
b = op('project1')
b = op('foot*', 'hand*') #comma separated
b = op('foot* hand*')  #space separated
b = op(154)
op.shortcut → OP
An operator specified with by a Global OP Shortcut. If no operator exists an exception is raised. These shortcuts are global, and must be unique. That is, cutting and pasting an operator with a Global OP Shortcut specified will lead to a name conflict. One shortcut must be renamed in that case. Furthermore, only components can be given Global OP Shortcuts.
shortcut - Corresponds to the Global OP Shortcut parameter specified in the target operator.
b = op.Videoplayer
To list all Global OP Shortcuts:
for x in op:
	print(x)

opex → OP (Read Only):

An operator finder object, for accessing operators through paths or shortcuts. Works like the op() shortcut method, except it will raise an exception if it fails to find the node instead of returning None as op() does. This is now the recommended way to get nodes in parameter expressions, as the error will be more useful than, for example, NoneType has no attribute "par", that is often seen when using op(). Note: a version of this method that searches relative to '/' is also in the global td module.
op(pattern1, pattern2..., includeUtility=False) → OP

Returns the first OP whose path matches the given pattern, relative to the inside of this operator. Will return None if nothing is found. Multiple patterns may be specified which are all added to the search. Numeric OP ids may also be used.

pattern - Can be string following the Pattern Matching rules, specifying which OP to return, or an integer, which must be an OP Id. Multiple patterns can be given, the first matching OP will be returned.

includeUtility (Optional) - if True, allow Utility nodes to be returned. If False, Utility operators will be ignored.

parent → Shortcut (Read Only):

The Parent Shortcut object, for accessing parent components through indices or shortcuts.
Note: a version of this method that searches relative to the current operator is also in the global td module.
parent(n) → OP or None
The nth parent of this operator. If n not specified, returns the parent. If n = 2, returns the parent of the parent, etc. If no parent exists at that level, None is returned.

n - (Optional) n is the number of levels up to climb. When n = 1 it will return the operator's parent.
p = parent(2) #grandfather
parent.shortcut → OP
A parent component specified with a shortcut. If no parent exists an exception is raised.

shortcut - Corresponds to the Parent Shortcut parameter specified in the target parent.
n = parent.Videoplayer
See also Parent Shortcut for more examples.

iop → OP (Read Only):

The Internal Operator Shortcut object, for accessing internal shortcuts. See also Internal Operators. Note: a version of this method that searches relative to the current operator is also in the global td Module.

ipar → ParCollection (Read Only):

The Internal Operator Parameter Shortcut object, for accessing internal shortcuts. See also Internal Parameters. Note: a version of this method that searches relative to the current operator is also in the global td Module.

currentPage → Page :

Get or set the currently displayed parameter page. It can be set by setting it to another page or a string label.
n.currentPage = 'Common'

Common Flags[edit]

The following methods get or set specific operator Flags. Note specific operators may contain other flags not in this section.

activeViewer → bool :

Get or set Viewer Active Flag.

allowCooking → bool :

Get or set Cooking Flag. Only COMPs can disable this flag.

bypass → bool :

Get or set Bypass Flag.

cloneImmune → bool :

Get or set Clone Immune Flag.

current → bool :

Get or set Current Flag.

display → bool :

Get or set Display Flag.

expose → bool :

Get or set the Expose Flag which hides a node from view in a network.

lock → bool :

Get or set Lock Flag.

selected → bool :

Get or set Selected Flag. This controls if the node is part of the network selection. (yellow box around it).

seq → (Read Only):

An intermediate sequence collection object, from which a specific sequence group can be found.
n.seq.Color #raises Exception if not found.
# or
n.seq['Color'] #returns None if not found.

python → bool :

Get or set parameter expression language as python.

render → bool :

Get or set Render Flag.

showCustomOnly → bool :

Get or set the Show Custom Only Flag which controls whether or not non custom parameters are display in parameter dialogs.

showDocked → bool :

Get or set Show Docked Flag. This controls whether this node is visible or hidden when it is docked to another node.

viewer → bool :

Get or set Viewer Flag.

Appearance[edit]

color → tuple(r, g, b) :

Get or set color value, expressed as a 3-tuple, representing its red, green, blue values. To convert between color spaces, use the built in colorsys module.

comment → str :

Get or set comment string.

nodeHeight → int :

Get or set node height, expressed in network editor units.

nodeWidth → int :

Get or set node width, expressed in network editor units.

nodeX → int :

Get or set node X value, expressed in network editor units, measured from its left edge.

nodeY → int :

Get or set node Y value, expressed in network editor units, measured from its bottom edge.

nodeCenterX → int :

Get or set node X value, expressed in network editor units, measured from its center.

nodeCenterY → int :

Get or set node Y value, expressed in network editor units, measured from its center.

dock → OP :

Get or set the operator this operator is docked to. To clear docking, set this member to None.

docked → list (Read Only):

The (possibly empty) list of operators docked to this node.

Connection[edit]

See also the OP.parent methods. To connect components together see COMP_Class#Connection section.

inputs → list (Read Only):

List of input operators (via left side connectors) to this operator. To get the number of inputs, use len(OP.inputs).

outputs → list (Read Only):

List of output operators (via right side connectors) from this operator.

inputConnectors → list (Read Only):

List of input connectors (on the left side) associated with this operator.

outputConnectors → list (Read Only):

List of output connectors (on the right side) associated with this operator.

Cook Information[edit]

cookFrame → float (Read Only):

Last frame at which this operator cooked.

cookTime → float (Read Only):

Deprecated Duration of the last measured cook (in milliseconds).

cpuCookTime → float (Read Only):

Duration of the last measured cook in CPU time (in milliseconds).

cookAbsFrame → float (Read Only):

Last absolute frame at which this operator cooked.

cookStartTime → float (Read Only):

Last offset from frame start at which this operator cook began, expressed in milliseconds.

cookEndTime → float (Read Only):

Last offset from frame start at which this operator cook ended, expressed in milliseconds. Other operators may have cooked between the start and end time. See the cookTime member for this operator's specific cook duration.

cookedThisFrame → bool (Read Only):

True when this operator has cooked this frame.

cookedPreviousFrame → bool (Read Only):

True when this operator has cooked the previous frame.

childrenCookTime → float (Read Only):

Deprecated The total accumulated cook time of all children of this operator during the last frame. Zero if the operator is not a COMP and/or has no children.

childrenCPUCookTime → float (Read Only):

The total accumulated cook time of all children of this operator during the last frame. Zero if the operator is not a COMP and/or has no children.

childrenCookAbsFrame → float (Read Only):

Deprecated The absolute frame on which childrenCookTime is based.

childrenCPUCookAbsFrame → float (Read Only):

The absolute frame on which childrenCPUCookTime is based.

gpuCookTime → float (Read Only):

Duration of GPU operations during the last measured cook (in milliseconds).

childrenGPUCookTime → float (Read Only):

The total accumulated GPU cook time of all children of this operator during the last frame. Zero if the operator is not a COMP and/or has no children.

childrenGPUCookAbsFrame → float (Read Only):

The absolute frame on which childrenGPUCookTime is based.

totalCooks → int (Read Only):

Number of times the operator has cooked.

cpuMemory → int (Read Only):

The approximate amount of CPU memory this Operator is using, in bytes.

gpuMemory → int (Read Only):

The amount of GPU memory this OP is using, in bytes.

Type[edit]

type → str (Read Only):

Operator type as a string. Example: 'oscin'.

subType → str (Read Only):

Operator subtype. Currently only implemented for components. May be one of: 'panel', 'object', or empty string in the case of base components.

OPType → str (Read Only):

Python operator class type, as a string. Example: 'oscinCHOP'. Can be used with COMP.create() method.

label → str (Read Only):

Operator type label. Example: 'OSC In'.

icon → str (Read Only):

Get the letters used to create the operator's icon.

family → str (Read Only):

Operator family. Example: CHOP. Use the global dictionary families for a list of each operator type.

isFilter → bool (Read Only):

True if operator is a filter, false if it is a generator.

minInputs → int (Read Only):

Minimum number of inputs to the operator.

maxInputs → int (Read Only):

Maximum number of inputs to the operator.

isMultiInputs → bool (Read Only):

True if inputs are ordered, false otherwise. Operators with an arbitrary number of inputs have unordered inputs, example Merge CHOP.

visibleLevel → int (Read Only):

Visibility level of the operator. For example, expert operators have visibility level 1, regular operators have visibility level 0.

isBase → bool (Read Only):

True if the operator is a Base (miscellaneous) component.

isCHOP → bool (Read Only):

True if the operator is a CHOP.

isCOMP → bool (Read Only):

True if the operator is a component.

isDAT → bool (Read Only):

True if the operator is a DAT.

isMAT → bool (Read Only):

True if the operator is a Material.

isObject → bool (Read Only):

True if the operator is an object.

isPanel → bool (Read Only):

True if the operator is a Panel.

isSOP → bool (Read Only):

True if the operator is a SOP.

isTOP → bool (Read Only):

True if the operators is a TOP.

licenseType → str (Read Only):

Type of License required for the operator.

Methods

General[edit]

NOTE: create(), copy() and copyOPs() is done by the parent operator (a component). For more information see COMP.create, COMP.copy and COMP.copyOPs methods.

pars(pattern)→ list:

Returns a (possibly empty) list of parameter objects that match the pattern.
pattern - Is a string following the Pattern Matching rules, specifying which parameters to return.
newlist = op('geo1').pars('t?', 'r?', 's?') #translate/rotate/scale parameters
Note: If searching for a single parameter given a name, it's much more efficient to use the subscript operator. For example:
name = 'MyName1'
op('geo1').par[name]

cook(force=False, recurse=False, includeUtility=False)→ None:

Cook the contents of the operator if required.
force - (Keyword, Optional) If True, the operator will always cook, even if it wouldn't under normal circumstances.

recurse - (Keyword, Optional) If True, all children and sub-children of the operator will be cooked.

includeUtility - (Keyword, Optional) If specified, controls whether or not utility components (eg Comments) are included in the results.

copyParameters(OP, custom=True, builtin=True)→ None:

Copy all of the parameters from the specified operator. Both operators should be the same type.
OP - The operator to copy.

custom - (Keyword, Optional) When True, custom parameters will be copied.

builtin - (Keyword, Optional) When True, built in parameters will be copied.
op('geo1').copyParameters( op('geo2') )

changeType(OPtype)→ OP:

Change referenced operator to a new operator type. After this call, this OP object should no longer be referenced. Instead use the returned OP object.
OPtype - The python class name of the operator type you want to change this operator to. This is not a string, but instead is a class defined in the global td module.
n = op('wave1').changeType(nullCHOP) #changes 'wave1' into a Null CHOP
n = op('text1').changeType(tcpipDAT) #changes 'text1' operator into a TCPIP DAT

dependenciesTo(OP)→ list:

Returns a (possibly empty) list of operator dependency paths between this operator and the specified operator. Multiple paths may be found.

evalExpression(str)→ value:

Evaluate the expression from the context of this OP. Can be used to evaluate arbitrary snippets of code from arbitrary locations.
str - The expression to evaluate.
op('wave1').evalExpression('me.digits')  #returns 1
If the expression already resides in a parameter, use that parameters evalExpression() method instead.

destroy()→ None:

Destroy the operator referenced by this OP. An exception will be raised if the OP's operator has already been destroyed.

var(name, search=True)→ str:

Evaluate a variable. This will return the empty string, if not found. Most information obtained from variables (except for Root and Component variables) are accessible through other means in Python, usually in the global td module.
name - The variable name to search for.

search - (Keyword, Optional) If set to True (which is default) the operator hierarchy is searched until a variable matching that name is found. If false, the search is constrained to the operator.

openMenu(x=None, y=None)→ None:

Open a node menu for the operator at x, y. Opens at mouse if x & y are not specified.
为操作员在 x, y 处打开一个节点菜单。如果 x 和 y 未指定，则会在鼠标位置打开。
x - (Keyword, Optional) The X coordinate of the menu, measured in screen pixels.
x - (关键字, 可选) 菜单的 X 坐标，以屏幕像素为单位。

y - (Keyword, Optional) The Y coordinate of the menu, measured in screen pixels.
y - (关键字, 可选) 菜单的 Y 坐标，以屏幕像素为单位。

relativePath(OP)→ str:

Returns the relative path from this operator to the OP that is passed as the argument. See OP.shortcutPath for a version using expressions.
返回此操作符到作为参数传递的 OP 的相对路径。参见 OP.shortcutPath，该版本使用表达式。

setInputs(listOfOPs)→ None:

Set all the operator inputs to the specified list.
将所有操作符输入设置为指定的列表。
listOfOPs - A list containing one or more OPs. Entries in the list can be None to disconnect specific inputs. An empty list disconnects all inputs.
listOfOPs - 包含一个或多个 OP 的列表。列表中的条目可以是 None 以断开特定输入。空列表断开所有输入。

shortcutPath(OP, toParName=None)→ str:

Returns an expression from this operator to the OP that is passed as the argument. See OP.relativePath for a version using relative path constants.
返回一个从该操作员到作为参数传递的 OP 的表达式。有关使用相对路径常量的版本，请参阅 OP.relativePath。
toParName - (Keyword, Optional) Return an expression to this parameter instead of its operator.
toParName - (关键字，可选) 将表达式返回到此参数而不是其操作符。

ops(pattern1, pattern2.., includeUtility=False)→ list of OPs:

Returns a (possibly empty) list of OPs that match the patterns, relative to the inside of this OP.
返回一个（可能为空）的 OP 列表，这些 OP 与模式匹配，相对于此 OP 内部。
Multiple patterns may be provided. Numeric OP ids may also be used.
可以提供多个模式。也可以使用数值 OP ID。

pattern - Can be string following the Pattern Matching rules, specifying which OPs to return, or an integer, which must be an OP Id. Multiple patterns can be given and all matched OPs will be returned.
pattern - 可以是遵循模式匹配规则的字符串，指定要返回哪些 OP，或是一个整数，必须是 OP ID。可以给出多个模式，所有匹配的 OP 都将被返回。

includeUtility - (Keyword, Optional) If specified, controls whether or not utility components (eg Comments) are included in the results.
includeUtility - (关键字，可选) 如果指定，则控制是否在结果中包含实用组件（例如注释）。
Note: a version of this method that searches relative to '/' is also in the global td module.
注意：还有一个相对于'/'进行搜索的此方法版本也在全局 td 模块中。
newlist = n.ops('arm*', 'leg*', 'leg5/foot*')

resetPars(parNames='*', parGroupNames='*', pageNames='*', includeBuiltin=True, includeCustom=True)→ bool:

Resets the specified parameters in the operator.
重置操作符中指定的参数。
Returns true if anything was changed.
如果任何内容被更改，则返回 true。

parNames (Keyword, Optional) - Specify parameters by Par name.
parNames（关键字，可选）- 通过 Par 名称指定参数。

parGroupNames (Keyword, Optional) - Specify parameters by ParGroup name.
parGroupNames（关键字，可选）- 通过 ParGroup 名称指定参数。

pageNames (Keyword, Optional) - Specify parameters by page name.
pageNames（关键字，可选）- 通过页面名称指定参数。

includeBuiltin (Keyword, Optional) - Include builtin parameters.
includeBuiltin（关键字，可选）- 包含内置参数。

includeCustom (Keyword, Optional) - Include custom parameters.
includeCustom (关键字，可选) - 包含自定义参数。
op('player').resetPars(includeBuiltin=False) # only reset custom

Errors 错误[edit]

addScriptError(msg)→ None:

Adds a script error to a node.
向节点添加脚本错误。
msg - The error to add.
msg - 要添加的错误。

addError(msg)→ None:

Adds an error to an operator. Only valid if added while the operator is cooking. (Example Script SOP, CHOP, DAT).
向操作器添加错误。仅在操作器正在处理时有效。（例如 Script SOP, CHOP, DAT）。
msg - The error to add.
msg - 要添加的错误。

addWarning(msg)→ None:

Adds a warning to an operator. Only valid if added while the operator is cooking. (Example Script SOP, CHOP, DAT).
向操作器添加警告。仅在操作器正在处理时有效。（例如 Script SOP, CHOP, DAT）。
msg - The error to add.
msg - 要添加的错误。

errors(recurse=False)→ str:

Get error messages associated with this OP.
获取与此 OP 相关的错误消息。
recurse - Get errors in any children or subchildren as well.
递归 - 获取任何子节点或子子节点的错误。

warnings(recurse=False)→ str:

Get warning messages associated with this OP.
获取与此 OP 相关的警告消息。
recurse - Get warnings in any children or subchildren as well.
递归 - 获取任何子节点或子子节点的警告。

scriptErrors(recurse=False)→ str:

Get script error messages associated with this OP.
获取与此操作器关联的脚本错误消息。
recurse - Get errors in any children or subchildren as well.
递归 - 获取任何子节点或子子节点的错误。

clearScriptErrors(recurse=False, error='*')→ None:

Clear any errors generated during script execution. These may be generated during execution of DATs, Script Nodes, Replicator COMP callbacks, etc.
清除脚本执行期间生成的任何错误。这些错误可能在 DAT 执行、Script 节点、Replicator COMP 回调等过程中生成。
recurse - Clear script errors in any children or subchildren as well.
recurse - 同时清除所有子节点或子子节点的脚本错误。

error - Pattern to match when clearing errors
error - 清除错误时匹配的模式
op('/project1').clearScriptErrors(recurse=True)

childrenCPUMemory()→ int:

Returns the total CPU memory usage for all the children from this COMP.
返回此 COMP 所有子节点的总 CPU 内存使用量。

childrenGPUMemory()→ int:

Returns the total GPU memory usage for all the children from this COMP.
返回此 COMP 所有子级的总 GPU 内存使用情况。

Appearance 外观[edit]

resetNodeSize()→ None:

Reset the node tile size to its default width and height.
将节点瓦片大小重置为其默认宽度和高度。

Viewers 查看器[edit]

closeViewer(topMost=False)→ None:

Close the floating content viewers of the OP.
关闭 OP 的浮动内容查看器。
topMost - (Keyword, Optional) If True, any viewer window containing any parent of this OP is closed instead.
topMost - (关键字，可选) 如果为 True，则关闭包含此 OP 任何父级的任何查看器窗口。
op('wave1').closeViewer()
op('wave1').closeViewer(topMost=True) # any viewer that contains 'wave1' will be closed.

openViewer(unique=False, borders=True)→ None:

Open a floating content viewer for the OP.
为 OP 打开浮动内容查看器。
unique - (Keyword, Optional) If False, any existing viewer for this OP will be re-used and popped to the foreground. If unique is True, a new window is created each time instead.
unique - (关键字，可选) 如果为 False，将重用此 OP 的现有查看器并将其带到前台。如果 unique 为 True，则每次都会创建一个新窗口。

borders - (Keyword, Optional) If true, the floating window containing the viewer will have borders.
borders - (关键字，可选) 如果为 true，包含查看器的浮动窗口将有边框。
op('geo1').openViewer(unique=True, borders=False) # opens a new borderless viewer window for 'geo1'

resetViewer(recurse=False)→ None:

Reset the OP content viewer to default view settings.
将 OP 内容查看器重置为默认视图设置。
recurse - (Keyword, Optional) If True, this is done for all children and sub-children as well.
recurse - (关键字，可选) 如果为 True，这将应用于所有子项和子子项。
op('/').resetViewer(recurse=True) # reset the viewer for all operators in the entire file.

openParameters()→ None:

Open a floating dialog containing the operator parameters.
打开一个包含操作参数的浮动对话框。

Storage 存储[edit]

Storage can be used to keep data within components. Storage is implemented as one python dictionary per node.
Storage 可用于在组件中保存数据。Storage 以每个节点一个 Python 字典的形式实现。

When an element of storage is changed by using n.store() as explained below, expressions and operators that depend on it will automatically re-cook. It is retrieved with the n.fetch() function.
当使用 n.store() （如下方所述）更改 Storage 的元素时，依赖于它的表达式和操作将自动重新计算。它通过 n.fetch() 函数获取。

Storage is saved in .toe and .tox files and restored on startup.
Storage 保存在 .toe 和 .tox 文件中，并在启动时恢复。

Storage can hold any python object type (not just strings as in Tscript variables). Storage elements can also have optional startup values, specified separately. Use these startup values for example, to avoid saving and loading some session specific object, and instead save or load a well defined object like None.
存储可以包含任何 Python 对象类型（不仅限于字符串，如 Tscript 变量中的情况）。存储元素还可以具有可选的启动值，这些值可以单独指定。例如，使用这些启动值来避免保存和加载某些特定会话的对象，而是保存或加载一个定义良好的对象，如 None 。

See the Examine DAT for procedurally viewing the contents of storage.
查看存储内容，请参阅 Examine DAT 以进行程序化查看。

fetch(key, default, search=True, storeDefault=False)→ value:

Return an object from the OP storage dictionary. If the item is not found, and a default it supplied, it will be returned instead.
从 OP 存储字典中返回一个对象。如果未找到该条目，并且提供了默认值，则将返回默认值。
key - The name of the entry to retrieve.
key - 要检索的条目的名称。

default - (Optional) If provided and no item is found then the passed value/object is returned instead.
默认值 - （可选）如果提供且未找到项，则返回传递的值/对象。

storeDefault - (Keyword, Optional) If True, and the key is not found, the default is stored as well.
存储默认值 - （关键字，可选）如果为 True，且未找到键，则将默认值也存储。

search - (Keyword, Optional) If True, the parent of each OP is searched recursively until a match is found
搜索 - （关键字，可选）如果为 True，则递归搜索每个 OP 的父级，直到找到匹配项。
v = n.fetch('sales5', 0.0)

fetchOwner(key)→ OP:

Return the operator which contains the stored key, or None if not found.
返回包含存储键的操作符，如果未找到则返回 None。
key - The key to the stored entry you are looking for.
key - 你要查找的存储条目的键。
who = n.fetchOwner('sales5') #find the OP that has a storage entry called 'sales5'

store(key, value)→ value:

Add the key/value pair to the OP's storage dictionary, or replace it if it already exists. If this value is not intended to be saved and loaded in the toe file, it can be be given an alternate value for saving and loading, by using the method storeStartupValue described below.
将键值对添加到 OP 的存储字典中，如果它已经存在，则替换它。如果这个值不打算在 toe 文件中保存和加载，可以通过使用下面描述的 storeStartupValue 方法，给它一个用于保存和加载的备用值。
key - A string name for the storage entry. Use this name to retrieve the value using fetch().
key - 存储条目的字符串名称。使用此名称通过 fetch()检索值。

value - The value/object to store.
value - 要存储的值/对象。
n.store('sales5', 34.5) # stores a floating point value 34.5.
n.store('moviebank', op('/project1/movies')) # stores an OP for easy access later on.

unstore(keys1, keys2..)→ None:

For key, remove it from the OP's storage dictionary. Pattern Matching is supported as well.
keys - The name or pattern defining which key/value pairs to remove from the storage dictionary.
n.unstore('sales*') # removes all entries from this OPs storage that start with 'sales'

storeStartupValue(key, value)→ None:

Add the key/value pair to the OP's storage startup dictionary. The storage element will take on this value when the file starts up.
key - A string name for the storage startup entry.

value - The startup value/object to store.
n.storeStartupValue('sales5', 1) # 'sales5' will have a value of 1 when the file starts up.

unstoreStartupValue(keys1, keys2..)→ None:

For key, remove it from the OP's storage startup dictionary. Pattern Matching is supported as well. This does not affect the stored value, just its startup value.
keys - The name or pattern defining which key/value pairs to remove from the storage startup dictionary.
n.unstoreStartupValue('sales*') # removes all entries from this OPs storage startup that start with 'sales'

Miscellaneous[edit]

__getstate__()→ dict:

Returns a dictionary with persistent data about the object suitable for pickling and deep copies.

__setstate__()→ dict:

Reads the dictionary to update persistent details about the object, suitable for unpickling and deep copies.

TouchDesigner Build:

mqttclientDAT Class mqttclientDAT 类

Contents

Members

Methods

Callbacks[edit]

DAT Class[edit]

Members

Methods

Modifying Content[edit]

Modifying Text Content[edit]

Modifying a Single Cell of a Table[edit]

Modifying Table Content[edit]

Accessing Table Content[edit]

OP Class[edit]

Members

General[edit]

Common Flags[edit]

Appearance[edit]

Connection[edit]

Cook Information[edit]

Type[edit]

Methods

General[edit]

Errors 错误[edit]

Appearance 外观[edit]

Viewers 查看器[edit]

Storage 存储[edit]

Miscellaneous[edit]

Navigation menu

mqttclientDAT Class mqttclientDAT 类

Members

Methods

Callbacks[edit]

DAT Class[edit]

Members

Methods

Modifying Content[edit]

Modifying Text Content[edit]

Modifying a Single Cell of a Table[edit]

Modifying Table Content[edit]

Accessing Table Content[edit]

OP Class[edit]

Members

General[edit]

Common Flags[edit]

Appearance[edit]

Connection[edit]

Cook Information[edit]

Type[edit]

Methods

General[edit]

Errors 错误[edit]

Appearance 外观[edit]

Viewers 查看器[edit]

Storage 存储[edit]

Miscellaneous[edit]

Navigation menu

Search