1. Epic GamesDeveloper
  3. UDMXSubsystem

UDMXSubsystem

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

API > API/Plugins > API/Plugins/DMXRuntime

Inheritance Hierarchy

  • UEngineSubsystem
  • UDMXSubsystem

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

  Type Name Description
Public variable FSimpleMulticastDelegate OnAllDMXLibraryAssetsLoaded Delegate broadcast when all DMX Library assets were loaded
Public variable FDMXOnDMXLibraryAssetDelegate OnDMXLibraryAssetAdded Delegate broadcast when a DMX Library asset was added
Public variable FDMXOnDMXLibraryAssetDelegate OnDMXLibraryAssetRemoved Delegate broadcast when a DMX Library asset was removed

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category int32

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

 Converts consecutive DMX channel values to a signed 32bit integer value.
Public function Const UFunction BlueprintPure, Category, Meta float

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

 Converts consecutive DMX channel values to a normalized value.
Public function Static UFunction BlueprintCallable, Category, Meta void Clears all buffered DMX data of Ports and Fixture Patches.
Public function UFunction BlueprintCallable, Category, Meta TArray< UDMXEntityController * >

GetAllControllersInLibrary ( const UDMXLibrary* DMXLibrary
)

 DEPRECATED 4.27
Public function TArray< UDMXLibrary * > DEPRECATED 5.5, instead use 'Load All DMX Libraries Synchronous'
Public function UFunction BlueprintCallable, Category TArray< UDMXEntityFixturePatch * >

GetAllFixturesInLibrary ( const UDMXLibrary* DMXLibrary
)

 Return an array of Fixture Patches in the provided DMX Library.
Public function UFunction BlueprintCallable, Category void

GetAllFixturesInUniverse ( const UDMXLibrary* DMXLibrary,
int32 UniverseId,
TArray< UDMXEntityFixturePatch* >& OutResult
)

 Return an array of Fixture Patches that reside in the provided universe.
Public function UFunction BlueprintCallable, Category void Return an array of Fixture Patches that use the provided category.
Public function UFunction BlueprintCallable, Category, Meta void Return an array of Fixture Patches that use the provided Fixture Type.
Public function UFunction BlueprintCallable, Category TArray< UDMXEntityFixturePatch * >

GetAllFixturesWithTag ( const UDMXLibrary* DMXLibrary,
FName CustomTag
)

 Return an array of Fixture Patches that have the custom tag set.
Public function UFunction BlueprintCallable, Category TArray< UDMXEntityFixtureType * > Returns all Fixture Types in a DMX Library.
Public function UFunction BlueprintCallable, Category, Meta bool Get array of all cells and associated data.
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 Gets the FName of an Attribute Name.
Public function UFunction BlueprintCallable, Category, Meta bool

GetCellAttributes ( UDMXEntityFixturePatch* FixturePatch,
TArray< FDMXAttributeName >& CellAttributes
)

 Get all attributes for the Fixture Patch.
Public function UFunction BlueprintCallable, Category, Meta UDMXEntityController *

GetControllerByName ( const UDMXLibrary* DMXLibrary,
const FString& Name
)

 DEPRECATED 4.27
Public function Static UFunction BlueprintCallable, Category, Meta void

GetDMXDataFromInputPort ( FDMXInputPortReference InputPortReference,
TArray< uint8 >& DMXData,
int32 LocalUniverse
)

 Gets latest DMX Values from a DMX Universe of a DMX Input Port.
Public function Static UFunction BlueprintCallable, Category, Meta void

GetDMXDataFromOutputPort ( FDMXOutputPortReference OutputPortReference,
TArray< uint8 >& DMXData,
int32 LocalUniverse
)

 Gets latest DMX Values from a DMX Universe of a DMX Output Port.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< TSoftObjectPtr< UDMXLibrary > > Gets all DMX Libraries in this project, returns an array of Soft Object References to the DMX Libraries without loading them.
Public function Static UFunction BlueprintCallable, Category, Meta UDMXSubsystem * Get the DMX Subsystem, callable.
Public function Static UFunction BlueprintPure, Category, Meta UDMXSubsystem * Get the DMX Subsystem, pure.
Public function UFunction BlueprintCallable, Category, Meta void

GetFixtureAttributes ( const UDMXEntityFixturePatch* InFixturePatch,
const TArray< uint8 >& DMXBuffer,
TMap< FDMXAttributeName, int32 >& OutResult
)

 Return a map with all DMX functions and their associated values provided DMX buffer and desired universe.
Public function UFunction BlueprintCallable, Category, Meta UDMXEntityFixturePatch *

GetFixtureByName ( const UDMXLibrary* DMXLibrary,
const FString& Name
)

 Return the Fixture Patch with given name or an invalid object if no Fixture Patch matches the name.
Public function UFunction BlueprintPure, Category, Meta UDMXEntityFixturePatch * Gets the Fixture Patch from a Fixture Patch Reference.
Public function UFunction BlueprintPure, Category, Meta UDMXEntityFixtureType * Gets the Fixture Type from a Fixture Type Reference.
Public function UFunction BlueprintCallable, Category, Meta UDMXEntityFixtureType *

GetFixtureTypeByName ( const UDMXLibrary* DMXLibrary,
const FString& Name
)

 Return the Fixture Type with provided name or an invalid object if no Fixture Type matches the name.
Public function UFunction BlueprintCallable, Category, Meta bool

GetFunctionsMap ( UDMXEntityFixturePatch* InFixturePatch,
TMap< FDMXAttributeName, int32 >& OutAttributesMap
)

 Gets a function map based on you active mode from FixturePatch
Public function UFunction BlueprintCallable, Category, Meta bool

GetFunctionsMapForPatch ( UDMXEntityFixturePatch* InFixturePatch,
TMap< FDMXAttributeName, int32 >& OutAttributesMap
)

 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, int32 >& InAttributesMap
)

 Gets function channel value by input function name
Public function UFunction BlueprintCallable, Category, Meta bool

GetMatrixCell ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
FDMXCell& Cell
)

 Get data for single cell.
Public function UFunction BlueprintCallable, Category, Meta bool

GetMatrixCellChannelsAbsolute ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
TMap< FDMXAttributeName, int32 >& AttributeChannelMap
)

 Gets the absolute starting channel of each cell attribute at given coordinate
Public function UFunction BlueprintCallable, Category, Meta bool

GetMatrixCellChannelsRelative ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
TMap< FDMXAttributeName, int32 >& AttributeChannelMap
)

 Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch.
Public function UFunction BlueprintCallable, Category, Meta bool

GetMatrixCellValue ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
TMap< FDMXAttributeName, int32 >& AttributeValueMap
)

 Get DMX Cell value using matrix coordinates.
Public function UFunction BlueprintPure, Category, Meta bool

GetMatrixProperties ( UDMXEntityFixturePatch* FixturePatch,
FDMXFixtureMatrix& MatrixProperties
)

 Get Matrix Fixture properties
Public function Const UFunction BlueprintPure, Category, Meta float

GetNormalizedAttributeValue ( UDMXEntityFixturePatch* InFixturePatch,
FDMXAttributeName InFunctionAttribute,
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 InSignalFormat
)

 Converts a signed 32bit integer value to a normalized value.
Public function Static UFunction BlueprintPure, Category, Meta void

IntValueToBytes ( int32 InValue,
EDMXFixtureSignalFormat InSignalFormat,
TArray< uint8 >& Bytes,
bool bUseLSB
)

 Converts a signed 32bit integer value to an array of DMX channel values.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< UDMXLibrary * > Loads all DMX Libraries in this project synchronous, returns an array of DMX Libraries
Public function Const UFunction BlueprintPure, Category, Meta void

NormalizedValueToBytes ( float InValue,
EDMXFixtureSignalFormat InSignalFormat,
TArray< uint8 >& Bytes,
bool bUseLSB
)

 Converts a normalized value to an array of DMX channel values.
Public function UFunction BlueprintCallable, Category, Meta bool

PatchIsOfSelectedType ( UDMXEntityFixturePatch* InFixturePatch,
FString RefTypeValue
)

 Returns true if a Fixture Patch is of a given FixtureType
Public function UFunction BlueprintCallable, Category void

PixelMappingDistributionSort ( EDMXPixelMappingDistribution InDistribution,
int32 InNumXPanels,
int32 InNumYPanels,
const TArray< int32 >& InUnorderedList,
TArray< int32 >& OutSortedList
)

 Sort an array according to the selected distribution pattern.
Public function UFunction BlueprintCallable, Category, Meta void

SendDMX ( UDMXEntityFixturePatch* FixturePatch,
TMap< FDMXAttributeName, int32 > AttributeMap,
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 > AddressValueMap,
EDMXSendResult& OutResult
)

 DEPRECATED 4.27
Public function Static UFunction BlueprintCallable, Category, Meta void

SendDMXToOutputPort ( FDMXOutputPortReference OutputPortReference,
TMap< int32, uint8 > ChannelToValueMap,
int32 LocalUniverse
)

 Sends DMX via an Output Port.
Public function UFunction BlueprintCallable, Category, Meta bool

SetMatrixCellValue ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
FDMXAttributeName Attribute,
int32 Value
)

 Set DMX Cell value using matrix coordinates.

Deprecated Variables

  Type Name Description
Public variable UProperty Category, Meta BlueprintAssignable FProtocolReceivedDelegate OnProtocolReceived_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page