1. Epic GamesDeveloper
  3. UDMXFixtureComponent

UDMXFixtureComponent

API > API/Plugins > API/Plugins/DMXFixtures

   
Name UDMXFixtureComponent
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXFixtures/Source/DMXFixtures/Public/DMXFixtureComponent.h
Include Path #include "DMXFixtureComponent.h"

Syntax

UCLASS (Abstract, Meta=(IsBlueprintBase=false))  
class UDMXFixtureComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXFixtureComponent()

   DMXFixtureComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsEnabled bool If used within a DMX Fixture Actor or Fixture Matrix Actor, the component only receives data when set to true. DMXFixtureComponent.h
  • EditAnywhere
  • Category="DMX Parameters"
  • Meta=(DisplayPriority=0)
bUseInterpolation bool If used within a DMX Fixture Actor or Fixture Matrix Actor, the plugin interpolates towards the last set value. DMXFixtureComponent.h
  • EditAnywhere
  • Category="DMX Parameters"
bUsingMatrixData bool True if the component is attached to a matrix fixture DMXFixtureComponent.h  
Cells TArray< FCell > 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) DMXFixtureComponent.h  
CurrentCell FCell * The currently handled cell DMXFixtureComponent.h  
InterpolationScale float The scale of the interpolation speed. Faster when > 1, slower when < 1 DMXFixtureComponent.h
  • EditAnywhere
  • Category="DMX Parameters"
SkipThreshold float Value changes smaller than this threshold are ignored DMXFixtureComponent.h
  • EditAnywhere
  • Category="DMX Parameters"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplySpeedScale()

 Applies the speed scale property DMXFixtureComponent.h  

ADMXFixtureActor * GetParentFixtureActor()

 If attached to a DMX Fixture Actor, returns the parent fixture actor. DMXFixtureComponent.h
  • BlueprintCallable
  • Category="DMX"

void GetSupportedDMXAttributes ( TArray< FName >& OutAttributeNames
)

 Should be implemented to let other objects (e.g. datasmith) know which attributes the component can handle DMXFixtureComponent.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="DMX"

virtual void GetSupportedDMXAttributes_Implementation ( TArray< FName >& OutAttributeNames
)

   DMXFixtureComponent.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="DMX"

TArray< FLinearColor > GetTextureCenterColors ( UTexture2D* TextureAtlas,
int numTextures,
bool bUpdateTextureResource
)

 Reads pixel color in the middle of each "Texture" and output linear colors. DMXFixtureComponent.h
  • BlueprintCallable
  • Category="DMX"

virtual void Initialize()

 Initializes the component DMXFixtureComponent.h  

void InterpolateComponent ( float DeltaSeconds
)

 Called each tick when interpolation is enabled, to calculate the next value DMXFixtureComponent.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="DMX"

virtual void PushNormalizedValuesPerAttribute ( const FDMXNormalizedAttributeValueMap& ValuePerAttribute
)

 Pushes DMX Values to the Fixture Component. Expects normalized values in the range of 0.0f to 1.0f DMXFixtureComponent.h  

virtual void SetBitResolution ( TMap< FDMXAttributeName, EDMXFixtureSignalFormat > AttributeNameToSignalFormatMap
)

 DERECATED 4.27. DMXFixtureComponent.h  

virtual void SetCurrentCell ( int Index
)

 Sets the cell that is currently active DMXFixtureComponent.h  

virtual void SetRangeValue()

   DMXFixtureComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void InitializeComponent()

 Called to initialize the component in blueprints DMXFixtureComponent.h
  • BlueprintCallable
  • BlueprintImplementableEvent
  • Category="DMX"

Protected

Name Remarks Include Path Unreal Specifiers

void InitCells ( int NumCells
)

 Initializes the cells for the fixture DMXFixtureComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page