UMovieSceneDMXLibrarySection

A DMX Fixture Patch section

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

DMXRuntime

Header

/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Sequencer/MovieSceneDMXLibrarySection.h

Include

#include "Sequencer/MovieSceneDMXLibrarySection.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UMovieSceneDMXLibrarySection : public UMovieSceneSection

Remarks

A DMX Fixture Patch section

Variables

Name Description

Protected variable

bool

 

bIsRecording

When recording DMX data into this track, this is set to true to prevent track evaluation from sending data to DMX simultaneously.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

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.

Protected variable UProperty

TArray< FDMXFix...

 

FixturePatchChannels

The Fixture Patches being controlled by this section and their respective chosen mode

Constructors

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

AddFixturePatch

(
    UDMXEntityFixturePatch* InPatc...
)

Adds a single patch to the section

Public function UFunction BlueprintCallable, Category

void

 

AddFixturePatches

(
    const TArray< FDMXEntityFixturePatc...
)

Adds all patches to the secion

Public function Const UFunction BlueprintPure, Category

bool

 

ContainsFixturePatch

(
    UDMXEntityFixturePatch* InPatc...
)

Check if this Section animates a Fixture Patch's Functions

Public function Const

void

 

EvaluateAndSendDMX

(
    const FFrameTime& InFrameTime
)

Evaluates DMX at given fame time and sends it

Public function Const UFunction BlueprintPure, Category

bool

 

GetFixturePatchChannelEnabled

(
    UDMXEntityFixturePatch* InPatc...,
    int32 InChannelIndex
)

Returns whether a Fixture Patch's Function curve channel is currently enabled

Public function Const

const TArray...

 

GetFixturePatchChannels()

Public function Const UFunction BlueprintPure, Category

TArray< UDMX...

 

GetFixturePatches()

Get a list of the Fixture Patches being animated by this Section

Public function Const

bool

 

GetIsRecording()

Checked in evaluation to prevent sending DMX data while recording it with the Take Recorder.

Public function

TArray< FDMX...

 

GetMutableFixturePatchChannels()

Public function Const UFunction BlueprintPure, Category

int32

 

GetNumPatches()

Get the list of animated Fixture Patches and their curve channels

Public function

FDMXFixtureP...

 

GetPatchChannel

(
    UDMXEntityFixturePatch* Patch
)

Returns the channel for specified patch or nullptr if the patch is not in use

Public function Const

void

 

RebuildPlaybackCache()

Precaches data for playback

Public function

void

 

RefreshChannels()

Refreshes the channels. Useful e.g. when underlying DMX Library changes

Public function UFunction BlueprintCallable, Category

void

 

RemoveFixturePatch

(
    UDMXEntityFixturePatch* InPatc...
)

Remove all Functions of a Fixture Patch

Public function

void

 

RemoveFixturePatch

(
    const FName& InPatchName
)

Remove all Functions of a Fixture Patch, searching it by name

Protected function Const

void

 

SendDMXForChannelsToInitialize()

Sends DMX for channels that need initialization (one time evaluation) only

Public function UFunction BlueprintCallable, Category

void

 

SetFixturePatchActiveMode

(
    UDMXEntityFixturePatch* InPatc...,
    int32 InActiveMode
)

Sets the active mode for a Fixture Patch

Public function

void

 

SetIsRecording

(
    bool bNewState
)

Used only by the Take Recorder to prevent Track evaluation from sending DMX data while recording it.

Public function UFunction BlueprintCallable, Category

void

 

ToggleFixturePatchChannel

(
    UDMXEntityFixturePatch* InPatc...,
    int32 InChannelIndex
)

Toggle the visibility and evaluation of a Fixture Patch's Function.

Public 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.

Protected function

void

 

UpdateChannelProxy

(
    bool bResetDefaultChannelValues
)

Update the displayed Patches and Function channels in the section

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditImport()

Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss