UST_DMXManager Class Reference

Manages DMX controls for the ShaderTech audio system. More...

#include <ST_DMXManager.h>

Public Member Functions
	UST_DMXManager ()
	Constructor for the UST_DMXManager class.
bool	SendDMXMatrixCellToMatrix (class UDMXEntityFixturePatch *FixturePatch, TArray< uint8 > LEDColourByteArray, ELEDColourFormat ColourFormat, TArray< FDMXCell > MatrixCells, TArray< FDMXAttributeName > MatrixCellAttributes)
	Sends DMX matrix cell data to the DMX matrix.
bool	SendDMXAttributeToMatrix (class UDMXEntityFixturePatch *FixturePatch, TMap< FDMXAttributeName, int32 > AttributeValueMap)
	Sends a set of DMX attribute values to a fixture patch.
Public Member Functions inherited from UST_AudioControlManagerBase
	UST_AudioControlManagerBase ()
	Constructor for UST_AudioControlManagerBase.
bool	RegisterManagedItem (UObject *ManagedItem)
	Registers a managed item with the subsystem.
bool	DeregisterManagedItem (UObject *ManagedItem)
	Deregisters a managed item from the subsystem.
bool	RegisterController (FST_AudioController Controller)
	Registers an audio controller with the subsystem.
bool	DeregisterController (FST_AudioController Controller)
	Deregisters an audio controller from the subsystem.
const TArray< UObject * > &	GetManagedItems () const
	Gets the list of currently managed items.
const TArray< FST_AudioController > &	GetRegisteredControllers () const
	Gets the list of currently registered controllers.
Public Member Functions inherited from IST_DMXControlInterface
void	OnDMXItemRegistered ()
	Called when a DMX item is registered.
void	OnDMXItemDeregistered ()
	Called when a DMX item is deregistered.

Static Public Member Functions
static UST_DMXManager *	GetInstance (const UObject *context)
	Retrieves the singleton instance of the UST_DMXManager.

Protected Member Functions
virtual void	OnManagedItemRegistered (UObject *ManagedItem, bool bFirstManagedItemRegistered) override
	Called when a managed item is registered.
virtual void	OnManagedItemDeregistered (UObject *ManagedItem, bool bAllManagedItemDeregistered) override
	Called when a managed item is deregistered.
virtual void	OnControllerRegistered (FST_AudioController Controller, bool bFirstControllerRegistered) override
	Called when a controller is registered.
virtual void	OnControllerDeregistered (FST_AudioController Controller, bool bAllControllersDeregistered) override
	Called when a controller is deregistered.
Protected Member Functions inherited from UST_AudioControlManagerBase
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
	Called when the subsystem is initialized.
virtual void	Deinitialize () override
	Called before the subsystem is destroyed.

Detailed Description

Manages DMX controls for the ShaderTech audio system.

The UST_DMXManager class is responsible for sending DMX data to the DMX matrix and managing DMX controllers and fixture patches. It provides functionality for controlling LED matrix cells and attributes, as well as handling the registration and deregistration of managed items and controllers.

Member Function Documentation

GetInstance()

UST_DMXManager * UST_DMXManager::GetInstance ( const UObject * context )

static

Retrieves the singleton instance of the UST_DMXManager.

This method ensures that there is only one instance of the DMX manager.

Parameters

context

The context object, used to determine the instance.

Returns

A pointer to the singleton instance of UST_DMXManager.

OnControllerDeregistered()

void UST_DMXManager::OnControllerDeregistered ( FST_AudioController Controller, bool bAllControllersDeregistered )

overrideprotectedvirtual

Called when a controller is deregistered.

This method is invoked when an audio controller is deregistered.

Parameters

Controller	The audio controller that was deregistered.
bAllControllersDeregistered	Whether all controllers have been deregistered.

Reimplemented from UST_AudioControlManagerBase.

OnControllerRegistered()

void UST_DMXManager::OnControllerRegistered ( FST_AudioController Controller, bool bFirstControllerRegistered )

overrideprotectedvirtual

Called when a controller is registered.

This method is invoked when a new audio controller is registered.

Parameters

Controller	The audio controller that was registered.
bFirstControllerRegistered	Whether this is the first controller to be registered.

Reimplemented from UST_AudioControlManagerBase.

OnManagedItemDeregistered()

void UST_DMXManager::OnManagedItemDeregistered ( UObject * ManagedItem, bool bAllManagedItemDeregistered )

overrideprotectedvirtual

Called when a managed item is deregistered.

This method is invoked when a managed item is deregistered. It can be used for cleanup tasks.

Parameters

ManagedItem	A pointer to the managed item.
bAllManagedItemDeregistered	Whether all managed items have been deregistered.

Reimplemented from UST_AudioControlManagerBase.

OnManagedItemRegistered()

void UST_DMXManager::OnManagedItemRegistered ( UObject * ManagedItem, bool bFirstManagedItemRegistered )

overrideprotectedvirtual

Called when a managed item is registered.

This method is invoked when a new managed item is registered. It can be used for setup or initialization tasks.

Parameters

ManagedItem	A pointer to the managed item.
bFirstManagedItemRegistered	Whether this is the first item to be registered.

Reimplemented from UST_AudioControlManagerBase.

SendDMXAttributeToMatrix()

bool UST_DMXManager::SendDMXAttributeToMatrix	(	class UDMXEntityFixturePatch *	FixturePatch,
		TMap< FDMXAttributeName, int32 >	AttributeValueMap )

Sends a set of DMX attribute values to a fixture patch.

This function allows sending attribute-value pairs to a fixture patch, modifying the DMX data associated with the fixture.

Parameters

FixturePatch	A pointer to the fixture patch that will receive the DMX attributes.
AttributeValueMap	A map containing DMX attribute names and their corresponding values.

Returns

True if the data was successfully sent, false otherwise.

SendDMXMatrixCellToMatrix()

bool UST_DMXManager::SendDMXMatrixCellToMatrix	(	class UDMXEntityFixturePatch *	FixturePatch,
		TArray< uint8 >	LEDColourByteArray,
		ELEDColourFormat	ColourFormat,
		TArray< FDMXCell >	MatrixCells,
		TArray< FDMXAttributeName >	MatrixCellAttributes )

Sends DMX matrix cell data to the DMX matrix.

This function sends a set of LED color data to a specified fixture patch, along with the attributes and formatting information for the cells in the matrix.

Parameters

FixturePatch	A pointer to the fixture patch that will receive the DMX data.
LEDColourByteArray	An array of bytes representing the LED color values.
ColourFormat	The format for the LED color data.
MatrixCells	An array of DMX cells representing the positions of the matrix cells.
MatrixCellAttributes	The attributes of the matrix cells.

Returns

True if the data was successfully sent, false otherwise.

---

The documentation for this class was generated from the following files:

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Public/DMX/ST_DMXManager.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioControl/Private/DMX/ST_DMXManager.cpp