1. Epic GamesDeveloper
  3. UDMXComponent

UDMXComponent

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

API > API/Plugins > API/Plugins/DMXRuntime > API/Plugins/DMXRuntime/Game

Inheritance Hierarchy

  • UActorComponent
  • UDMXComponent

References

   
Module DMXRuntime
Header /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Game/DMXComponent.h
Include #include "Game/DMXComponent.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly bool bReceiveDMXFromPatch If true, the component will receive DMX from the patch
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FDMXEntityFixturePatchRef FixturePatchRef  
Public variable UProperty Category, Meta BlueprintAssignable FDMXOnDMXComponentTickSignature OnDMXComponentTick Event raised each tick, when the component has a Fixture Patch set and either:
Public variable UProperty Category BlueprintAssignable FDMXComponentFixturePatchReceivedSignature OnFixturePatchReceived Broadcast when the component's fixture patch received DMX

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Virtual void  
Protected function Virtual void

DestroyComponent ( bool bPromoteChildren
)

  
Public function Const UFunction BlueprintPure, Category UDMXEntityFixturePatch * Gets the fixture patch used in the component
Protected function UFunction void

OnFixturePatchReceivedDMX ( UDMXEntityFixturePatch* FixturePatch,
const FDMXNormalizedAttributeValueMap& NormalizedValuePerAttribute
)

 Called when the fixture patch received DMX
Protected function Virtual void  
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function UFunction BlueprintCallable, Category void Sets the fixture patch used in the component
Public function UFunction BlueprintCallable, Category, Meta void

SetReceiveDMXFromPatch ( bool bReceive
)

 Sets whether the component receives dmx from the patch.
Protected function void Sets up binding for receiving depending on the patch's and the component's properties
Protected function Virtual void

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

  
Protected function void Enables or disables the component tick depending of it being required for the OnDXMComponentTick function

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page