unreal.DMXModulator

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

Bases: Object

Base class for custom modulators. Override Modulate and ModulateMatrix functions in the blueprints to implement functionality. Input maps hold all attribute values of the patch. Output Maps can be freely defined, but Attributes not present in the patch will be ignored.

C++ Source:

  • Plugin: DMXEngine

  • Module: DMXRuntime

  • File: DMXModulator.h

modulate(fixture_patch, normalized_attribute_values) → Map[DMXAttributeName, float]

Modulate

Parameters:
Returns:

out_normalized_attribute_values (Map[DMXAttributeName, float]):

Return type:

Map[DMXAttributeName, float]

modulate_matrix(fixture_patch, normalized_matrix_attribute_values) → Array[DMXNormalizedAttributeValueMap]

Modulate Matrix

Parameters:
Returns:

out_normalized_matrix_attribute_values (Array[DMXNormalizedAttributeValueMap]):

Return type:

Array[DMXNormalizedAttributeValueMap]