1. Epic GamesDeveloper
  3. UDMXComponent

UDMXComponent

Component that receives DMX input each Tick from a fixture patch.

API > API/Plugins > API/Plugins/DMXRuntime

Component that receives DMX input each Tick from a fixture patch.

   
Name UDMXComponent
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Game/DMXComponent.h
Include Path #include "Game/DMXComponent.h"

Syntax

UCLASS (ClassGroup=(DMX), Meta=(BlueprintSpawnableComponent),  
       HideCategories=("Variable", "Sockets", "Activation", "Cooking", "ComponentReplication", "Collision", "ComponentTick"))  
class UDMXComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXComponent()

   Game/DMXComponent.h  

Classes

Name Remarks
FDMXComponentFixturePatchReceivedSignature  
FDMXOnDMXComponentTickSignature  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FixturePatchRef FDMXEntityFixturePatchRef   Game/DMXComponent.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="DMX"
  • Meta=(ShowOnlyInnerProperties)
OnDMXComponentTick FDMXOnDMXComponentTickSignature Event raised each tick, when the component has a Fixture Patch set and either: Game/DMXComponent.h
  • BlueprintAssignable
  • Category="DMX"
  • Meta=(DisplayName="On DMX Component Tick")
OnFixturePatchReceived FDMXComponentFixturePatchReceivedSignature Broadcast when the component's fixture patch received DMX Game/DMXComponent.h
  • BlueprintAssignable
  • Category="DMX"

Functions

Public

Name Remarks Include Path Unreal Specifiers

UDMXEntityFixturePatch * GetFixturePatch()

 Gets the fixture patch used in the component Game/DMXComponent.h
  • BlueprintPure
  • Category="DMX"

void SetFixturePatch ( UDMXEntityFixturePatch* InFixturePatch
)

 Sets the fixture patch used in the component Game/DMXComponent.h
  • BlueprintCallable
  • Category="DMX"

void SetReceiveDMXFromPatch ( bool bReceive
)

 Sets whether the component receives dmx from the patch. Game/DMXComponent.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Set Receive DMX From Patch")

Protected

Name Remarks Include Path Unreal Specifiers

void OnFixturePatchReceivedDMX ( UDMXEntityFixturePatch* FixturePatch,
const FDMXNormalizedAttributeValueMap& NormalizedValuePerAttribute
)

 Called when the fixture patch received DMX Game/DMXComponent.h  

void SetupReceiveDMXBinding()

 Sets up binding for receiving depending on the patch's and the component's properties Game/DMXComponent.h  

void UpdateTickEnabled()

 Enables or disables the component tick depending of it being required for the OnDXMComponentTick function Game/DMXComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   Game/DMXComponent.h  

virtual void DestroyComponent ( bool bPromoteChildren
)

   Game/DMXComponent.h  

virtual void OnRegister()

   Game/DMXComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   Game/DMXComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Game/DMXComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page