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 Modeauto_assign_address
(bool): [Read-Write] Auto-assign address from drag/drop list order and available channelscustom_tags
(Array(Name)): [Read-Write] Custom Tagseditor_color
(LinearColor): [Read-Write] Color when displayed in the fixture patch editormanual_starting_address
(int32): [Read-Write] Starting channel for when auto-assign address is falsename
(str): [Read-Write] Nameparent_fixture_type_template
(DMXEntityFixtureType): [Read-Only] Property to point to the template parent fixture for details panel purposesuniverse_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.
-
property
active_mode
¶ [Read-Only] Active Mode
- Type
(int32)
-
property
auto_assign_address
¶ [Read-Only] Auto-assign address from drag/drop list order and available channels
- Type
(bool)
-
contains_attribute
(function_attribute) → bool¶ Return if fixture contains function.
- Parameters
function_attribute (DMXAttributeName) –
- Returns
- Return type
-
convert_attribute_map_to_raw_map
(function_map)¶ Return map of function channels and their values. Functions outside the Active Mode’s channel span range are ignored.
- Parameters
function_map (Map(DMXAttributeName, int32)) –
- Returns
- Return type
Map(int32, uint8)
-
convert_raw_map_to_attribute_map
(raw_map)¶ 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(DMXAttributeName, int32)
-
convert_to_valid_map
(function_map)¶ Return a map that is valid for this fixture.
- Parameters
function_map (Map(DMXAttributeName, int32)) –
- Returns
- Return type
Map(DMXAttributeName, int32)
-
property
editor_color
¶ [Read-Only] Color when displayed in the fixture patch editor
- Type
-
get_all_attributes_in_active_mode
()¶ Return an array of valid attributes for the currently active mode. Attributes outside the Active Mode’s channel span range are ignored.
- Returns
- Return type
-
get_all_functions_in_active_mode
()¶ Return an array of function names for the currently active mode. Functions outside the Active Mode’s channel span range are ignored. deprecated: Deprecated 4.26. Conversion from function name String to FName is lossy.
-
get_all_matrix_cells
() → Array(DMXCell) or None¶ Get array of all cells and associated data.
-
get_attribute_channel_assignments
()¶ Return map of Attributes and their assigned channels
- Returns
- Return type
Map(DMXAttributeName, int32)
-
get_attribute_default_map
()¶ Return map of function names and default values. Functions outside the Active Mode’s channel span range are ignored.
- Returns
- Return type
Map(DMXAttributeName, int32)
-
get_attribute_functions_map
()¶ Return map of attributes and function names. Attributes outside the Active Mode’s channel span range are ignored.
- Returns
- Return type
-
get_attribute_signal_formats
()¶ Return map of function names and their Data Types. Functions outside the Active Mode’s channel span range are ignored.
- Returns
- Return type
-
get_attribute_value
(attribute) -> (int32, success=bool)¶ Retrieve 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
-
get_attributes_values
()¶ 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¶ Get all attributes for the fixture patch.
- Returns
cell_attributes (Array(DMXAttributeName)):
- Return type
-
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_ending_channel
() → int32¶ Get Ending Channel
- Returns
- Return type
int32
-
get_function_attributes_map
()¶ Return map of function names and attributes Attributes outside the Active Mode’s channel span range are ignored. deprecated: Deprecated 4.26. Conversion from function name String to FName is lossy.
- Returns
- Return type
-
get_matrix_cell
(cell_coordinate) → DMXCell or None¶ Cell coordinate X/Y
-
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_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¶ Get Matrix Fixture properties
- Returns
matrix_properties (DMXFixtureMatrix):
- Return type
-
get_normalized_attribute_value
(attribute) -> (float, success=bool)¶ Retrieve 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
-
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
-
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
()¶ Scans the parent DMXLibrary and returns the Controllers which Universe range match this Patch’s UniverseID
- Returns
- Return type
-
get_remote_universe
() → int32¶ Return the remote universe the patch is registered to.
- Returns
- Return type
int32
-
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
-
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
-
is_map_valid
(function_map) → bool¶ Return if given function map is valid for this fixture.
- Parameters
function_map (Map(DMXAttributeName, int32)) –
- Returns
- Return type
-
property
parent_fixture_type_template
¶ [Read-Only] Property to point to the template parent fixture for details panel purposes
- Type
-
send_matrix_cell_value
(cell_coordinate, attribute, value) → bool¶ Cell coordinate X/Y
- Parameters
cell_coordinate (IntPoint) –
attribute (DMXAttributeName) –
value (int32) –
- Returns
- Return type
-
send_normalized_matrix_cell_value
(cell_coordinate, attribute, relative_value) → bool¶ Cell coordinate X/Y
- Parameters
cell_coordinate (IntPoint) –
attribute (DMXAttributeName) –
relative_value (float) –
- Returns
- Return type
-
property
universe_id
¶ [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.
- Type
(int32)