className: FDMXNormalizedAttributeValueMap

description: Holds an array Attribute Names with their normalized Values (expand the property to see the map)

Map

type: TMap<FDMXAttri...


className: FDMXOnDMXLibraryAssetDelegate

module: DMXRuntime

code: typedef TMulticastDelegate_OneParam< void, [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * > FDMXOnDMXLibraryAssetDelegate


description: Returns the Value of the optional, only call when the value is set.

code: const bool & GetValue() const


description: Returns true if the optional is set

code: bool IsSet() const


code: const [FDMXOptionalBool](API\Plugins\DMXRuntime\FDMXOptionalBool) & operator= ( const bool & Transform )


description: Resets the optional

code: void Reset()


code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: FDMXOptionalBool

Value

type: TOptional< bool...

description: The Optional Value


code: const [FDMXColorCIE1931xyY](API\Plugins\DMXRuntime\FDMXColorCIE1931xyY) & GetValue() const


code: const [FDMXOptionalColorCIE1931](API\Plugins\DMXRuntime\FDMXOptionalColorCIE1931) & operator= ( const [FDMXColorCIE1931xyY](API\Plugins\DMXRuntime\FDMXColorCIE1931xyY) & Transform )


type: TOptional<FDMX...

description: The Optional Value


code: const float & GetValue() const


code: const [FDMXOptionalFloat](API\Plugins\DMXRuntime\FDMXOptionalFloat) & operator= ( const float & Transform )


className: FDMXOptionalFloat

type: TOptional< floa...

description: The Optional Value


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetValue() const


code: const [FDMXOptionalGuid](API\Plugins\DMXRuntime\FDMXOptionalGuid) & operator= ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Transform )


code: [FArchive](API\Runtime\Core\Serialization\FArchive) & operator<< ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: FDMXOptionalGuid

type: TOptional<FGui...

description: The Optional Value


code: const int32 & GetValue() const


code: const [FDMXOptionalInt32](API\Plugins\DMXRuntime\FDMXOptionalInt32) & operator= ( const int32 & Transform )


type: TOptional< int3...

description: The Optional Value


code: const [FString](API\Runtime\Core\Containers\FString) & GetValue() const


description: Returns true if the optional is set


code: const [FDMXOptionalString](API\Plugins\DMXRuntime\FDMXOptionalString) & operator= ( const [FString](API\Runtime\Core\Containers\FString) & Transform )


description: Resets the optional


className: FDMXOptionalString

type: TOptional<FStr...

description: The Optional Value


code: const FTransform & GetValue() const


code: const [FDMXOptionalTransform](API\Plugins\DMXRuntime\FDMXOptionalTransform) & operator= ( const FTransform & Transform )


className: FDMXOptionalTransform

type: TOptional< FTra...

description: The Optional Value


code: const FVector2D & GetValue() const


code: const [FDMXOptionalVector2D](API\Plugins\DMXRuntime\FDMXOptionalVector2D) & operator= ( const FVector2D & Vector2D )


type: TOptional< FVec...

description: The Optional Value


description: Converts a UE transform to a GDTF style string

code: static [FString](API\Runtime\Core\Containers\FString) ConvertTransformToGDTF4x3MatrixString ( FTransform Transform )


description:
Creates an unique name for an Entity from a specific type, using the type name as base.
Unique name for an Entity amongst others from the same type.

code: static [FString](API\Runtime\Core\Containers\FString) FindUniqueEntityName ( const [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * InLibrary, [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > InEntityClass, const [FString](API\Runtime\Core\Containers\FString) & InBaseName )


description: Generates a unique name given a base one and a list of potential ones

code: static [FString](API\Runtime\Core\Containers\FString) GenerateUniqueNameForImportFunction ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), uint32 > & OutPotentialFunctionNamesAndCount, const [FString](API\Runtime\Core\Containers\FString) & InBaseName )


description:
Generates a unique name given a base one and a list of existing ones, by appending an index.
Returns the unique name.

code: static [FString](API\Runtime\Core\Containers\FString) GenerateUniqueNameFromExisting ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & InExistingNames, [FString](API\Runtime\Core\Containers\FString) InDesiredName, uint8 NumDigitsInPostfix, bool bAlwaysGeneratePostfix )


description:
Utility to separate a name from an index at the end.
True if there was an index on InString.

code: static bool GetNameAndIndexFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString, [FString](API\Runtime\Core\Containers\FString) & OutName, int32 & OutIndex )


description:
Maps each patch to its universe.
Key: universe Value: patches in universe with associated key

code: static [TMap](API\Runtime\Core\Containers\TMap)< int32, [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * > > MapToUniverses ( const [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * > & AllPatches )


description: Parses a GDTF (or MVR) Transformation Matrix from a String. Result is optional and set if parsing succeeded.

code: static [FDMXOptionalTransform](API\Plugins\DMXRuntime\FDMXOptionalTransform) ParseGDTFMatrix ( const [FString](API\Runtime\Core\Containers\FString) & String )


description: Sort a distribution array for widget InDistribution Distribution schema InNumXPanels Num columns InNumYPanels Num rows InUnorderedList Templated unsorted array input OutSortedList Templated unsorted array output

code: template<typename T> static void PixelMappingDistributionSort ( [EDMXPixelMappingDistribution](API\Plugins\DMXRuntime\Library\EDMXPixelMappingDistribution) InDistribution, int32 InNumXPanels, int32 InNumYPanels, const [TArray](API\Runtime\Core\Containers\TArray)< T > & InUnorderedList, [TArray](API\Runtime\Core\Containers\TArray)< T > & OutSortedList )


description: Serializes a struct to a Sting

code: template<typename StructType> static [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > SerializeStructToString ( const StructType & Struct )


description: Can't instantiate this class

code: FDMXRuntimeUtils()


className: FDMXRuntimeUtils

code: class FDMXRuntimeUtils


className: FLogCategoryLogDMXRuntime

code: struct FLogCategoryLogDMXRuntime : public [FLogCategory< ELogVerbosity::Log, ELogVerbosity::All >](API\Runtime\Core\Logging\FLogCategory)


className: FProtocolReceivedDelegate

code: class FProtocolReceivedDelegate


description: Begins Play for the component. Called when the owning Actor begins play or when the component is created if the Actor has already begun play. Actor BeginPlay normally happens right after PostInitializeComponents but can be delayed for networked or child actors. Requires component to be registered and initialized.

code: virtual void BeginPlay()


description: Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.

code: virtual void DestroyComponent ( bool bPromoteChildren )


description: Gets the fixture patch used in the component

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX") [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * GetFixturePatch() const


description: Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

code: virtual void OnRegister()


description: Called when the fixture patch received DMX

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)() void OnFixturePatchReceivedDMX ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch, const [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) & NormalizedValuePerAttribute )


description: Sets the fixture patch used in the component

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") void SetFixturePatch ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * InFixturePatch )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Sets whether the component receives dmx from the patch. Note, this is saved with the component when called in editor.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") void SetReceiveDMXFromPatch ( bool bReceive )


description: Sets up binding for receiving depending on the patch's and the component's properties

code: void SetupReceiveDMXBinding()


description: Function called every frame on this ActorComponent. Override this function to implement custom logic to be executed every frame. Only executes if the component is registered, and also PrimaryComponentTick.bCanEverTick must be set to true.

code: virtual void TickComponent ( float DeltaTime, enum ELevelTick TickType, [FActorComponentTickFunction](API\Runtime\Engine\Engine\FActorComponentTickFunction) * ThisTickFunction )


description: Enables or disables the component tick depending of it being required for the OnDXMComponentTick function

code: void UpdateTickEnabled()


className: UDMXComponent

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

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(DMX), Meta=(BlueprintSpawnableComponent), HideCategories=("Variable", "Sockets", "Activation", "Cooking", "ComponentReplication", "Collision", "ComponentTick")) class UDMXComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent)

bReceiveDMXFromPatch

type: bool

description: If true, the component will receive DMX from the patch

FixturePatchRef

type: FDMXEntityFixtu...

OnDMXComponentTick

type: FDMXOnDMXCompon...

description: Event raised each tick, when the component has a Fixture Patch set and either:

OnFixturePatchReceived

type: FDMXComponentFi...

description: Broadcast when the component's fixture patch received DMX


code: namespace DMXImport { template<typename EnumType> static EnumType DMXImport::GetEnumValueFromString ( const [FString](API\Runtime\Core\Containers\FString) & String ) }


className: EDMXImportGDTFBeamType

code: enum EDMXImportGDTFBeamType { Wash, Spot, None, }


className: EDMXImportGDTFDMXInvert

code: enum EDMXImportGDTFDMXInvert { Yes, No, }


className: EDMXImportGDTFInterpolationTo

code: enum EDMXImportGDTFInterpolationTo { Linear, Step, Log, }


className: EDMXImportGDTFLampType

code: enum EDMXImportGDTFLampType { Discharge, Tungsten, Halogen, LED, }


className: EDMXImportGDTFMaster

code: enum EDMXImportGDTFMaster { None, Grand, Group, }


className: EDMXImportGDTFMode

code: enum EDMXImportGDTFMode { Custom, sRGB, ProPhoto, ANSI, }


className: EDMXImportGDTFPrimitiveType

code: enum EDMXImportGDTFPrimitiveType { Undefined, Cube, Cylinder, Sphere, Base, Yoke, Head, Scanner, Conventional, Pigtail, }


className: EDMXImportGDTFPhysicalUnit

code: enum EDMXImportGDTFPhysicalUnit { None, Percent, Length, Mass, Time, Temperature, LuminousIntensity, Angle, Force, Frequency, Current, Voltage, Power, Energy, Area, Volume, Speed, Acceleration, AngularSpeed, AngularAccc, WaveLength, ColorComponent, }


className: EDMXImportGDTFSnap

code: enum EDMXImportGDTFSnap { Yes, No, On, Off, }


className: EDMXImportGDTFType

code: enum EDMXImportGDTFType { Multiply, Override, }


className: EDMXPixelMappingDistribution

code: enum EDMXPixelMappingDistribution { TopLeftToRight, TopLeftToBottom, TopLeftToClockwise, TopLeftToAntiClockwise, TopRightToLeft, BottomLeftToTop, TopRightToAntiClockwise, BottomLeftToClockwise, BottomLeftToRight, TopRightToBottom, BottomLeftAntiClockwise, TopRightToClockwise, BottomRightToLeft, BottomRightToTop, BottomRightToClockwise, BottomRightToAntiClockwise, }


className: FDataTypeChangeDelegate

description: Notification when data type changed

code: typedef TMulticastDelegate_TwoParams< void, const [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) *, const [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & > FDataTypeChangeDelegate


className: FDMXCell

CellID

description: The cell index in a 1D Array (row order), starting from 0

Coordinate

type: FIntPoint

description: The cell coordinate in a 2D Array, starting from (0, 0)


description: SpecializedGetEntity()to return it already cast

code: [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * GetController() const


code: FDMXEntityControllerRef ( [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * InController )


description: Returns all raw attribute values. Returns nullptr if there is no data

code: const [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) * GetAllNormalizedAttributeValues() const


className: FDMXEntityControllerRef

description: Represents a Controller from a DMX Library. Used to store a reference to a Controller outside the DMX Library

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType), Meta=(DisplayName="DMX Controller Ref")) struct FDMXEntityControllerRef : public [FDMXEntityReference](API\Plugins\DMXRuntime\Library\FDMXEntityReference)


description: Returns the all raw attribute values for the specified Cell. Returns nullptr if the attribute cannot be found.

code: const [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) * GetAllNormalizedMatrixAttributeValuesFromCell ( int32 CellIndex ) const


description: Returns all raw matrix attribute values. Returns nullptr if the attribute cannot be accessed or if there is no data.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) > * GetAllNormalizedMatrixAttributeValues() const


code: const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > * GetAllRawAttributeValues() const


code: const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > * GetAllRawMatrixAttributeValuesFromCell ( int32 CellIndex ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > > * GetAllRawMatrixAttributeValues() const


description: Returns the attributes of the mode's function, without matrix attributes

code: [TArray](API\Runtime\Core\Containers\TArray)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) > GetAttributeNames() const


description: Returns the attribute names of the fixture matrix' cell attributes, without common function attributes

code: [TArray](API\Runtime\Core\Containers\TArray)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) > GetCellAttributeNames() const


description: Returns the cell attributes of the fixture matrix

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXFixtureCellAttribute](API\Plugins\DMXRuntime\Library\FDMXFixtureCellAttribute) > & GetCellAttributes() const


description: Returns the data size of a single cell

code: int32 GetCellSize() const


description: Returns the channel span

code: int32 GetChannelSpan() const


description: Returns a pixel mapping distribution ordered CellIndexfrom a Cell Coordinate, or INDEX_NONE if not a valid index

code: int32 GetDistributedCellIndex ( const FIntPoint & CellCoordinate ) const


code: int32 GetDistributedCellIndex ( int32 CellIndex ) const


description: Returns the functions of the mode

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) > & GetFunctions() const


description: Returns the number of collumns in the matrix. Does not test if the cache is using the matrix.

code: int32 GetMatrixNumXCells() const


description: Returns the number of rows in the matrix. Does not test if the cache is using the matrix.

code: int32 GetMatrixNumYCells() const


description: Returns the absolute starting channel of the matrix attributes

code: const int32 GetMatrixStartingChannelAbsolute() const


description: Returns the raw attribute value for the specified Attribute Name. Returns nullptr if the attribute cannot be found

code: const float * GetNormalizedAttributeValue ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & AttributeName ) const


description: Returns the normalized attribute value for the specified Attribute Name. Returns nullptr if the attribute cannot be found.

code: const float * GetNormalizedMatrixAttributeValueFromCell ( int32 CellIndex, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & AttributeName ) const


description: Returns the raw attribute value for the specified Attribute Name. Returns nullptr if the attribute cannot be found.

code: const int32 * GetRawAttributeValue ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & AttributeName ) const


code: const int32 * GetRawMatrixAttributeValueFromCell ( int32 CellIndex, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & AttributeName ) const


description: Returns true if the cache holds valid properties retrived from mode and matrix. Cached values may be empty if no signal was input yet.

code: bool HasValidProperties() const


description: Inputs a signal into the cache. Returns true if cached data changed.

code: bool InputDMXSignal ( const [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & DMXSignal )


description: Returns true if there is the matrix properties are valid and can ever hold data

code: bool IsFixtureMatrix() const


description: Applies the modulator to the cache

code: void Modulate ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch, [UDMXModulator](API\Plugins\DMXRuntime\Modulators\UDMXModulator) * Modulator )


description: Resets cached data

code: void Reset()


description: Default constructor

code: FDMXEntityFixturePatchCache()


description: InStartingChannel The Starting Channel of the patch.  InActiveModePtr Pointer to the Active Mode of the patch, or nullptr if no Active Mode is available.  InFixtureMatrixPtr Pointer to the fixture matrix of the patch, or nullptr if no Fixture Matrix is available

code: FDMXEntityFixturePatchCache ( int32 InStartingChannel, const [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) * InActiveModePtr, const [FDMXFixtureMatrix](API\Plugins\DMXRuntime\Library\FDMXFixtureMatrix) * InFixtureMatrixPtr )


className: FDMXEntityFixturePatchCache

description: Cache for fixture patches. This object takes care of handling the fixture patch data in a single point. The fixture patch self is used to define it.

code: class FDMXEntityFixturePatchCache


description: Parameters to construct a Fixture Patch.

ActiveMode

description: TheIndexof the Mode in the Fixture Type the Patch uses

FixtureTypeRef

description: Property to point to the template parent fixture for details panel purposes

MVRFixtureUUID

type: FGuid

description: When spawning the DMX Library as MVR Scene in Editor, each Fixture Patch has to correspond to a Fixture in the World (if it is desired to export the Scene as MVR later).

StartingAddress

description: Starting channel for when auto-assign address is false

UniverseID

description: The local universe of the patch


description: SpecializedGetEntity()to return it already cast

code: [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * GetFixturePatch() const


code: FDMXEntityFixturePatchRef ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * InFixturePatch )


className: FDMXEntityFixturePatchRef

description: Represents a Fixture Patch from a DMX Library. Used to store a reference to a Fixture Patch outside the DMX Library

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType), Meta=(DisplayName="DMX Fixture Patch Ref")) struct FDMXEntityFixturePatchRef : public [FDMXEntityReference](API\Plugins\DMXRuntime\Library\FDMXEntityReference)


className: FDMXEntityFixtureTypeConstructionParams

description: Parameters to construct a Fixture Type.

DMXCategory

type: FDMXFixtureCate...

description: The Category of the Fixture, useful for Filtering

Modes

type: TArray<FDMXFix...

description: The Modes of the Fixture Type

ParentDMXLibrary

type: TObjectPtr<UDM...

description: The DMX Library in which the Fixture Type will be constructed


code: [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * GetFixtureType() const


code: FDMXEntityFixtureTypeRef ( [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * InFixtureType )


className: FDMXEntityFixtureTypeRef

description: Represents a Fixture Type from a DMX Library. Used to store a reference to a Fixture Type outside the DMX Library

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType), Meta=(DisplayName="DMX Fixture Type Ref")) struct FDMXEntityFixtureTypeRef : public [FDMXEntityReference](API\Plugins\DMXRuntime\Library\FDMXEntityReference)


description: Get the Entity referenced by this struct or nullptr if none was set.

code: [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * GetEntity() const


description: Get the type of entity this reference points to

code: [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > GetEntityType() const


code: bool operator!= ( const [FDMXEntityReference](API\Plugins\DMXRuntime\Library\FDMXEntityReference) & Other ) const


description: Comparison operators

code: bool operator== ( const [FDMXEntityReference](API\Plugins\DMXRuntime\Library\FDMXEntityReference) & Other ) const


description: Set the Entity and DMX Library this struct represents

code: void SetEntity ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * NewEntity )


description: Construct with invalid values by default

code: FDMXEntityReference()


description: Construct as a reference to an existing Entity and its type as EntityType

code: FDMXEntityReference ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * InEntity )


className: FDMXEntityReference

description: Represents an Entity from a DMX Library. Used to allow objects outside the DMX Library package to store references toUDMXEntityobjects

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Meta=(DisplayName="DMX Entity Reference")) struct FDMXEntityReference

bDisplayLibraryPicker

description: Display the DMX Library asset picker. True by default, for Blueprint variables

DMXLibrary

description: The parent DMX library of the Entity Automatically set when calling SetEntity with a valid Entity.

EntityType

type: TSubclassOf<UD...


description: Returns the number of channels of the attribute

code: uint8 GetNumChannels() const


className: FDMXFixtureCellAttribute

Attribute

type: FDMXAttributeNa...

description: The Attribute name to map this Function to.

bUseLSBMode

description: The Endianess of the Attribute: 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.

DataType

type: EDMXFixtureSign...

description: This function's data type. Defines the used number of channels (bytes)

DefaultValue

description: Initial value for this function when no value is set

Description

type: FString


description: Constructor

code: FDMXFixtureCellAttribute()


description: Returns the last channel of the Function

code: int32 GetLastChannel() const


description: Returns the number of channels the function spans, according to its data type


description: Constructor

code: FDMXFixtureFunction()


className: FDMXFixtureFunction

bUseLSBMode

description: 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).

Channel

description: This function's starting channel (use editor above to make changes)

DefaultValue

description: The Default Value of the function, imported from GDTF.


description: Deprecated* Deprecated to reduce redundant code. Instead use UDMXFixturePatch::GetMatrixCellChannelsRelative

code: bool GetChannelsFromCell ( FIntPoint CellCoordinate, [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) Attribute, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & Channels ) const


description: Returns the last channel of the Matrix


description: Returns the number of channels of the Matrix

code: int32 GetNumChannels() const


description: Constructor

code: FDMXFixtureMatrix()


className: FDMXFixtureMatrix

PixelMappingDistribution

type: EDMXPixelMappin...


description: DEPRECATED 5.0

code: int32 AddOrInsertFunction ( int32 IndexOfFunction, [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) InFunction )


className: FDMXFixtureMode

bAutoChannelSpan

description: When enabled, ChannelSpan is automatically set based on the created functions and their data types.

ChannelSpan

description: Number of channels (bytes) used by this mode's functions

FixtureMatrixConfig

type: FDMXFixtureMatr...


className: FDMXImportGDTFActivationGroup

Name

type: FName


description: Deprecated* Deprecated for more consistent naming. Instead useFDMXFixtureMatrix::GetLastChannel


className: FDMXImportGDTFBeam

BeamAngle

type: float

BeamType

type: EDMXImportGDTFB...

LampType

type: EDMXImportGDTFL...


className: FDMXImportGDTFChannelFunction

Attribute

type: FDMXImportGDTFA...

ChannelSets

type: TArray<FDMXImp...

DMXFrom

type: FDMXImportGDTFD...

DMXInvert

type: EDMXImportGDTFD...

Emitter

type: FDMXImportGDTFE...

Filter

type: FDMXImportGDTFF...

Wheel

type: FDMXImportGDTFW...


className: FDMXImportGDTFColorSpace

Blue

type: FDMXColorCIE

Mode

type: EDMXImportGDTFM...


className: FDMXImportGDTFChannelSet


description: Parses the offset of the channel. Returns false if no valid offset is specified

code: bool ParseOffset ( const [FString](API\Runtime\Core\Containers\FString) & InOffsetStr )


className: FDMXImportGDTFAttribute

PhysicalUnit

type: EDMXImportGDTFP...


className: FDMXImportGDTFDMXChannel

LogicalChannel

type: FDMXImportGDTFL...

Offset

type: TArray< int32 >


className: FDMXImportGDTFDMXMode


code: FDMXImportGDTFDMXValue ( const [FString](API\Runtime\Core\Containers\FString) & InDMXValueStr )


className: FDMXImportGDTFEmitter

DiodePart

type: FString

Measurement

type: FDMXImportGDTFM...


className: FDMXImportGDTFFeatureGroup

Name

type: FName


className: FDMXImportGDTFFilter


className: FDMXImportGDTFGeneralAxis


className: FDMXImportGDTFGeneralGeometry

Axis

type: FDMXImportGDTFG...

Geometry

type: FDMXImportGDTFT...


className: FDMXImportGDTFGeometryBase

Position

type: FMatrix


className: FDMXImportGDTFLogicalChannel

Attribute

type: FDMXImportGDTFA...

ChannelFunction

type: FDMXImportGDTFC...

DMXChangeTimeLimit

type: float

Snap

type: EDMXImportGDTFS...


className: FDMXImportGDTFMeasurement

InterpolationTo

type: EDMXImportGDTFI...

MeasurementPoints

type: TArray<FDMXImp...


className: FDMXImportGDTFGeometryReference


className: FDMXImportGDTFMeasurementPoint


className: FDMXImportGDTFRelation

Type

type: EDMXImportGDTFT...


className: FDMXImportGDTFTypeAxis


className: FDMXImportGDTFWheel


className: FDMXLibraryPortReferences

description: Custom struct of in put and output port references for custom details customization with an enabled state

InputPortReferences

type: TArray<FDMXInp...

description: Map of input port references of a Library

OutputPortReferences

type: TArray<FDMXOut...

description: Output ports of the Library of a Library


className: FDMXOnEntityArrayChangedDelegate

code: typedef TMulticastDelegate_TwoParams< void, class [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) *, [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * > > FDMXOnEntityArrayChangedDelegate


className: FDMXImportGDTFWheelSlot

Color

type: FDMXColorCIE

Filter

type: FDMXImportGDTFF...

MediaFileName

type: TObjectPtr<UTe...


className: FDMXImportGDTFModel

PrimitiveType

type: EDMXImportGDTFP...


description: DEPRECATED 5.0

code: typedef TMulticastDelegate_OneParam< void, class [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * > FOnEntitiesUpdated_DEPRECATED


className: FDMXOnFixtureTypeChangedDelegate

code: typedef TMulticastDelegate_OneParam< void, const [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * > FDMXOnFixtureTypeChangedDelegate


className: FDMXOnFixturePatchChangedDelegate

code: typedef TMulticastDelegate_OneParam< void, const [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * > FDMXOnFixturePatchChangedDelegate


description: Destroys the Entity

code: void Destroy()


description: Returns the entity name to be used in UI elements


description: This Entity's unique ID

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetID() const


description: Gets the library the Entity resides in

code: [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * GetParentLibrary() const


description:
Checks for Entity correctness for usability with protocols.
True if the Entity can be used with protocols.

code: virtual bool IsValidEntity() const


code: virtual bool IsValidEntity ( [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const


description: Used by DMX Library to resolve ID conflicts among entities

code: void RefreshID()


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Copy another Entity's ID. Used when copying, to not lose the original Entity's reference

code: void ReplicateID ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * Other )


description: Sets the DMX Library of the entity

code: void SetParentLibrary ( [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * InParent )


description: Constructor, for default objects only

code: UDMXEntity()


className: UDMXEntityController

description: DEPRECATED 4.27, can't be flagged as such to retain upgrade path, some nodes could not be compiled anymore. All members are deprecated.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UDMXEntityController : public [UDMXEntityUniverseManaged](API\Plugins\DMXRuntime\Library\UDMXEntityUniverseManaged)


description: Constructor that specifies the outer Library

code: UDMXEntity ( [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * InParentLibrary )


description: Updates this Entity's name and the UI friendly display name

code: void SetName ( const [FString](API\Runtime\Core\Containers\FString) & InNewName )


className: UDMXEntity

description: Base class for all entity types

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Meta=(DisplayName="DMX Entity")) class UDMXEntity : public [UDMXObjectBase](API\Plugins\DMXRuntime\Library\UDMXObjectBase)

Id

type: FGuid

description: Uniquely identifies the parameter, used for fixing up Blueprints that reference this Entity when renaming.

Name

type: FString

ParentLibrary

type: TWeakObjectPtr<...


description: Checks if the current Mode for this Patch is valid for its Fixture Type

code: bool CanReadActiveMode() const


description: Returns true if the fixture patch contains the attribute.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") bool ContainsAttribute ( [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) FunctionAttribute ) const


description: Returns a map of function channels and their values. Functions outside the Active Mode's channel span range are ignored.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") [TMap](API\Runtime\Core\Containers\TMap)< int32, uint8 > ConvertAttributeMapToRawMap ( const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & FunctionMap ) const


description: DEPRECATED 4.27

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Please use DMXSubsystem's Bytes to Int instead, then create a map from that with Attribute Names .")) [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > ConvertRawMapToAttributeMap ( const [TMap](API\Runtime\Core\Containers\TMap)< int32, uint8 > & RawMap ) const


description: Returns a map that only contains attributes used this patch.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > ConvertToValidMap ( const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & FunctionMap ) const


description: Creates a new Fixture Patch in the DMX Library using the specified Fixture Type

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * CreateFixturePatchInLibrary ( [FDMXEntityFixturePatchConstructionParams](API\Plugins\DMXRuntime\Library\FDMXEntityFixturePatchConstructi-) ConstructionParams, const [FString](API\Runtime\Core\Containers\FString) & DesiredName, bool bMarkDMXLibraryDirty )


description: Tries to find the fixture ID of the patch. Looks up the general scene description resulting in a relatively slow operation. Returns false if the patch has no fixture ID could be found, typically the case when the patch is no valid MVR Fixture.

code: bool FindFixtureID ( int32 & OutFixtureID ) const


description: Returns the active mode, or nullptr if there is no valid active mode

code: const [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) * GetActiveMode() const


description: Returns the index of the Mode the Patch uses from its Fixture Type

code: int32 GetActiveModeIndex() const


description: Returns an array of valid attributes for the currently active mode. Attributes outside the Active Mode's channel span range are ignored.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") [TArray](API\Runtime\Core\Containers\TArray)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) > GetAllAttributesInActiveMode() const


description: Gets all matrix cells

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetAllMatrixCells ( [TArray](API\Runtime\Core\Containers\TArray)< [FDMXCell](API\Plugins\DMXRuntime\Library\FDMXCell) > & Cells )


description: Returns a map of function names and default values. Functions outside the Active Mode's channel span range are ignored.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > GetAttributeDefaultMap() const


description:
Returns the function currently mapped to the passed in Attribute, if any. If no function is mapped to it, returns nullptr.
The function mapped to the passed in Attribute or nullptr if no function is mapped to it.

code: const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) * GetAttributeFunction ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & Attribute ) const


description: Returns a map of attributes and function names. Attributes outside the Active Mode's channel span range are ignored.


description: Returns a map of function names and their Data Types. Functions outside the Active Mode's channel span range are ignored.


description: Returns the value of each attribute, or zero if no value was ever received.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") void GetAttributesValues ( [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & AttributesValues )


description: Deprecated* bAutoAssignAddress and related members are deprecated. Auto assign is now a method inFDMXEditorUtilsand applied on demand.


description:
Retrieves the value of an Attribute. Will fail and return 0 if the Attribute doesn't exist.
The value of the Function mapped to the selected Attribute, if found.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") int32 GetAttributeValue ( [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) Attribute, bool & bSuccess )


description: Returns a map of Attributes and their assigned channels

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > GetAttributeChannelAssignments() const


description: Deprecated* bAutoAssignAddress and related members are deprecated. Please use GetStartingChannel instead of GetAutoStartingAddress.

code: int32 GetAutoStartingAddress() const


description: Gets all attributes names of a cell

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetCellAttributes ( [TArray](API\Runtime\Core\Containers\TArray)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) > & CellAttributes )


description: Returns the number of channels this Patch occupies with the Fixture functions from its Active Mode or 0 if the patch has no valid Active Mode

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") int32 GetChannelSpan() const


description: Returns custom tags defined for the patch

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & GetCustomTags() const


description: Returns the last channel of the patch

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") int32 GetEndingChannel() const


description: Gets the parent fixture type this was constructed from

code: [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * GetFixtureType() const


description: Returns the last received DMX signal.

code: const [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & GetLastReceivedDMXSignal() const


description: Gets the cell corresponding to the passed in coordinate

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetMatrixCell ( const FIntPoint & CellCoordinate, [FDMXCell](API\Plugins\DMXRuntime\Library\FDMXCell) & Cell )


description: Deprecated* bAutoAssignAddress and related members are deprecated. Please use GetStartingChannel instead of GetManualStartingAddress.

code: int32 GetManualStartingAddress() const


description: Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetMatrixCellChannelsRelative ( const FIntPoint & CellCoordinate, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & AttributeChannelMap )


description: Gets the absolute starting channel of each cell attribute at given coordinate

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetMatrixCellChannelsAbsolute ( const FIntPoint & CellCoordinate, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & AttributeChannelMap )


description: Validates and gets the absolute starting channel of each cell attribute at given coordinate

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetMatrixCellChannelsAbsoluteWithValidation ( const FIntPoint & InCellCoordinate, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & OutAttributeChannelMap )


description: Gets the Matrix Fixture properties, returns false if the patch is not using a matrix fixture

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") bool GetMatrixProperties ( [FDMXFixtureMatrix](API\Plugins\DMXRuntime\Library\FDMXFixtureMatrix) & MatrixProperties ) const


description: Gets the DMX Cell value using matrix coordinates

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetMatrixCellValues ( const FIntPoint & CellCoordinate, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & ValuePerAttribute )


description: Returns the MVR Fixture UUIDs of this patch

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetMVRFixtureUUID() const


description: Returns the normalized value of each attribute, or zero if no value was ever received.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") void GetNormalizedAttributesValues ( [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) & NormalizedAttributesValues )


description:
Retrieves the normalized value of an Attribute. Will fail and return 0 if the Attribute doesn't exist.
The value of the Function mapped to the selected Attribute, if found.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. Use GetNormalizedAttributeValue instead. Note, new method returns normalized values!")) float GetNormalizedAttributeValue ( [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) Attribute, bool & bSuccess )


description: Gets the DMX Cell value using matrix coordinates.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool GetNormalizedMatrixCellValues ( const FIntPoint & CellCoordinate, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), float > & NormalizedValuePerAttribute )


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


description: DEPRECATED 4.27

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are replaced with DMX Ports.")) [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * > GetRelevantControllers() const


description: DEPRECATED 4.27

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. No clear remote universe can be deduced from controllers (before 4.27) or ports (from 4.27 on).")) int32 GetRemoteUniverse() const


description: Return the starting channel

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") int32 GetStartingChannel() const


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object will ever be able to tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame
true if object will ever want to be ticked, false otherwise.

code: virtual ETickableTickType GetTickableTickType() const


description: Returns the universe ID of the patch

code: int32 GetUniverseID() const


description: Property name getters. When accessing the this way, use with care. The patch will need to update its cache after using property setters, use Pre/PostEditChanged events to achieve that.


description: Returns true if the patch is set to auto assign address

code: bool IsAutoAssignAddress() const


description: DEPRECATED 4.27

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are replaced with DMX Ports.")) bool IsInControllerRange ( const [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * InController ) const


description: DEPRECATED 4.27

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are replaced with DMX Ports.")) bool IsInControllersRange ( const [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * > & InControllers ) const


description: Returns true if given function map is valid for this fixture.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMX|Fixture Patch") bool IsMapValid ( const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & FunctionMap ) const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for allUObjectderived classes as they might be loaded async and therefore won't be ready immediately.
true if object is ready to be ticked, false otherwise.

code: virtual bool IsTickable() const


description:
Used to determine whether the object should be ticked in the editor. Defaults to false since that is the previous behavior.
true if this tickable object can be ticked in the editor

code: virtual bool IsTickableInEditor() const


description:
Checks for Entity correctness for usability with protocols.
True if the Entity can be used with protocols.

code: virtual bool IsValidEntity ( [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const


description:
Note that the object will be modified. If we are currently recording into the transaction buffer (undo/redo), save a copy of this object into the buffer and marks the package as needing to be saved.
true if the object was saved to the transaction buffer

code: virtual bool Modify ( bool bAlwaysMarkDirty )


className: OnFixturePatchChangedDelegate

description: Delegate broadcast when a Fixture Patch changed


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Rebuilds the cache. Should be called when relevant properties, for example the starting channel changed. This will not clear cached DMX data.

code: void RebuildCache()


description: Removes a fixture patch from the DMX Library

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void RemoveFixturePatchFromLibrary ( [FDMXEntityFixturePatchRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixturePatchRef) FixturePatchRef )


description: Send DMX using attribute names and integer values.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") void SendDMX ( [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > AttributeMap )


description: Sends the DMX value of the Attribute to specified matrix coordinates

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool SendMatrixCellValue ( const FIntPoint & CellCoordinate, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & Attribute, int32 Value )


description: Sends the DMX value of the Attribute to specified matrix coordinates with given Attribute Name Channel Map

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated due to ambigous arguments CellCoordinate and InAttributeNameChannelMap. Use SendMatrixCellValue or SendNormalizedMatrixCellValue instead.")) bool SendMatrixCellValueWithAttributeMap ( const FIntPoint & CellCoordinate, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & Attribute, int32 Value, const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), int32 > & InAttributeNameChannelMap )


description: Maps the normalized value to the Attribute's full value range and sends it to specified matrix coordinates

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") bool SendNormalizedMatrixCellValue ( const FIntPoint & CellCoordinate, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & Attribute, float RelativeValue )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Sets bAutoAssignAddress for the patch. Does not update relevant properties. Use UDMXEditor Module's UDMXEditorUtils::AutoAssignAddresses methods instead.

code: void SetAutoAssignAddressUnsafe ( bool bShouldAutoAssignAddress )


description: Sets the index of the Mode the Patch uses from its Fixture Type

code: bool SetActiveModeIndex ( int32 NewActiveModeIndex )


description: Deprecated* bAutoAssignAddress and related members are deprecated. Please use SetStartingChannel instead of SetAutoStartingAddress.

code: void SetAutoStartingAddress ( int32 NewAutoStartingAddress )


description: Sets the fixture type this is using

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") void SetFixtureType ( [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * NewFixtureType )


description: Deprecated* bAutoAssignAddress and related members are deprecated. Please use SetStartingChannel instead of SetManualStartingAddress.

code: void SetManualStartingAddress ( int32 NewManualStartingAddress )


description: If Auto Assign Address was set to true, turns off Auto Assign Address.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX|Fixture Patch") void SetStartingChannel ( int32 NewStartingChannel )


description: Sets the Universe ID of the patch

code: void SetUniverseID ( int32 NewUniverseID )


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


description: Called from Fixture Type to keep ActiveMode in valid range when Modes are removed from the Type

code: void ValidateActiveMode()


className: UDMXEntityFixturePatch

description: Use in DMXComponent or call SetReceiveDMXEnabled with 'true' to enable receiving DMX.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Meta=(DisplayName="DMX Fixture Patch")) class UDMXEntityFixturePatch : public [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)

ActiveMode

description: TheIndexof the Mode in the Fixture Type the Patch uses

bReceiveDMXInEditor

type: bool

description: If true, the patch receives dmx and raises the OnFixturePatchReceivedDMX event in editor.

CustomTags

type: TArray<FName>

description: Custom tags for filtering patches

EditorColor

type: FLinearColor

description: Color when displayed in the fixture patch editor

MVRFixtureUUID

description: The MVR Fixture UUID when used as such

OnFixturePatchReceivedDMX

type: FDMXOnFixturePa...

description: Broadcasts when the patch received dmx

ParentFixtureTypeTemplate

type: TObjectPtr<UDM...

description: Property to point to the template parent fixture for details panel purposes

StartingChannel

description: Starting Channel of the Patch

UniverseID

description: The local universe of the patch


description: Adds a new cell attribute to the Mode

code: void AddCellAttribute ( int32 ModeIndex )


description:
Adds a new Function to the Mode's Functions array
TheIndexof the newly added Function.

code: int32 AddFunction ( int32 InModeIndex )


description: Adds a Mode to the Modes Array

code: int32 AddMode ( [FString](API\Runtime\Core\Containers\FString) BaseModeName )


code: static float BytesToFunctionNormalizedValue ( const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction, const uint8 * InBytes )


code: static uint32 BytesToFunctionValue ( const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction, const uint8 * InBytes )


code: static uint32 BytesToInt ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) InSignalFormat, bool bUseLSB, const uint8 * InBytes )


code: static float BytesToNormalizedValue ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) InSignalFormat, bool bUseLSB, const uint8 * InBytes )


description: Deprecated* Deprecated to reduce redundant code. UseFDMXConversions::ClampValueBySignalFormatlocally where clamping is required.

code: static void ClampDefaultValue ( [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction )


description: Clamps the Default Value of the Function by its Data Type

code: void ClampFunctionDefautValueByDataType ( int32 ModeIndex, int32 FunctionToRemoveIndex )


description: Deprecated* Deprecated in favor ofFDMXConversionsnow holding all conversions. UseFDMXConversions::ClampValueBySignalFormatinstead.

code: static uint32 ClampValueToDataType ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) DataType, uint32 InValue )


description: Creates a new Fixture Type in the DMX Library

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * CreateFixtureTypeInLibrary ( [FDMXEntityFixtureTypeConstructionParams](API\Plugins\DMXRuntime\Library\FDMXEntityFixtureTypeConstructio-) ConstructionParams, const [FString](API\Runtime\Core\Containers\FString) & DesiredName, bool bMarkDMXLibraryDirty )


description: DEPRECATED 5.0


description: Aligns alls channels of the functions in the Mode to be consecutive

code: void AlignFunctionChannels ( int32 InModeIndex )


description: Adds a Function to the Mode's Function Array

code: void DuplicateFunctions ( int32 InModeIndex, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & InFunctionIndicesToDuplicate, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutNewFunctionIndices )


description: Duplicates the Modes at specified Indices

code: void DuplicateModes ( [TArray](API\Runtime\Core\Containers\TArray)< int32 > InModeIndicesToDuplicate, [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutNewModeIndices )


code: static void FunctionNormalizedValueToBytes ( const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction, float InValue, uint8 * OutBytes )


description: Conversions. , move toFDMXConversions.

code: static void FunctionValueToBytes ( const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction, uint32 InValue, uint8 * OutBytes )


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

code: static [FDataTypeChangeDelegate](API\Plugins\DMXRuntime\Library\FDataTypeChangeDelegate) & GetDataTypeChangeDelegate()


description: Deprecated* Deprecated in favor ofFDMXConversions::GetSignalFormatMaxValue.

code: static uint32 GetDataTypeMaxValue ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) DataType )


description: Deprecated* Deprecated in favor ofFDMXFixtureFunction::GetLastChannel.

code: static uint8 GetFunctionLastChannel ( const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & Function )


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


description:
Inserts a Function to the Mode's Function Array
TheIndexof the newly added Function.

code: int32 InsertFunction ( int32 InModeIndex, int32 InInsertAtIndex, [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InOutNewFunction )


code: static void IntToBytes ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) InSignalFormat, bool bUseLSB, uint32 InValue, uint8 * OutBytes )


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

code: static bool IsFixtureMatrixInModeRange ( const [FDMXFixtureMatrix](API\Plugins\DMXRuntime\Library\FDMXFixtureMatrix) & InFixtureMatrix, const [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & InMode, int32 ChannelOffset )


description: Deprecated* Deprecated to reduce redundant code. Instead useFDMXFixtureFunction::GetNumChannels()andFDMXFixtureMode::ChannelSpan

code: static bool IsFunctionInModeRange ( const [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction, const [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & InMode, int32 ChannelOffset )


description:
Note that the object will be modified. If we are currently recording into the transaction buffer (undo/redo), save a copy of this object into the buffer and marks the package as needing to be saved.
true if the object was saved to the transaction buffer

code: virtual bool Modify ( bool bAlwaysMarkDirty )


description: Deprecated* Deprecated in favor of FDMXConversions::SizeOfSignalFormat.

code: static uint8 NumChannelsToOccupy ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) DataType )


className: OnFixtureTypeChangedDelegate

description: Delegate that should be broadcast whenever a fixture type changed


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


description: Removes a cell attribute to the Mode

code: void RemoveCellAttribute ( int32 ModeIndex, int32 CellAttributeIndex )


description: Removes a Fixture Type from a DMX Library

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void RemoveFixtureTypeFromLibrary ( [FDMXEntityFixtureTypeRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixtureTypeRef) FixtureTypeRef )


description: Removes Functions from the Mode's Function Array

code: void RemoveFunctions ( int32 ModeIndex, [TArray](API\Runtime\Core\Containers\TArray)< int32 > FunctionIndicesToDelete )


description: Deletes the Modes at specified Indices

code: void RemoveModes ( const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & ModeIndicesToDelete )


description: Reorders a function to reside at the Insert AtIndex, subsequently reorders other affected Functions

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


code: static void NormalizedValueToBytes ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) InSignalFormat, bool bUseLSB, float InValue, uint8 * OutBytes )


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

code: void ReorderMatrix ( int32 ModeIndex, int32 InsertAtFunctionIndex )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Enables or disables the Matrix, reorders Function channels accordingly

code: void SetFixtureMatrixEnabled ( int32 ModeIndex, bool bEnableMatrix )


description: Sets a Mode Name for specified Mode

code: void SetFunctionName ( int32 InModeIndex, int32 InFunctionIndex, const [FString](API\Runtime\Core\Containers\FString) & InDesiredFunctionName, [FString](API\Runtime\Core\Containers\FString) & OutUniqueFunctionName )


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

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


description: Deprecated* Deprecated because of unclear use. Set viaFDMXFixtureFunction::DataTypedirectly instead.

code: static void SetFunctionSize ( [FDMXFixtureFunction](API\Plugins\DMXRuntime\Library\FDMXFixtureFunction) & InFunction, uint8 Size )


description: Sets a Mode Name for specified Mode

code: void SetModeName ( int32 InModeIndex, const [FString](API\Runtime\Core\Containers\FString) & InDesiredModeName, [FString](API\Runtime\Core\Containers\FString) & OutUniqueModeName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Fixture Settings") void SetModesFromDMXImport ( [UDMXImport](API\Plugins\DMXRuntime\Library\UDMXImport) * DMXImportAsset )


description: Updates the channel span of the Mode.

code: void UpdateChannelSpan ( int32 ModeIndex )


description: Deprecated* Deprecated in favor ofUDMXEntityFixtureType::UpdateChannelSpan(int32 ModeIndex).

code: void UpdateChannelSpan ( [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & Mode )


description: Deprecated* Use MakeValid instead.

code: void UpdateModeChannelProperties ( [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & Mode )


description: Updates the channel span of the Mode.

code: void UpdateXCellsFromYCells ( int32 ModeIndex )


description: Deprecated* Deprecated to in favor ofUDMXEntityFixtureType::UpdateXCellsFromYCells(int32 ModeIndex).

code: void UpdateXCellsFromYCells ( [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & Mode )


description: Updates the channel span of the Mode.

code: void UpdateYCellsFromXCells ( int32 ModeIndex )


description: Deprecated* Deprecated in favor ofUDMXEntityFixtureType::UpdateYCellsFromXCells(int32 ModeIndex).

code: void UpdateYCellsFromXCells ( [FDMXFixtureMode](API\Plugins\DMXRuntime\Library\FDMXFixtureMode) & Mode )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToControllerRef (Controller)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FDMXEntityControllerRef](API\Plugins\DMXRuntime\Library\FDMXEntityControllerRef) Conv_ControllerObjToRef ( [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * InController )


className: UDMXEntityFixtureType

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

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Meta=(DisplayName="DMX Fixture Type")) class UDMXEntityFixtureType : public [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity)

DMXCategory

type: FDMXFixtureCate...

description: The Category of the Fixture, useful for Filtering

DMXImport

description: The GDTF file from which the Fixture Type was setup

InputModulators

type: TArray<TObject...

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

Modes

type: TArray<FDMXFix...


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToController (ControllerReference)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [UDMXEntityController](API\Plugins\DMXRuntime\Library\UDMXEntityController) * Conv_ControllerRefToObj ( const [FDMXEntityControllerRef](API\Plugins\DMXRuntime\Library\FDMXEntityControllerRef) & InControllerRef )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToFixturePatch (FixturePatchReference)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * Conv_FixturePatchRefToObj ( const [FDMXEntityFixturePatchRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixturePatchRef) & InFixturePatchRef )


code: static [FDMXEntityFixturePatchRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixturePatchRef) Conv_FixturePatchObjToRef ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * InFixturePatch )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToFixtureType (FixtureTypeReference)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * Conv_FixtureTypeRefToObj ( const [FDMXEntityFixtureTypeRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixtureTypeRef) & InFixtureTypeRef )


className: UDMXEntityReferenceConversions

description: Extend type conversions to handle Entity Reference structs


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToFixtureTypeRef (FixtureType)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FDMXEntityFixtureTypeRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixtureTypeRef) Conv_FixtureTypeObjToRef ( [UDMXEntityFixtureType](API\Plugins\DMXRuntime\Library\UDMXEntityFixtureType) * InFixtureType )


className: UDMXEntityUniverseManaged

description: DEPRECATED 4.27, can't be flagged as such to retain upgrade path, some nodes could not be compiled anymore. All members are deprecated.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UDMXEntityUniverseManaged : public [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity)


description: Returns the imported file path and name

code: const [FString](API\Runtime\Core\Containers\FString) & GetFilePathAndName() const


description: Returns the source data the asset was generated from

code: const TArray64< uint8 > & GetRawSourceData() const


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Creates new asset GDTF Asset Import Data from the File. Returns the GDTF Asset Import Data or nullptr if not a valid GDTF File

code: void SetSourceFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilePathAndName )


className: UDMXGDTFAssetImportData

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UDMXGDTFAssetImportData : public [UAssetImportData](API\Runtime\Engine\EditorFramework\UAssetImportData)


code: template<typename TType> TType * CreateNewObject()


className: UDMXImport

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Abstract) class UDMXImport : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportDMXModes

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportDMXModes : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportAttributeDefinitions

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportAttributeDefinitions : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportFixtureType

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportFixtureType : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMXGDTF|Import Data") [UDMXImportGDTFDMXModes](API\Plugins\DMXRuntime\Library\UDMXImportGDTFDMXModes) * GetDMXModes() const


description: Returns GDTF Asset Import Data for this GDTF

code: [UDMXGDTFAssetImportData](API\Plugins\DMXRuntime\Library\UDMXGDTFAssetImportData) * GetGDTFAssetImportData() const


description: Constructor

code: UDMXImportGDTF()


className: UDMXImportGDTF

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTF : public [UDMXImport](API\Plugins\DMXRuntime\Library\UDMXImport)


code: bool FindFeature ( const [FString](API\Runtime\Core\Containers\FString) & InQuery, [FDMXImportGDTFFeature](API\Plugins\DMXRuntime\Library\FDMXImportGDTFFeature) & OutFeature ) const


code: bool FindAtributeByName ( const [FName](API\Runtime\Core\UObject\FName) & InName, [FDMXImportGDTFAttribute](API\Plugins\DMXRuntime\Library\FDMXImportGDTFAttribute) & OutAttribute ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="DMXGDTF|Import Data") [TArray](API\Runtime\Core\Containers\TArray)< [FDMXImportGDTFChannelFunction](API\Plugins\DMXRuntime\Library\FDMXImportGDTFChannelFunction) > GetDMXChannelFunctions ( const [FDMXImportGDTFDMXMode](API\Plugins\DMXRuntime\Library\FDMXImportGDTFDMXMode) & InMode )


className: UDMXImportGDTFAttributeDefinitions

ActivationGroups

type: TArray<FDMXImp...


className: UDMXImportGDTFDMXModes

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTFDMXModes : public [UDMXImportDMXModes](API\Plugins\DMXRuntime\Library\UDMXImportDMXModes)


className: UDMXImportGDTFFixtureType

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTFFixtureType : public [UDMXImportFixtureType](API\Plugins\DMXRuntime\Library\UDMXImportFixtureType)

Name

type: FName


className: UDMXImportGDTFGeometries

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTFGeometries : public [UDMXImportGeometries](API\Plugins\DMXRuntime\Library\UDMXImportGeometries)


className: UDMXImportGDTFModels

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTFModels : public [UDMXImportModels](API\Plugins\DMXRuntime\Library\UDMXImportModels)


code: bool FindEmitterByName ( const [FName](API\Runtime\Core\UObject\FName) & InName, [FDMXImportGDTFEmitter](API\Plugins\DMXRuntime\Library\FDMXImportGDTFEmitter) & OutEmitter ) const


className: UDMXImportGDTFPhysicalDescriptions

ColorSpace

type: FDMXImportGDTFC...

DMXProfiles

type: FDMXImportGDTFD...


className: UDMXImportGDTFProtocols

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTFProtocols : public [UDMXImportProtocols](API\Plugins\DMXRuntime\Library\UDMXImportProtocols)


code: bool FindWeelByName ( const [FName](API\Runtime\Core\UObject\FName) & InName, [FDMXImportGDTFWheel](API\Plugins\DMXRuntime\Library\FDMXImportGDTFWheel) & OutWheel ) const


className: UDMXImportGDTFWheels

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGDTFWheels : public [UDMXImportWheels](API\Plugins\DMXRuntime\Library\UDMXImportWheels)


className: UDMXImportGeometries

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportGeometries : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportModels

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportModels : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportProtocols

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportProtocols : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportPhysicalDescriptions

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportPhysicalDescriptions : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXImportWheels

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXImportWheels : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Adds an Entity to the library

code: void AddEntity ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * InEntity )


description: Returns an Entity named InSearchName. If none exists, return nullptr This is not very reliable since Entities of different types can have the same name.

code: [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * FindEntity ( const [FString](API\Runtime\Core\Containers\FString) & InSearchName ) const


description: Returns an Entity with the passed in ID. The most reliable method since Entities ID are always unique.

code: [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * FindEntity ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Id )


description:
The finds the index of an existing entity.
The index of the entity or INDEX_NONE if not found or the Entity doesn't belong to this Library.

code: int32 FindEntityIndex ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * InEntity ) const


description: Calls Predicate on all Entities of the template type. This is the version without break.

code: template<typename EntityType> void ForEachEntityOfType ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(EntityType *)> Predicate ) const


description: Calls Predicate on all Entities of the passed in type. This is the version without break. Casting is left to the caller.

code: void ForEachEntityOfType ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > InEntityClass, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) *)> Predicate ) const


description: Calls Predicate on all Entities of the template type Return false from the predicate to break the iteration loop or true to keep iterating.

code: template<typename EntityType> void ForEachEntityOfTypeWithBreak ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(EntityType *)> Predicate ) const


description: Calls Predicate on all Entities of the passed in type. Return false from the predicate to break the iteration loop or true to keep iterating. Casting is left to the caller.

code: void ForEachEntityOfTypeWithBreak ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > InEntityClass, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) *)> Predicate ) const


description: Returns all ports as a set, slower than GetInputPorts and GetOutputPorts.

code: [TSet](API\Runtime\Core\Containers\TSet)< [FDMXPortSharedRef](API\Plugins\DMXProtocol\FDMXPortSharedRef) > GenerateAllPortsSet() const


description: Returns all local Universe IDs in Ports

code: [TSet](API\Runtime\Core\Containers\TSet)< int32 > GetAllLocalUniversesIDsInPorts() const


description: Returns all Entities in this DMX Library

code: const [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * > & GetEntities() const


description: Get an array with entities from the specifiedUClass, but not typecast.

code: [TArray](API\Runtime\Core\Containers\TArray)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * > GetEntitiesOfType ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > InEntityClass ) const


description: Get an array of Entities from the specified template type, already cast.

code: template<typename EntityType> [TArray](API\Runtime\Core\Containers\TArray)< EntityType * > GetEntitiesTypeCast() const


description: Returns the input ports

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) > & GetInputPorts() const


description: Returns the Entity that was last added to the Library

code: [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > GetLastAddedEntity() const


description: Returns the General Scene Description of the Library. May not always represent the state of the library. Use WriteGeneralSceneDescription to update it to get an exact version.


description: Returns a delegate that is broadcast when entities were added to the library


description: Returns a delegate that is broadcast when entities were removed from the library


description: Deprecated* Deprecated in favor of the more expressiveUDMXLibrary::GetOnEntitiesAdded()andUDMXLibrary::GetOnEntitiesRemoved()that also forwards the added resp. removed entities


description: Deprecated* Deprecated in favor of new UDMXEntityFixtureType::CreateFixtureType and UDMXEntityFixturePatch::CreateFixturePatch that support creating patches in blueprints.

code: [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * GetOrCreateEntityObject ( const [FString](API\Runtime\Core\Containers\FString) & InName, [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) > DMXEntityClass )


description: Returns the output ports

code: const [TSet](API\Runtime\Core\Containers\TSet)< [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) > & GetOutputPorts() const


className: OnEntitiesAddedDelegate

description: Delegate broadcast when Entities were added


className: OnEntitiesRemovedDelegate

description: Delegate broadcast when Entities were removed


code: virtual void PostDuplicate ( [EDuplicateMode::Type](API\Runtime\CoreUObject\UObject\EDuplicateMode__Type) DuplicateMode )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Registers an Entity with this Library

code: void RegisterEntity ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * Entity )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Empties this DMX Library array of Entities

code: void RemoveAllEntities()


description: Removes an Entity from this DMX Library searching it by name.

code: void RemoveEntity ( const [FString](API\Runtime\Core\Containers\FString) & EntityName )


description: Removes an Entity from this DMX Library.

code: void RemoveEntity ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * InEntity )


description: Move an Entity to a specific index in the Entities Array.

code: void SetEntityIndex ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * InEntity, const int32 NewIndex )


description: Sets the MVR General Scene Description of the Library. Note, this will not add any patches that occur in the new General Scene Description. Note, this will remove any patches that do not occur in the new General Scene Description.

code: void SetMVRGeneralSceneDescription ( [UDMXMVRGeneralSceneDescription](API\Plugins\DMXRuntime\MVR\UDMXMVRGeneralSceneDescription) * NewGeneralSceneDescription )


description: Unregisters an Entity from this Library

code: void UnregisterEntity ( [UDMXEntity](API\Plugins\DMXRuntime\Library\UDMXEntity) * Entity )


description: Updates the General Scene Description to reflect the Library


description: Updates the ports from what's set in the Input and Output Port References arrays

code: void UpdatePorts()


description: Upgrades libraries that use controllers (before 4.27) to use ports instead (from 4.27 on). Creates corresponding ports if they do not exist yet.

code: void UpgradeFromControllersToPorts()


description: Constructor

code: UDMXLibrary()


className: UDMXObjectBase

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UDMXObjectBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDMXLibrary

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, Config=DMXEditor, AutoExpandCategories=DMX) class UDMXLibrary : public [UDMXObjectBase](API\Plugins\DMXRuntime\Library\UDMXObjectBase)

PortReferences

type: FDMXLibraryPort...

description: Ports of the Library


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent, Category="DMX") void Modulate ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch, const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), float > & InNormalizedAttributeValues, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), float > & OutNormalizedAttributeValues )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent, Category="DMX") void ModulateMatrix ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch, const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) > & InNormalizedMatrixAttributeValues, [TArray](API\Runtime\Core\Containers\TArray)< [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) > & OutNormalizedMatrixAttributeValues )


code: virtual void ModulateMatrix_Implementation ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch, const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) > & InNormalizedMatrixAttributeValues, [TArray](API\Runtime\Core\Containers\TArray)< [FDMXNormalizedAttributeValueMap](API\Plugins\DMXRuntime\FDMXNormalizedAttributeValueMap) > & OutNormalizedMatrixAttributeValues )


code: virtual void Modulate_Implementation ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch, const [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), float > & InNormalizedAttributeValues, [TMap](API\Runtime\Core\Containers\TMap)< [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName), float > & OutNormalizedAttributeValues )


className: UDMXModulator

description: Base class for custom modulators. Override Modulate and ModulateMatrix functions in the blueprints to implement functionality. Input maps hold all attribute values of the patch. Output Maps can be freely defined, but Attributes not present in the patch will be ignored.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, EditInlineNew, Abstract) class UDMXModulator : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Returns an array of actors that are currently spawned in the scene for specified GDTF

code: [TArray](API\Runtime\Core\Containers\TArray)< [AActor](API\Runtime\Engine\GameFramework\AActor) * > GetActorsSpawnedForGDTF ( const [UDMXImportGDTF](API\Plugins\DMXRuntime\Library\UDMXImportGDTF) * GDTF ) const


description: Returns the DMX Library of this MVR Scene Actor

code: [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * GetDMXLibrary() const


description: Property name getters.


description: Returns the MVR UUID To Related Actor Map

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TSoftObjectPtr](API\Runtime\CoreUObject\UObject\TSoftObjectPtr)< [AActor](API\Runtime\Engine\GameFramework\AActor) > > & GetRelatedActors() const


code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: virtual void PostLoad()


description: Called after all the components in the Components array are registered, called both in editor and during gameplay. bHasRegisteredAllComponents must be set true prior to calling this function.


description: This is called when a property is about to be modified externally

code: virtual void PreEditChange ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )


description: Refreshes the scene from the DMX Library

code: void RefreshFromDMXLibrary()


description: Sets the dmx library for this MVR actor. Should only be called once, further calls will have no effect and hit an ensure condition

code: void SetDMXLibrary ( [UDMXLibrary](API\Plugins\DMXRuntime\Library\UDMXLibrary) * NewDMXLibrary )


description: Constructor

code: ADMXMVRSceneActor()


description: Destructor

code: ~ADMXMVRSceneActor()


className: ADMXMVRSceneActor

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintable) class ADMXMVRSceneActor : public [AActor](API\Runtime\Engine\GameFramework\AActor)

bRespawnDeletedActorsOnRefresh

description: If checked, respawns Fixture Actors deleted from the MVR Scene

bUpdateTransformsOnRefresh

description: If checked, updates transforms from the DMX Library


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description: Returns the Actor that can represent the patch best

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * FindMostAppropriateActorClassForPatch ( const [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) *const Patch ) const


description: Overload this method to report a name for your referencer

code: virtual [FString](API\Runtime\Core\Containers\FString) GetReferencerName() const


className: FDMXMVRFixtureActorLibrary

code: class FDMXMVRFixtureActorLibrary : public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject), public [TSharedFromThis< FDMXMVRFixtureActorLibrary >](API\Runtime\Core\Templates\TSharedFromThis)


description: Constructor

code: FDMXMVRFixtureActorLibrary()


className: FDMXMVRSceneGDTFToActorClassPair

ActorClass

type: TSoftClassPtr< ...

description: The Actor Class that should be or was spawned

GDTF

type: TSoftObjectPtr<...

description: The GDTF of the Actor (may not correlate with its Patch after the Patch changed)


code: static const [FString](API\Runtime\Core\Containers\FString) GetMajorVersionAsString()


code: static const [FString](API\Runtime\Core\Containers\FString) GetMinorVersionAsString()


description: Returns true if the provided version is the latest version

code: static bool IsLatest ( int32 InMajorVersion, int32 InMinorVersion )


className: MajorVersion

code: static const int32 MajorVersion = 1;


className: MinorVersion

code: static const int32 MinorVersion = 5;


className: FDMXMVRVersion

description: Version of the MVR standard currently being used by the engine

code: struct FDMXMVRVersion


description: Creates a DMX Xml Node as per MVR standard in parent, or logs warnings if no compliant Node can be created.

code: void CreateXmlNodeInParent ( [FXmlNode](API\Runtime\XmlParser\FXmlNode) & ParentNode ) const


code: FDMXMVRFixtureAddresses ( int32 InUniverse, int32 InAddress )


className: FDMXMVRFixtureAddresses

description: The container for DMX Addresses for this fixture.


className: FDMXMVRFixtureGobo

description: The Gobo used for the fixture. The image ressource must apply to the GDTF standard.

Rotation

type: FDMXOptionalFlo...

description: The roation of the Gobo in degree.

Value

type: FString

description: The node value is the Gobo used for the fixture.


className: FDMXMVRFixtureMapping

description: Defines a Mapping

LinkedDef

type: FGuid

description: The unique identifier of the MappingDefinition node that will be the source of the mapping.

OX

type: TOptional< int3...

description: The size in pixels in x direction from top left of the starting point.

OY

description: The size in pixels in y direction from top left of the starting point.

RZ

type: TOptional< floa...

description: The rotation around the middle point of the defined rectangle in degree.

UX

description: The offset in pixels in x direction from top left corner of the source that will be used for the mapped object.

UY

description: The offset in pixels in y direction from top left corner of the source that will be used for the mapped object.


code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: FDMXOptionalMVRFixtureGobo

Value

type: TOptional<FDMX...


className: WithIdenticalViaEquality

code: enum &123; WithIdenticalViaEquality = true &125;


className: WithSerializer

code: enum &123; WithSerializer = true &125;


description: Creates a Parametric Object Node as a Child in the Child List Node

code: template<typename ParametricObjectNodeClass, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsDerivedFrom](API\Runtime\Core\Templates\TIsDerivedFrom)< ParametricObjectNodeClass, [UDMXMVRParametricObjectNodeBase](API\Plugins\DMXRuntime\MVR\Types\UDMXMVRParametricObjectNodeBase) >::Value, bool >::Type> ParametricObjectNodeClass * CreateParametricObject()


code: template<> struct TStructOpsTypeTraits< FDMXOptionalMVRFixtureGobo > : public [TStructOpsTypeTraitsBase2< FDMXOptionalMVRFixtureGobo >](API\Runtime\CoreUObject\UObject\TStructOpsTypeTraitsBase2)


description: Returns true if the Parametric Object Node is contained in this Child List

code: bool Contains ( [UDMXMVRParametricObjectNodeBase](API\Plugins\DMXRuntime\MVR\Types\UDMXMVRParametricObjectNodeBase) * ParametricObjectNode )


description: Returns a pointer ot the Parametric Object Node that corresponds to the UUID, or nullptr if there is no corresponding Parametric Object Node

code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UDMXMVRParametricObjectNodeBase](API\Plugins\DMXRuntime\MVR\Types\UDMXMVRParametricObjectNodeBase) > * FindParametricObjectNodeByUUID ( const [FGuid](API\Runtime\Core\Misc\FGuid) & UUID )


description: Returns the Fixture Nodes contained in this Layer. Note, does not clear the array.

code: void GetFixtureNodes ( [TArray](API\Runtime\Core\Containers\TArray)< [UDMXMVRFixtureNode](API\Plugins\DMXRuntime\MVR\Types\UDMXMVRFixtureNode) * > & OutFixtureNodes ) const


description: Returns the Parametric Object Node Children of this Child List Node

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UDMXMVRParametricObjectNodeBase](API\Plugins\DMXRuntime\MVR\Types\UDMXMVRParametricObjectNodeBase) > > & GetParametricObjectNodes() const


description: Initializes the Child List Node and its Children from a Child List Xml Node. Does not merge, clears previous entries.

code: void InitializeFromChildListXmlNode ( const [FXmlNode](API\Runtime\XmlParser\FXmlNode) & ChildListXmlNode )


description: Removes a Parametric Object Child from the Child List. Returns true if the Parametric Object Node was contained and Removed

code: bool RemoveParametricObject ( [UDMXMVRParametricObjectNodeBase](API\Plugins\DMXRuntime\MVR\Types\UDMXMVRParametricObjectNodeBase) * ParametricObjectNodeToRemove )


description: Creates a DMX Xml Node as per MVR standard in parent, or logs warnings if no compliant Node can be created.

code: virtual void CreateXmlNodeInParent ( [FXmlNode](API\Runtime\XmlParser\FXmlNode) & ParentNode ) const


className: UDMXMVRChildListNode

description: This node defines a generic graphical object.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UDMXMVRChildListNode : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Returns the Address of the MVR Fixture

code: int32 GetStartingChannel() const


description: Returns the Universe ID, in UE form (Index0 is ID 1)

code: int32 GetUniverseID() const


description: Initializes the Fixture Node and its Children from a Fixture Xml Node. Does not merge, clears previous entries.

code: bool InitializeFromFixtureXmlNode ( const [FXmlNode](API\Runtime\XmlParser\FXmlNode) & FixtureXmlNode )


description: Returns true if the data is sufficient to fullfill the mvr standard. If bLogInvalidReason is set to true, logs the reason for the fixture being invalid

code: bool IsValid ( bool bLogInvalidReason ) const


description: Sets the Address of the MVR Fixture

code: void SetStartingChannel ( int32 Address )


description: Sets the Universe ID, in UE form (Index0 is ID 1)

code: void SetUniverseID ( int32 UniverseID )


className: UDMXMVRFixtureNode

description: This node defines a light fixture object.

CastShadow

type: FDMXOptionalBoo...

description: Defines if a Object cast Shadow.

CIEColor

type: FDMXOptionalCol...

description: A color assigned to a fixture. If it is not defined, there is no color for the fixture.

CustomId

type: FDMXOptionalInt...

description: The Custom ID is a value that can be used as a short name of the Fixture Instance.

FixtureID

description: The Fixture Id of the lighting fixture. This is the short name of the fixture.

FixtureTypeId

description: The Fixture Type ID is a value that can be used as a short name of the Fixture Type.

Focus

type: FDMXOptionalGui...

description: A focus point reference that this lighting fixture aims at if this reference exists.

GDTFMode

description: The name of the used DMX mode. This has to match the name of a DMXMode in the GDTF file.

GDTFSpec

description: The name of the file containing the GDTF information for this light fixture.

Gobo

type: FDMXOptionalMVR...

description: The Gobo used for the fixture. The image ressource must apply to the GDTF standard.

Mappings

type: TArray<FDMXMVR...

description: The container for Mappings for this fixture.

Name

description: The name of the object.

Position

description: A position reference that this lighting fixture belongs to if this reference exists.

UnitNumber

description: The unit number of the lighting fixture in a position.