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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXObjectBase

UDMXEntity

UDMXEntityFixturePatch

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Meta=(DisplayName="DMX Fixture Patch"))
class UDMXEntityFixturePatch : public UDMXEntity

Variables

	Name	Description
int32	ActiveMode
int32	AutoStartingAddress	Starting channel from auto-assignment. Used when AutoAssignAddress is true
bool	bAutoAssignAddress	Auto-assign channel from drag/drop list order and available channels
TArray< FName >	CustomTags
int32	ManualStartingAddress	Starting channel for when auto-assign channel is false
UDMXEntityFixtu...	ParentFixtureTypeTemplate	Property to point to the template parent fixture for details panel purposes
int32	UniverseID	If set to a value on a Controller's Universe IDs range (without the Range Offset), this Patch's functions are sent over the network by that Controller.

Constructors

	Name	Description
	UDMXEntityFixturePatch()

Functions

	Name	Description
bool	CanReadActiveMode()
bool	ContainsFunction ( const FName& FunctionName )	Return if fixture contains function.
TMap< int32,...	ConvertFunctionMapToRawMap ( const TMap< FName, int32 >& Functi... )	Return map of function channels and their values.
TMap< FName,...	ConvertRawMapToFunctionMap ( const TMap< int32, uint8 >& RawMap )	Given a Raw Value> map , return map of function names and their values.
TMap< FName,...	ConvertToValidMap ( const TMap< FName, int32 >& Functi... )	Return a map that is valid for this fixture.
TArray< FNam...	GetAllFunctionsInActiveMode()	Return an array of function names for the currently active mode.
int32	GetChannelSpan()	Returns the number of channels this Patch occupies with the Fixture functions from its Active Mode.
TMap< FName,...	GetFunctionChannelAssignments()	Return map of function names and their assigned channels.
TMap< FName,...	GetFunctionDefaultMap()	Return map of function names and default values.
TMap< FName,...	GetFunctionSignalFormats()	Return map of function names and their Data Types.
TArray< UDMX...	GetRelevantControllers()	Scans the parent DMXLibrary and returns the Controllers which Universe range match this Patch's UniverseID
int32	GetStartingChannel()	Return the active starting channel, evaluated after checking if Auto-Assignment is activated.
bool	IsInControllerRange ( const UDMXEntityController* In... )	Returns true if this Patch's UniverseID is in InController's range
bool	IsInControllersRange ( const TArray< UDMXEntityController ... )	Returns true if this Patch's UniverseID is in any of InControllers' ranges
bool	IsMapValid ( const TMap< FName, int32 >& Functi... )	Return if given function map valid for this fixture.
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.

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

Take our survey

Dismiss