Houdini 18.0 Nodes TOP nodes

File Copy TOP node

Copies a file from one location to another, either at runtime or whenever the node generates.

On this page

The node sets the destination file path(s) as the result file of this node’s work item.

TOP Attributes

filesource

integer

The selected menu item of the File Source parameter.

filetag

string

The file tag of source inputs.

filepath

string

The file path of the file to copy.

destfile

string

The file path that the input(s) will be copied to.

destfolder

string

The destination folder where files will be copied to.

resultdatatag

string

The file tag to use for the copied file(s).

copyto

integer

The selected menu item of the Copy To parameter

filestocopy

string

The list of files that will be copied when the inputs are sourced from upstream result files.

Parameters

Copy File(s) During

When to copy the files:

Generate

The file(s) will be copied during the work item generation stage. When this is on, the file is copied whenever the node generates static items (when the network starts cooking, or when you explicitly ask to generate static items). Only turn this on if the file exists ahead of time or the node is set to dynamic work item generation.

Cook (In-Process)

The file(s) will be copied during the cook and within the graph cooking process. This will usually be preferred to cooking out of process unless the file size is very large.

Cook (Out-of-Process)

The file(s) will be copied during the cook and within their own process. This mode is usually best for copying large files in another process so that it doesn’t hold up cooking the rest of the network.

Source

File Source

Specifies the source for the file(s) to be copied:

Upstream Output File

Get the file path(s) from the incoming work item’s output attribute and copy any files that have a tag matching the File Tag parameter. This allows multiple files to be copied at once.

Custom File Path

Copy the file specified by the File Path parameter.

File Tag

When the file source is upstream result files, this specifies the tag of the result files that should be copied.

File Path

When the file source is a custom file path, this specifies the filepath of that file.

Destination

Copy To

Specifies where the files will be copied to:

Directory

The file(s) will be copied to the directory specified by the Directory parameter. This option should be used when copying multiple files.

File

The file will be copied to the directory specified by the File Path parameter. This option should be avoided when copying multiple files, or each file copy will overwrite the previous copy.

Directory

The directory that the source file(s) will be copied to when copying to a directory.

File Path

The filepath that the source file will be copied to when copying to a file path.

File Tag

This node sets the destination path as the "file result" of its work item. The file tag to use for the result. The default is just file. You may want to specialize the tag based on the type of file being copied (for example, file/image/exr or file/geo).

Examples

example_top_filecopy Example for File Copy TOP node

This example demonstrates how to copy files using TOPs / PDG.

input1 Example for File Copy TOP node

This is the first input for the PDG copyfile node test.

TOP nodes