| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityFixturePatch.h |
Include |
#include "Library/DMXEntityFixturePatch.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Meta=(DisplayName="DMX Fixture Patch"))
class UDMXEntityFixturePatch :
public UDMXEntity,
public FTickableGameObject
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 | Description | ||
---|---|---|---|
|
ActiveMode |
The fixture type mode the patch should use |
|
|
AutoStartingAddress |
Starting channel from auto-assignment. Used when AutoAssignAddress is true |
|
|
bAutoAssignAddress |
Auto-assign address from drag/drop list order and available channels |
|
|
bReceiveDMXInEditor |
If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX event in editor. |
|
|
CustomTags |
Custom tags for filtering patches |
|
|
EditorColor |
Color when displayed in the fixture patch editor |
|
|
ManualStartingAddress |
Starting channel for when auto-assign address is false |
|
|
FDMXOnFixturePa... |
OnFixturePatchReceivedDMX |
Broadcasts when the patch received dmx |
|
ParentFixtureTypeTemplate |
Property to point to the template parent fixture for details panel purposes |
|
|
UniverseID |
The local universe of the patch |
Name | Description | |
---|---|---|
|
UDMXEntityFixturePatch() |
Name | Description | ||
---|---|---|---|
|
ClearCachedData() |
Clears cached data. Useful in dmx to rest to default state on begin and end PIE |
|
|
ContainsAttribute ( |
Return if fixture contains function. |
|
|
ConvertAttributeMapToRawMap ( |
Return map of function channels and their values. |
|
|
ConvertRawMapToAttributeMap |
Given a |
|
|
ConvertToValidMap ( |
Return a map that is valid for this fixture. |
|
|
const FDMXFi... |
GetActiveMode() |
Returns the active mode, or nullptr if there is no valid active mode |
|
GetAllAttributesInActiveMode() |
Return an array of valid attributes for the currently active mode. |
|
|
GetAllMatrixCells |
Get array of all cells and associated data. |
|
|
GetAttributeChannelAssignments() |
Return map of Attributes and their assigned channels |
|
|
GetAttributeDefaultMap() |
Return map of function names and default values. |
|
|
const FDMXFi... |
GetAttributeFunction ( |
Return the function currently mapped to the passed in Attribute, if any. |
|
GetAttributeFunctionsMap() |
Return map of attributes and function names. |
|
|
GetAttributeSignalFormats() |
Return map of function names and their Data Types. |
|
|
GetAttributesValues ( |
Returns the value of each attribute, or zero if no value was ever received. |
|
|
GetAttributeValue ( |
Retrieve the value of an Attribute. Will fail and return 0 if the Attribute doesn't exist. |
|
|
GetCellAttributes ( |
Get all attributes for the fixture patch. |
|
|
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. |
|
|
GetEndingChannel() |
||
|
const FDMXSi... |
GetLastReceivedDMXSignal() |
Returns the last received DMX signal. |
|
GetMatrixCell |
Get data for single cell. |
|
|
GetMatrixCellChannelsAbsolute ( |
Gets the absolute starting channel of each cell attribute at given coordinate |
|
|
GetMatrixCellChannelsAbsoluteWithValidation ( |
Validate and gets the absolute starting channel of each cell attribute at given coordinate |
|
|
GetMatrixCellChannelsRelative ( |
Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch. |
|
|
GetMatrixCellValues ( |
Get DMX Cell value using matrix coordinates. |
|
|
GetMatrixProperties ( |
Get Matrix Fixture properties |
|
|
GetNormalizedAttributesValues ( |
Returns the normalized value of each attribute, or zero if no value was ever received. |
|
|
float |
GetNormalizedAttributeValue ( |
Retrieve the normalized value of an Attribute. |
|
GetNormalizedMatrixCellValues ( |
Get DMX Cell value using matrix coordinates. |
|
|
GetStartingChannel() |
Return the active starting channel, evaluated after checking if Auto-Assignment is activated. |
|
|
IsMapValid ( |
Return if given function map is valid for this fixture. |
|
|
SendDMX ( |
Send DMX using attribute names and integer values. |
|
|
SendMatrixCellValue ( |
Sends the DMX value of the Attribute to specified matrix coordinates |
|
|
SendMatrixCellValueWithAttributeMap ( |
Sends the DMX value of the Attribute to specified matrix coordinates with given Attribute Name Channel Map |
|
|
SendNormalizedMatrixCellValue ( |
Maps the normalized value to the Attribute's full value range and sends it to specified matrix coordinates |
|
|
ValidateActiveMode() |
Called from Fixture Type to keep ActiveMode in valid range when Modes are removed from the Type |
Name | Description | ||
---|---|---|---|
|
IsValidEntity ( |
Checks for Entity correctness for usability with protocols. |
Name | Description | ||
---|---|---|---|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
Name | Description | ||
---|---|---|---|
|
IsTickableInEditor() |
Used to determine whether the object should be ticked in the editor. |
Name | Description | ||
---|---|---|---|
|
GetStatId() |
Return the stat id to use for this tickable |
|
|
ETickableTic... |
GetTickableTickType() |
Virtual that can be overloaded by the inheriting class. |
|
IsTickable() |
Virtual that can be overloaded by the inheriting class. |
|
|
Tick ( |
Pure virtual that must be overloaded by the inheriting class. |
Name | Description | ||
---|---|---|---|
|
CanReadActiveMode() |
Use GetActiveMode instead. |
|
|
GetRelevantControllers() |
Controllers are replaced with DMX Ports. |
|
|
GetRemoteUniverse() |
Controllers are replaced with DMX Ports. |
|
|
IsInControllerRange ( |
Controllers are replaced with DMX Ports. |
|
|
IsInControllersRange ( |
Controllers are replaced with DMX Ports. |