unreal.MovieSceneDMXLibrarySection
¶
- class unreal.MovieSceneDMXLibrarySection(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
MovieSceneSection
A DMX Fixture Patch section
C++ Source:
Plugin: DMXEngine
Module: DMXRuntime
File: MovieSceneDMXLibrarySection.h
Editor Properties: (see get_editor_property/set_editor_property)
color_tint
(Color): [Read-Write] The color tint for this sectioneasing
(MovieSceneEasingSettings): [Read-Write]eval_options
(MovieSceneSectionEvalOptions): [Read-Write]is_active
(bool): [Read-Write] Toggle whether this section is active/inactiveis_locked
(bool): [Read-Write] Toggle whether this section is locked/unlockedpost_roll_frames
(FrameNumber): [Read-Write] The amount of time to continue ‘postrolling’ this section for after evaluation has ended.pre_roll_frames
(FrameNumber): [Read-Write] The amount of time to prepare this section for evaluation before it actually starts.section_range
(MovieSceneFrameRange): [Read-Write] The range in which this section is activetimecode_source
(MovieSceneTimecodeSource): [Read-Write] The timecode at which this movie scene section is based (ie. when it was recorded)use_normalized_values
(bool): [Read-Write] If true, all values are interpreted as normalized values (0.0 to 1.0) and are mapped to the actual value range of a patch automatically.If false, values are interpreted as absolute values, depending on the data type of a patch: 0-255 for 8bit, 0-65’536 for 16bit, 0-16’777’215 for 24bit. 32bit is not fully supported in this mode.
- add_fixture_patch(patch) None ¶
Adds a single patch to the section
- Parameters:
patch (DMXEntityFixturePatch) –
- add_fixture_patches(fixture_patch_refs) None ¶
Adds all patches to the secion
- Parameters:
fixture_patch_refs (Array[DMXEntityFixturePatchRef]) –
- contains_fixture_patch(patch) bool ¶
Check if this Section animates a Fixture Patch’s Functions
- Parameters:
patch (DMXEntityFixturePatch) –
- Return type:
- get_fixture_patch_channel_enabled(patch, channel_index) bool ¶
Returns whether a Fixture Patch’s Function curve channel is currently enabled
- Parameters:
patch (DMXEntityFixturePatch) –
channel_index (int32) –
- Return type:
- get_fixture_patches() Array[DMXEntityFixturePatch] ¶
Get a list of the Fixture Patches being animated by this Section
- Return type:
- get_num_patches() int32 ¶
Get the list of animated Fixture Patches and their curve channels
- Return type:
int32
- remove_fixture_patch(patch) None ¶
Remove all Functions of a Fixture Patch
- Parameters:
patch (DMXEntityFixturePatch) –
- set_fixture_patch_active_mode(patch, active_mode) None ¶
Sets the active mode for a Fixture Patch
- Parameters:
patch (DMXEntityFixturePatch) –
active_mode (int32) –
- toggle_fixture_patch_channel(patch, channel_index) None ¶
Toggle the visibility and evaluation of a Fixture Patch’s Function. When invisible, the Function won’t send its data to DMX Protocol.
- Parameters:
patch (DMXEntityFixturePatch) –
channel_index (int32) –
- property use_normalized_values: bool¶
[Read-Write] If true, all values are interpreted as normalized values (0.0 to 1.0) and are mapped to the actual value range of a patch automatically.
If false, values are interpreted as absolute values, depending on the data type of a patch: 0-255 for 8bit, 0-65’536 for 16bit, 0-16’777’215 for 24bit. 32bit is not fully supported in this mode.
- Type:
(bool)