Experimental:Palette:threadManagerClient Ext

These Extensions reference a specific Palette:threadManagerClient. This is the extension of the ThreadManagerClient.

ClientQueueManager

A wrapper to handle both the Refresh queues and the success payload.

Members

refreshPayloadQueue → queue.Queue :

The queue to be used for refresh payloads, during execution of the threaded method.

successPayload → Object :

A member that can hold a generic object such as a dict, to be used on success.

stateLock → threading.Lock :

A lock to be used when accessing the success payload. The queue does not require a lock.

Methods

ClientQueueManager.AddInRefreshQueue(data: object)→ None:

Put in queue without blocking execution the object passed as data.

ClientQueueManager.SetSuccessPayload(data: object)→ None:

Set the success payload from the threaded method to be used in the main thread success method. This is relying on the stateLock.

Args:

• data (object): The object to be set as the successPayload.

ClientQueueManager.GetSuccessPayload()→ object:

Get the success payload relying on state lock.

ClientQueueManager.Reset()→ None:

Reset the ThreadManagerClient COMP to a default state.

ThreadManagerClientExt

This is the extension of the ThreadManagerClient.

The ThreadManagerClient is a custom TouchDesigner component designed to rely on the Thread Manager COMP.

The ThreadManagerClient is designed around it's callback DAT. Users should review the template code and adapt it to their own cases.

The customized methods implemented in the ThreadManagerClient Callback are generating a TDTask that gets passed to the Thread Manager TDTask queue.

Keep in mind that users need to be cautious when using threading in TouchDesigner. As a rule of thumb don't access objects from the main TouchDesigner thread such as OPs, COMPs, Parameters, from another thread. Whether it be for writing, reading, or any other operation.

While advanced developers can rely on the Thread Manager directly,users not familiar with threading should consider using the ThreadManager Client instead.

Members

threadManager → Thread Manager COMP :

The Thread Manager that this client is relying on.

logger → Logger COMP :

Reference to a local TouchDesigner Logger. Not to be used within a thread.

safeLogger → logging.Logger :

Reference to the python logger object of a local TouchDesigner Logger. Can be used safely in threaded methods.

clientQueueManager → ClientQueueManager :

The clientQueue manager used as a helper for the ThreadManagerClient.

callbackDat → Text DAT :

The DAT used for callbacks.

TouchDesigner Build: Latest\nwikieditorwikieditorwikieditorwikieditorwikieditorwikieditor

Any component can be extended with its own Python classes which contain python functions and data.

The sub-Family of Component types that are used to define and render 3D scenes. A Geometry Component is an Object that contains the 3D shapes to render. A Camera COMP and Light COMP are other Object types. Separately, "Objects" also refers to Python objects.

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

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

Some operators have a DAT docked to them that contains some python functions. These functions, called "callbacks", get called when something in the operator changes.

A Link. The grey dashed lines between nodes is a Reference or Link that indicates one operator is getting data from another operator from any Operator Family.

The grey dashed lines between nodes is a Reference (or Link). A Reference is (1) a Parameter Reference, a parameter in an OP that is a name or path to another operator, (2) a Node Reference, an expression in a parameter or DAT script that contains the name or path of another operator, (3) a DAT Cell Reference or (4) a CHOP Channel Reference.

A Link or Reference is a dashed line between nodes that represent other data flowing between nodes. Examples are CHOP Exports, node Paths in parameters, and expressions in parameters referencing CHOP channels, DAT tables and other nodes. In contrast is a Wire that connects nodes in the same Operator Family.