unreal.DMXEntityFixturePatch

class unreal.DMXEntityFixturePatch(outer=None, name='None')

Bases: unreal.DMXEntity

DMXEntity Fixture Patch

C++ Source:

  • Plugin: DMXEngine
  • Module: DMXRuntime
  • File: DMXEntityFixturePatch.h

Editor Properties: (see get_editor_property/set_editor_property)

  • active_mode (int32): [Read-Write] Active Mode

  • auto_assign_address (bool): [Read-Write] Auto-assign channel from drag/drop list order and available channels

  • custom_tags (Array(Name)): [Read-Write] Custom Tags

  • manual_starting_address (int32): [Read-Write] Starting channel for when auto-assign channel is false

  • name (str): [Read-Write] Name

  • parent_fixture_type_template (DMXEntityFixtureType): [Read-Only] Property to point to the template parent fixture for details panel purposes

  • universe_id (int32): [Read-Write] If set to a value on a Controller’s Universe IDs range (without the Range Offset), this Patch’s functions are sent over the network by that Controller.

    When set to a value on several Controllers’ range, the functions are sent by all of those Controllers.

active_mode

(int32) – [Read-Only] Active Mode

auto_assign_address

(bool) – [Read-Only] Auto-assign channel from drag/drop list order and available channels

contains_function(function_name) → bool

Return if fixture contains function.

Parameters:function_name (Name) –
Returns:
Return type:bool
convert_function_map_to_raw_map(function_map) -> Map(int32, uint8)

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

Parameters:function_map (Map(Name, int32)) –
Returns:
Return type:Map(int32, uint8)
convert_raw_map_to_function_map(raw_map) -> Map(Name, int32)

Given a <Channel Index -> Raw Value> map , return map of function names and their values.

Parameters:raw_map (Map(int32, uint8)) –
Returns:
Return type:Map(Name, int32)
convert_to_valid_map(function_map) -> Map(Name, int32)

Return a map that is valid for this fixture.

Parameters:function_map (Map(Name, int32)) –
Returns:
Return type:Map(Name, int32)
custom_tags

(Array(Name)) – [Read-Only] Custom Tags

get_all_functions_in_active_mode() -> Array(Name)

Return an array of function names for the currently active mode. Functions outside the Active Mode’s channel span range are ignored.

Returns:
Return type:Array(Name)
get_channel_span() → int32

Returns the number of channels this Patch occupies with the Fixture functions from its Active Mode. It’ll always be at least 1 channel.

Returns:
Return type:int32
get_function_channel_assignments() -> Map(Name, int32)

Return map of function names and their assigned channels. Functions outside the Active Mode’s channel span range are ignored.

Returns:
Return type:Map(Name, int32)
get_function_default_map() -> Map(Name, int32)

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

Returns:
Return type:Map(Name, int32)
get_function_signal_formats() -> Map(Name, DMXFixtureSignalFormat)

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

Returns:
Return type:Map(Name, DMXFixtureSignalFormat)
get_relevant_controllers() -> Array(DMXEntityController)

Scans the parent DMXLibrary and returns the Controllers which Universe range match this Patch’s UniverseID

Returns:
Return type:Array(DMXEntityController)
get_starting_channel() → int32

Return the active starting channel, evaluated after checking if Auto-Assignment is activated.

Returns:
Return type:int32
is_in_controller_range(controller) → bool

Returns true if this Patch’s UniverseID is in InController’s range

Parameters:controller (DMXEntityController) –
Returns:
Return type:bool
is_in_controllers_range(controllers) → bool

Returns true if this Patch’s UniverseID is in any of InControllers’ ranges

Parameters:controllers (Array(DMXEntityController)) –
Returns:
Return type:bool
is_map_valid(function_map) → bool

Return if given function map valid for this fixture.

Parameters:function_map (Map(Name, int32)) –
Returns:
Return type:bool
parent_fixture_type_template

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

universe_id

(int32) – [Read-Only] If set to a value on a Controller’s Universe IDs range (without the Range Offset), this Patch’s functions are sent over the network by that Controller.

When set to a value on several Controllers’ range, the functions are sent by all of those Controllers.