Navigation
API > API/Plugins > API/Plugins/DMXRuntime
A DMX Fixture Patch section
| Name | UMovieSceneDMXLibrarySection |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Sequencer/MovieSceneDMXLibrarySection.h |
| Include Path | #include "Sequencer/MovieSceneDMXLibrarySection.h" |
Syntax
UCLASS ()
class UMovieSceneDMXLibrarySection : public UMovieSceneSection
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneSignedObject → UMovieSceneDecorationContainerObject → UMovieSceneSection → UMovieSceneDMXLibrarySection
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieSceneDMXLibrarySection() |
Sequencer/MovieSceneDMXLibrarySection.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseNormalizedValues | bool | 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. | Sequencer/MovieSceneDMXLibrarySection.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bNeedsSendChannelsToInitialize | bool | Cache. | Sequencer/MovieSceneDMXLibrarySection.h | |
| CachedChannelsToEvaluate | TArray< FDMXCachedFunctionChannelInfo > | Cached channel info for functions that need continous evaluation | Sequencer/MovieSceneDMXLibrarySection.h | |
| CachedChannelsToInitialize | TArray< FDMXCachedFunctionChannelInfo > | Cached channel info for functions that need initialization (one time evaluation) only | Sequencer/MovieSceneDMXLibrarySection.h | |
| CachedOutputPorts | TSet< FDMXOutputPortSharedRef > | The output ports which should be used during playback | Sequencer/MovieSceneDMXLibrarySection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddFixturePatch
(
UDMXEntityFixturePatch* InPatch |
Adds a single patch to the section | Sequencer/MovieSceneDMXLibrarySection.h |
|
void AddFixturePatches
(
const TArray< FDMXEntityFixturePatchRef >& InFixturePatchRefs |
Adds all patches to the secion | Sequencer/MovieSceneDMXLibrarySection.h |
|
bool ContainsFixturePatch
(
UDMXEntityFixturePatch* InPatch |
Check if this Section animates a Fixture Patch's Functions | Sequencer/MovieSceneDMXLibrarySection.h |
|
void EvaluateAndSendDMX
(
const FFrameTime& InFrameTime |
Evaluates DMX at given fame time and sends it | Sequencer/MovieSceneDMXLibrarySection.h | |
bool GetFixturePatchChannelEnabled
(
UDMXEntityFixturePatch* InPatch, |
Returns whether a Fixture Patch's Function curve channel is currently enabled | Sequencer/MovieSceneDMXLibrarySection.h |
|
const TArray< FDMXFixturePatchChannel > & GetFixturePatchChannels() |
Sequencer/MovieSceneDMXLibrarySection.h | ||
TArray< UDMXEntityFixturePatch * > GetFixturePatches() |
Get a list of the Fixture Patches being animated by this Section | Sequencer/MovieSceneDMXLibrarySection.h |
|
bool GetIsRecording() |
Checked in evaluation to prevent sending DMX data while recording it with the Take Recorder. | Sequencer/MovieSceneDMXLibrarySection.h | |
TArray< FDMXFixturePatchChannel > & GetMutableFixturePatchChannels() |
Sequencer/MovieSceneDMXLibrarySection.h | ||
int32 GetNumPatches() |
Get the list of animated Fixture Patches and their curve channels | Sequencer/MovieSceneDMXLibrarySection.h |
|
FDMXFixturePatchChannel * GetPatchChannel
(
UDMXEntityFixturePatch* Patch |
Returns the channel for specified patch or nullptr if the patch is not in use | Sequencer/MovieSceneDMXLibrarySection.h | |
void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Sequencer/MovieSceneDMXLibrarySection.h | ||
virtual void PostEditImport() |
Sequencer/MovieSceneDMXLibrarySection.h | ||
virtual void PostLoad() |
Sequencer/MovieSceneDMXLibrarySection.h | ||
void RebuildPlaybackCache() |
Precaches data for playback | Sequencer/MovieSceneDMXLibrarySection.h | |
void RefreshChannels() |
Refreshes the channels. Useful e.g. when underlying DMX Library changes | Sequencer/MovieSceneDMXLibrarySection.h | |
void RemoveFixturePatch
(
UDMXEntityFixturePatch* InPatch |
Remove all Functions of a Fixture Patch | Sequencer/MovieSceneDMXLibrarySection.h |
|
void RemoveFixturePatch
(
const FName& InPatchName |
Remove all Functions of a Fixture Patch, searching it by name | Sequencer/MovieSceneDMXLibrarySection.h | |
virtual void Serialize
(
FArchive& Ar |
Sequencer/MovieSceneDMXLibrarySection.h | ||
void SetFixturePatchActiveMode
(
UDMXEntityFixturePatch* InPatch, |
Sets the active mode for a Fixture Patch | Sequencer/MovieSceneDMXLibrarySection.h |
|
void SetIsRecording
(
bool bNewState |
Used only by the Take Recorder to prevent Track evaluation from sending DMX data while recording it. | Sequencer/MovieSceneDMXLibrarySection.h | |
void ToggleFixturePatchChannel
(
UDMXEntityFixturePatch* InPatch, |
Toggle the visibility and evaluation of a Fixture Patch's Function. | Sequencer/MovieSceneDMXLibrarySection.h |
|
void ToggleFixturePatchChannel
(
const FName& InPatchName, |
Toggle the visibility and evaluation of a Fixture Patch's Function searching both the Patch and Function by name. | Sequencer/MovieSceneDMXLibrarySection.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SendDMXForChannelsToInitialize() |
Sends DMX for channels that need initialization (one time evaluation) only | Sequencer/MovieSceneDMXLibrarySection.h | |
void UpdateChannelProxy
(
bool bResetDefaultChannelValues |
Update the displayed Patches and Function channels in the section | Sequencer/MovieSceneDMXLibrarySection.h |