1. Epic GamesDeveloper
  3. FDMXFixtureFunction

FDMXFixtureFunction

API > API/Plugins > API/Plugins/DMXRuntime

   
Name FDMXFixtureFunction
Type struct
Header File /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityFixtureType.h
Include Path #include "Library/DMXEntityFixtureType.h"

Syntax

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

Constructors

Name Remarks Include Path Unreal Specifiers
  Library/DMXEntityFixtureType.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXFixtureFunction ( const FDMXFixtureFunction&
)

 Workaround for clang deprecation warnings for any deprecated members in implicitly-defined special member functions. Library/DMXEntityFixtureType.h  
Constructor Library/DMXEntityFixtureType.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Attribute FDMXAttributeName The Attribute name to map this Function to. Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Attribute Mapping", DisplayPriority="11")
  • Category="Function Settings"
bUseLSBMode bool 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). Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Use LSB Mode", DisplayPriority="29")
  • Category="Function Settings"
Channel int32 This function's starting channel (use editor above to make changes) Library/DMXEntityFixtureType.h
  • VisibleAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayName="Channel Assignment", DisplayPriority="2")
  • Category="Function Settings"
DataType EDMXFixtureSignalFormat This function's data type. Defines the used number of channels (bytes) Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayPriority="5")
  • Category="Function Settings"
DefaultValue int64 The Default DMX Value of the function Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayPriority="30")
  • Category="Function Settings"
Description FString   Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayPriority="20")
  • Category="Function Settings"
FunctionName FString   Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(DisplayPriority="10")
  • Category="Function Settings"

Protected

Name Type Remarks Include Path Unreal Specifiers
PhysicalDefaultValue double The Physical Value used by default, based on the Physical Unit Library/DMXEntityFixtureType.h
  • EditAnywhere
  • Transient
  • Category="Physical Properties"
PhysicalFrom double The starting value of the Physical Value range, based on the Physical Unit Library/DMXEntityFixtureType.h
  • EditAnywhere
  • Category="Physical Properties"
PhysicalTo double The ending value of the Physical Value range, based on the Physical Unit Library/DMXEntityFixtureType.h
  • EditAnywhere
  • Category="Physical Properties"
PhysicalUnit EDMXGDTFPhysicalUnit The Physical Unit this Physical Value is based on Library/DMXEntityFixtureType.h
  • EditAnywhere
  • Category="Physical Properties"

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GetLastChannel()

 Returns the last channel of the Function Library/DMXEntityFixtureType.h  

uint8 GetNumChannels()

 Returns the number of channels the function spans, according to its data type Library/DMXEntityFixtureType.h  

double GetPhysicalDefaultValue()

 Gets the Physical Value of the Function Library/DMXEntityFixtureType.h  

double GetPhysicalFrom()

 The starting value of the Physical Value range, based on the Physical Unit Library/DMXEntityFixtureType.h  

double GetPhysicalTo()

 The ending value of the Physical Value range, based on the Physical Unit Library/DMXEntityFixtureType.h  

EDMXGDTFPhysicalUnit GetPhysicalUnit()

 The Physical Unit this Physical Value is based on Library/DMXEntityFixtureType.h  

void PostSerialize ( const FArchive& Ar
)

 Implementing Serialize to convert UClass to FFieldClass Library/DMXEntityFixtureType.h  

void SetPhysicalDefaultValue ( double InPhysicalDefaultValue
)

 Sets the Physical Default Value of the Function. Library/DMXEntityFixtureType.h  

void SetPhysicalUnit ( EDMXGDTFPhysicalUnit NewPhysicalUnit
)

 Sets the Physical Default Value of the Function. Library/DMXEntityFixtureType.h  

void SetPhysicalValueRange ( double InPhysicalFrom,
double InPhysicalTo
)

 Sets the Physical Default Value range of the Function. Library/DMXEntityFixtureType.h  

void UpdatePhysicalDefaultValue()

 Updated the Physica Default Value of the Function by the Default Value. Library/DMXEntityFixtureType.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetPhysicalDefaultValuePropertyName()

 Property Name getters. Library/DMXEntityFixtureType.h  

static FName GetPhysicalFromPropertyName()

   Library/DMXEntityFixtureType.h  

static FName GetPhysicalToPropertyName()

   Library/DMXEntityFixtureType.h  

static FName GetPhysicalUnitPropertyName()

   Library/DMXEntityFixtureType.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Library/DMXEntityFixtureType.h  
  Library/DMXEntityFixtureType.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ChannelOffset_DEPRECATED int32 DEPRECATED 5.0 Library/DMXEntityFixtureType.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Deprecated, instead please refer to the Channel property.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page