1. Epic GamesDeveloper
  3. UDMXEntityFixtureType

UDMXEntityFixtureType

Class to describe a type of Fixture.

API > API/Plugins > API/Plugins/DMXRuntime

Class to describe a type of Fixture. Fixture Patches can be created from Fixture Types (see UDMXEntityFixturePatch::ParentFixtureTypeTemplate).

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

Syntax

UCLASS (BlueprintType, Blueprintable, Meta=(DisplayName="DMX Fixture Type"))  
class UDMXEntityFixtureType : public UDMXEntity

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXEntityFixtureType()

   Library/DMXEntityFixtureType.h  

Constants

Name Type Remarks Include Path
OnFixtureTypeChangedDelegate FDMXOnFixtureTypeChangedDelegate Delegate that should be broadcast whenever a Fixture Type changed Library/DMXEntityFixtureType.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActorClassToSpawn TSoftClassPtr< AActor > The Actor Class that is spawned when the DMX Library dropped onto a Level. Library/DMXEntityFixtureType.h
  • EditAnywhere
  • Category="MVR"
  • Meta=(MustImplement="/Script/DMXFixtureActorInterface.DMXMVRFixtureActorInterface")
bExportGeneratedGDTF bool If checked, generates a new GDTF instead of exporting the imported GDTF. Library/DMXEntityFixtureType.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Fixture Type"
  • Meta=(DisplayName="Generate GDTF (not recommended)")
bShowOnlyLatestGDTFModeRevisions bool If true only shows latest GDTF mode revisions in editor Library/DMXEntityFixtureType.h  
DMXCategory FDMXFixtureCategory The Category of the Fixture, useful for Filtering Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Fixture Type"
  • Meta=(DisplayName="DMX Category")
DMXImport TObjectPtr< UDMXImport > DEPRECATED 5.5 - The GDTF from which this Fixture Type was setup. Library/DMXEntityFixtureType.h
  • BlueprintReadOnly
  • Category="Fixture Settings"
  • Meta=(DeprecatedProperty, DeprecationMessage="Changed to a soft object pointer to reduce the memory footprint of Fixture Types. Please use GDTF Source instead.")
GDTFSource TSoftObjectPtr< UDMXImportGDTF > The GDTF that initializes this Fixture Type. When changed, reinitializes with data from the GDTF. Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Fixture Type"
  • Meta=(DisplayName="GDTF Source")
InputModulators TArray< TObjectPtr< UDMXModulator > > Modulators applied right before a patch of this type is received. Library/DMXEntityFixtureType.h
  • EditAnywhere
  • Instanced
  • Category="Fixture Type"
  • Meta=(DisplayPriority="50")
Modes TArray< FDMXFixtureMode >   Library/DMXEntityFixtureType.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Fixture Type"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCellAttribute ( int32 ModeIndex
)

 Fixture Matrix related. Library/DMXEntityFixtureType.h  

int32 AddFunction ( int32 InModeIndex
)

 Fixture Function related. Library/DMXEntityFixtureType.h  

int32 AddMode ( FString BaseModeName
)

 Fixture Mode related. Library/DMXEntityFixtureType.h  

void AlignFunctionChannels ( int32 InModeIndex
)

 Aligns alls channels of the functions in the Mode to be consecutive Library/DMXEntityFixtureType.h  

void ClampFunctionDefautValueByDataType ( int32 ModeIndex,
int32 FunctionIndex
)

 Clamps the Default Value of the Function by its Data Type Library/DMXEntityFixtureType.h  

void DuplicateFunctions ( int32 InModeIndex,
const TArray< int32 >& InFunctionIndicesToDuplicate,
TArray< int32 >& OutNewFunctionIndices
)

 Adds a Function to the Mode's Function Array Library/DMXEntityFixtureType.h  

void DuplicateModes ( TArray< int32 > InModeIndicesToDuplicate,
TArray< int32 >& OutNewModeIndices
)

 Duplicates the Modes at specified Indices Library/DMXEntityFixtureType.h  

FString GetCleanGDTFFileNameSynchronous ( bool bWithExtension
) const

 Acquires the GDTF file name of this Fixture Type. Library/DMXEntityFixtureType.h  

int32 InsertFunction ( int32 InModeIndex,
int32 InInsertAtIndex,
FDMXFixtureFunction& InOutNewFunction
)

 Inserts a Function to the Mode's Function Array Library/DMXEntityFixtureType.h  

void RemoveCellAttribute ( int32 ModeIndex,
int32 CellAttributeIndex
)

 Removes a cell attribute from the Mode Library/DMXEntityFixtureType.h  

void RemoveFunctions ( int32 ModeIndex,
TArray< int32 > FunctionIndicesToDelete
)

 Removes Functions from the Mode's Function Array Library/DMXEntityFixtureType.h  

void RemoveModes ( const TArray< int32 >& ModeIndicesToDelete
)

 Deletes the Modes at specified Indices Library/DMXEntityFixtureType.h  

void ReorderFunction ( int32 ModeIndex,
int32 FunctionToReorderIndex,
int32 InsertAtIndex
)

 Reorders a function to reside at the Insert At Index, subsequently reorders other affected Functions Library/DMXEntityFixtureType.h  

void ReorderMatrix ( int32 ModeIndex,
int32 InsertAtFunctionIndex
)

 Reorders the Fixture Matrix to reside after a function, subsequently reorders other affected Functions Library/DMXEntityFixtureType.h  

void SetFixtureMatrixEnabled ( int32 ModeIndex,
bool bEnableMatrix
)

 Enables or disables the Matrix, reorders Function channels accordingly Library/DMXEntityFixtureType.h  

void SetFunctionName ( int32 InModeIndex,
int32 InFunctionIndex,
const FString& InDesiredFunctionName,
FString& OutUniqueFunctionName
)

 Sets a Mode Name for specified Mode Library/DMXEntityFixtureType.h  

void SetFunctionStartingChannel ( int32 InModeIndex,
int32 InFunctionIndex,
int32 InDesiredStartingChannel,
int32& OutStartingChannel
)

 Sets a Starting Channel for the Function, aligns it to other functions Library/DMXEntityFixtureType.h  

void SetModeName ( int32 InModeIndex,
const FString& InDesiredModeName,
FString& OutUniqueModeName
)

 Sets a Mode Name for specified Mode Library/DMXEntityFixtureType.h  

void SetModesFromDMXImport ( UDMXImport* DMXImportAsset
)

   Library/DMXEntityFixtureType.h
  • BlueprintCallable
  • Category="Fixture Settings"
  • Meta=(DeprecatedFunction, DeprecationMessage="Setting GDTFs from blueprints was never fully supported and now deprecated. Instead please refer to the Create Fixture Type In DMX Library function.")

void UpdateChannelSpan ( int32 ModeIndex
)

 Updates the channel span of the Mode. Library/DMXEntityFixtureType.h  

void UpdateXCellsFromYCells ( int32 ModeIndex
)

 Updates the channel span of the Mode. Library/DMXEntityFixtureType.h  

void UpdateYCellsFromXCells ( int32 ModeIndex
)

 Updates the channel span of the Mode. Library/DMXEntityFixtureType.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bAlwaysMarkDirty
)

   Library/DMXEntityFixtureType.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   Library/DMXEntityFixtureType.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Library/DMXEntityFixtureType.h  

virtual void PostEditUndo()

   Library/DMXEntityFixtureType.h  

virtual void Serialize ( FArchive& Ar
)

   Library/DMXEntityFixtureType.h  

Static

Name Remarks Include Path Unreal Specifiers

static float BytesToFunctionNormalizedValue ( const FDMXFixtureFunction& InFunction,
const uint8* InBytes
)

   Library/DMXEntityFixtureType.h  

static uint32 BytesToFunctionValue ( const FDMXFixtureFunction& InFunction,
const uint8* InBytes
)

   Library/DMXEntityFixtureType.h  

static uint32 BytesToInt ( EDMXFixtureSignalFormat InSignalFormat,
bool bUseLSB,
const uint8* InBytes
)

   Library/DMXEntityFixtureType.h  

static float BytesToNormalizedValue ( EDMXFixtureSignalFormat InSignalFormat,
bool bUseLSB,
const uint8* InBytes
)

   Library/DMXEntityFixtureType.h  

static UDMXEntityFixtureType * CreateFixtureTypeInLibrary ( FDMXEntityFixtureTypeConstructionParams ConstructionParams,
const FString& DesiredName,
bool bMarkDMXLibraryDirty
)

 Creates a new Fixture Type in the DMX Library Library/DMXEntityFixtureType.h
  • BlueprintCallable
  • Category="DMX|Fixture Type"

static void FunctionNormalizedValueToBytes ( const FDMXFixtureFunction& InFunction,
float InValue,
uint8* OutBytes
)

   Library/DMXEntityFixtureType.h  

static void FunctionValueToBytes ( const FDMXFixtureFunction& InFunction,
uint32 InValue,
uint8* OutBytes
)

 Conversions. @TODO, move to FDMXConversions. Library/DMXEntityFixtureType.h  

static FDMXOnFixtureTypeChangedDelegate & GetOnFixtureTypeChanged()

 Returns a delegate that is and should be broadcast whenever a Fixture Type changed Library/DMXEntityFixtureType.h  

static void IntToBytes ( EDMXFixtureSignalFormat InSignalFormat,
bool bUseLSB,
uint32 InValue,
uint8* OutBytes
)

   Library/DMXEntityFixtureType.h  

static void NormalizedValueToBytes ( EDMXFixtureSignalFormat InSignalFormat,
bool bUseLSB,
float InValue,
uint8* OutBytes
)

   Library/DMXEntityFixtureType.h  

static void RemoveFixtureTypeFromLibrary ( FDMXEntityFixtureTypeRef FixtureTypeRef
)

 Removes a Fixture Type from a DMX Library Library/DMXEntityFixtureType.h
  • BlueprintCallable
  • Category="DMX|Fixture Type"

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bFixtureMatrixEnabled_DEPRECATED bool   Library/DMXEntityFixtureType.h
  • Meta=(DeprecatedProperty, DeprecationMessage="FixtureMatrixEnabled is deprecated. Instead now each Mode has a FixtureMatrixEnabled property.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page