MOD Class

From Derivative
Jump to: navigation, search

The MOD class provides access to Module On Demand object, which allows DATs to be dynamically imported as modules. It can be accessed with the mod object, found in the automatically imported td module. Alternatively, one can use the regular python statement: import. Use of the import statement is limited to modules in the search path, where as the mod format allows complete statements in one line, which is more useful for entering expressions. Also note that DAT modules cannot be organized into packages as regular file system based python modules can be.


Members[edit]

No operator specific members.


Methods[edit]

No operator specific methods.

Usage[edit]

There are three methods to import DATs as modules in a script.

  • import datName
    Import the module defined by the DAT named datName. All regular import options are supported (from, as, etc). If a DAT is not found, the regular file system search path is then used.
    # import a DAT named addMonth
    import addMonths
    
  • m = mod.datName
    Import the module defined by the DAT named datName.
    m = mod.addMonths(1,2,3)
    
  • m = mod(pathToDat)
    Similar to above, except a path to the DAT can be used.
    m = mod('myMods/adders').addMonths(1,2,3)
    

Comparing Usage[edit]

Example using import:

import myUtils
a = myUtils.add(5,6)

Same example using mod:

a = mod.myUtils.add(5,6)

Example using mod outside the search path:

a = mod('/projects/utils/utilsA').add(5,6)

Notice however, that a single import statement will be faster than the case of multiple identical mod statements:

import myUtils
a = myUtils.add(5,6)
b = myUtils.add(5,6)
c = myUtils.add(5,6)

will execute faster than:

a = mod.myUtils.add(5,6)
b = mod.myUtils.add(5,6)
c = mod.myUtils.add(5,6)

However the above could be rewritten more efficiently like this, which would then execute at the same speed as the import statement:

m = mod.myUtils
a = m.add(5,6)
b = m.add(5,6)
c = m.add(5,6)

Search Path[edit]

The current component is searched first.

If the DAT is not found, the local/modules component of the current component is then searched.

Next the local/modules component of each parent is successively searched.

If the DAT is still not found, None is returned.


TouchDesigner Build:

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.

The location of an operator within the TouchDesigner environment, for example, /geo1/torus1, a node called torus1 in a component called geo1. The path / is called Root. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.