Navigation
API > API/Plugins > API/Plugins/DMXRuntime > API/Plugins/DMXRuntime/Library
References
| Module | DMXRuntime |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityFixturePatchCache.h |
| Include | #include "Library/DMXEntityFixturePatchCache.h" |
Syntax
class FDMXEntityFixturePatchCache
Remarks
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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Default constructor | ||
 |
FDMXEntityFixturePatchCache
(
int32 InStartingChannel, |
Constructs the cache. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const FDMXNormalizedAttributeValueMap * | Returns all raw attribute values. Returns nullptr if there is no data | |
  |
const TArray< FDMXNormalizedAttributeValueMap > * | Returns all raw matrix attribute values. | |
  |
const FDMXNormalizedAttributeValueMap * | GetAllNormalizedMatrixAttributeValuesFromCell
(
int32 CellIndex |
Returns the all raw attribute values for the specified Cell. |
  |
const TMap< FDMXAttributeName, int32 > * | Returns all raw attribute values. Returns nullptr if there is no data | |
  |
const TArray< TMap< FDMXAttributeName, int32 > > * | Returns all raw matrix attribute values. | |
  |
const TMap< FDMXAttributeName, int32 > * | GetAllRawMatrixAttributeValuesFromCell
(
int32 CellIndex |
Returns the all raw attribute values for the specified Cell. |
  |
TArray< FDMXAttributeName > | Returns the attributes of the mode's function, without matrix attributes | |
  |
TArray< FDMXAttributeName > | Returns the attribute names of the fixture matrix' cell attributes, without common function attributes | |
  |
const TArray< FDMXFixtureCellAttribute > & | Returns the cell attributes of the fixture matrix | |
  |
int32 | GetCellSize () |
Returns the data size of a single cell |
  |
int32 | Returns the channel span | |
  |
int32 | GetDistributedCellIndex
(
int32 CellIndex |
Returns a pixel mapping distribution ordered Cell Index from a Cell Coordinate, or INDEX_NONE if not a valid index |
  |
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 |
  |
const TArray< FDMXFixtureFunction > & | GetFunctions () |
Returns the functions of the mode |
  |
int32 | Returns the number of collumns in the matrix. Does not test if the cache is using the matrix. | |
  |
int32 | Returns the number of rows in the matrix. Does not test if the cache is using the matrix. | |
  |
const int32 | Returns the absolute starting channel of the matrix attributes | |
  |
const float * | GetNormalizedAttributeValue
(
const FDMXAttributeName& AttributeName |
Returns the raw attribute value for the specified Attribute Name. |
  |
const float * | GetNormalizedMatrixAttributeValueFromCell
(
int32 CellIndex, |
Returns the normalized attribute value for the specified Attribute Name. |
  |
const int32 * | GetRawAttributeValue
(
const FDMXAttributeName& AttributeName |
Returns the raw attribute value for the specified Attribute Name. |
  |
const int32 * | GetRawMatrixAttributeValueFromCell
(
int32 CellIndex, |
Returns the raw attribute value for the specified Attribute Name. |
  |
bool | Returns true if the cache holds valid properties retrived from mode and matrix. | |
 |
bool | InputDMXSignal
(
const FDMXSignalSharedPtr& DMXSignal |
Inputs a signal into the cache. Returns true if cached data changed. |
  |
bool | Returns true if there is the matrix properties are valid and can ever hold data | |
 |
void | Modulate
(
UDMXEntityFixturePatch* FixturePatch, |
Applies the modulator to the cache |
 |
void | Reset () |
Resets cached data |