1. Epic GamesDeveloper
  3. UDMXFixtureComponent

UDMXFixtureComponent

API > API/Plugins > API/Plugins/DMXFixtures

Inheritance Hierarchy

References

   
Module DMXFixtures
Header /Engine/Plugins/VirtualProduction/DMX/DMXFixtures/Source/DMXFixtures/Public/DMXFixtureComponent.h
Include #include "DMXFixtureComponent.h"

Syntax

UCLASS&40;Abstract, Meta&61;&40;IsBlueprintBase&61;false&41;&41;  
class UDMXFixtureComponent : public UActorComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta bool bIsEnabled If used within a DMX Fixture Actor or Fixture Matrix Actor, the component only receives data when set to true.
Public variable UProperty Category, EditAnywhere bool bUseInterpolation If used within a DMX Fixture Actor or Fixture Matrix Actor, the plugin interpolates towards the last set value.
Public variable UProperty bool bUsingMatrixData True if the component is attached to a matrix fixture
Public variable 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)
Public variable FCell * CurrentCell The currently handled cell
Public variable UProperty Category, EditAnywhere float InterpolationScale The scale of the interpolation speed. Faster when > 1, slower when < 1
Public variable UProperty Category, EditAnywhere float SkipThreshold Value changes smaller than this threshold are ignored

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Applies the speed scale property
Public function UFunction BlueprintCallable, Category ADMXFixtureActor * If attached to a DMX Fixture Actor, returns the parent fixture actor.
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

GetSupportedDMXAttributes ( TArray< FName >& OutAttributeNames
)

 Should be implemented to let other objects (e.g. datasmith) know which attributes the component can handle
Public function Virtual void  
Public function UFunction BlueprintCallable, Category TArray< FLinearColor >

GetTextureCenterColors ( UTexture2D* TextureAtlas,
int numTextures,
bool bUpdateTextureResource
)

 Reads pixel color in the middle of each "Texture" and output linear colors.
Protected function void

InitCells ( int NumCells
)

 Initializes the cells for the fixture
Public function Virtual UFunction void Initializes the component
Public function UFunction BlueprintCallable, Category, BlueprintImplementableEvent void

InterpolateComponent ( float DeltaSeconds
)

 Called each tick when interpolation is enabled, to calculate the next value
Public function Virtual void Pushes DMX Values to the Fixture Component. Expects normalized values in the range of 0.0f to 1.0f
Public function Virtual void

SetCurrentCell ( int Index
)

 Sets the cell that is currently active

Overridden from UActorComponent

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category, BlueprintImplementableEvent void Called to initialize the component in blueprints

Deprecated Functions

  Type Name Description
Public function Virtual void

SetBitResolution ( TMap< FDMXAttributeName, EDMXFixtureSignalFormat > AttributeNameToSignalFormatMap
)

 Removed, was unused 4.26 and has no clear use.
Public function Virtual void Only call initialize instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page