FDMXEditorUtils

Windows
MacOS
Linux

References

Module

DMXEditor

Header

/Engine/Plugins/Experimental/DigitalMultiplex/DMXEngine/Source/DMXEditor/Public/DMXEditorUtils.h

Include

#include "DMXEditorUtils.h"

Syntax

class FDMXEditorUtils

Constructors

Name Description

Public function

FDMXEditorUtils()

Can't instantiate this class

Functions

Name Description

Public function Static

bool

 

AddEntity

(
    UDMXLibrary* InLibrary,
    const FString& NewEntityName,
    TSubclassOf< UDMXEntity > NewEntity...,
    UDMXEntity** OutNewEntity
)

Creates a named Entity from the specified type and add it to the DMXLibrary.

Public function Static

bool

 

AreFixtureTypesIdentical

(
    const UDMXEntityFixtureType* A,
    const UDMXEntityFixtureType* B
)

Compares the property values of two Fixture Types, including properties in arrays, and returns true if they are almost all the same.

Public function Static

bool

 

CanPasteEntities()

Determines whether the current contents of the clipboard contain paste-able DMX Entity information

Public function Static

void

 

CopyEntities

(
    const TArray< UDMXEntity* >&&...
)

Copies Entities to the operating system's clipboard.

Public function Static

UDMXEntityFa...

 

CreateFaderTemplate

(
    const UDMXLibrary* InLibrary
)

Creates new fader template.

Public function Static

FString

 

FindUniqueEntityName

(
    const UDMXLibrary* InLibrary,
    TSubclassOf< UDMXEntity > InEntityC...,
    const FString& InBaseName
)

Creates an unique name for an Entity from a specific type, using the type name as base.

Public function Static

FString

 

GenerateUniqueNameFromExisting

(
    const TSet< FString >& InExistingN...,
    const FString& InBaseName
)

Generates a unique name given a base one and a list of existing ones, by appending an index to existing names.

Public function Static

void

 

GetEntitiesFromClipboard

(
    TArray< UDMXEntity* >& OutNew...
)

Gets the copied DMX Entities from the clipboard without attempting to paste/apply them in any way

Public function Static

FText

 

GetEntityTypeNameText

(
    TSubclassOf< UDMXEntity > EntityCla...,
    bool bPlural
)

Returns the Entity class type name (e.g: Fixture Type for UDMXEntityFixtureType) in singular or plural

Public function Static

bool

 

GetNameAndIndexFromString

(
    const FString& InString,
    FString& OutName,
    int32& OutIndex
)

Utility to separate a name from an index at the end.

Public function Static

bool

 

IsEntityUsed

(
    const UDMXLibrary* InLibrary,
    const UDMXEntity* InEntity
)

Checks if the Entity is being referenced by other objects.

Public function Static

void

 

RemoveEntities

(
    UDMXLibrary* InLibrary,
    const TArray< UDMXEntity* >&&...
)

Removes the entities and fixes references to it.

Public function Static

void

 

RenameEntity

(
    UDMXLibrary* InLibrary,
    UDMXEntity* InEntity,
    const FString& NewName
)

Renames an Entity

Public function Static

void

 

SetNewFixtureFunctionsNames

(
    UDMXEntityFixtureType* InFixtu...
)

Set unique names for Fixture Types' Modes, Functions and Sub Functions when they have just been created.

Public function Static

bool

 

ValidateEntityName

(
    const FString& NewEntityName,
    const UDMXLibrary* InLibrary,
    UClass* InEntityClass,
    FText& OutReason
)

Validates an Entity name, also checking for uniqueness among others of the same type.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss