unreal.MovieGraphAccumulationDOFModifierNode

class unreal.MovieGraphAccumulationDOFModifierNode(outer: Object | None = None, name: Name | str = 'None')

Bases: MovieGraphSettingNode

Modifies the properties on the Accumulation DOF component (on all cameras within the world).

C++ Source:

  • Plugin: AccumulationDOF

  • Module: AccumulationDOF

  • File: MovieGraphAccumulationDOFModifierNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • dof_splat_size (float): [Read-Write] The splat size that the Accumulation DOF component should use.

  • dynamic_properties (InstancedPropertyBag): [Read-Write] Properties which can be dynamically declared on the node (vs. native properties which are always present).

  • enable_accumulation_depth_of_field (MovieGraphAccumulationDOFEnableState): [Read-Write] Whether the Accumulation DOF component should be enabled/disabled.

  • num_samples (int32): [Read-Write] The number of samples that the Accumulation DOF component should use.

  • override_dof_splat_size (bool): [Read-Write]

  • override_enable_accumulation_depth_of_field (bool): [Read-Write]

  • override_num_samples (bool): [Read-Write]

  • script_tags (Array[str]): [Read-Write] Tags that can be used to identify this node within a pre/post render script. Tags can be unique in order to identify this specific node, or the same tag can be applied to multiple nodes in order to identify a grouping of nodes.

add_collection(collection_name) → None

Adds a collection identified by the given name which will be affected by the modifiers on this node.

Parameters:

collection_name (Name)

property dof_splat_size: float

[Read-Write] The splat size that the Accumulation DOF component should use.

Type:

(float)

property enable_accumulation_depth_of_field: MovieGraphAccumulationDOFEnableState

[Read-Write] Whether the Accumulation DOF component should be enabled/disabled.

Type:

(MovieGraphAccumulationDOFEnableState)

get_all_collections() → Array[Name]

Gets all collections that will be affected by the modifiers used by this node.

Return type:

Array[Name]

get_all_modifiers() → Array[MovieGraphModifierBase]

Gets all modifiers that will be applied with this modifier node.

Return type:

Array[MovieGraphModifierBase]

is_collection_enabled(collection_name) → bool

Gets the enable state (within this modifier) of the collection with the given name.

Parameters:

collection_name (Name)

Return type:

bool

property num_samples: int

[Read-Write] The number of samples that the Accumulation DOF component should use.

Type:

(int32)

property override_dof_splat_size: bool

[Read-Write]

Type:

(bool)

property override_enable_accumulation_depth_of_field: bool

[Read-Write]

Type:

(bool)

property override_num_samples: bool

[Read-Write]

Type:

(bool)

remove_collection(collection_name) → bool

Removes a collection identified by the given name. Returns true if the collection was found and removed successfully, else false.

Parameters:

collection_name (Name)

Return type:

bool

set_collection_enabled(collection_name, is_collection_enabled) → None

Sets the enable state (within this modifier) of the collection with the given name. Disabled collections will not be modified by this modifier node. Collections that are added to the modifier are enabled by default.

Parameters:

  • collection_name (Name)

  • is_collection_enabled (bool)

supports_collections() → bool

Gets whether this modifier node supports/uses collections.

Return type:

bool