UDMXEntityFixtureType

Class to describe a type of Fixture.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXRuntime

Header

/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXEntityFixtureType.h

Include

#include "Library/DMXEntityFixtureType.h"

Syntax

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

Remarks

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

Variables

Name Description

Public variable UProperty Meta

bool

 

bFixtureMatrixEnabled

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FDMXFixtureCate...

 

DMXCategory

The Category of the Fixture, useful for Filtering

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

UDMXImport *...

 

DMXImport

The GDTF file from which the Fixture Type was setup

Public variable UProperty Category, EditAnywhere, Meta instanced

TArray< UDMXMod...

 

InputModulators

Modulators applied right before a patch of this type is received.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

TArray< FDMXFix...

 

Modes

Functions

Name Description

Public function

void

 

AddCellAttribute

(
    int32 ModeIndex
)

Fixture Matrix related.

Public function

int32

 

AddFunction

(
    int32 InModeIndex
)

Fixture Function related.

Public function

int32

 

AddMode()

Fixture Mode related.

Public function Static

float

 

BytesToFunctionNormalizedValue

(
    const FDMXFixtureFunction& InFunct...,
    const uint8* InBytes
)

Public function Static

uint32

 

BytesToFunctionValue

(
    const FDMXFixtureFunction& InFunct...,
    const uint8* InBytes
)

Public function Static

uint32

 

BytesToInt

(
    EDMXFixtureSignalFormat InSignalFor...,
    bool bUseLSB,
    const uint8* InBytes
)

Public function Static

float

 

BytesToNormalizedValue

(
    EDMXFixtureSignalFormat InSignalFor...,
    bool bUseLSB,
    const uint8* InBytes
)

Public function

void

 

ClampFunctionDefautValueByDataType

(
    int32 ModeIndex,
    int32 FunctionToRemoveIndex
)

Clamps the Default Value of the Function by its Data Type

Public function Static UFunction BlueprintCallable, Category

UDMXEntityFi...

 

CreateFixtureTypeInLibrary

(
    FDMXEntityFixtureTypeConstructionPa...,
    const FString& DesiredName,
    bool bMarkDMXLibraryDirty
)

Creates a new Fixture Type in the DMX Library

Public function

void

 

DuplicateFunctions

(
    int32 InModeIndex,
    const TArray< int32 >& InFunctionI...,
    TArray< int32 >& OutNewFunctionInd...
)

Adds a Function to the Mode's Function Array

Public function

void

 

DuplicateModes

(
    TArray< int32 > InModeIndicesToDupl...,
    TArray< int32 >& OutNewModeIndices
)

Duplicates the Modes at specified Indices

Public function Static

void

 

FunctionNormalizedValueToBytes

(
    const FDMXFixtureFunction& InFunct...,
    float InValue,
    uint8* OutBytes
)

Public function Static

void

 

FunctionValueToBytes

(
    const FDMXFixtureFunction& InFunct...,
    uint32 InValue,
    uint8* OutBytes
)

  1. , move to FDMXConversions.

Public function Static

FDMXOnFixtur...

 

GetOnFixtureTypeChanged()

Returns a delegate that is and should be broadcast whenever a Fixture Type changed

Public function

int32

 

InsertFunction

(
    int32 InModeIndex,
    int32 InInsertAtIndex,
    FDMXFixtureFunction& InOutNewFunct...
)

Inserts a Function to the Mode's Function Array

Public function Static

void

 

IntToBytes

(
    EDMXFixtureSignalFormat InSignalFor...,
    bool bUseLSB,
    uint32 InValue,
    uint8* OutBytes
)

Public function Static

void

 

NormalizedValueToBytes

(
    EDMXFixtureSignalFormat InSignalFor...,
    bool bUseLSB,
    float InValue,
    uint8* OutBytes
)

Public function

void

 

RemoveCellAttribute

(
    int32 ModeIndex,
    int32 CellAttributeIndex
)

Removes a cell attribute to the Mode

Public function Static UFunction BlueprintCallable, Category

void

 

RemoveFixtureTypeFromLibrary

(
    FDMXEntityFixtureTypeRef FixtureTyp...
)

Removes a Fixture Type from a DMX Library

Public function

void

 

RemoveFunctions

(
    int32 ModeIndex,
    TArray< int32 > FunctionIndicesToDe...
)

Removes Functions from the Mode's Function Array

Public function

void

 

RemoveModes

(
    const TArray< int32 >& ModeIndices...
)

Deletes the Modes at specified Indices

Public function

void

 

ReorderFunction

(
    int32 ModeIndex,
    int32 FunctionToReorderIndex,
    int32 InsertAtIndex
)

Reorders a function to reside at the Insert At Index, subsequently reorders other affected Functions

Public function

void

 

ReorderMatrix

(
    int32 ModeIndex,
    int32 InsertAtFunctionIndex
)

Reorders the Fixture Matrix to reside after a function, subsequently reorders other affected Functions

Public function

void

 

SetFixtureMatrixEnabled

(
    int32 ModeIndex,
    bool bEnableMatrix
)

Enables or disables the Matrix, reorders Function channels accordingly

Public function

void

 

SetFunctionName

(
    int32 InModeIndex,
    int32 InFunctionIndex,
    const FString& InDesiredFunctionNa...,
    FString& OutUniqueFunctionName
)

Sets a Mode Name for specified Mode

Public function

void

 

SetFunctionStartingChannel

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

Sets a Starting Channel for the Function, aligns it to other functions

Public function

void

 

SetModeName

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

Sets a Mode Name for specified Mode

Public function UFunction BlueprintCallable, Category

void

 

SetModesFromDMXImport

(
    UDMXImport* DMXImportAsset
)

Public function

void

 

UpdateChannelSpan

(
    int32 ModeIndex
)

Updates the channel span of the Mode.

Public function

void

 

UpdateXCellsFromYCells

(
    int32 ModeIndex
)

Updates the channel span of the Mode.

Public function

void

 

UpdateYCellsFromXCells

(
    int32 ModeIndex
)

Updates the channel span of the Mode.

Overridden from UObject

Name Description

Public function Virtual

bool

 

Modify

(
    bool bAlwaysMarkDirty
)

That the object will be modified.

Public function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Protected function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Constants

Name

Description

DataTypeChangeDelegate_DEPRECATED

Editor only data type change delagate

DEPRECATED 5.0

OnFixtureTypeChangedDelegate

Delegate that should be broadcast whenever a fixture type changed

Deprecated Functions

Name Description

Public function Static

void

 

ClampDefaultValue

(
    FDMXFixtureFunction& InFunction
)

Deprecated to reduce redundant code. Use FDMXConversions::ClampValueBySignalFormat locally where clamping is required.

Public function Static

uint32

 

ClampValueToDataType

(
    EDMXFixtureSignalFormat DataType,
    uint32 InValue
)

Deprecated in favor of FDMXConversions now holding all conversions. Use FDMXConversions::ClampValueBySignalFormat instead.

Public function Static

FDataTypeCha...

 

GetDataTypeChangeDelegate()

Deprecated in favor of the more generic GetOnFixtureTypeChanged which is supported in non-editor builds as well.

Public function Static

uint32

 

GetDataTypeMaxValue

(
    EDMXFixtureSignalFormat DataType
)

Deprecated in favor of FDMXConversions::GetSignalFormatMaxValue.

Public function Static

uint8

 

GetFunctionLastChannel

(
    const FDMXFixtureFunction& Functio...
)

Deprecated in favor of FDMXFixtureFunction::GetLastChannel.

Public function Static

bool

 

IsFixtureMatrixInModeRange

(
    const FDMXFixtureMatrix& InFixture...,
    const FDMXFixtureMode& InMode,
    int32 ChannelOffset
)

Deprecated since the use of the function and its name were not clear, leading to hard to read, complicated code.

Public function Static

bool

 

IsFunctionInModeRange

(
    const FDMXFixtureFunction& InFunct...,
    const FDMXFixtureMode& InMode,
    int32 ChannelOffset
)

Deprecated to reduce redundant code. Instead use FDMXFixtureFunction::GetNumChannels() and FDMXFixtureMode::ChannelSpan

Public function Static

uint8

 

NumChannelsToOccupy

(
    EDMXFixtureSignalFormat DataType
)

Deprecated in favor of FDMXConversions::SizeOfSignalFormat.

Public function Static

void

 

SetFunctionSize

(
    FDMXFixtureFunction& InFunction,
    uint8 Size
)

Deprecated because of unclear use. Set via FDMXFixtureFunction::DataType directly instead.

Public function

void

 

UpdateChannelSpan

(
    FDMXFixtureMode& Mode
)

Deprecated in favor of UDMXEntityFixtureType::UpdateChannelSpan.

Public function

void

 

UpdateModeChannelProperties

(
    FDMXFixtureMode& Mode
)

Use MakeValid instead.

Public function

void

 

UpdateXCellsFromYCells

(
    FDMXFixtureMode& Mode
)

Deprecated to in favor of UDMXEntityFixtureType::UpdateXCellsFromYCells.

Public function

void

 

UpdateYCellsFromXCells

(
    FDMXFixtureMode& Mode
)

Deprecated in favor of UDMXEntityFixtureType::UpdateYCellsFromXCells.