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 > API/Plugins/DMXRuntime/Library

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Blueprintable, Meta&61;&40;DisplayName&61;"DMX Fixture Patch"&41;&41;  
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

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly int32 ActiveMode The Index of the Mode in the Fixture Type the Patch uses
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bReceiveDMXInEditor If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX event in editor.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< FName > CustomTags Custom tags for filtering patches
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FLinearColor EditorColor Color when displayed in the fixture patch editor
Protected variable UProperty Category BlueprintReadOnly visibleanywhere FGuid MVRFixtureUUID The MVR Fixture UUID when used as such
Public variable FDMXOnFixturePatchReceivedDMXDelegate OnFixturePatchReceivedDMX Broadcasts when the patch received dmx
Protected variable UProperty Category, Meta BlueprintReadWrite blueprintsetter, visibledefaultsonly TObjectPtr< UDMXEntityFixtureType > ParentFixtureTypeTemplate Property to point to the template parent fixture for details panel purposes
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 StartingChannel Starting Channel of the Patch
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 UniverseID The local universe of the patch

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category bool

ContainsAttribute ( FDMXAttributeName FunctionAttribute
)

 Returns true if the fixture patch contains the attribute.
Public function Const UFunction BlueprintPure, Category TMap< int32, uint8 >

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

 Returns a map of function channels and their values.
Public function Const UFunction BlueprintPure, Category TMap< FDMXAttributeName, int32 >

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

 Returns a map that only contains attributes used this patch.
Public function Static UFunction BlueprintCallable, Category UDMXEntityFixturePatch *

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

 Creates a new Fixture Patch in the DMX Library using the specified Fixture Type
Public function Const bool

FindFixtureID ( int32& OutFixtureID
)

 Tries to find the fixture ID of the patch.
Public function Const const FDMXFixtureMode * Returns the active mode, or nullptr if there is no valid active mode
Public function Const int32 Returns the index of the Mode the Patch uses from its Fixture Type
Public function Static FName  
Public function Const UFunction BlueprintPure, Category TArray< FDMXAttributeName > Returns an array of valid attributes for the currently active mode.
Public function UFunction BlueprintCallable, Category bool Gets all matrix cells
Public function Const UFunction BlueprintPure, Category TMap< FDMXAttributeName, int32 > Returns a map of Attributes and their assigned channels
Public function Const UFunction BlueprintPure, Category TMap< FDMXAttributeName, int32 > Returns a map of function names and default values.
Public function Const const FDMXFixtureFunction * Returns the function currently mapped to the passed in Attribute, if any.
Public function Const UFunction BlueprintPure, Category TMap< FDMXAttributeName, FDMXFixtureFunction > Returns a map of attributes and function names.
Public function Const UFunction BlueprintPure, Category TMap< FDMXAttributeName, EDMXFixtureSignalFormat > Returns a map of function names and their Data Types.
Public function UFunction BlueprintCallable, Category void

GetAttributesValues ( TMap< FDMXAttributeName, int32 >& AttributesValues
)

 Returns the value of each attribute, or zero if no value was ever received.
Public function UFunction BlueprintCallable, Category int32

GetAttributeValue ( FDMXAttributeName Attribute,
bool& bSuccess
)

 Retrieves the value of an Attribute. Will fail and return 0 if the Attribute doesn't exist.
Public function UFunction BlueprintCallable, Category bool

GetCellAttributes ( TArray< FDMXAttributeName >& CellAttributes
)

 Gets all attributes names of a cell
Public function Const UFunction BlueprintPure, Category int32 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
Public function Const const TArray< FName > & Returns custom tags defined for the patch
Public function Const UFunction BlueprintPure, Category int32 Returns the last channel of the patch
Public function Const UDMXEntityFixtureType * Gets the parent fixture type this was constructed from
Public function Const const FDMXSignalSharedPtr & Returns the last received DMX signal.
Public function UFunction BlueprintCallable, Category bool

GetMatrixCell ( const FIntPoint& CellCoordinate,
FDMXCell& Cell
)

 Gets the cell corresponding to the passed in coordinate
Public function UFunction BlueprintCallable, Category bool

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

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

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

 Validates and gets the absolute starting channel of each cell attribute at given coordinate
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category bool

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

 Gets the DMX Cell value using matrix coordinates
Public function Const UFunction BlueprintPure, Category bool

GetMatrixProperties ( FDMXFixtureMatrix& MatrixProperties
)

 Gets the Matrix Fixture properties, returns false if the patch is not using a matrix fixture
Public function Const const FGuid & Returns the MVR Fixture UUIDs of this patch
Public function Static FName  
Public function UFunction BlueprintCallable, Category void Returns the normalized value of each attribute, or zero if no value was ever received.
Public function UFunction BlueprintCallable, Category, Meta float

GetNormalizedAttributeValue ( FDMXAttributeName Attribute,
bool& bSuccess
)

 Retrieves the normalized value of an Attribute.
Public function UFunction BlueprintCallable, Category bool

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

 Gets the DMX Cell value using matrix coordinates.
Public function Static FDMXOnFixturePatchChangedDelegate & Returns a delegate that is and should be broadcast whenever a Fixture Type changed
Public function Static FName  
Public function Const UFunction BlueprintCallable, Category int32 Return the starting channel
Public function Static FName  
Public function Const int32 Returns the universe ID of the patch
Public function Static FName Property name getters.
Public function Const UFunction BlueprintPure, Category bool

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

 Returns true if given function map is valid for this fixture.
Public function void Rebuilds the cache.
Public function Static UFunction BlueprintCallable, Category void Removes a fixture patch from the DMX Library
Public function UFunction BlueprintCallable, Category void

SendDMX ( TMap< FDMXAttributeName, int32 > AttributeMap
)

 Send DMX using attribute names and integer values.
Public function UFunction BlueprintCallable, Category bool

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

 Sends the DMX value of the Attribute to specified matrix coordinates
Public function UFunction BlueprintCallable, Category 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
Public function bool

SetActiveModeIndex ( int32 NewActiveModeIndex
)

 Sets the index of the Mode the Patch uses from its Fixture Type
Public function UFunction BlueprintCallable, Category void Sets the fixture type this is using
Public function UFunction BlueprintCallable, Category void

SetStartingChannel ( int32 NewStartingChannel
)

 Sets the starting channel of the Fixture Patch.
Public function void

SetUniverseID ( int32 NewUniverseID
)

 Sets the Universe ID of the patch
Public function void Called from Fixture Type to keep ActiveMode in valid range when Modes are removed from the Type

Overridden from UDMXEntity

  Type Name Description
Public function Virtual Const bool

IsValidEntity ( FText& OutReason
)

 Checks for Entity correctness for usability with protocols.

Overridden from UObject

  Type Name Description
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Note that the object will be modified.
Protected function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from FTickableGameObject

  Type Name Description
Protected function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Protected function Virtual Const TStatId Return the stat id to use for this tickable
Protected function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Protected function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Protected function Virtual 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 Variables

  Type Name Description
Protected variable UProperty Meta int32 AutoStartingAddress_DEPRECATED DEPRECATED 5.1
Protected variable UProperty Meta bool bAutoAssignAddress_DEPRECATED DEPRECATED 5.1
Protected variable UProperty Meta int32 ManualStartingAddress_DEPRECATED DEPRECATED 5.1

Deprecated Functions

  Type Name Description
Public function Const bool Use GetActiveMode instead.
Public function Const UFunction BlueprintPure, Category, Meta TMap< FDMXAttributeName, int32 >

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

 Deprecated since it's unclear how to use this function correctly. Use UDMXSubsystem::BytesToInt instead.
Public function Static FName bAutoAssignAddress and related members are deprecated. Auto assign is now a method in FDMXEditorUtils and applied on demand.
Public function Const int32 bAutoAssignAddress and related members are deprecated. Please use GetStartingChannel instead of GetAutoStartingAddress.
Public function Static FName bAutoAssignAddress and related members are deprecated. Auto assign is now a method in FDMXEditorUtils and applied on demand.
Public function Const int32 bAutoAssignAddress and related members are deprecated. Please use GetStartingChannel instead of GetManualStartingAddress.
Public function Static FName bAutoAssignAddress and related members are deprecated. Auto assign is now a method in FDMXEditorUtils and applied on demand.
Public function Const UFunction BlueprintPure, Category, Meta TArray< UDMXEntityController * > Controllers are replaced with DMX Ports.
Public function Const UFunction BlueprintPure, Category, Meta int32 Controllers are replaced with DMX Ports.
Public function Const bool bAutoAssignAddress and related members are deprecated. Auto assign is now a method in FDMXEditorUtils and applied on demand.
Public function Const UFunction BlueprintPure, Category, Meta bool

IsInControllerRange ( const UDMXEntityController* InController
)

 Controllers are replaced with DMX Ports.
Public function Const UFunction BlueprintPure, Category, Meta bool

IsInControllersRange ( const TArray< UDMXEntityController* >& InControllers
)

 Controllers are replaced with DMX Ports.
Public function UFunction BlueprintCallable, Category, Meta bool

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

 Deprecated due to ambigous arguments CellCoordinate and InAttributeNameChannelMap. Use SendMatrixCellValue or SendNormalizedMatrixCellValue instead.
Public function void

SetAutoAssignAddressUnsafe ( bool bShouldAutoAssignAddress
)

 bAutoAssignAddress and related members are deprecated. Auto assign is now a method in FDMXEditorUtils and applied on demand.
Public function void

SetAutoStartingAddress ( int32 NewAutoStartingAddress
)

 bAutoAssignAddress and related members are deprecated. Please use SetStartingChannel instead of SetAutoStartingAddress.
Public function void

SetManualStartingAddress ( int32 NewManualStartingAddress
)

 bAutoAssignAddress and related members are deprecated. Please use SetStartingChannel instead of SetManualStartingAddress.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page