1. Epic GamesDeveloper
  3. UDMXLibrary

UDMXLibrary

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

Unreal Engine C++ API Reference > Plugins > DMXRuntime > Library

Inheritance Hierarchy

References

   
Module DMXRuntime
Header /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/Library/DMXLibrary.h
Include #include "Library/DMXLibrary.h"

Syntax

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

Remarks

DMX Library.

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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly nontransactional FDMXLibraryPortReferences PortReferences Ports of the Library

Constructors

  Type Name Description
Public function   Constructor

Functions

  Type Name Description
Public function void

AddEntity ( UDMXEntity* InEntity
)

 Adds an Entity to the library
Public function UDMXEntity *

FindEntity ( const FGuid& Id
)

 Returns an Entity with the passed in ID.
Public function Const UDMXEntity *

FindEntity ( const FString& InSearchName
)

 Returns an Entity named InSearchName.
Public function Const int32

FindEntityIndex ( UDMXEntity* InEntity
)

 The finds the index of an existing entity.
Public function Const void

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

 Calls Predicate on all Entities of the template type. This is the version without break.
Public function Const void

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

 Calls Predicate on all Entities of the passed in type.
Public function Const void

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

 Calls Predicate on all Entities of the template type Return false from the predicate to break the iteration loop or true to keep iterating.
Public function Const void

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

 Calls Predicate on all Entities of the passed in type.
Public function Const TSet< FDMXPortSharedRef > Returns all ports as a set, slower than GetInputPorts and GetOutputPorts.
Public function Const TSet< int32 > Returns all local Universe IDs in Ports
Public function Const const TArray< UDMXEntity * > & Returns all Entities in this DMX Library
Public function Const TArray< UDMXEntity * > Get an array with entities from the specified UClass, but not typecast.
Public function Static FName  
Public function Const TArray< EntityType * > Get an array of Entities from the specified template type, already cast.
Public function Static FName  
Public function Const const TSet< FDMXInputPortSharedRef > & Returns the input ports
Public function Const TWeakObjectPtr< UDMXEntity > Returns the Entity that was last added to the Library
Public function Const UDMXMVRGeneralSceneDescription * Returns the General Scene Description of the Library.
Public function Static FDMXOnEntityArrayChangedDelegate & Returns a delegate that is broadcast when entities were added to the library
Public function Static FDMXOnEntityArrayChangedDelegate & Returns a delegate that is broadcast when entities were removed from the library
Public function FOnEntitiesUpdated_DEPRECATED &  
Public function UDMXEntity *

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

  
Public function Const const TSet< FDMXOutputPortSharedRef > & Returns the output ports
Public function Static FName  
Protected function void Registers an Entity with this Library
Public function void Empties this DMX Library array of Entities
Public function void

RemoveEntity ( const FString& EntityName
)

 Removes an Entity from this DMX Library searching it by name.
Public function void

RemoveEntity ( UDMXEntity* InEntity
)

 Removes an Entity from this DMX Library.
Public function void

SetEntityIndex ( UDMXEntity* InEntity,
const int32 NewIndex
)

 Move an Entity to a specific index in the Entities Array.
Public function void Sets the MVR General Scene Description of the Library.
Protected function void Unregisters an Entity from this Library
Public function UDMXMVRGeneralSceneDescription * Updates the General Scene Description to reflect the Library
Public function void Updates the ports from what's set in the Input and Output Port References arrays
Protected function void Upgrades libraries that use controllers (before 4.27) to use ports instead (from 4.27 on).

Overridden from UObject

  Type Name Description
Protected function Virtual void  
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
OnEntitiesAddedDelegate Delegate broadcast when Entities were added
OnEntitiesRemovedDelegate Delegate broadcast when Entities were removed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page