`unreal.DMXEntityFixturePatch`¶

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

Bases: DMXEntity

A DMX fixture patch that can be patch to channels in a DMX Universe via the DMX Library Editor.

Use in DMXComponent or call SetReceiveDMXEnabled with ‘true’ to enable receiving DMX.

C++ Source:

Plugin: DMXEngine
Module: DMXRuntime
File: DMXEntityFixturePatch.h

Editor Properties: (see get_editor_property/set_editor_property)

active_mode (int32): [Read-Write] The Index of the Mode in the Fixture Type the Patch uses
auto_assign_address (bool): [Read-Write] DEPRECATED 5.1 deprecated: bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.
auto_starting_address (int32): [Read-Write] DEPRECATED 5.1 deprecated: bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.
custom_tags (Array[Name]): [Read-Write] Custom tags for filtering patches
editor_color (LinearColor): [Read-Write] Color when displayed in the fixture patch editor
manual_starting_address (int32): [Read-Write] DEPRECATED 5.1 deprecated: bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.
mvr_fixture_uuid (Guid): [Read-Only] The MVR Fixture UUID when used as such
name (str): [Read-Write]
on_fixture_patch_received_dmx (DMXOnFixturePatchReceivedDMXDelegate): [Read-Write] Broadcasts when the patch received dmx
parent_fixture_type_template (DMXEntityFixtureType): [Read-Only] Property to point to the template parent fixture for details panel purposes
receive_dmx_in_editor (bool): [Read-Write] If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX event in editor. NOTE: If ‘All Fixture Patches receive DMX in editor’ is set to true in Project Settings -> Plugins -> DMX, this setting here is ignored.
starting_channel (int32): [Read-Write] Starting Channel of the Patch
universe_id (int32): [Read-Write] The local universe of the patch

property active_mode: int¶

[Read-Only] The Index of the Mode in the Fixture Type the Patch uses

Type:: (int32)

property auto_assign_address: bool¶

[Read-Write] DEPRECATED 5.1 deprecated: bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.

Type:: (bool)

property auto_starting_address: int¶

[Read-Write] DEPRECATED 5.1 deprecated: bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.

Type:: (int32)

contains_attribute(function_attribute) → bool¶

Returns true if the fixture patch contains the attribute.

Parameters:: function_attribute (DMXAttributeName) –
Return type:: bool

convert_attribute_map_to_raw_map(function_map) → Map[int32, uint8]¶

Returns a map of function channels and their values. Functions outside the Active Mode’s channel span range are ignored.

Parameters:: function_map (Map[DMXAttributeName, int32]) –
Return type:: Map[int32, uint8]

convert_raw_map_to_attribute_map(raw_map) → Map[DMXAttributeName, int32]¶

Convert Raw Map to Attribute Map deprecated: Deprecated 4.27. Please use DMXSubsystem’s Bytes to Int instead, then create a map from that with Attribute Names .

Parameters:: raw_map (Map[int32, uint8]) –
Return type:: Map[DMXAttributeName, int32]

convert_to_valid_map(function_map) → Map[DMXAttributeName, int32]¶

Returns a map that only contains attributes used this patch.

Parameters:: function_map (Map[DMXAttributeName, int32]) –
Return type:: Map[DMXAttributeName, int32]

classmethod create_fixture_patch_in_library(construction_params, desired_name='', mark_dmx_library_dirty=True) → DMXEntityFixturePatch¶

Creates a new Fixture Patch in the DMX Library using the specified Fixture Type

Parameters:

construction_params (DMXEntityFixturePatchConstructionParams) –
desired_name (str) –
mark_dmx_library_dirty (bool) –

Return type:

DMXEntityFixturePatch

property custom_tags: None¶

[Read-Only] Custom tags for filtering patches

Type:: (Array[Name])

property editor_color: LinearColor¶

[Read-Only] Color when displayed in the fixture patch editor

Type:: (LinearColor)

get_all_attributes_in_active_mode() → Array[DMXAttributeName]¶

Returns an array of valid attributes for the currently active mode. Attributes outside the Active Mode’s channel span range are ignored.

Return type:: Array[DMXAttributeName]

get_all_matrix_cells() → Array[DMXCell] or None¶

Gets all matrix cells

Returns:: cells (Array[DMXCell]):
Return type:: Array[DMXCell] or None

get_attribute_channel_assignments() → Map[DMXAttributeName, int32]¶

Returns a map of Attributes and their assigned channels

Return type:: Map[DMXAttributeName, int32]

get_attribute_default_map() → Map[DMXAttributeName, int32]¶

Returns a map of function names and default values. Functions outside the Active Mode’s channel span range are ignored.

Return type:: Map[DMXAttributeName, int32]

get_attribute_functions_map() → Map[DMXAttributeName, DMXFixtureFunction]¶

Returns a map of attributes and function names. Attributes outside the Active Mode’s channel span range are ignored.

Return type:: Map[DMXAttributeName, DMXFixtureFunction]

get_attribute_signal_formats() → Map[DMXAttributeName, DMXFixtureSignalFormat]¶

Returns a map of function names and their Data Types. Functions outside the Active Mode’s channel span range are ignored.

Return type:: Map[DMXAttributeName, DMXFixtureSignalFormat]

get_attribute_value(attribute) -> (int32, success=bool)¶

Retrieves the value of an Attribute. Will fail and return 0 if the Attribute doesn’t exist.

Parameters:

attribute (DMXAttributeName) – The Attribute to try to get the value from.

Returns:

The value of the Function mapped to the selected Attribute, if found.

success (bool): Whether the Attribute was found in this Fixture Patch

Return type:

bool

get_attributes_values() → Map[DMXAttributeName, int32]¶

Returns the value of each attribute, or zero if no value was ever received.

Returns:: attributes_values (Map[DMXAttributeName, int32]): Out: Resulting map of Attributes with their values
Return type:: Map[DMXAttributeName, int32]

get_cell_attributes() → Array[DMXAttributeName] or None¶

Gets all attributes names of a cell

Returns:: cell_attributes (Array[DMXAttributeName]):
Return type:: Array[DMXAttributeName] or None

get_channel_span() → int32¶

Returns the number of channels this Patch occupies with the Fixture functions from its Active Mode or 0 if the patch has no valid Active Mode

Return type:: int32

get_ending_channel() → int32¶

Returns the last channel of the patch

Return type:: int32

get_matrix_cell(cell_coordinate) → DMXCell or None¶

Cell coordinate X/Y

Parameters:: cell_coordinate (IntPoint) –
Returns:: cell (DMXCell):
Return type:: DMXCell or None

get_matrix_cell_channels_absolute(cell_coordinate) → Map[DMXAttributeName, int32] or None¶

Cell coordinate X/Y

Parameters:: cell_coordinate (IntPoint) –
Returns:: attribute_channel_map (Map[DMXAttributeName, int32]):
Return type:: Map[DMXAttributeName, int32] or None

get_matrix_cell_channels_absolute_with_validation(cell_coordinate) → Map[DMXAttributeName, int32] or None¶

Cell coordinate X/Y

Parameters:: cell_coordinate (IntPoint) –
Returns:: out_attribute_channel_map (Map[DMXAttributeName, int32]):
Return type:: Map[DMXAttributeName, int32] or None

get_matrix_cell_channels_relative(cell_coordinate) → Map[DMXAttributeName, int32] or None¶

Cell coordinate X/Y

Parameters:: cell_coordinate (IntPoint) –
Returns:: attribute_channel_map (Map[DMXAttributeName, int32]):
Return type:: Map[DMXAttributeName, int32] or None

get_matrix_cell_values(cell_coordinate) → Map[DMXAttributeName, int32] or None¶

Cell coordinate X/Y

Parameters:: cell_coordinate (IntPoint) –
Returns:: value_per_attribute (Map[DMXAttributeName, int32]):
Return type:: Map[DMXAttributeName, int32] or None

get_matrix_properties() → DMXFixtureMatrix or None¶

Gets the Matrix Fixture properties, returns false if the patch is not using a matrix fixture

Returns:: matrix_properties (DMXFixtureMatrix):
Return type:: DMXFixtureMatrix or None

get_normalized_attribute_value(attribute) -> (float, success=bool)¶

Retrieves the normalized value of an Attribute. Will fail and return 0 if the Attribute doesn’t exist. deprecated: Deprecated 4.26. Use GetNormalizedAttributeValue instead. Note, new method returns normalized values!

Parameters:

attribute (DMXAttributeName) – The Attribute to try to get the value from.

Returns:

The value of the Function mapped to the selected Attribute, if found.

success (bool): Whether the Attribute was found in this Fixture Patch

Return type:

bool

get_normalized_attributes_values() → DMXNormalizedAttributeValueMap¶

Returns the normalized value of each attribute, or zero if no value was ever received.

Returns:: normalized_attributes_values (DMXNormalizedAttributeValueMap):
Return type:: DMXNormalizedAttributeValueMap

get_normalized_matrix_cell_values(cell_coordinate) → Map[DMXAttributeName, float] or None¶

Cell coordinate X/Y

Parameters:: cell_coordinate (IntPoint) –
Returns:: normalized_value_per_attribute (Map[DMXAttributeName, float]):
Return type:: Map[DMXAttributeName, float] or None

get_relevant_controllers() → Array[DMXEntityController]¶

Get Relevant Controllers deprecated: Deprecated 4.27. Controllers are replaced with DMX Ports.

Return type:: Array[DMXEntityController]

get_remote_universe() → int32¶

Get Remote Universe deprecated: Deprecated 4.27. No clear remote universe can be deduced from controllers (before 4.27) or ports (from 4.27 on).

Return type:: int32

get_starting_channel() → int32¶

Return the starting channel

Return type:: int32

is_in_controller_range(controller) → bool¶

Is in Controller Range deprecated: Deprecated 4.27. Controllers are replaced with DMX Ports.

Parameters:: controller (DMXEntityController) –
Return type:: bool

is_in_controllers_range(controllers) → bool¶

Is in Controllers Range deprecated: Deprecated 4.27. Controllers are replaced with DMX Ports.

Parameters:: controllers (Array[DMXEntityController]) –
Return type:: bool

is_map_valid(function_map) → bool¶

Returns true if given function map is valid for this fixture.

Parameters:: function_map (Map[DMXAttributeName, int32]) –
Return type:: bool

property manual_starting_address: int¶

[Read-Write] DEPRECATED 5.1 deprecated: bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.

Type:: (int32)

property mvr_fixture_uuid: Guid¶

[Read-Only] The MVR Fixture UUID when used as such

Type:: (Guid)

property on_fixture_patch_received_dmx: DMXOnFixturePatchReceivedDMXDelegate¶

[Read-Write] Broadcasts when the patch received dmx

Type:: (DMXOnFixturePatchReceivedDMXDelegate)

property parent_fixture_type_template: DMXEntityFixtureType¶

[Read-Only] Property to point to the template parent fixture for details panel purposes

Type:: (DMXEntityFixtureType)

property receive_dmx_in_editor: bool¶

[Read-Only] If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX event in editor. NOTE: If ‘All Fixture Patches receive DMX in editor’ is set to true in Project Settings -> Plugins -> DMX, this setting here is ignored.

Type:: (bool)

classmethod remove_fixture_patch_from_library(fixture_patch_ref) → None¶

Removes a fixture patch from the DMX Library

Parameters:: fixture_patch_ref (DMXEntityFixturePatchRef) –

send_dmx(attribute_map) → None¶

Send DMX using attribute names and integer values.

Parameters:: attribute_map (Map[DMXAttributeName, int32]) –

send_matrix_cell_value(cell_coordinate, attribute, value) → bool¶

Cell coordinate X/Y

Parameters:

cell_coordinate (IntPoint) –
attribute (DMXAttributeName) –
value (int32) –

Return type:

bool

send_matrix_cell_value_with_attribute_map(cell_coordinate, attribute, value, attribute_name_channel_map) → bool¶

Cell coordinate X/Y deprecated: Deprecated due to ambigous arguments CellCoordinate and InAttributeNameChannelMap. Use SendMatrixCellValue or SendNormalizedMatrixCellValue instead.

Parameters:

cell_coordinate (IntPoint) –
attribute (DMXAttributeName) –
value (int32) –
attribute_name_channel_map (Map[DMXAttributeName, int32]) –

Return type:

bool

send_normalized_matrix_cell_value(cell_coordinate, attribute, relative_value) → bool¶

Cell coordinate X/Y

Parameters:

cell_coordinate (IntPoint) –
attribute (DMXAttributeName) –
relative_value (float) –

Return type:

bool

set_fixture_type(new_fixture_type) → None¶

Sets the fixture type this is using

Parameters:: new_fixture_type (DMXEntityFixtureType) –

set_starting_channel(new_starting_channel) → None¶

Sets the starting channel of the Fixture Patch.

If Auto Assign Address was set to true, turns off Auto Assign Address.

Parameters:: new_starting_channel (int32) –

property starting_channel: int¶

[Read-Only] Starting Channel of the Patch

Type:: (int32)

property universe_id: int¶

[Read-Only] The local universe of the patch

Type:: (int32)

`unreal.DMXEntityFixturePatch`¶

Table of Contents

Previous topic

Next topic

unreal.DMXEntityFixturePatch¶

`unreal.DMXEntityFixturePatch`¶