DOF - Depth of Field (Flowgraph Node)

Overview

• Node Name: DOF
• File: extensions/flowgraph/nodes/gfx/dof.lua
• Tags: gfx, dof

Animates Depth of Field blur in or out over a configurable fade time. Saves and restores the original DOF settings on reset.

Pin Schema

Input Pins

Output Pins

Internals

• State: mode tracks current animation ("in", "out", or ""), timer tracks elapsed time.
• On mode change, saves current TorqueScript DOF variables:
  • $DOFPostFx::BlurMin, $DOFPostFx::BlurMax, $DOFPostFx::FocusRangeMax, $DOFPostFx::BlurCurveFar
• Sets $DOFPostFx::FocusRangeMax to 3 and targetBlur to 430.
• Each frame, interpolates BlurMin, BlurMax, and BlurCurveFar based on timer progress.
• On reset or execution stop, restores all saved DOF values.
• Calls dofPostEffect.updateDOFSettings() via scenetree after every change.

How It Works

1. When blurIn or blurOut flow activates, saves current DOF state and begins animation.
2. Each frame, updates DOF parameters based on elapsed time vs fade duration.
3. For blurIn: interpolates from 0 to 1. For blurOut: interpolates from 1 to 0.
4. BlurCurveFar is scaled by targetBlur (430).
5. When timer exceeds fadeTime, outputs blurDone = true.
6. On reset, restores original DOF settings.

Lua Code Example

-- Manually set DOF blur via TorqueScript variables
TorqueScriptLua.setVar('$DOFPostFx::BlurMin', 0.5)
TorqueScriptLua.setVar('$DOFPostFx::BlurMax', 0.5)
TorqueScriptLua.setVar('$DOFPostFx::FocusRangeMax', 3)
TorqueScriptLua.setVar('$DOFPostFx::BlurCurveFar', 215)

local dofPostEffect = scenetree.findObject("DOFPostEffect")
if dofPostEffect and dofPostEffect.updateDOFSettings then
  dofPostEffect.updateDOFSettings()
end

Key Dependencies

• TorqueScriptLua.setVar() / getVar() - reads/writes DOF TorqueScript globals
• DOFPostEffect scene object - the depth of field post-processing effect

Additional Methods

C:_executionStopped()

Called when graph execution stops. Used for cleanup.

C:init(mgr, ...)

Initializes the node, setting up pins and default properties.

Parameters:

• mgr
• ...

C:updateSettings()

Node method.

C:work()

Main work function called each frame/tick when the node is active.

See Also

• Blur (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide