UDMXLibrary

Choose your operating system:

Windows

macOS

Linux

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, AutoExpandCategories=DMX)
class UDMXLibrary : public UDMXObjectBase

Variables

Name Description

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly nontransactional

FDMXLibraryPort...

 

PortReferences

Input ports of the Library

Functions

Name Description

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

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

Public function Const

void

 

ForEachEntityOfType

(
    TSubclassOf< UDMXEntity > InEntityC...,
    TFunction< void*)> ...
)

Calls Predicate on all Entities of the passed in type.

Public function Const

void

 

ForEachEntityOfTypeWithBreak

(
    TFunction< bool> ...
)

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 > InEntityC...,
    TFunction< bool*)> ...
)

Calls Predicate on all Entities of the passed in type.

Public function Const

TSet< FDMXPo...

 

GenerateAllPortsSet()

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

Public function Const

TSet< int32 ...

 

GetAllLocalUniversesIDsInPorts()

Returns all local Universe IDs in Ports

Public function Const

const TArray...

 

GetEntities()

Returns all Entities in this DMX Library

Public function Const

TArray< UDMX...

 

GetEntitiesOfType

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Get an array with entities from the specified UClass, but not typecast.

Public function Static

FName

 

GetEntitiesPropertyName()

Returns the name of the Entities property.

Public function Const

TArray< Enti...

 

GetEntitiesTypeCast()

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

Public function Const

const TSet< ...

 

GetInputPorts()

Returns the input ports

Public function Const

TWeakObjectP...

 

GetLastAddedEntity()

Returns the Entity that was last added to the Library

Public function Static

FDMXOnEntity...

 

GetOnEntitiesAdded()

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

Public function Static

FDMXOnEntity...

 

GetOnEntitiesRemoved()

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

Public function Const

const TSet< ...

 

GetOutputPorts()

Returns the output ports

Public function Static

FName

 

GetPortReferencesPropertyName()

Returns the name of the Ports property.

Protected function

void

 

RegisterEntity

(
    UDMXEntity* Entity
)

Registers an Entity with this Library

Public function

void

 

SetEntityIndex

(
    UDMXEntity* InEntity,
    const int32 NewIndex
)

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

Protected function

void

 

UnregisterEntity

(
    UDMXEntity* Entity
)

Unregisters an Entity from this Library

Public function

void

 

UpdatePorts()

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

Protected function

void

 

UpgradeFromControllersToPorts()

Upgrades libraries that use controllers (before 4.27) to use ports instead (from 4.27 on).

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostDuplicate

(
    EDuplicateMode::Type DuplicateMode
)

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Protected function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Constants

Name

Description

OnEntitiesAddedDelegate

Delegate broadcast when Entities were added

OnEntitiesRemovedDelegate

Delegate broadcast when Entities were removed

Deprecated Functions

Name Description

Public function

void

 

AddEntity

(
    UDMXEntity* InEntity
)

Entites no longer can be added or removed explicitly.

Public function

FOnEntitiesU...

 

GetOnEntitiesUpdated()

Deprecated in favor of the more expressive UDMXLibrary::GetOnEntitiesAdded() and UDMXLibrary::GetOnEntitiesRemoved() that also forwards the added resp. removed entities

Public function

UDMXEntity &...

 

GetOrCreateEntityObject

(
    const FString& InName,
    TSubclassOf< UDMXEntity > DMXEntity...
)

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

Public function

void

 

RemoveAllEntities()

Entites no longer can be added or removed explicitly.

Public function

void

 

RemoveEntity

(
    const FString& EntityName
)

Entites no longer can be added or removed explicitly.

Public function

void

 

RemoveEntity

(
    UDMXEntity* InEntity
)

Entites no longer can be added or removed explicitly.