FieldVolumeWrite

The FieldVolumeWrite node allows you to write volume files.

Note:  This is a LABS node, indicated in Nuke with the tag:
LABS nodes are experimental and not intended to be used for production.

Inputs and Controls

Connection Type

Connection Name

Function

Input

Source

The volume you wish to write.

Control (UI)

Knob (Scripting)

Default Value

Function

FieldVolumeWrite Tab

Filename filename N/A Select a file location to save the volume file.
Voxel Size voxel_size 0.01 Specify the size of the volume pixels.
Grid Type grid_type Float Specify a grid type for the volume.
Grid Name grid_name default Specify a name for the grid.
Bounds Specifier bounds_specifier Field Select Field to set the bounds based on the field. Set Custom to set the bounds manually.
Execute Execute N/A Press this button to write the file(s).
Display Tab
Draw Bounding Box preview_bounds Unchanged

Draw the bounding box of the field if it has one.

Select between On, Off, and Unchanged. Unchanged means that this option is inherited from nodes above it in the node graph. By inheriting On or Off from above, this means this setting only needs to be edited in one node to affect the display across all Field nodes in the node graph.

Draw Preview preview_on Unchanged

Draw a rough preview of the field.

Select between On, Off, and Unchanged. Unchanged means that this option is inherited from nodes above it in the node graph. By inheriting On or Off from above, this means this setting only needs to be edited in one node to affect the display across all Field nodes in the node graph.

Opacity preview_opacity 1 The opacity at which to draw the preview.
Scale preview_scale 1 A value by which the field is multiplied before drawing. You may need to increase this to display faint volumes for example.
Offset preview_offset 0 A value added to the field before drawing (after scaling).
Detail preview_detail 1 The detail level at which the preview is drawn. Large values are more accurate but slower to draw.
Python Tab (These controls are for Python callbacks and can be used to have Python functions automatically called when various events happen in Nuke.)

Before Render

beforeRender

none

These functions run prior to starting rendering in execute(). If they throw an exception, the render aborts.

Before Each Frame

beforeFrameRender

none

These functions run prior to starting rendering of each individual frame. If they throw an exception, the render aborts.

After Each Frame

afterFrameRender

none

These functions run after each frame is finished rendering. They are not called if the render aborts. If they throw an exception, the render aborts.

After Render

afterRender

none

These functions run after rendering of all frames is finished. If they throw an error, the render aborts.

Render Progress

renderProgress

none

These functions run during rendering to determine progress or failure.