Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DMXRuntime > Library > UDMXEntityFixturePatch

Light Theme

Dark Theme

UDMXEntityFixturePatch

A DMX fixture patch that can be patch to channels in a DMX Universe via the DMX Library Editor.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXObjectBase

UDMXEntity

UDMXEntityFixturePatch

References

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

Syntax

UCLASS(BlueprintType, Blueprintable, Meta=(DisplayName="DMX Fixture Patch"))
class UDMXEntityFixturePatch :
public UDMXEntity,
public FTickableGameObject

Remarks

A DMX fixture patch that can be patch to channels in a DMX Universe via the DMX Library Editor.

Use in DMXComponent or call SetReceiveDMXEnabled with 'true' to enable receiving DMX.

Variables

	Name	Description
int32	ActiveMode	The Index of the Mode in the Fixture Type the Patch uses
int32	AutoStartingAddress	Starting channel from auto-assignment. Used when AutoAssignAddress is true
bool	bAutoAssignAddress	Auto-assign address from drag/drop list order and available channels
bool	bReceiveDMXInEditor	If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX event in editor.
TArray< FName >	CustomTags	Custom tags for filtering patches
FLinearColor	EditorColor	Color when displayed in the fixture patch editor
int32	ManualStartingAddress	Starting channel for when auto-assign address is false
FDMXOnFixturePa...	OnFixturePatchReceivedDMX	Broadcasts when the patch received dmx
UDMXEntityFixtu...	ParentFixtureTypeTemplate	Property to point to the template parent fixture for details panel purposes
int32	UniverseID	The local universe of the patch

Constructors

	Name	Description
	UDMXEntityFixturePatch()

Functions

	Name	Description
bool	ContainsAttribute ( FDMXAttributeName FunctionAttribute )	Returns true if the fixture patch contains the attribute.
TMap< int32,...	ConvertAttributeMapToRawMap ( const TMap< FDMXAttributeName, int3... )	Returns a map of function channels and their values.
TMap< FDMXAt...	ConvertToValidMap ( const TMap< FDMXAttributeName, int3... )	Returns a map that only contains attributes used this patch.
UDMXEntityFi...	CreateFixturePatchInLibrary ( FDMXEntityFixturePatchConstructionP..., const FString& DesiredName, bool bMarkDMXLibraryDirty )	Creates a new Fixture Patch in the DMX Library using the specified Fixture Type
const FDMXFi...	GetActiveMode()	Returns the active mode, or nullptr if there is no valid active mode
int32	GetActiveModeIndex()	Returns the index of the Mode the Patch uses from its Fixture Type
FName	GetActiveModePropertyNameChecked()
TArray< FDMX...	GetAllAttributesInActiveMode()	Returns an array of valid attributes for the currently active mode.
bool	GetAllMatrixCells ( TArray< FDMXCell >& Cells )	Gets all matrix cells
TMap< FDMXAt...	GetAttributeChannelAssignments()	Returns a map of Attributes and their assigned channels
TMap< FDMXAt...	GetAttributeDefaultMap()	Returns a map of function names and default values.
const FDMXFi...	GetAttributeFunction ( const FDMXAttributeName& Attribute )	Returns the function currently mapped to the passed in Attribute, if any.
TMap< FDMXAt...	GetAttributeFunctionsMap()	Returns a map of attributes and function names.
TMap< FDMXAt...	GetAttributeSignalFormats()	Returns a map of function names and their Data Types.
void	GetAttributesValues ( TMap< FDMXAttributeName, int32 >& ... )	Returns the value of each attribute, or zero if no value was ever received.
int32	GetAttributeValue ( FDMXAttributeName Attribute, bool& bSuccess )	Retrieves the value of an Attribute. Will fail and return 0 if the Attribute doesn't exist.
FName	GetAutoAssignAddressPropertyNameChecked()
int32	GetAutoStartingAddress()	Returns the auto starting channel.
FName	GetAutoStartingAddressPropertyNameChecked()
bool	GetCellAttributes ( TArray< FDMXAttributeName >& CellA... )	Gets all attributes names of a cell
int32	GetChannelSpan()	Returns the number of channels this Patch occupies with the Fixture functions from its Active Mode or 0 if the patch has no valid Active Mode
const TArray...	GetCustomTags()	Returns custom tags defined for the patch
int32	GetEndingChannel()	Returns the last channel of the patch
UDMXEntityFi...	GetFixtureType()	Gets the parent fixture type this was constructed from
const FDMXSi...	GetLastReceivedDMXSignal()	Returns the last received DMX signal.
int32	GetManualStartingAddress()	Returns the manual starting channel.
FName	GetManualStartingAddressPropertyNameChecked()
bool	GetMatrixCell ( const FIntPoint& CellCoordinate, FDMXCell& Cell )	Gets the cell corresponding to the passed in coordinate
bool	GetMatrixCellChannelsAbsolute ( const FIntPoint& CellCoordinate, TMap< FDMXAttributeName, int32 >& ... )	Gets the absolute starting channel of each cell attribute at given coordinate
bool	GetMatrixCellChannelsAbsoluteWithValidation ( const FIntPoint& InCellCoordinate, TMap< FDMXAttributeName, int32 >& ... )	Validates and gets the absolute starting channel of each cell attribute at given coordinate
bool	GetMatrixCellChannelsRelative ( const FIntPoint& CellCoordinate, TMap< FDMXAttributeName, int32 >& ... )	Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch.
bool	GetMatrixCellValues ( const FIntPoint& CellCoordinate, TMap< FDMXAttributeName, int32 >& ... )	Gets the DMX Cell value using matrix coordinates
bool	GetMatrixProperties ( FDMXFixtureMatrix& MatrixPropertie... )	Gets the Matrix Fixture properties, returns false if the patch is not using a matrix fixture
void	GetNormalizedAttributesValues ( FDMXNormalizedAttributeValueMap& N... )	Returns the normalized value of each attribute, or zero if no value was ever received.
float	GetNormalizedAttributeValue ( FDMXAttributeName Attribute, bool& bSuccess )	Retrieves the normalized value of an Attribute.
bool	GetNormalizedMatrixCellValues ( const FIntPoint& CellCoordinate, TMap< FDMXAttributeName, float >& ... )	Gets the DMX Cell value using matrix coordinates.
FDMXOnFixtur...	GetOnFixturePatchChanged()	Returns a delegate that is and should be broadcast whenever a Fixture Type changed
FName	GetParentFixtureTypeTemplatePropertyNameChecked()
int32	GetStartingChannel()	Return the starting channel
int32	GetUniverseID()	Returns the universe ID of the patch
FName	GetUniverseIDPropertyNameChecked()	Property name getters.
bool	IsAutoAssignAddress()	Returns true if the patch is set to auto assign address
bool	IsMapValid ( const TMap< FDMXAttributeName, int3... )	Returns true if given function map is valid for this fixture.
void	RebuildCache()	Rebuilds the cache.
void	RemoveFixturePatchFromLibrary ( FDMXEntityFixturePatchRef FixturePa... )	Removes a fixture patch from the DMX Library
void	SendDMX ( TMap< FDMXAttributeName, int32 > At... )	Send DMX using attribute names and integer values.
bool	SendMatrixCellValue ( const FIntPoint& CellCoordinate, const FDMXAttributeName& Attribute, int32 Value )	Sends the DMX value of the Attribute to specified matrix coordinates
bool	SendNormalizedMatrixCellValue ( const FIntPoint& CellCoordinate, const FDMXAttributeName& Attribute, float RelativeValue )	Maps the normalized value to the Attribute's full value range and sends it to specified matrix coordinates
bool	SetActiveModeIndex ( int32 NewActiveModeIndex )	Sets the index of the Mode the Patch uses from its Fixture Type
void	SetAutoAssignAddressUnsafe ( bool bShouldAutoAssignAddress )	Sets bAutoAssignAddress for the patch.
void	SetAutoStartingAddress ( int32 NewAutoStartingAddress )	Sets the auto starting address
void	SetFixtureType ( UDMXEntityFixtureType* NewFixt... )	Sets the fixture type this is using
void	SetManualStartingAddress ( int32 NewManualStartingAddress )	Sets the manual starting address
void	SetStartingChannel ( int32 NewStartingChannel )	Sets the starting channel of the Fixture Patch.
void	SetUniverseID ( int32 NewUniverseID )	Sets the Universe ID of the patch
void	ValidateActiveMode()	Called from Fixture Type to keep ActiveMode in valid range when Modes are removed from the Type

Overridden from UDMXEntity

		Name	Description
	bool	IsValidEntity ( FText& OutReason )	Checks for Entity correctness for usability with protocols.

Overridden from UObject

	Name	Description
bool	Modify ( bool bAlwaysMarkDirty )	That the object will be modified.
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
ETickableTic...	GetTickableTickType()	Virtual that can be overloaded by the inheriting class.
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Constants

Name	Description
OnFixturePatchChangedDelegate	Delegate broadcast when a Fixture Patch changed

Deprecated Functions

	Name	Description
bool	CanReadActiveMode()	Use GetActiveMode instead.
TMap< FDMXAt...	ConvertRawMapToAttributeMap ( const TMap< int32, uint8 >& RawMap )	Deprecated since it's unclear how to use this function correctly. Use UDMXSubsystem::BytesToInt instead.
TArray< UDMX...	GetRelevantControllers()	Controllers are replaced with DMX Ports.
int32	GetRemoteUniverse()	Controllers are replaced with DMX Ports.
bool	IsInControllerRange ( const UDMXEntityController* In... )	Controllers are replaced with DMX Ports.
bool	IsInControllersRange ( const TArray< UDMXEntityController ... )	Controllers are replaced with DMX Ports.
bool	SendMatrixCellValueWithAttributeMap ( const FIntPoint& CellCoordinate, const FDMXAttributeName& Attribute, int32 Value, const TMap< FDMXAttributeName, int3... )	Deprecated due to ambigous arguments CellCoordinate and InAttributeNameChannelMap. Use SendMatrixCellValue or SendNormalizedMatrixCellValue instead.