openvrTOP Class

From TouchDesigner 088 Wiki


This class inherits from the TOP class. It references a specific OpenVR TOP.


Members

No operator specific members.


Methods

No operator specific methods.


TOP Class

Members

width (Read Only) Texture width, measured in pixels.
height (Read Only) Texture height, measured in pixels.
aspectWidth (Read Only) Texture aspect ratio, width.
aspectHeight (Read Only) Texture aspect ratio, height.
depth (Read Only) Texture depth, when using a 3 dimensional texture.
gpuMemory (Read Only) The amount of GPU memory this TOP is using, in bytes.


Methods

sample(x,y,u,v)(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.

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

Refer to Working with OPs in Python for examples on how to work with CHOPs in Python.

Members

General

valid (Read Only) True if the referenced operator currently exists, False if it has been deleted.
id (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 Get or set the operator name.
path (Read Only) Full path to the operator.
digits (Read Only) Returns the numeric value of the last consecutive group of digits in the name, or None if not found.
base (Read Only) Returns the beginning portion of the name occurring before any digits.
passive (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).
time (Read Only) Time Component that defines the operator's time reference.
ext (Read Only) The object to search for parent extensions. Example: me.ext.MyClass
mod (Read Only) Get a module on demand object that searches for DAT modules relative to this operator.
par (Read Only) An intermediate parameter collection object, from which a specific parameter can be found. Example: n.par.tx
customPars (Read Only) A list of all custom parameters.
customPages (Read Only) A list of all custom pages.
customTuplets (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.
replicator (Read Only) The replicatorCOMP that created this operator, if any.
storage (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 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:
Example: n.tags = ['effect', 'image filter']
Example: n.tags.add('darken')

children (Read Only) A list of operators contained within this operator. Only component operators have children, otherwise an empty list is returned.
op (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...)OP or None

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

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)

Similarly, to test if a shortcut exists:

   if 'MoviePlayer' in op:
       op.MoviePlayer.begin()

or equivalently:

   if hasattr(op, 'MoviePlayer')
       op.MoviePlayer.begin()
   

parent (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.shortcutOP

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.

activeViewer Get or set viewer active flag.
allowCooking Get or set cooking flag. Components only.
bypass Get or set bypass flag.
cloneImmune Get or set clone immune flag.
current Get or set current flag.
display Get or set display flag.
expose Get or set Expose Flag which hides a node from view in a network.
lock Get or set lock flag.
selected Get or set selected flag. This controls if the node is part of the network selection. (yellow box around it).
python Get or set parameter expression language as python.
render Get or set render flag.
showCustomOnly Get or set the Show Custom Only Flag which controls whether or not non custom parameters are display in parameter dialogs.
showDocked Get or set show docked flag. This controls whether this node is visible or hidden when it is docked to another node.
viewer Get or set viewer flag.

Appearance

color 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 Get or set comment string.
nodeHeight Get or set node height, expressed in network editor units.
nodeWidth Get or set node width, expressed in network editor units.
nodeX Get or set node X value, expressed in network editor units, measured from its left edge.
nodeY Get or set node Y value, expressed in network editor units, measured from its bottom edge.
nodeCenterX Get or set node X value, expressed in network editor units, measured from its center.
nodeCenterY Get or set node Y value, expressed in network editor units, measured from its center.
dock Get or set the operator this operator is docked to. To clear docking, set this member to None.
docked (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.
inputs (Read Only) List of input operators to this operator. To get the number of inputs, use len(OP.inputs).
outputs (Read Only) List of output operators from this operator.
inputConnectors (Read Only) List of input connectors asssociated with this operator.
outputConnectors (Read Only) List of output connectors associated with this operator.

Cook Information

cookFrame (Read Only) Last frame at which this operator cooked.
cookTime (Read Only) Duration of the last measured cook (in milliseconds).
cookAbsFrame (Read Only) Last absolute frame at which this operator cooked.
cookStartTime (Read Only) Last offset from frame start at which this operator cook began, expressed in milliseconds.
cookEndTime (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 (Read Only) True when this operator has cooked this frame.
cookedPreviousFrame (Read Only) True when this operator has cooked the previous frame.
childrenCookTime (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 (Read Only) The absolute frame on which childrenCookTime is based.
totalCooks (Read Only) Number of times the operator has cooked.
cpuMemory (Read Only) The approximate amount of CPU memory this Operator is using, in bytes.
warning Get or set the warning message associated with this OP.
error Get or set the error message associated with this OP.

Type

type (Read Only) Operator type. Example: oscin
subType (Read Only) Operator subtype. Currently only implemented for components. May be one of: panel, object, or blank in the case of base components.
label (Read Only) Operator type label. Example: 'OSC In'.
family (Read Only) Operator family. Example: CHOP. Use the global dictionary families for a list of each operator type.
isFilter (Read Only) True if operator is a filter, false if it is a generator.
minInputs (Read Only) Minimum number of inputs to the operator.
maxInputs (Read Only) Maximum number of inputs to the operator.
isMultiInputs (Read Only) True if inputs are ordered, false otherwise. Operators with an arbitrary number of inputs have unordered inputs, example Merge CHOP.
visibleLevel (Read Only) Visibility level of the operator. For example, expert operators have visibility level 1, regular operators have visibility level 0.
isBase (Read Only) True if the operator is a Base (miscellaneous) component.
isCHOP (Read Only) True if the operator is a CHOP.
isCOMP (Read Only) True if the operator is a component.
isDAT (Read Only) True if the operator is a DAT.
isMAT (Read Only) True if the operator is a Material.
isObject (Read Only) True if the operator is an object.
isPanel (Read Only) True if the operator is a Panel.
isSOP (Read Only) True if the operator is a SOP.
isTOP (Read Only) True if the operators is a TOP.



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.

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

cook(force=False, recurse=False)

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.

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

copyParameters(OP)

Copy all of the parameters from the specified operator. Both operators should be the same type.
   op('geo1').copyParameters( op('geo2') )

clearScriptErrors(recurse=False)

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.
   op('/project1').clearScriptErrors(recurse=True)

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

destroy()

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.

Appearance

resetNodeSize()

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

Viewers

closeViewer(topMost=False)

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.

openViewer(unique=False, borders=True)

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'

resetViewer(recurse=False)

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.

openParameters()

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.

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

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)

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'

store(key, value)value

Add the key/value pair to the OP's storage dictionary, or replace it if it already exists.
  • 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.

unstore(keys1, keys2..)

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)

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

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

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