Difference between revisions of "OP Class"

From TouchDesigner Documentation
Jump to: navigation, search
Line 8: Line 8:
 
     |class=OP
 
     |class=OP
 
     |name=activeViewer
 
     |name=activeViewer
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set viewer active flag.
 
     |text=Get or set viewer active flag.
Line 15: Line 15:
 
     |class=OP
 
     |class=OP
 
     |name=allowCooking
 
     |name=allowCooking
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set cooking flag. Components only.
 
     |text=Get or set cooking flag. Components only.
Line 22: Line 22:
 
     |class=OP
 
     |class=OP
 
     |name=base
 
     |name=base
     |returns=
+
     |returns=string
 
     |set=0
 
     |set=0
 
     |text=Returns the beginning portion of the name occurring before any digits.
 
     |text=Returns the beginning portion of the name occurring before any digits.
Line 29: Line 29:
 
     |class=OP
 
     |class=OP
 
     |name=bypass
 
     |name=bypass
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set bypass flag.
 
     |text=Get or set bypass flag.
Line 36: Line 36:
 
     |class=OP
 
     |class=OP
 
     |name=children
 
     |name=children
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=A list of operators contained within this operator.  Only component operators have children, otherwise an empty list is returned.
 
     |text=A list of operators contained within this operator.  Only component operators have children, otherwise an empty list is returned.
Line 43: Line 43:
 
     |class=OP
 
     |class=OP
 
     |name=childrenCookAbsFrame
 
     |name=childrenCookAbsFrame
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=The absolute frame on which childrenCookTime is based.
 
     |text=The absolute frame on which childrenCookTime is based.
Line 50: Line 50:
 
     |class=OP
 
     |class=OP
 
     |name=childrenCookTime
 
     |name=childrenCookTime
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=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.
 
     |text=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.
Line 57: Line 57:
 
     |class=OP
 
     |class=OP
 
     |name=childrenGPUCookAbsFrame
 
     |name=childrenGPUCookAbsFrame
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=The absolute frame on which childrenGPUCookTime is based.
 
     |text=The absolute frame on which childrenGPUCookTime is based.
Line 64: Line 64:
 
     |class=OP
 
     |class=OP
 
     |name=childrenGPUCookTime
 
     |name=childrenGPUCookTime
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=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.
 
     |text=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.
Line 71: Line 71:
 
     |class=OP
 
     |class=OP
 
     |name=cloneImmune
 
     |name=cloneImmune
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set clone immune flag.
 
     |text=Get or set clone immune flag.
Line 78: Line 78:
 
     |class=OP
 
     |class=OP
 
     |name=color
 
     |name=color
     |returns=
+
     |returns=tuple
 
     |set=1
 
     |set=1
 
     |text=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.
 
     |text=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.
Line 85: Line 85:
 
     |class=OP
 
     |class=OP
 
     |name=comment
 
     |name=comment
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set comment string.
 
     |text=Get or set comment string.
Line 92: Line 92:
 
     |class=OP
 
     |class=OP
 
     |name=cookAbsFrame
 
     |name=cookAbsFrame
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=Last absolute frame at which this operator cooked.
 
     |text=Last absolute frame at which this operator cooked.
Line 99: Line 99:
 
     |class=OP
 
     |class=OP
 
     |name=cookEndTime
 
     |name=cookEndTime
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=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.
 
     |text=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.
Line 106: Line 106:
 
     |class=OP
 
     |class=OP
 
     |name=cookFrame
 
     |name=cookFrame
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=Last frame at which this operator cooked.
 
     |text=Last frame at which this operator cooked.
Line 113: Line 113:
 
     |class=OP
 
     |class=OP
 
     |name=cookStartTime
 
     |name=cookStartTime
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=Last offset from frame start at which this operator cook began, expressed in milliseconds.
 
     |text=Last offset from frame start at which this operator cook began, expressed in milliseconds.
Line 120: Line 120:
 
     |class=OP
 
     |class=OP
 
     |name=cookTime
 
     |name=cookTime
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=Duration of the last measured cook (in milliseconds).
 
     |text=Duration of the last measured cook (in milliseconds).
Line 127: Line 127:
 
     |class=OP
 
     |class=OP
 
     |name=cookedPreviousFrame
 
     |name=cookedPreviousFrame
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True when this operator has cooked the previous frame.
 
     |text=True when this operator has cooked the previous frame.
Line 134: Line 134:
 
     |class=OP
 
     |class=OP
 
     |name=cookedThisFrame
 
     |name=cookedThisFrame
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True when this operator has cooked this frame.
 
     |text=True when this operator has cooked this frame.
Line 141: Line 141:
 
     |class=OP
 
     |class=OP
 
     |name=cpuMemory
 
     |name=cpuMemory
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=The approximate amount of CPU memory this Operator is using, in bytes.
 
     |text=The approximate amount of CPU memory this Operator is using, in bytes.
Line 148: Line 148:
 
     |class=OP
 
     |class=OP
 
     |name=curPar
 
     |name=curPar
     |returns=
+
     |returns=parameter
 
     |set=0
 
     |set=0
 
     |text=The parameter currently being evaluated. Can be used in a parameter expression to reference itself.
 
     |text=The parameter currently being evaluated. Can be used in a parameter expression to reference itself.
Line 155: Line 155:
 
     |class=OP
 
     |class=OP
 
     |name=current
 
     |name=current
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set current flag.
 
     |text=Get or set current flag.
Line 162: Line 162:
 
     |class=OP
 
     |class=OP
 
     |name=customPages
 
     |name=customPages
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=A list of all custom pages.
 
     |text=A list of all custom pages.
Line 169: Line 169:
 
     |class=OP
 
     |class=OP
 
     |name=customPars
 
     |name=customPars
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=A list of all custom parameters.
 
     |text=A list of all custom parameters.
Line 176: Line 176:
 
     |class=OP
 
     |class=OP
 
     |name=customTuplets
 
     |name=customTuplets
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=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.
 
     |text=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.
Line 183: Line 183:
 
     |class=OP
 
     |class=OP
 
     |name=digits
 
     |name=digits
     |returns=
+
     |returns=int or None
 
     |set=0
 
     |set=0
 
     |text=Returns the numeric value of the last consecutive group of digits in the name, or None if not found.
 
     |text=Returns the numeric value of the last consecutive group of digits in the name, or None if not found.
Line 190: Line 190:
 
     |class=OP
 
     |class=OP
 
     |name=display
 
     |name=display
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set display flag.
 
     |text=Get or set display flag.
Line 197: Line 197:
 
     |class=OP
 
     |class=OP
 
     |name=dock
 
     |name=dock
     |returns=
+
     |returns=OP or None
 
     |set=1
 
     |set=1
 
     |text=Get or set the operator this operator is docked to.  To clear docking, set this member to None.
 
     |text=Get or set the operator this operator is docked to.  To clear docking, set this member to None.
Line 204: Line 204:
 
     |class=OP
 
     |class=OP
 
     |name=docked
 
     |name=docked
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=The (possibly empty) list of operators docked to this node.
 
     |text=The (possibly empty) list of operators docked to this node.
Line 211: Line 211:
 
     |class=OP
 
     |class=OP
 
     |name=error
 
     |name=error
     |returns=
+
     |returns=string
 
     |set=1
 
     |set=1
 
     |text=Get or set the error message associated with this OP.
 
     |text=Get or set the error message associated with this OP.
Line 218: Line 218:
 
     |class=OP
 
     |class=OP
 
     |name=expose
 
     |name=expose
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set the expose flag which hides a node from view in a network.
 
     |text=Get or set the expose flag which hides a node from view in a network.
Line 225: Line 225:
 
     |class=OP
 
     |class=OP
 
     |name=ext
 
     |name=ext
     |returns=
+
     |returns=extension object
 
     |set=0
 
     |set=0
     |text=The object to search for parent extensions. Example: me.ext.MyClass
+
     |text=The object to search for parent extensions.
 +
<syntaxhighlight lang=python>
 +
me.ext.MyClass
 +
</syntaxhighlight>
 
}}
 
}}
 
{{ClassMember
 
{{ClassMember
 
     |class=OP
 
     |class=OP
 
     |name=gpuCookTime
 
     |name=gpuCookTime
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=Duration GPU operations cook on the last measured cook (in milliseconds).
 
     |text=Duration GPU operations cook on the last measured cook (in milliseconds).
Line 239: Line 242:
 
     |class=OP
 
     |class=OP
 
     |name=inputConnectors
 
     |name=inputConnectors
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=List of input connectors asssociated with this operator.
 
     |text=List of input connectors asssociated with this operator.
Line 246: Line 249:
 
     |class=OP
 
     |class=OP
 
     |name=inputs
 
     |name=inputs
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=List of input operators to this operator. To get the number of inputs, use len(OP.inputs).
 
     |text=List of input operators to this operator. To get the number of inputs, use len(OP.inputs).
Line 253: Line 256:
 
     |class=OP
 
     |class=OP
 
     |name=isBase
 
     |name=isBase
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a Base (miscellaneous) component.
 
     |text=True if the operator is a Base (miscellaneous) component.
Line 260: Line 263:
 
     |class=OP
 
     |class=OP
 
     |name=isCHOP
 
     |name=isCHOP
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a CHOP.
 
     |text=True if the operator is a CHOP.
Line 267: Line 270:
 
     |class=OP
 
     |class=OP
 
     |name=isCOMP
 
     |name=isCOMP
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a component.
 
     |text=True if the operator is a component.
Line 274: Line 277:
 
     |class=OP
 
     |class=OP
 
     |name=isDAT
 
     |name=isDAT
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a DAT.
 
     |text=True if the operator is a DAT.
Line 281: Line 284:
 
     |class=OP
 
     |class=OP
 
     |name=isMAT
 
     |name=isMAT
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a Material.
 
     |text=True if the operator is a Material.
Line 288: Line 291:
 
     |class=OP
 
     |class=OP
 
     |name=isObject
 
     |name=isObject
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is an object.
 
     |text=True if the operator is an object.
Line 295: Line 298:
 
     |class=OP
 
     |class=OP
 
     |name=isPanel
 
     |name=isPanel
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a Panel.
 
     |text=True if the operator is a Panel.
Line 302: Line 305:
 
     |class=OP
 
     |class=OP
 
     |name=isSOP
 
     |name=isSOP
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operator is a SOP.
 
     |text=True if the operator is a SOP.
Line 309: Line 312:
 
     |class=OP
 
     |class=OP
 
     |name=isTOP
 
     |name=isTOP
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the operators is a TOP.
 
     |text=True if the operators is a TOP.
Line 316: Line 319:
 
     |class=OP
 
     |class=OP
 
     |name=lock
 
     |name=lock
     |returns=
+
     |returns=BOOL
 
     |set=1
 
     |set=1
 
     |text=Get or set lock flag.
 
     |text=Get or set lock flag.
Line 323: Line 326:
 
     |class=OP
 
     |class=OP
 
     |name=mod
 
     |name=mod
     |returns=
+
     |returns=mod object
 
     |set=0
 
     |set=0
 
     |text=Get a module on demand object that searches for DAT modules relative to this operator.
 
     |text=Get a module on demand object that searches for DAT modules relative to this operator.
Line 330: Line 333:
 
     |class=OP
 
     |class=OP
 
     |name=name
 
     |name=name
     |returns=
+
     |returns=string
 
     |set=1
 
     |set=1
 
     |text=Get or set the operator name.
 
     |text=Get or set the operator name.
Line 337: Line 340:
 
     |class=OP
 
     |class=OP
 
     |name=nodeCenterX
 
     |name=nodeCenterX
     |returns=
+
     |returns=float
 
     |set=1
 
     |set=1
 
     |text=Get or set node X value, expressed in network editor units, measured from its center.
 
     |text=Get or set node X value, expressed in network editor units, measured from its center.
Line 344: Line 347:
 
     |class=OP
 
     |class=OP
 
     |name=nodeCenterY
 
     |name=nodeCenterY
     |returns=
+
     |returns=float
 
     |set=1
 
     |set=1
 
     |text=Get or set node Y value, expressed in network editor units, measured from its center.
 
     |text=Get or set node Y value, expressed in network editor units, measured from its center.
Line 351: Line 354:
 
     |class=OP
 
     |class=OP
 
     |name=nodeHeight
 
     |name=nodeHeight
     |returns=
+
     |returns=float
 
     |set=1
 
     |set=1
 
     |text=Get or set node height, expressed in network editor units.
 
     |text=Get or set node height, expressed in network editor units.
Line 358: Line 361:
 
     |class=OP
 
     |class=OP
 
     |name=nodeWidth
 
     |name=nodeWidth
     |returns=
+
     |returns=float
 
     |set=1
 
     |set=1
 
     |text=Get or set node width, expressed in network editor units.
 
     |text=Get or set node width, expressed in network editor units.
Line 365: Line 368:
 
     |class=OP
 
     |class=OP
 
     |name=nodeX
 
     |name=nodeX
     |returns=
+
     |returns=float
 
     |set=1
 
     |set=1
 
     |text=Get or set node X value, expressed in network editor units, measured from its left edge.
 
     |text=Get or set node X value, expressed in network editor units, measured from its left edge.
Line 372: Line 375:
 
     |class=OP
 
     |class=OP
 
     |name=nodeY
 
     |name=nodeY
     |returns=
+
     |returns=float
 
     |set=1
 
     |set=1
 
     |text=Get or set node Y value, expressed in network editor units, measured from its bottom edge.
 
     |text=Get or set node Y value, expressed in network editor units, measured from its bottom edge.
Line 379: Line 382:
 
     |class=OP
 
     |class=OP
 
     |name=op
 
     |name=op
     |returns=
+
     |returns=OP or None
 
     |set=0
 
     |set=0
 
     |text=The OPFinder object, for accessing operators through paths or shortcuts.
 
     |text=The OPFinder object, for accessing operators through paths or shortcuts.
Line 406: Line 409:
 
     |class=OP
 
     |class=OP
 
     |name=outputConnectors
 
     |name=outputConnectors
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=List of output connectors associated with this operator.
 
     |text=List of output connectors associated with this operator.
Line 413: Line 416:
 
     |class=OP
 
     |class=OP
 
     |name=outputs
 
     |name=outputs
     |returns=
+
     |returns=list
 
     |set=0
 
     |set=0
 
     |text=List of output operators from this operator.
 
     |text=List of output operators from this operator.
Line 420: Line 423:
 
     |class=OP
 
     |class=OP
 
     |name=par
 
     |name=par
     |returns=
+
     |returns=parameter collection object
 
     |set=0
 
     |set=0
 
     |text=An intermediate parameter collection object, from which a specific parameter can be found. Example: n.par.tx
 
     |text=An intermediate parameter collection object, from which a specific parameter can be found. Example: n.par.tx
Line 444: Line 447:
 
     |class=OP
 
     |class=OP
 
     |name=path
 
     |name=path
     |returns=
+
     |returns=string
 
     |set=0
 
     |set=0
 
     |text=Full path to the operator.
 
     |text=Full path to the operator.
Line 451: Line 454:
 
     |class=OP
 
     |class=OP
 
     |name=python
 
     |name=python
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=Get or set parameter expression language as python.
 
     |text=Get or set parameter expression language as python.
Line 458: Line 461:
 
     |class=OP
 
     |class=OP
 
     |name=render
 
     |name=render
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=Get or set render flag.
 
     |text=Get or set render flag.
Line 465: Line 468:
 
     |class=OP
 
     |class=OP
 
     |name=replicator
 
     |name=replicator
     |returns=
+
     |returns=OP o None
 
     |set=0
 
     |set=0
 
     |text=The replicatorCOMP that created this operator, if any.
 
     |text=The replicatorCOMP that created this operator, if any.
Line 472: Line 475:
 
     |class=OP
 
     |class=OP
 
     |name=selected
 
     |name=selected
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=Get or set selected flag. This controls if the node is part of the network selection. (yellow box around it).
 
     |text=Get or set selected flag. This controls if the node is part of the network selection. (yellow box around it).
Line 479: Line 482:
 
     |class=OP
 
     |class=OP
 
     |name=showCustomOnly
 
     |name=showCustomOnly
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=Get or set the Show Custom Only Flag which controls whether or not non custom parameters are display in parameter dialogs.
 
     |text=Get or set the Show Custom Only Flag which controls whether or not non custom parameters are display in parameter dialogs.
Line 486: Line 489:
 
     |class=OP
 
     |class=OP
 
     |name=showDocked
 
     |name=showDocked
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
     |text=Get or set show docked flag. This controls whether this node is visible or hidden when it is docked to another node.
+
     |text=Get or set show docked flag. This controls whether this node is visible or hidden when it is docked to another node.
 
}}
 
}}
 
{{ClassMember
 
{{ClassMember
 
     |class=OP
 
     |class=OP
 
     |name=storage
 
     |name=storage
     |returns=
+
     |returns=dict
 
     |set=0
 
     |set=0
     |text=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.
+
     |text=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.
 
}}
 
}}
 
{{ClassMember
 
{{ClassMember
 
     |class=OP
 
     |class=OP
 
     |name=tags
 
     |name=tags
     |returns=
+
     |returns=str
 
     |set=0
 
     |set=0
     |text=Get or set a set of user defined strings. Tags can be searched using OP.findChildren() and the OP Find DAT.
+
     |text=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:
 
The set is a regular python set, and can be accessed accordingly:
  
Line 512: Line 515:
 
     |class=OP
 
     |class=OP
 
     |name=time
 
     |name=time
     |returns=
+
     |returns=OP
 
     |set=0
 
     |set=0
 
     |text=Time Component that defines the operator's time reference.
 
     |text=Time Component that defines the operator's time reference.
Line 519: Line 522:
 
     |class=OP
 
     |class=OP
 
     |name=totalCooks
 
     |name=totalCooks
     |returns=
+
     |returns=float
 
     |set=0
 
     |set=0
 
     |text=Number of times the operator has cooked.
 
     |text=Number of times the operator has cooked.
Line 526: Line 529:
 
     |class=OP
 
     |class=OP
 
     |name=valid
 
     |name=valid
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=True if the referenced operator currently exists, False if it has been deleted.
 
     |text=True if the referenced operator currently exists, False if it has been deleted.
Line 533: Line 536:
 
     |class=OP
 
     |class=OP
 
     |name=viewer
 
     |name=viewer
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=Get or set viewer flag.
 
     |text=Get or set viewer flag.
Line 540: Line 543:
 
     |class=OP
 
     |class=OP
 
     |name=warning
 
     |name=warning
     |returns=
+
     |returns=str
 
     |set=0
 
     |set=0
 
     |text=Get or set the warning message associated with this OP.
 
     |text=Get or set the warning message associated with this OP.
Line 547: Line 550:
 
     |class=OP
 
     |class=OP
 
     |name=id
 
     |name=id
     |returns=
+
     |returns=int
 
     |set=0
 
     |set=0
 
     |text=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.
 
     |text=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.
Line 554: Line 557:
 
     |class=OP
 
     |class=OP
 
     |name=passive
 
     |name=passive
     |returns=
+
     |returns=BOOL
 
     |set=0
 
     |set=0
 
     |text=If true, operator will not cook before its access methods are called.  To use a passive version of an operator n, use passive(n).
 
     |text=If true, operator will not cook before its access methods are called.  To use a passive version of an operator n, use passive(n).
Line 567: Line 570:
 
     |call=storeStartupValue(key, value)
 
     |call=storeStartupValue(key, value)
 
     |returns=
 
     |returns=
     |text=:
+
     |text=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.
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.
 
*key - A string name for the storage startup entry.
 
*value - The startup value/object to store.
 
*value - The startup value/object to store.
Line 578: Line 580:
 
     |call=resetNodeSize()
 
     |call=resetNodeSize()
 
     |returns=
 
     |returns=
     |text=:
+
     |text=Reset the node tile size to its default width and height.
Reset the node tile size to its default width and height.
 
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 586: Line 587:
 
     |call=openViewer(unique=False, borders=True)
 
     |call=openViewer(unique=False, borders=True)
 
     |returns=
 
     |returns=
     |text=:
+
     |text=Open a floating content viewer for the OP.
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.
 
*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.
 
*borders - (Keyword, Optional) If true, the floating window containing the viewer will have borders.
Line 597: Line 597:
 
     |call=destroy()
 
     |call=destroy()
 
     |returns=
 
     |returns=
     |text=:
+
     |text=Destroy the operator referenced by this OP. An exception will be raised if the OP's operator has already been destroyed.
Destroy the operator referenced by this OP. An exception will be raised if the OP's operator has already been destroyed.
 
 
}}
 
}}
 
{{ClassMethod
 
{{ClassMethod
Line 605: Line 604:
 
     |call=resetViewer(recurse=False)
 
     |call=resetViewer(recurse=False)
 
     |returns=
 
     |returns=
     |text=:
+
     |text=Reset the OP content viewer to default view settings.
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.
 
*recurse - (Keyword, Optional) If True, this is done for all children and sub-children as well.
 
<syntaxhighlight lang=python>op('/').resetViewer(recurse=True) # reset the viewer for all operators in the entire file.</syntaxhighlight>
 
<syntaxhighlight lang=python>op('/').resetViewer(recurse=True) # reset the viewer for all operators in the entire file.</syntaxhighlight>

Revision as of 13:28, 15 September 2017

The OP class defines a reference to a single operator.


Members[edit]

activeViewer →  :

Get or set viewer active flag.

allowCooking →  :

Get or set cooking flag. Components only.

base(Read Only):

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

bypass →  :

Get or set bypass flag.

children(Read Only):

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

childrenCookAbsFrame(Read Only):

The absolute frame on which childrenCookTime is based.

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.

childrenGPUCookAbsFrame(Read Only):

The absolute frame on which childrenGPUCookTime is based.

childrenGPUCookTime(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.

cloneImmune →  :

Get or set clone immune flag.

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.

cookAbsFrame(Read Only):

Last absolute frame at which this operator cooked.

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.

cookFrame(Read Only):

Last frame at which this operator cooked.

cookStartTime(Read Only):

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

cookTime(Read Only):

Duration of the last measured cook (in milliseconds).

cookedPreviousFrame(Read Only):

True when this operator has cooked the previous frame.

cookedThisFrame(Read Only):

True when this operator has cooked this frame.

cpuMemory(Read Only):

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

curPar(Read Only):

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

current →  :

Get or set current flag.

customPages(Read Only):

A list of all custom pages.

customPars(Read Only):

A list of all custom parameters.

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.

digits(Read Only):

Returns the numeric value of the last consecutive group of digits in the name, or None if not found.

display →  :

Get or set display flag.

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.

error →  :

Get or set the error message associated with this OP.

expose →  :

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

ext(Read Only):

The object to search for parent extensions.

me.ext.MyClass

gpuCookTime(Read Only):

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

inputConnectors(Read Only):

List of input connectors asssociated with this operator.

inputs(Read Only):

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

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.

lock →  :

Get or set lock flag.

mod(Read Only):

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

name →  :

Get or set the operator name.

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.

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.

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

outputConnectors(Read Only):

List of output connectors associated with this operator.

outputs(Read Only):

List of output operators from this operator.

par(Read Only):

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

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)

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

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.

path(Read Only):

Full path to the operator.

python(Read Only):

Get or set parameter expression language as python.

render(Read Only):

Get or set render flag.

replicator(Read Only):

The replicatorCOMP that created this operator, if any.

selected(Read Only):

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

showCustomOnly(Read Only):

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

showDocked(Read Only):

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

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(Read Only):

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

time(Read Only):

Time Component that defines the operator's time reference.

totalCooks(Read Only):

Number of times the operator has cooked.

valid(Read Only):

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

viewer(Read Only):

Get or set viewer flag.

warning(Read Only):

Get or set the warning message associated with this OP.

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.

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

Methods[edit]

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.

resetNodeSize():

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

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'

destroy():

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

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.

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)

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.

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.

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'

addWarning(msg):

Adds a warning to a node. Only valid if warning is added while a node is cooking.

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.

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

addScriptErrors(msg):

Adds a script error to a node.

openParameters():

Open a floating dialog containing the operator parameters.

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

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)

scriptErrors(recurse=False):

Get script error and warning messages associated with this 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.

warnings(recurse=False):

Get warning messages associated with this 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'

copyParameters(OP):

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

addError(msg):

Adds an error to a node. Only valid if error is added while a node is cooking.

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'

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.

errors(recurse=False):

Get error messages associated with this 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

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

dependenciesTo(OP)list:

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

TouchDesigner Build:

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.

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 which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

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.

An Operator Family that associates a shader with a SOP or Geometry Object for rendering textured and lit objects.

A custom interactive control panel built within TouchDesigner. Panels are created using Panel Components whose look is created entirely with TOPs.

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

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.

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.

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.

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

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.

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

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.

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