Navigation
API > API/Plugins > API/Plugins/DMXFixtures
Inheritance Hierarchy
- UActorComponent
- UDMXFixtureComponent
- UDMXFixtureComponentColor
- UDMXFixtureComponentDouble
- UDMXFixtureComponentSingle
References
| Module | DMXFixtures |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXFixtures/Source/DMXFixtures/Public/DMXFixtureComponent.h |
| Include | #include "DMXFixtureComponent.h" |
Syntax
UCLASS (Abstract, Meta=(IsBlueprintBase=false))
class UDMXFixtureComponent : public UActorComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bIsEnabled | If used within a DMX Fixture Actor or Fixture Matrix Actor, the component only receives data when set to true. | |
| bool | bUseInterpolation | If used within a DMX Fixture Actor or Fixture Matrix Actor, the plugin interpolates towards the last set value. | |
| bool | bUsingMatrixData | True if the component is attached to a matrix fixture | |
| TArray< FCell > | Cells | A cell represent one "lens" in a light fixture i.e.: Single light fixture contains one cell but Matrix fixtures contain multiple cells Also, a cell can have multiple channels (single, double) | |
| FCell * | CurrentCell | The currently handled cell | |
| float | InterpolationScale | The scale of the interpolation speed. Faster when > 1, slower when < 1 | |
| float | SkipThreshold | Value changes smaller than this threshold are ignored |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Applies the speed scale property | ||
| ADMXFixtureActor * | If attached to a DMX Fixture Actor, returns the parent fixture actor. | ||
| void | GetSupportedDMXAttributes
(
TArray< FName >& OutAttributeNames |
Should be implemented to let other objects (e.g. datasmith) know which attributes the component can handle | |
| void | GetSupportedDMXAttributes_Implementation
(
TArray< FName >& OutAttributeNames |
||
| TArray< FLinearColor > | GetTextureCenterColors
(
UTexture2D* TextureAtlas, |
Reads pixel color in the middle of each "Texture" and output linear colors. | |
| void | InitCells
(
int NumCells |
Initializes the cells for the fixture | |
| void | Initialize () |
Initializes the component | |
| void | Called to initialize the component in blueprints | ||
| void | InterpolateComponent
(
float DeltaSeconds |
Called each tick when interpolation is enabled, to calculate the next value | |
| void | PushNormalizedValuesPerAttribute
(
const FDMXNormalizedAttributeValueMap& ValuePerAttribute |
Pushes DMX Values to the Fixture Component. Expects normalized values in the range of 0.0f to 1.0f | |
| void | SetBitResolution
(
TMap< FDMXAttributeName, EDMXFixtureSignalFormat > AttributeNameToSignalFormatMap |
DERECATED 4.27. | |
| void | SetCurrentCell
(
int Index |
Sets the cell that is currently active | |
| void |