View source for Td Module

{{lowercase}}
{{TDClassSummary|label=td|summary=The td module is the main module containing all application related classes and objects. It is imported by default when the application launches.}}
<section begin=HELPBODY />
{{ClassMemberSection|empty=
		|Sectionsummary=
		|items=
{{ClassMember
    |class=td
    |name=me
    |type=OP
    |set=0
    |text=Reference to the current [[OP Class|operator]] that is being executed or evaluated. This can be used in parameter expressions, or DAT scripts.}}
{{ClassMember
    |class=td
    |name=absTime
    |type=absTime
    |set=0
    |text=Reference to the [[AbsTime Class|AbsTime]] object.}}
{{ClassMember
    |class=td
    |name=app
    |type=app
    |set=0
    |text=Reference to the [[App Class|application]] installation.}}
{{ClassMember
    |class=td
    |name=ext
    |type=ext
    |set=0
    |text=Reference to the extension searching object. See [[extensions]] for more information.}}
{{ClassMember
    |class=td
    |name=families
    |type=dict
    |set=0
    |text=A dictionary containing a list of [[OP Class|operator]] types for each operator family. 
<syntaxhighlight lang=python>
for a in families['SOP']:
	# do something with a
</syntaxhighlight>}}
{{ClassMember
    |class=td
    |name=licenses
    |type=licenses
    |set=0
    |text=Reference to the currently installed licences.
}}
{{ClassMember
    |class=td
    |name=mod
    |type=mod
    |set=0
    |text=Reference to the [[MOD Class|Module On Demand]] object.}}
{{ClassMember
    |class=td
    |name=monitors
    |type=monitors
    |set=0
    |text=Reference to the group of available [[Monitors Class|monitors]].}}
{{ClassMember
    |class=td
    |name=op
    |type=OP
    |set=0
    |text=The [[Global OP Shortcut|Shortcut]] object, for accessing operators through paths or shortcuts.
'''Note:''' a version of this method that searches relative to a specific operator is also in [[OP Class]].

<code>op(pattern1, pattern2...)  [[OP Class|OP]] or None</code>

Returns the first OP whose path matches the given pattern, relative to the current 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.
<syntaxhighlight lang=python>
b = op('project1')
b = op('foot*', 'hand*')
b = op(154)
</syntaxhighlight>
<code>op.shortcut  OP</code>

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.
<syntaxhighlight lang=python>
b = op.Videoplayer # or alternatively op.Videoplayer, as its not relative to this operator.
</syntaxhighlight>
To list all Global OP Shortcuts:
<syntaxhighlight lang=python>
for x in op:
	print(x)
</syntaxhighlight>}}
{{ClassMember
    |class=td
    |name=parent
    |type=OP
    |set=0
    |text=The [[Parent Shortcut|Parent Shortcut]] object, for accessing parent components through indices or shortcuts.
'''Note:''' a version of this method that searches from a specific operator is also in [[OP Class]].

<code>parent(n)  OP or None</code>

The nth parent of the current 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.
<syntaxhighlight lang=python>
p = parent(2) #grandfather
</syntaxhighlight>
<code>parent.shortcut  OP</code>

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.
<syntaxhighlight lang=python>
   n = parent.Videoplayer
</syntaxhighlight>
See also Parent Shortcut for more examples.}}
{{ClassMember
    |class=td
    |name=iop
    |type=OP
    |set=0
    |text=The Internal Operator Shortcut object, for accessing internal shortcuts.
    
'''Note:''' a version of this method that searches from a specific operator is also in [[OP Class]].}}
{{ClassMember
    |class=td
    |name=ipar
    |type=OP
    |set=0
    |text=The Internal Operator Parameter Shortcut object, for accessing internal shortcuts.
    
'''Note:''' a version of this method that searches from a specific operator is also in [[OP Class]].}}
{{ClassMember
    |class=td
    |name=project
    |type=project
    |set=0
    |text=Reference to the [[Project Class|project session]].}}
{{ClassMember
    |class=td
    |name=root
    |type=OP
    |set=0
    |text=Reference to the topmost root [[OP Class|operator]].}}
{{ClassMember
    |class=td
    |name=runs
    |type=runs
    |set=0
    |text=Reference to the [[Runs Class|runs]] object, which contains delayed executions.}}
{{ClassMember
    |class=td
    |name=sysinfo
    |type=sysinfo
    |set=0
    |text=Reference to the [[SysInfo Class|system information]].}}
{{ClassMember
    |class=td
    |name=ui
    |type=ui
    |set=0
    |text=Reference to the [[UI Class|ui options]].}}}}
{{ClassMethodSection|empty=
		|Sectionsummary=
		|items=
{{ClassMethod
    |class=td
    |name=passive
    |call=passive(OP)
    |returns=OP
    |text=Returns a passive version of the [[OP Class|operator]]. Passive OPs do not cook before their members are accessed.}}
{{ClassMethod
    |class=td
    |name=run
    |call=run(script, arg1, arg2..., endFrame=False, fromOP=None, asParameter=False, group=None, delayFrames=0, delayMilliSeconds=0, delayRef=me)
    |returns=Run
    |text=[[Run Class|Run]] the script specified as a string in the script parameter, returning a Run object which can be used to optionally modify its execution.
*script - A string that is the script code to execute.
*arg - (Optional) One or more arguments to be passed into the script when it executes. They are accessible in the script using a tuple named args.
*endFrame - (Keyword, Optional) If True, the execution will be delayed until the end of the current frame.
*fromOP - (Keyword, Optional) Specifies an optional [[OP Class|operator]] from which the execution will be run relative to.
*asParameter - (Keyword, Optional) When fromOP used, run relative to a parameter of fromOP.
*group - (Keyword, Optional) Can be used to specify a string label for the group of Run objects this belongs to. This label can then be used with the [[Runs Class|td.runs]] object to modify its execution.
*delayFrames - (Keyword, Optional) The number of frames to wait before executing the script.
*delayMilliSeconds - (Keyword, Optional) The number of milliseconds to wait before executing the script. This value is rounded to the nearest frame.
*delayRef - (Keyword, Optional) Specifies an optional [[OP Class|operator]] from which the delay time is derived.}}
{{ClassMethod
    |class=td
    |name=fetchStamp
    |call=fetchStamp(key, default)
    |returns=value
    |text=Return an object from the global stamped parameters. If the item is not found, the default is returned instead. Parameters can be stamped with the [[Copy SOP]].
*key - The name of the entry to retrieve.
*default - If no item is found then the passed value is returned instead.
<syntaxhighlight lang=python>
v = fetchStamp('sides', 3)
</syntaxhighlight>}}
{{ClassMethod
    |class=td
    |name=var
    |call=var(varName)
    |returns=str
    |text=Find the value for the given [[Variables|variable]].}}
{{ClassMethod
    |class=td
    |name=varExists
    |call=varExists(varName)
    |returns=bool
    |text=Returns true if the [[Variables|variable]] is defined.}}
{{ClassMethod
    |class=td
    |name=varOwner
    |call=varOwner(varName)
    |returns=OP or None
    |text=Returns the [[OP Class|operator]] that defines the [[Variables|variable]], or None if it's not defined.}}
{{ClassMethod
    |class=td
    |name=isMainThread
    |call=isMainTread()
    |returns=bool
    |text=Is True when called from the main application editing thread. Any calls that access operators, etc., must be called from the main thread.
}}
{{ClassMethod
    |class=td
    |name=clear
    |call=clear()
    |returns=None
    |text=Clear the textport of all text.
}}}}
<section end=HELPBODY />
{{History}}
{{#invoke:Category|list|Python Reference}}