TOP Class

From Derivative
Jump to: navigation, search

A TOP describes a reference to a TOP operator.



Members

TOP.aspectfloat (Read Only):

Texture aspect ratio, width divided by height.

TOP.aspectHeightfloat (Read Only):

Texture aspect ratio, height.

TOP.aspectWidthfloat (Read Only):

Texture aspect ratio, width.

TOP.curPassint (Read Only):

The current cooking pass iteration, beginning at 0. The total can be set with the 'Passes' parameter on the operator's common page.

TOP.depthint (Read Only):

Texture depth, when using a 3 dimensional texture.

TOP.gpuMemoryint (Read Only):

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

TOP.heightint (Read Only):

Texture height, measured in pixels.

TOP.isTOPbool (Read Only):

True if the operators is a TOP.

TOP.widthint (Read Only):

Texture width, measured in pixels.

Methods

TOP.sample(x,y,u,v)tuple(r,g,b,a):

Returns a 4-tuple representing the color value at the specified texture location. One horizontal and one vertical component must be specified.
  • x - The horizontal pixel coordinate to be sampled.
  • y - The vertical pixel coordinate to be sampled.
  • u - The normalized horizontal coordinate to be sampled.
  • v - The normalized vertical coordinate to be sampled.
r = n.sample(x=25,y=100)[0]   #The red component at pixel 25,100.
g = n.sample(u=0.5,v=0.5)[1]  #The green component at the central location.
b = n.sample(x=25,v=0.5)[2]  #The blue 25 pixels across, and half way down.

TOP.save(filepath, async=False)filepath:

Saves the image to the file system. Multiple file types are supported. Returns the filename and path used.
  • filepath - (Optional) The path and filename to save to. If not given then a default filename will be used, and the file will be saved in the project.folder folder.
  • aysnc - (Keyword, Optional) If True, the save will occur in another thread. The file may not be done writing at the time this function returns.
name = n.save()   #save in default format with default name.
n.save('picture.jpg')

OP Class

Members

General

OP.validbool (Read Only):

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

OP.idint (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.

OP.namestr :

Get or set the operator name.

OP.pathstr (Read Only):

Full path to the operator.

OP.digitsint (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.

OP.basestr (Read Only):

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

OP.passivebool (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).

OP.timeOP (Read Only):

Time Component that defines the operator's time reference.

OP.extclass (Read Only):

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

OP.modmod (Read Only):

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

OP.partd.Par (Read Only):

An intermediate parameter collection object, from which a specific parameter can be found.
n.par.tx

OP.curPartd.Par (Read Only):

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

OP.customParslist (Read Only):

A list of all custom parameters.

OP.customPageslist (Read Only):

A list of all custom pages.

OP.customTupletslist (Read Only):

A list of all parameter tuplets, where a tuplet is a set of parameters all drawn on the same line of a dialog, sharing the same label.

OP.replicatorOP or None (Read Only):

The replicatorCOMP that created this operator, if any.

OP.storagedict (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.

OP.tagslist :

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')

OP.childrenlist (Read Only):

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

OP.opOP or None (Read Only):

The OPFinder object, for accessing operators through paths or shortcuts.

Note a version of this method that searches relative to the current operator is also in the global td module. op(pattern1, pattern2...) Returns the first OP whose path matches the given pattern, relative to this OP, or 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.
b = n.op('project1')
b = n.op('foot*', 'hand*')
b = n.op(154)  #or alternatively op(154), as its not relative to this operator.

op.shortcut An operator specified with by a 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 = me.op.Videoplayer   #or alternatively op.Videoplayer, as its not relative to this operator.

To list all Global OP Shortcuts:

for x in op:
	print(x)

OP.parentOP (Read Only):

The ParentFinder 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 = me.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 = me.parent.Videoplayer
See also Parent Shortcut for more examples.

Common Flags

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


OP.activeViewerbool :

Get or set viewer active flag.

OP.allowCookingbool :

Get or set cooking flag. Components only.

OP.bypassbool :

Get or set bypass flag.

OP.cloneImmunebool :

Get or set clone immune flag.

OP.currentbool :

Get or set current flag.

OP.displaybool :

Get or set display flag.

OP.exposebool :

Get or set the expose flag which hides a node from view in a network.

OP.lockbool :

Get or set lock flag.

OP.selectedbool :

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

OP.pythonbool :

Get or set parameter expression language as python.

OP.renderbool :

Get or set render flag.

OP.showCustomOnlybool :

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

OP.showDockedbool :

Get or set show docked flag. This controls whether this node is visible or hidden when it is docked to another node.

OP.viewerbool :

Get or set viewer flag.

Appearance

OP.colortuple(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.

OP.commentstr :

Get or set comment string.

OP.nodeHeightint :

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

OP.nodeWidthint :

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

OP.nodeXint :

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

OP.nodeYint :

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

OP.nodeCenterXint :

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

OP.nodeCenterYint :

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

OP.dockOP :

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

OP.dockedlist (Read Only):

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

Connection

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


OP.inputslist (Read Only):

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

OP.outputslist (Read Only):

List of output operators from this operator.

OP.inputConnectorslist (Read Only):

List of input connectors asssociated with this operator.

OP.outputConnectorslist (Read Only):

List of output connectors associated with this operator.

Cook Information

OP.cookFramefloat (Read Only):

Last frame at which this operator cooked.

OP.cookTimefloat (Read Only):

Duration of the last measured cook (in milliseconds).

OP.cookAbsFramefloat (Read Only):

Last absolute frame at which this operator cooked.

OP.cookStartTimefloat (Read Only):

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

OP.cookEndTimefloat (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.

OP.cookedThisFramebool (Read Only):

True when this operator has cooked this frame.

OP.cookedPreviousFramebool (Read Only):

True when this operator has cooked the previous frame.

OP.childrenCookTimefloat (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.

OP.childrenCookAbsFramefloat (Read Only):

The absolute frame on which childrenCookTime is based.

OP.gpuCookTimefloat (Read Only):

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

OP.childrenGPUCookTimefloat (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.

OP.childrenGPUCookAbsFramefloat (Read Only):

The absolute frame on which childrenGPUCookTime is based.

OP.totalCooksint (Read Only):

Number of times the operator has cooked.

OP.cpuMemoryint (Read Only):

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

Type

OP.typestr (Read Only):

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

OP.subTypestr (Read Only):

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

OP.OPTypestr (Read Only):

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

OP.labelstr (Read Only):

Operator type label. Example: 'OSC In'.

OP.familystr (Read Only):

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

OP.isFilterbool (Read Only):

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

OP.minInputsint (Read Only):

Minimum number of inputs to the operator.

OP.maxInputsint (Read Only):

Maximum number of inputs to the operator.

OP.isMultiInputsbool (Read Only):

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

OP.visibleLevelint (Read Only):

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

OP.isBasebool (Read Only):

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

OP.isCHOPbool (Read Only):

True if the operator is a CHOP.

OP.isCOMPbool (Read Only):

True if the operator is a component.

OP.isDATbool (Read Only):

True if the operator is a DAT.

OP.isMATbool (Read Only):

True if the operator is a Material.

OP.isObjectbool (Read Only):

True if the operator is an object.

OP.isPanelbool (Read Only):

True if the operator is a Panel.

OP.isSOPbool (Read Only):

True if the operator is a SOP.

OP.isTOPbool (Read Only):

True if the operators is a TOP.

OP.licenseTypestr (Read Only):

Type of License required for the operator.

Methods

General

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.


OP.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

OP.cook(force=False, recurse=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.

OP.ops(pattern1, pattern2..)list:

Returns a (possibly empty) list of OPs that match the patterns, relative to this OP.

Multiple patterns may be provided. Numeric OP ids may also be used.

  • 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.

Note a version of this method that searches relative to '/' is also in the global td module.

newlist = n.ops('arm*', 'leg*', 'leg5/foot*')

OP.copyParameters(OP)None:

Copy all of the parameters from the specified operator. Both operators should be the same type.
  • OP - The operator to copy.
op('geo1').copyParameters( op('geo2') )

OP.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

OP.dependenciesTo(OP)list:

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

OP.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').evaluateExpression('me.digits')  #returns 1
If the expression already resides in a parameter, use that parameters evalExpression()() method instead.

OP.destroy()None:

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

OP.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.

OP.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 - (Keyword, Optional) The X coordinate of the menu, measured in screen pixels.
  • y - (Keyword, Optional) The Y coordinate of the menu, measured in screen pixels.

OP.relativePath(OP)str:

Returns the relative path from this operator to the OP that is passed as the argument.

Errors

OP.addScriptErrors(msg)None:

Adds a script error to a node.
  • msg - The error to add.

OP.addError(msg)None:

Adds an error to an operator. Only valid if added while the operator is cooking. (Example Script SOP, CHOP, DAT).
  • msg - The error to add.

OP.addWarning(msg)None:

Adds a warning to an operator. Only valid if added while the operator is cooking. (Example Script SOP, CHOP, DAT).
  • msg - The error to add.

OP.errors(recurse=False)str:

Get error messages associated with this OP.
  • recurse - Get errors in any children or subchildren as well.

OP.warnings(recurse=False)str:

Get warning messages associated with this OP.
  • recurse - Get warnings in any children or subchildren as well.

OP.scriptErrors(recurse=False)str:

Get script error messages associated with this OP.
  • recurse - Get errors in any children or subchildren as well.

OP.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.
  • recurse - Clear script errors in any children or subchildren as well.
  • error - Pattern to match when clearing errors
op('/project1').clearScriptErrors(recurse=True)

Appearance

OP.resetNodeSize()None:

Reset the node tile size to its default width and height.

Viewers

OP.closeViewer(topMost=False)None:

Close the floating content viewers of the OP.
  • topMost - (Keyword, Optional) If True, any viewer window containing any parent of this OP is closed instead.
op('wave1').closeViewer()
op('wave1').closeViewer(topMost=True) # any viewer that contains 'wave1' will be closed.

OP.openViewer(unique=False, borders=True)None:

Open a floating content viewer for the 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.
  • borders - (Keyword, Optional) If true, the floating window containing the viewer will have borders.
op('geo1').openViewer(unique=True, borders=False) # opens a new borderless viewer window for 'geo1'

OP.resetViewer(recurse=False)None:

Reset the OP content viewer to default view settings.
  • recurse - (Keyword, Optional) If True, this is done for all children and sub-children as well.
op('/').resetViewer(recurse=True) # reset the viewer for all operators in the entire file.

OP.openParameters()None:

Open a floating dialog containing the operator parameters.

Storage

Storage can be used to keep data within components. Storage is implemented as one python dictionary per node.

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.

Storage is saved in .toe and .tox files and restored on startup.

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.

See the Examine DAT for procedurally viewing the contents of storage.


OP.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.
  • key - The name of the entry to retrieve.
  • 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.
  • search - (Keyword, Optional) If True, the parent of each OP is searched recursively until a match is found
v = n.fetch('sales5', 0.0)

OP.fetchOwner(key)OP:

Return the operator which contains the stored key, or None if not found.
  • key - The key to the stored entry you are looking for.
who = n.fetchOwner('sales5') #find the OP that has a storage entry called 'sales5'

OP.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.
  • key - A string name for the storage entry. Use this name to retrieve the value using fetch().
  • value - The value/object to store.
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.

OP.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'

OP.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.

OP.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

OP.__getstate__()dict:

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

OP.__setstate__()dict:

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


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.

The Graphics Processing Unit. This is the high-speed, many-core processor of the graphics card/chip that takes geometry, images and data from the CPU and creates images and processed data.

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

A name for a component that is accessible from any node in a project, which can be declared in a component's Global Operator Shortcut parameter.

A Parent Shortcut is a parameter on a component that contains a name that you can use anywhere inside the component to refer to that component using the syntax parent.Name, for example parent.Effect.width to obtain panel width.

(1) Indicator of certain states of an operator (bypass, display, lock), or (2) option of a Tscript command.

To re-compute the output data of the Operators. An operator cooks when (1) its inputs change, (2) its Parameters change, (3) when the timeline moves forward in some cases, or (4) Scripting commands are run on the node. When the operator is a Gadget, it also cooks when a user interacts with it. When an operator cooks, it usually causes operators connected to its output to re-cook. When TouchDesigner draws the screen, it re-cooks all the necessary operators in all Networks, contributing to a frame's total "cook time".

An Operator Family that contains its own Network inside. There are twelve 3D Object Component and eight 2D Panel Component types. See also Network Path.

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.

TouchDesigner is a hierarchy of components. "root" is the top-most network in the hierarchy. The Path is simply /. A typical path is /project1/moviein1.

An Operator Family that contains its own Network inside. There are twelve 3D Object Component and eight 2D Panel Component types. See also Network Path.

A set of commands located in a Text DAT that are triggered to run under certain conditions. There are two scripting languages in TouchDesigner: Python and the original Tscript. Scripts and single-line commands can also be run in the Textport.

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

Creates a new component for every line in a table. Unlike Clone, it automatically creates copies of a master component.

Storage is a python dictionary associated with any operator, used to keep user-specified data within the operator.

TOuch Environment file, the file type used by TouchDesigner to save your project.

TouchDesigner Component file, the file type used to save a Component from TouchDesigner.

TouchDesigner's original built-in Command scripting language prior to Python.

Matching strings using wildcard characters and bracketing. Useful in "Select" parameters to select multiple operators, paths, etc.

Matching strings using wildcard characters and bracketing. Useful in "Select" parameters to select multiple operators, paths, etc.