Navigation
API > API/Plugins > API/Plugins/DMXRuntime
Cache for fixture patches. This object takes care of handling the fixture patch data in a single point. The fixture patch self is used to define it.
| Name | FDMXEntityFixturePatchCache |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityFixturePatchCache.h |
| Include Path | #include "Library/DMXEntityFixturePatchCache.h" |
Syntax
class FDMXEntityFixturePatchCache
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDMXEntityFixturePatchCache
(
int32 InStartingChannel, |
Constructs the cache. | Library/DMXEntityFixturePatchCache.h | |
| Default constructor | Library/DMXEntityFixturePatchCache.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFixtureMatrix | bool | True if this is constructed for a matrix fixture | Library/DMXEntityFixturePatchCache.h | |
| bValid | bool | True if it holds valid properties | Library/DMXEntityFixturePatchCache.h | |
| CachedDMXValues | TArray< uint8 > | Raw cached DMX values, last received. | Library/DMXEntityFixturePatchCache.h | |
| CachedNormalizedValuesPerAttribute | FDMXNormalizedAttributeValueMap | Map of latest normalized values per (non-matrix) attribute | Library/DMXEntityFixturePatchCache.h | |
| CachedNormalizedValuesPerMatrixCell | TArray< FDMXNormalizedAttributeValueMap > | Map of latest normalized values per matrix attributen | Library/DMXEntityFixturePatchCache.h | |
| CachedRawValuesPerAttribute | TMap< FDMXAttributeName, int32 > | Map of latest normalized values per (non-matrix) attribute | Library/DMXEntityFixturePatchCache.h | |
| CachedRawValuesPerMatrixCell | TArray< TMap< FDMXAttributeName, int32 > > | Map of raw values per matrix attribute | Library/DMXEntityFixturePatchCache.h | |
| CellDataSize | int32 | Data Size of a single Cell | Library/DMXEntityFixturePatchCache.h | |
| DataIndex | int32 | Index where the data of the Patch starts in a Universe | Library/DMXEntityFixturePatchCache.h | |
| DataSize | int32 | Number of DMX channels the patch spans, including the matrix | Library/DMXEntityFixturePatchCache.h | |
| FixtureMatrix | FDMXFixtureMatrix | The matrix to use | Library/DMXEntityFixturePatchCache.h | |
| MatrixOffset | int32 | Offset of the fixture matrix from the starting channel. Can exceed the data size. | Library/DMXEntityFixturePatchCache.h | |
| Mode | FDMXFixtureMode | The mode to use | Library/DMXEntityFixturePatchCache.h | |
| NumCells | int32 | Number of cells in the matrix | Library/DMXEntityFixturePatchCache.h | |
| OrderedCellIndicies | TArray< int32 > | Cell indicies ordered by fixture, for fast conversion of a raw cell index | Library/DMXEntityFixturePatchCache.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FDMXNormalizedAttributeValueMap * GetAllNormalizedAttributeValues() |
Returns all raw attribute values. Returns nullptr if there is no data | Library/DMXEntityFixturePatchCache.h | |
| Returns all raw matrix attribute values. | Library/DMXEntityFixturePatchCache.h | ||
const FDMXNormalizedAttributeValueMap * GetAllNormalizedMatrixAttributeValuesFromCell
(
int32 CellIndex |
Returns the all raw attribute values for the specified Cell. | Library/DMXEntityFixturePatchCache.h | |
const TMap< FDMXAttributeName, int32 > * GetAllRawAttributeValues() |
Returns all raw attribute values. Returns nullptr if there is no data | Library/DMXEntityFixturePatchCache.h | |
const TArray< TMap< FDMXAttributeName, int32 > > * GetAllRawMatrixAttributeValues () |
Returns all raw matrix attribute values. | Library/DMXEntityFixturePatchCache.h | |
const TMap< FDMXAttributeName, int32 > * GetAllRawMatrixAttributeValuesFromCell
(
int32 CellIndex |
Returns the all raw attribute values for the specified Cell. | Library/DMXEntityFixturePatchCache.h | |
TArray< FDMXAttributeName > GetAttributeNames() |
Returns the attributes of the mode's function, without matrix attributes | Library/DMXEntityFixturePatchCache.h | |
TArray< FDMXAttributeName > GetCellAttributeNames() |
Returns the attribute names of the fixture matrix' cell attributes, without common function attributes | Library/DMXEntityFixturePatchCache.h | |
const TArray< FDMXFixtureCellAttribute > & GetCellAttributes() |
Returns the cell attributes of the fixture matrix | Library/DMXEntityFixturePatchCache.h | |
int32 GetCellSize() |
Returns the data size of a single cell | Library/DMXEntityFixturePatchCache.h | |
int32 GetChannelSpan() |
Returns the channel span | Library/DMXEntityFixturePatchCache.h | |
int32 GetDistributedCellIndex
(
int32 CellIndex |
Returns a pixel mapping distribution ordered Cell Index from a Cell Coordinate, or INDEX_NONE if not a valid index | Library/DMXEntityFixturePatchCache.h | |
int32 GetDistributedCellIndex
(
const FIntPoint& CellCoordinate |
Returns a pixel mapping distribution ordered Cell Index from a Cell Coordinate, or INDEX_NONE if not a valid index | Library/DMXEntityFixturePatchCache.h | |
const TArray< FDMXFixtureFunction > & GetFunctions() |
Returns the functions of the mode | Library/DMXEntityFixturePatchCache.h | |
int32 GetMatrixNumXCells() |
Returns the number of collumns in the matrix. Does not test if the cache is using the matrix. | Library/DMXEntityFixturePatchCache.h | |
int32 GetMatrixNumYCells() |
Returns the number of rows in the matrix. Does not test if the cache is using the matrix. | Library/DMXEntityFixturePatchCache.h | |
const int32 GetMatrixStartingChannelAbsolute() |
Returns the absolute starting channel of the matrix attributes | Library/DMXEntityFixturePatchCache.h | |
const float * GetNormalizedAttributeValue
(
const FDMXAttributeName& AttributeName |
Returns the raw attribute value for the specified Attribute Name. | Library/DMXEntityFixturePatchCache.h | |
const float * GetNormalizedMatrixAttributeValueFromCell
(
int32 CellIndex, |
Returns the normalized attribute value for the specified Attribute Name. | Library/DMXEntityFixturePatchCache.h | |
const int32 * GetRawAttributeValue
(
const FDMXAttributeName& AttributeName |
Returns the raw attribute value for the specified Attribute Name. | Library/DMXEntityFixturePatchCache.h | |
const int32 * GetRawMatrixAttributeValueFromCell
(
int32 CellIndex, |
Returns the raw attribute value for the specified Attribute Name. | Library/DMXEntityFixturePatchCache.h | |
bool HasValidProperties () |
Returns true if the cache holds valid properties retrived from mode and matrix. | Library/DMXEntityFixturePatchCache.h | |
bool InputDMXSignal
(
const FDMXSignalSharedPtr& DMXSignal |
Inputs a signal into the cache. Returns true if cached data changed. | Library/DMXEntityFixturePatchCache.h | |
bool IsFixtureMatrix() |
Returns true if there is the matrix properties are valid and can ever hold data | Library/DMXEntityFixturePatchCache.h | |
void Modulate
(
UDMXEntityFixturePatch* FixturePatch, |
Applies the modulator to the cache | Library/DMXEntityFixturePatchCache.h | |
void Reset() |
Resets cached data | Library/DMXEntityFixturePatchCache.h |