1. Epic GamesDeveloper
  3. FDMXFixtureFunction

FDMXFixtureFunction

API > API/Plugins > API/Plugins/DMXRuntime > API/Plugins/DMXRuntime/Library

References

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

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="DMX Fixture Function"))  
struct FDMXFixtureFunction

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FDMXAttributeName Attribute The Attribute name to map this Function to.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUseLSBMode Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number (endianness).
Public variable UProperty Category, Meta BlueprintReadWrite visibleanywhere int32 Channel This function's starting channel (use editor above to make changes)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EDMXFixtureSignalFormat DataType This function's data type. Defines the used number of channels (bytes)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int64 DefaultValue The Default DMX Value of the function
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString Description  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString FunctionName  

Constructors

  Type Name Description
Public function   Constructor
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS Workaround for clang deprecation warnings for any deprecated members in implicitly-defined special member functions.
Public function    

Functions

  Type Name Description
Public function Const int32 Returns the last channel of the Function
Public function Const uint8 Returns the number of channels the function spans, according to its data type
Public function Const double Gets the Physical Value of the Function
Public function Static FName Property Name getters.
Public function Const double The starting value of the Physical Value range, based on the Physical Unit
Public function Static FName  
Public function Const double The ending value of the Physical Value range, based on the Physical Unit
Public function Static FName  
Public function Const EDMXGDTFPhysicalUnit The Physical Unit this Physical Value is based on
Public function Static FName  
Public function void

PostSerialize ( const FArchive& Ar
)

 Implementing Serialize to convert UClass to FFieldClass
Public function void

SetPhysicalDefaultValue ( double InPhysicalDefaultValue
)

 Sets the Physical Default Value of the Function.
Public function void Sets the Physical Default Value of the Function.
Public function void

SetPhysicalValueRange ( double InPhysicalFrom,
double InPhysicalTo
)

 Sets the Physical Default Value range of the Function.
Public function void Updated the Physica Default Value of the Function by the Default Value.

Operators

  Type Name Description
Public function FDMXFixtureFunction &  
Public function FDMXFixtureFunction &  

Deprecated Variables

  Type Name Description
Public variable UProperty Meta int32 ChannelOffset_DEPRECATED DEPRECATED 5.0

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page