UDMXSubsystem

[UDMXSubsystem](API\Plugins\DMXRuntime\UDMXSubsystem) Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXRuntime

Header

/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/DMXSubsystem.h

Include

#include "DMXSubsystem.h"

Syntax

UCLASS()
class UDMXSubsystem : public UEngineSubsystem

Remarks

UDMXSubsystem Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes

Variables

Name Description

Public variable

FSimpleMulticas...

 

OnAllDMXLibraryAssetsLoaded

Delegate broadcast when all dmx library assets were loaded

Public variable

FDMXOnDMXLibrar...

 

OnDMXLibraryAssetAdded

Delegate broadcast when a dmx library asset was added

Public variable

FDMXOnDMXLibrar...

 

OnDMXLibraryAssetRemoved

Delegate broadcast when a dmx library asset was removed

Functions

Name Description

Public function Const UFunction BlueprintPure, Category

int32

 

BytesToInt

(
    const TArray< uint8 >& Bytes,
    bool bUseLSB
)

Return integer given an array of bytes.

Public function Const UFunction BlueprintPure, Category, Meta

float

 

BytesToNormalizedValue

(
    const TArray< uint8 >& Bytes,
    bool bUseLSB
)

Return normalized value given an array of bytes.

Public function UFunction BlueprintCallable, Category, Meta

TArray< UDMX...

 

GetAllControllersInLibrary

(
    const UDMXLibrary* DMXLibrary
)

DEPRECATED 4.27

Public function UFunction BlueprintCallable, Category

const TArray...

 

GetAllDMXLibraries()

Return reference to array of DMX Library objects.

Public function UFunction BlueprintCallable, Category

TArray< UDMX...

 

GetAllFixturesInLibrary

(
    const UDMXLibrary* DMXLibrary
)

Return reference to array of Fixture Patch objects in library.

Public function UFunction BlueprintCallable, Category

void

 

GetAllFixturesInUniverse

(
    const UDMXLibrary* DMXLibrary,
    int32 UniverseId,
    TArray< UDMXEntityFixturePatch*...
)

Return reference to array of Fixture Patch objects in a given universe.

Public function UFunction BlueprintCallable, Category

void

 

GetAllFixturesOfCategory

(
    const UDMXLibrary* DMXLibrary,
    FDMXFixtureCategory Category,
    TArray< UDMXEntityFixturePatch*...
)

Return reference to array of Fixture Patch objects of a given category.

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetAllFixturesOfType

(
    const FDMXEntityFixtureTypeRef& Fi...,
    TArray< UDMXEntityFixturePatch*...
)

Return reference to array of Fixture Patch objects of a given type.

Public function UFunction BlueprintCallable, Category

TArray< UDMX...

 

GetAllFixturesWithTag

(
    const UDMXLibrary* DMXLibrary,
    FName CustomTag
)

Return reference to array of Fixture Patch objects with a given tag.

Public function UFunction BlueprintCallable, Category

TArray< UDMX...

 

GetAllFixtureTypesInLibrary

(
    const UDMXLibrary* DMXLibrary
)

Return reference to array of Fixture Types objects in library.

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetAllUniversesInController

(
    const UDMXLibrary* DMXLibrary,
    FString ControllerName,
    TArray< int32 >& OutResult
)

DEPRECATED 4.27

Public function UFunction BlueprintCallable, Category

FName

 

GetAttributeLabel

(
    FDMXAttributeName AttributeName
)

Gets the FName for a FDMXAttributeName, since structs can't have UFUCNTIONS to create a getter

Public function UFunction BlueprintCallable, Category, Meta

UDMXEntityCo...

 

GetControllerByName

(
    const UDMXLibrary* DMXLibrary,
    const FString& Name
)

DEPRECATED 4.27

Public function Static UFunction BlueprintCallable, Category

void

 

GetDMXDataFromInputPort

(
    FDMXInputPortReference InputPortRef...,
    TArray< uint8 >& DMXData,
    int32 LocalUniverse
)

Gets accumulated latest DMX Values from the Input Port (all that's been received since Begin Play)

Public function Static UFunction BlueprintCallable, Category

void

 

GetDMXDataFromOutputPort

(
    FDMXOutputPortReference OutputPortR...,
    TArray< uint8 >& DMXData,
    int32 LocalUniverse
)

Gets accumulated latest DMX Values from the Output Port (all that's been sent since Begin Play)

Public function Static UFunction BlueprintCallable, Category, Meta

UDMXSubsyste...

 

GetDMXSubsystem_Callable()

Get a DMX Subsystem, callable version

Public function Static UFunction BlueprintPure, Category, Meta

UDMXSubsyste...

 

GetDMXSubsystem_Pure()

Get a DMX Subsystem, pure version

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetFixtureAttributes

(
    const UDMXEntityFixturePatch* ...,
    const TArray< uint8 >& DMXBuffer,
    TMap< FDMXAttributeName, int32 >& ...
)

Return map with all DMX functions and their associated values given DMX buffer and desired universe.

Public function UFunction BlueprintCallable, Category, Meta

UDMXEntityFi...

 

GetFixtureByName

(
    const UDMXLibrary* DMXLibrary,
    const FString& Name
)

Return reference to Fixture Patch object with a given name.

Public function UFunction BlueprintPure, Category, Meta

UDMXEntityFi...

 

GetFixturePatch

(
    FDMXEntityFixturePatchRef InFixture...
)

Creates a literal UDMXEntityFixturePatch reference

Public function UFunction BlueprintPure, Category, Meta

UDMXEntityFi...

 

GetFixtureType

(
    FDMXEntityFixtureTypeRef InFixtureT...
)

Creates a literal UDMXEntityFixturePatch reference

Public function UFunction BlueprintCallable, Category, Meta

UDMXEntityFi...

 

GetFixtureTypeByName

(
    const UDMXLibrary* DMXLibrary,
    const FString& Name
)

Return reference to Fixture Type object with a given name.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetFunctionsMap

(
    UDMXEntityFixturePatch* InFixt...,
    TMap< FDMXAttributeName, int32 >& ...
)

Gets a function map based on you active mode from FixturePatch

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetFunctionsMapForPatch

(
    UDMXEntityFixturePatch* InFixt...,
    TMap< FDMXAttributeName, int32 >& ...
)

Gets a function map based on you active mode from FixturePatch, but instead of passing a Protocol as parameters, it looks for the first Protocol found in the Patch's universe and use that one

Public function UFunction BlueprintCallable, Category, Meta

int32

 

GetFunctionsValue

(
    const FName FunctionAttributeName,
    const TMap< FDMXAttributeName, int3...
)

Gets function channel value by input function name

Public function Const UFunction BlueprintPure, Category, Meta

float

 

GetNormalizedAttributeValue

(
    UDMXEntityFixturePatch* InFixt...,
    FDMXAttributeName InFunctionAttribu...,
    int32 InValue
)

Return the normalized value of an Int value from a Fixture Patch function.

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetRawBuffer

(
    FDMXProtocolName SelectedProtocol,
    int32 RemoteUniverse,
    TArray< uint8 >& DMXBuffer
)

DEPRECATED 4.27

Public function Const UFunction BlueprintPure, Category, Meta

float

 

IntToNormalizedValue

(
    int32 InValue,
    EDMXFixtureSignalFormat InSignalFor...
)

Return the normalized value of an Int value from the specified Signal Format.

Public function Static UFunction BlueprintPure, Category

void

 

IntValueToBytes

(
    int32 InValue,
    EDMXFixtureSignalFormat InSignalFor...,
    TArray< uint8 >& Bytes,
    bool bUseLSB
)

Return the Bytes format of Value in the desired Signal Format.

Public function Const UFunction BlueprintPure, Category, Meta

void

 

NormalizedValueToBytes

(
    float InValue,
    EDMXFixtureSignalFormat InSignalFor...,
    TArray< uint8 >& Bytes,
    bool bUseLSB
)

Return the Bytes format of Value in the desired Signal Format.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

PatchIsOfSelectedType

(
    UDMXEntityFixturePatch* InFixt...,
    FString RefTypeValue
)

Checks if a FixturePatchs is of a given FixtureType

Public function UFunction BlueprintCallable, Category

void

 

PixelMappingDistributionSort

(
    EDMXPixelMappingDistribution InDist...,
    int32 InNumXPanels,
    int32 InNumYPanels,
    const TArray< int32 >& InUnordered...,
    TArray< int32 >& OutSortedList
)

Sort an array according to the selected distribution pattern.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SendDMX

(
    UDMXEntityFixturePatch* Fixtur...,
    TMap< FDMXAttributeName, int32 > At...,
    EDMXSendResult& OutResult
)

Send DMX using function names and integer values.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SendDMXRaw

(
    FDMXProtocolName SelectedProtocol,
    int32 RemoteUniverse,
    TMap< int32, uint8 > AddressValueMa...,
    EDMXSendResult& OutResult
)

DEPRECATED 4.27

Public function Static UFunction BlueprintCallable, Category

void

 

SendDMXToOutputPort

(
    FDMXOutputPortReference OutputPortR...,
    TMap< int32, uint8 > ChannelToValue...,
    int32 LocalUniverse
)

Sends DMX Values over the Output Port

Overridden from USubsystem

Name Description

Public function Virtual

void

 

Initialize

(
    FSubsystemCollectionBase& Collecti...
)

Implement this for initialization of instances of the system

Deprecated Variables

Name Description

Public variable UProperty Category, Meta BlueprintAssignable

FProtocolReceiv...

 

OnProtocolReceived_DEPRECATED

Use DMXComponent's OnFixturePatchReceived event or GetRawBuffer instead.

Deprecated Functions

Name Description

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetAllMatrixCells

(
    UDMXEntityFixturePatch* Fixtur...,
    TArray< FDMXCell >& Cells
)

Use UDMXEntityFixturePatch::GetAllMatrixCells instead.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetCellAttributes

(
    UDMXEntityFixturePatch* Fixtur...,
    TArray< FDMXAttributeName >& CellA...
)

Use UDMXEntityFixturePatch::GetCellAttributes instead.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetMatrixCell

(
    UDMXEntityFixturePatch* Fixtur...,
    FIntPoint Coordinate,
    FDMXCell& Cell
)

Use UDMXEntityFixturePatch::GetMatrixCell instead.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetMatrixCellChannelsAbsolute

(
    UDMXEntityFixturePatch* Fixtur...,
    FIntPoint Coordinate,
    TMap< FDMXAttributeName, int32 >& ...
)

Use UDMXEntityFixturePatch::GetMatrixCellChannelsAbsolute instead.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetMatrixCellChannelsRelative

(
    UDMXEntityFixturePatch* Fixtur...,
    FIntPoint Coordinate,
    TMap< FDMXAttributeName, int32 >& ...
)

Use UDMXEntityFixturePatch::GetMatrixCellChannelsRelative instead.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

GetMatrixCellValue

(
    UDMXEntityFixturePatch* Fixtur...,
    FIntPoint Coordinate,
    TMap< FDMXAttributeName, int32 >& ...
)

Use UDMXEntityFixturePatch::GetMatrixCellValue instead.

Public function UFunction BlueprintPure, Category, Meta

bool

 

GetMatrixProperties

(
    UDMXEntityFixturePatch* Fixtur...,
    FDMXFixtureMatrix& MatrixPropertie...
)

Use UDMXEntityFixturePatch::GetMatrixProperties instead.

Public function UFunction BlueprintCallable, Category, Meta

bool

 

SetMatrixCellValue

(
    UDMXEntityFixturePatch* Fixtur...,
    FIntPoint Coordinate,
    FDMXAttributeName Attribute,
    int32 Value
)

Use UDMXEntityFixturePatch::SetMatrixCellValue instead.