1. Epic GamesDeveloper
  3. UDMXEntityFixturePatch

UDMXEntityFixturePatch

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

API > API/Plugins > API/Plugins/DMXRuntime

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.

   
Name UDMXEntityFixturePatch
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityFixturePatch.h
Include Path #include "Library/DMXEntityFixturePatch.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXEntityFixturePatch()

   Library/DMXEntityFixturePatch.h  

Classes

Name Remarks
FDMXOnFixturePatchReceivedDMXDelegate  

Typedefs

Name Type Remarks Include Path
FDMXOnFixturePatchReceivedDMXDelegateNative TMulticastDelegate_TwoParams< void, UDMXEntityFixturePatch *, const FDMXNormalizedAttributeValueMap & >   Library/DMXEntityFixturePatch.h

Constants

Name Type Remarks Include Path
OnFixturePatchChangedDelegate FDMXOnFixturePatchChangedDelegate Delegate broadcast when a Fixture Patch changed Library/DMXEntityFixturePatch.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bReceiveDMXInEditor bool If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX events in editor. Library/DMXEntityFixturePatch.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Fixture Patch"
CustomTags TArray< FName > Custom tags for filtering patches Library/DMXEntityFixturePatch.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Fixture Patch"
EditorColor FLinearColor Color when displayed in the fixture patch editor Library/DMXEntityFixturePatch.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Fixture Patch"
OnFixturePatchReceivedDMX FDMXOnFixturePatchReceivedDMXDelegate Returns a delegate broadcast when the fixture patch received DMX. Library/DMXEntityFixturePatch.h
  • BlueprintAssignable
  • Category="DMX"
OnFixturePatchReceivedDMXNative FDMXOnFixturePatchReceivedDMXDelegateNative Delegate broadcast when the fixture patch received DMX. Library/DMXEntityFixturePatch.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Cache FDMXEntityFixturePatchCache Cache of dmx values Library/DMXEntityFixturePatch.h  
LastDMXSignal FDMXSignalSharedPtr The last received DMX signal Library/DMXEntityFixturePatch.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ContainsAttribute ( FDMXAttributeName FunctionAttribute
) const

 Returns true if the Fixture Patch contains the specified attribute and can use it to send and receive DMX Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

TMap< int32, uint8 > ConvertAttributeMapToRawMap ( const TMap< FDMXAttributeName, int32 >& FunctionMap
) const

 Converts a map of Attribute Names with their DMX values to a map of DMX channels and with their DMX Values. Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

TMap< FDMXAttributeName, int32 > ConvertRawMapToAttributeMap ( const TMap< int32, uint8 >& RawMap
) const

 DEPRECATED 4.27 Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Please use DMXSubsystem's Bytes to Int instead, then create a map from that with Attribute Names .")

TMap< FDMXAttributeName, int32 > ConvertToValidMap ( const TMap< FDMXAttributeName, int32 >& FunctionMap
) const

 Removes any Attribute Name that can not be sent or received by a Fixture Patch from an Attribute Name to DMX Value Map Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

bool FindFixtureID ( int32& OutFixtureID
) const

 Tries to find the fixture ID of the patch. Library/DMXEntityFixturePatch.h  

void GenerateFixtureID ( int32 DesiredFixtureID
)

 Generates a unique Fixture ID for this patch. Library/DMXEntityFixturePatch.h  

const FDMXFixtureMode * GetActiveMode()

 Returns the active mode, or nullptr if there is no valid active mode Library/DMXEntityFixturePatch.h  

int32 GetActiveModeIndex()

 Returns the index of the Mode the Patch uses from its Fixture Type Library/DMXEntityFixturePatch.h  
Returns an array of attributes for the currently active mode. Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

bool GetAllMatrixCells ( TArray< FDMXCell >& Cells
)

 Gets all matrix cells Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

TMap< FDMXAttributeName, int32 > GetAttributeChannelAssignments()

 Returns a map of Attributes and their assigned channels Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"
Returns a map of function names and default values. Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

const FDMXFixtureFunction * GetAttributeFunction ( const FDMXAttributeName& Attribute
) const

 Returns the function currently mapped to the passed in Attribute, if any. Library/DMXEntityFixturePatch.h  
Returns a map of attributes and function names. Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

TMap< FDMXAttributeName, EDMXFixtureSignalFormat > GetAttributeSignalFormats()

 Returns a map of function names and their Data Types. Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

void GetAttributesValues ( TMap< FDMXAttributeName, int32 >& AttributesValues
)

 DEPRECATED 5.5, renamed to GetAttributeValues. Library/DMXEntityFixturePatch.h  

int32 GetAttributeValue ( FDMXAttributeName Attribute,
bool& bSuccess
)

 Retrieves the value of an Attribute. Will fail and return 0 if the Attribute doesn't exist. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

void GetAttributeValues ( TMap< FDMXAttributeName, int32 >& AttributeValues
)

 Returns the value of each attribute, or zero if no value was ever received. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetCellAttributes ( TArray< FDMXAttributeName >& CellAttributes
)

 Gets all attributes names of a cell Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

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 Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

const TArray< FName > & GetCustomTags()

 Returns custom tags defined for the patch Library/DMXEntityFixturePatch.h  

const FTransform & GetDefaultTransform ()

 Returns The transform used when the DMX Library is spawned in a level. Library/DMXEntityFixturePatch.h  

int32 GetEndingChannel()

 Returns the last channel of the patch Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

int32 GetFixtureID()

 Returns the MVR Fixture ÎD of this patch Library/DMXEntityFixturePatch.h  

UDMXEntityFixtureType * GetFixtureType()

 Gets the parent fixture type this was constructed from Library/DMXEntityFixturePatch.h  

const FDMXSignalSharedPtr & GetLastReceivedDMXSignal()

 Returns the last received DMX signal. Library/DMXEntityFixturePatch.h  

bool GetMatrixCell ( const FIntPoint& CellCoordinate,
FDMXCell& Cell
)

 Gets the cell corresponding to the passed in coordinate Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetMatrixCellChannelsAbsolute ( const FIntPoint& CellCoordinate,
TMap< FDMXAttributeName, int32 >& AttributeChannelMap
)

 Gets the absolute starting channel of each cell attribute at given coordinate Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetMatrixCellChannelsAbsoluteWithValidation ( const FIntPoint& InCellCoordinate,
TMap< FDMXAttributeName, int32 >& OutAttributeChannelMap
)

 Validates and gets the absolute starting channel of each cell attribute at given coordinate Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetMatrixCellChannelsRelative ( const FIntPoint& CellCoordinate,
TMap< FDMXAttributeName, int32 >& AttributeChannelMap
)

 Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetMatrixCellValues ( const FIntPoint& CellCoordinate,
TMap< FDMXAttributeName, int32 >& ValuePerAttribute
)

 Gets the DMX Cell value using matrix coordinates Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetMatrixProperties ( FDMXFixtureMatrix& MatrixProperties
) const

 Gets the Matrix Fixture properties, returns false if the patch is not using a matrix fixture Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

const FGuid & GetMVRFixtureUUID()

 Returns the MVR Fixture UUIDs of this patch Library/DMXEntityFixturePatch.h  

void GetNormalizedAttributesValues ( FDMXNormalizedAttributeValueMap& NormalizedAttributeValues
)

 DEPRECATED 5.5, renamed to GetNormalizedAttributeValues. Library/DMXEntityFixturePatch.h  

float GetNormalizedAttributeValue ( FDMXAttributeName Attribute,
bool& bSuccess
)

 Retrieves the normalized value of an Attribute. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. Use GetNormalizedAttributeValue instead. Note, new method returns normalized values!")

void GetNormalizedAttributeValues ( FDMXNormalizedAttributeValueMap& NormalizedAttributesValues
)

 Returns the normalized value of each attribute, or zero if no value was ever received. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool GetNormalizedMatrixCellValues ( const FIntPoint& CellCoordinate,
TMap< FDMXAttributeName, float >& NormalizedValuePerAttribute
)

 Gets the DMX Cell value using matrix coordinates. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

TArray< UDMXEntityController * > GetRelevantControllers()

 DEPRECATED 4.27 Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are replaced with DMX Ports.")

int32 GetRemoteUniverse()

 DEPRECATED 4.27 Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. No clear remote universe can be deduced from controllers (before 4.27) or ports (from 4.27 on).")

int32 GetStartingChannel()

 Return the starting channel Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

int32 GetUniverseID()

 Returns the universe ID of the patch Library/DMXEntityFixturePatch.h  

bool IsInControllerRange ( const UDMXEntityController* InController
) const

 DEPRECATED 4.27 Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are replaced with DMX Ports.")

bool IsInControllersRange ( const TArray< UDMXEntityController* >& InControllers
) const

 DEPRECATED 4.27 Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are replaced with DMX Ports.")

bool IsMapValid ( const TMap< FDMXAttributeName, int32 >& FunctionMap
) const

 Returns true if the Fixture Patch contains all Attributes in an Attribute Name to DMX Value Map. Library/DMXEntityFixturePatch.h
  • BlueprintPure
  • Category="DMX|Fixture Patch"

void RebuildCache ()

 Rebuilds the cache. Library/DMXEntityFixturePatch.h  
Sends the default value for all attributes, including matrix attributes. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX"

void SendDMX ( TMap< FDMXAttributeName, int32 > AttributeMap
)

 Send DMX using attribute names and integer values. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX"

bool SendMatrixCellValue ( const FIntPoint& CellCoordinate,
const FDMXAttributeName& Attribute,
int32 Value
)

 Sends the DMX value of the Attribute to specified matrix coordinates Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

bool SendMatrixCellValueWithAttributeMap ( const FIntPoint& CellCoordinate,
const FDMXAttributeName& Attribute,
int32 Value,
const TMap< FDMXAttributeName, int32 >& InAttributeNameChannelMap
)

 Sends the DMX value of the Attribute to specified matrix coordinates with given Attribute Name Channel Map Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated due to ambigous arguments CellCoordinate and InAttributeNameChannelMap. Use SendMatrixCellValue or SendNormalizedMatrixCellValue instead.")

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 Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

void SendZeroValues ()

 Sends zeroes for all attributes, including matrix attributes. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX"

bool SetActiveModeIndex ( int32 NewActiveModeIndex
)

 Sets the index of the Mode the Patch uses from its Fixture Type Library/DMXEntityFixturePatch.h  

void SetDefaultTransform ( const FTransform& NewDefaultTransform
)

 Sets The transform used when the DMX Library is spawned in a level. Library/DMXEntityFixturePatch.h  

void SetFixtureType ( UDMXEntityFixtureType* NewFixtureType
)

 Sets the fixture type this is using Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

void SetStartingChannel ( int32 NewStartingChannel
)

 Sets the starting channel of the Fixture Patch. Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

void SetUniverseID ( int32 NewUniverseID
)

 Sets the Universe ID of the patch Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX|Fixture Patch"

void ValidateActiveMode()

 Called from Fixture Type to keep ActiveMode in valid range when Modes are removed from the Type Library/DMXEntityFixturePatch.h  

Overridden from UDMXEntity

Name Remarks Include Path Unreal Specifiers

virtual bool IsValidEntity ( FText& OutReason
) const

 Checks for Entity correctness for usability with protocols. Library/DMXEntityFixturePatch.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bAlwaysMarkDirty
)

   Library/DMXEntityFixturePatch.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   Library/DMXEntityFixturePatch.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Library/DMXEntityFixturePatch.h  

virtual void PostInitProperties()

   Library/DMXEntityFixturePatch.h  

virtual void PostLoad()

   Library/DMXEntityFixturePatch.h  

virtual void Serialize ( FArchive& Ar
)

   Library/DMXEntityFixturePatch.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsTickableInEditor()

   Library/DMXEntityFixturePatch.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   Library/DMXEntityFixturePatch.h  

virtual ETickableTickType GetTickableTickType()

   Library/DMXEntityFixturePatch.h  

virtual bool IsTickable()

   Library/DMXEntityFixturePatch.h  

virtual void Tick ( float DeltaTime
)

   Library/DMXEntityFixturePatch.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AreCoordinatesValid ( const FDMXFixtureMatrix& FixtureMatrix,
const FIntPoint& Coordinate,
bool bLogged
)

 Returns true if the specified coordinates are valid for the specified matrix Library/DMXEntityFixturePatch.h  

static UDMXEntityFixturePatch * CreateFixturePatchInLibrary ( FDMXEntityFixturePatchConstructionParams ConstructionParams,
const FString& DesiredName,
bool bMarkDMXLibraryDirty
)

 Creates a new Fixture Patch in the DMX Library using the specified Fixture Type Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX"

static FName GetActiveModePropertyNameChecked()

   Library/DMXEntityFixturePatch.h  

static FName GetDefaultTransformPropertyNameChecked()

   Library/DMXEntityFixturePatch.h  

static FName GetFixtureIDPropertyNameChecked()

   Library/DMXEntityFixturePatch.h  

static FName GetMVRFixtureUUIDPropertyNameChecked()

   Library/DMXEntityFixturePatch.h  

static FDMXOnFixturePatchChangedDelegate & GetOnFixturePatchChanged()

 Returns a delegate that is and should be broadcast whenever a Fixture Type changed Library/DMXEntityFixturePatch.h  

static FName GetParentFixtureTypeTemplatePropertyNameChecked()

   Library/DMXEntityFixturePatch.h  

static FName GetStartingChannelPropertyNameChecked()

   Library/DMXEntityFixturePatch.h  
Property name getters. Library/DMXEntityFixturePatch.h  

static void RemoveFixturePatchFromLibrary ( FDMXEntityFixturePatchRef FixturePatchRef
)

 Removes a fixture patch from the DMX Library Library/DMXEntityFixturePatch.h
  • BlueprintCallable
  • Category="DMX"

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
AutoStartingAddress_DEPRECATED int32 DEPRECATED 5.1 Library/DMXEntityFixturePatch.h
  • Meta=(DeprecatedProperty, DeprecationMessage="bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.")
bAutoAssignAddress_DEPRECATED bool DEPRECATED 5.1 Library/DMXEntityFixturePatch.h
  • Meta=(DeprecatedProperty, DeprecationMessage="bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.")
ManualStartingAddress_DEPRECATED int32 DEPRECATED 5.1 Library/DMXEntityFixturePatch.h
  • Meta=(DeprecatedProperty, DeprecationMessage="bAutoAssignAddress and related members are deprecated. Auto assign is now only a method in FDMXEditorUtils and should be applied on demand.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page