File surface node

Reads, writes, or caches geometry on disk.

This node has two modes of operation. If its input is connected, you can choose a File mode to control how the node reads, writes, or caches geometry on disk. If no input is connected, you can specify a geometry file to read in from disk and send through the node’s output.

It also supports reading, but not writing, of .sim and .simdata files created from File and File Data DOPs.

Tip

You can also write out the geometry from any surface node as a one-shot action by right-clicking the node and choosing Save Geometry.

To set up a procedural workflow where the geometry output of a surface node network is always written to disk as part of a render dependency network, set up a Geometry render driver.

Parameters

File Mode

How this node reads/writes the geometry to/from the disk file.

This parameter is only available when the node’s input is connected.

Automatic

Writes the file if it doesn’t exist, reads it if it does exist.

This is useful for caching, where the node will write the cache to disk the first time it cooks, and use the cache file from then on.

To force a refresh of the cache, manually delete the file on disk.

Read Files

Reads the geometry from the file. If the node’s input is connected, it’s ignored.

Write Files

Writes the input geometry to disk.

No Operation

No file access will occur. Pass through the input geometry to the output, like a Null surface node.

Geometry File

The name of the file to read or write.

Reload Geometry

Force a reload of the file.

Object Mask

When loading .sim files this determines which objects should be loaded from disk. Any objects matching this pattern will be loaded.

Geometry Data Path

For each object loaded from a .sim file, any data attached to the object that matches this path will be loaded. Patterns like * can be used to match multiple data. If blank, only the Geometry data will be loaded.

Missing Frame

What should be done if the specified file does not exist on disk. This is only used if in Read Files mode. By default, if no file of the given name exists, the SOP will error. This can be troublesome in a network that can recover from the error. In these cases the behaviour can be set to No Geometry so only a warning is posted.

Note that in No Geometry mode, if an input exists to the File SOP, it will be passed through. This allows the File SOP to become a read-only cache.

Usages in other examples

Example name Example for

Material shader

Load | Launch

Material shader

Load | Launch

Poly Frame surface node

Load | Launch

Attrib Create surface node

Load | Launch

Add surface node

Load | Launch

Creep surface node

Load | Launch

Creep surface node

Load | Launch

Cap surface node

Load | Launch

Ray surface node

Load | Launch

Peak surface node

Load | Launch

Particle surface node

Load | Launch

Delete surface node

Load | Launch

Font surface node

Load | Launch

L-system surface node

Load | Launch

Rest Position surface node

Load | Launch

Fur surface node

Load | Launch

Box surface node

Load | Launch

Particle Fluid Sink dynamics node

Load | Launch

Particle Fluid Sink dynamics node

Load | Launch

Drag Force dynamics node

Load | Launch

Smoke Object dynamics node

Load | Launch

Smoke Object dynamics node

Load | Launch

Particle Fluid Emitter dynamics node

Load | Launch

Particle Fluid Emitter dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Object dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Particle Fluid Solver dynamics node

Load | Launch

Fluid Object dynamics node

Load | Launch

Fetch channel node

Load | Launch

Orbit particle node

Load | Launch

Lookat particle node

Load | Launch

Follow particle node

Load | Launch

Follow particle node

Load | Launch

Instance particle node

Load | Launch

Mantra render node

Load | Launch

Mantra render node

Load | Launch

Mantra render node

Load | Launch

Mantra render node

Load | Launch