Project

Only in Wrap4D

Computes a given Wrap project with a subprocess. It can be used for creating and executing multi-project workflows.

How does it work

The node takes a .wrap file and runs WrapCmd to compute it. It computes each frame from the project timeline. If any error occur during the computation, all processes will be terminated and the error will be displayed as the node status.

Inputs

Input Signals: Signal You may connect here Project nodes, that must be computed beforehead

Tip

Signal connection type doesn’t transfer data. It just defines the node computation order and prerequests. It can be used in Project or Script nodes.

Output

Signal Use this signal to trigger next Project nodes

Parameters

Project File Name:

a project to compute file path. Supports Path Interpretation.

Compute:

runs a node.

Compute Frame Range:

runs a node for frame range specified. Frame range affects the context of the Project node, not the project being computed.

Open Project:

opens a new instance of Wrap and loads a given project.

Auto-Compute:

if set, the node will be recomputed each time some parameter or input data is changed.

Process Count:

amount of subprocesses to start for computing a project. You only need more than 1 processes when computing several compute intense frames or really long frame ranges.

Custom Frames:

if specified, overrides a frame range to be computed. Otherwise the whole project timeline will be computed.

Frame Distribution:

Static: if set, project frames will be split evenly before running subprocesses.
Dynamic: if set, next project frame will be given to a subprocess only after previous one was computed. Use it, if project frames take uneven time to compute.

Dynamic Batch Size:

use this number to measure chunks instead of giving single frames for Dynamic Frame Distribution. Use it to decrease process sync overhead. E.g. if you have 10.000 uneven frames you can set a Batch Size to 100 and be calm.

Custom Common Dir:

if specified, overrides the project’s $COMMON_DIR.

Environment Variables:

alters environment to start subprocesses in. Doesn’t affect your system environment. Use the formatting below to set them.

MY_VAR1=42
MY_VAR2 = C:/path/to/some.file
MY_VAR3 = "string value with spaces"

Tip

Then you can use environment variables inside the project. Use Python Scripting expressions such as below.

import os

my_var1_string_value = os.environ["MY_VAR1"]  # "42"

Custom Executable:

if specified, will try to run given executable file as a WrapCmd. Otherwise the WrapCmd of this Wrap will be used.

Custom Arguments:

use this param to alter WrapCmd subprocess properties. For details see Command Line Interface

–maxThreads=X: sets max process threads count to X.
–writingverbose: if set, prints file paths written to the disk.
–timing: if set, after each frame prints time consumed by each node computation.