UMovieSceneDMXLibrarySection | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/DMXRuntime > API/Plugins/DMXRuntime/Sequencer

Inheritance Hierarchy

UObject
UMovieSceneSignedObject
UMovieSceneSection
UMovieSceneDMXLibrarySection

References


Module	DMXRuntime
Header	/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Sequencer/MovieSceneDMXLibrarySection.h
Include	#include "Sequencer/MovieSceneDMXLibrarySection.h"

Syntax

UCLASS ()  
class UMovieSceneDMXLibrarySection : public UMovieSceneSection

Remarks

A DMX Fixture Patch section

Variables

Type	Name	Description
bool	bIsRecording	When recording DMX data into this track, this is set to true to prevent track evaluation from sending data to DMX simultaneously.
bool	bUseNormalizedValues	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.
TArray< FDMXFixturePatchChannel >	FixturePatchChannels	The Fixture Patches being controlled by this section and their respective chosen mode

Constructors

	Type	Name	Description
		UMovieSceneDMXLibrarySection ()

Functions

Type	Name	Description
void	AddFixturePatch ( UDMXEntityFixturePatch* InPatch )	Adds a single patch to the section
void	AddFixturePatches ( const TArray< FDMXEntityFixturePatchRef >& InFixturePatchRefs )	Adds all patches to the secion
bool	ContainsFixturePatch ( UDMXEntityFixturePatch* InPatch )	Check if this Section animates a Fixture Patch's Functions
void	EvaluateAndSendDMX ( const FFrameTime& InFrameTime )	Evaluates DMX at given fame time and sends it
bool	GetFixturePatchChannelEnabled ( UDMXEntityFixturePatch* InPatch, int32 InChannelIndex )	Returns whether a Fixture Patch's Function curve channel is currently enabled
const TArray< FDMXFixturePatchChannel > &	GetFixturePatchChannels ()
TArray< UDMXEntityFixturePatch * >	GetFixturePatches ()	Get a list of the Fixture Patches being animated by this Section
bool	GetIsRecording ()	Checked in evaluation to prevent sending DMX data while recording it with the Take Recorder.
TArray< FDMXFixturePatchChannel > &	GetMutableFixturePatchChannels ()
int32	GetNumPatches ()	Get the list of animated Fixture Patches and their curve channels
FDMXFixturePatchChannel *	GetPatchChannel ( UDMXEntityFixturePatch* Patch )	Returns the channel for specified patch or nullptr if the patch is not in use
void	RebuildPlaybackCache ()	Precaches data for playback
void	RefreshChannels ()	Refreshes the channels. Useful e.g. when underlying DMX Library changes
void	RemoveFixturePatch ( UDMXEntityFixturePatch* InPatch )	Remove all Functions of a Fixture Patch
void	RemoveFixturePatch ( const FName& InPatchName )	Remove all Functions of a Fixture Patch, searching it by name
void	SendDMXForChannelsToInitialize ()	Sends DMX for channels that need initialization (one time evaluation) only
void	SetFixturePatchActiveMode ( UDMXEntityFixturePatch* InPatch, int32 InActiveMode )	Sets the active mode for a Fixture Patch
void	SetIsRecording ( bool bNewState )	Used only by the Take Recorder to prevent Track evaluation from sending DMX data while recording it.
void	ToggleFixturePatchChannel ( UDMXEntityFixturePatch* InPatch, int32 InChannelIndex )	Toggle the visibility and evaluation of a Fixture Patch's Function.
void	ToggleFixturePatchChannel ( const FName& InPatchName, const FName& InChannelName )	Toggle the visibility and evaluation of a Fixture Patch's Function searching both the Patch and Function by name.
void	UpdateChannelProxy ( bool bResetDefaultChannelValues )	Update the displayed Patches and Function channels in the section