1. Epic GamesDeveloper
  3. UDMXLibrary

UDMXLibrary

DMX Library. Holds Fixture Types and Fixture Patches that can be used to send and receive DMX.

API > API/Plugins > API/Plugins/DMXRuntime

DMX Library.

Holds Fixture Types and Fixture Patches that can be used to send and receive DMX.

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

Syntax

UCLASS (BlueprintType, Blueprintable, Config=DMXEditor, AutoExpandCategories=DMX)  
class UDMXLibrary : public UDMXObjectBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXLibrary()

 Constructor Library/DMXLibrary.h  

Constants

Name Type Remarks Include Path
OnEntitiesAddedDelegate FDMXOnEntityArrayChangedDelegate Delegate broadcast when Entities were added Library/DMXLibrary.h
OnEntitiesRemovedDelegate FDMXOnEntityArrayChangedDelegate Delegate broadcast when Entities were removed Library/DMXLibrary.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Entities TArray< TObjectPtr< UDMXEntity > > All Fixture Types and Fixture Patches in the Library Library/DMXLibrary.h  
GeneralSceneDescription TObjectPtr< UDMXMVRGeneralSceneDescription > The General Scene Description of this Library Library/DMXLibrary.h  
InputPorts TSet< FDMXInputPortSharedRef > The input ports available to the library, according to the InputPortReferences array Library/DMXLibrary.h  
LastAddedEntity TWeakObjectPtr< UDMXEntity > The entity that was added last to the Library Library/DMXLibrary.h  
OutputPorts TSet< FDMXOutputPortSharedRef > The output ports available to the library, according to the OutputPortReferences array Library/DMXLibrary.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEntity ( UDMXEntity* InEntity
)

 Adds an Entity to the library Library/DMXLibrary.h  

UDMXEntity * FindEntity ( const FGuid& Id
)

 Returns an Entity with the passed in ID. Library/DMXLibrary.h  

UDMXEntity * FindEntity ( const FString& InSearchName
) const

 Returns an Entity named InSearchName. Library/DMXLibrary.h  

int32 FindEntityIndex ( UDMXEntity* InEntity
) const

 The finds the index of an existing entity. Library/DMXLibrary.h  

void ForEachEntityOfType ( TFunction< void(EntityType*)> Predicate
) const

 Calls Predicate on all Entities of the template type. This is the version without break. Library/DMXLibrary.h  

void ForEachEntityOfType ( TSubclassOf< UDMXEntity > InEntityClass,
TFunction< void(UDMXEntity*)> Predicate
) const

 Calls Predicate on all Entities of the passed in type. Library/DMXLibrary.h  

void ForEachEntityOfTypeWithBreak ( TFunction< bool(EntityType*)> Predicate
) const

 Calls Predicate on all Entities of the template type Return false from the predicate to break the iteration loop or true to keep iterating. Library/DMXLibrary.h  

void ForEachEntityOfTypeWithBreak ( TSubclassOf< UDMXEntity > InEntityClass,
TFunction< bool(UDMXEntity*)> Predicate
) const

 Calls Predicate on all Entities of the passed in type. Library/DMXLibrary.h  

TSet< FDMXPortSharedRef > GenerateAllPortsSet()

 Returns all ports as a set, slower than GetInputPorts and GetOutputPorts. Library/DMXLibrary.h  

TSet< int32 > GetAllLocalUniversesIDsInPorts()

 Returns all local Universe IDs in Ports Library/DMXLibrary.h  

const TArray< UDMXEntity * > & GetEntities()

 Returns all Entities in this DMX Library Library/DMXLibrary.h  

TArray< UDMXEntity * > GetEntitiesOfType ( TSubclassOf< UDMXEntity > InEntityClass
) const

 Get an array with entities from the specified UClass, but not typecast. Library/DMXLibrary.h  

TArray< EntityType * > GetEntitiesTypeCast()

 Get an array of Entities from the specified template type, already cast. Library/DMXLibrary.h  

const TSet< FDMXInputPortSharedRef > & GetInputPorts()

 Returns the input ports Library/DMXLibrary.h  

TWeakObjectPtr< UDMXEntity > GetLastAddedEntity()

 Returns the Entity that was last added to the Library Library/DMXLibrary.h  
Returns the General Scene Description of the Library. Library/DMXLibrary.h  

FOnEntitiesUpdated_DEPRECATED & GetOnEntitiesUpdated()

   Library/DMXLibrary.h  

UDMXEntity * GetOrCreateEntityObject ( const FString& InName,
TSubclassOf< UDMXEntity > DMXEntityClass
)

   Library/DMXLibrary.h  

const TSet< FDMXOutputPortSharedRef > & GetOutputPorts()

 Returns the output ports Library/DMXLibrary.h  

void RemoveAllEntities()

 Empties this DMX Library array of Entities Library/DMXLibrary.h  

void RemoveEntity ( const FString& EntityName
)

 Removes an Entity from this DMX Library searching it by name. Library/DMXLibrary.h  

void RemoveEntity ( UDMXEntity* InEntity
)

 Removes an Entity from this DMX Library. Library/DMXLibrary.h  

void SetEntityIndex ( UDMXEntity* InEntity,
const int32 NewIndex
)

 Move an Entity to a specific index in the Entities Array. Library/DMXLibrary.h  

void SetMVRGeneralSceneDescription ( UDMXMVRGeneralSceneDescription* NewGeneralSceneDescription
)

 Sets the MVR General Scene Description of the Library. Library/DMXLibrary.h  

UDMXMVRGeneralSceneDescription * UpdateGeneralSceneDescription()

 Updates the General Scene Description to reflect the Library Library/DMXLibrary.h  

void UpdatePorts()

 Updates the ports from what's set in the Input and Output Port References arrays Library/DMXLibrary.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RegisterEntity ( UDMXEntity* Entity
)

 Registers an Entity with this Library Library/DMXLibrary.h  

void UnregisterEntity ( UDMXEntity* Entity
)

 Unregisters an Entity from this Library Library/DMXLibrary.h  
Upgrades libraries that use controllers (before 4.27) to use ports instead (from 4.27 on). Library/DMXLibrary.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   Library/DMXLibrary.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Library/DMXLibrary.h  

virtual void PostInitProperties()

   Library/DMXLibrary.h  

virtual void PostLoad()

   Library/DMXLibrary.h  

virtual void Serialize ( FArchive& Ar
)

   Library/DMXLibrary.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetEntitiesPropertyName()

   Library/DMXLibrary.h  

static FName GetGeneralSceneDescriptionPropertyName()

   Library/DMXLibrary.h  

static FDMXOnEntityArrayChangedDelegate & GetOnEntitiesAdded()

 Returns a delegate that is broadcast when entities were added to the library Library/DMXLibrary.h  

static FDMXOnEntityArrayChangedDelegate & GetOnEntitiesRemoved()

 Returns a delegate that is broadcast when entities were removed from the library Library/DMXLibrary.h  

static FName GetPortReferencesPropertyName()

   Library/DMXLibrary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page