1. Epic GamesDeveloper
  3. FDMXEditorUtils

FDMXEditorUtils

Generic Editor Utilities. for Fixture Type, refer to DMXFixtureTypeSharedData instead.

API > API/Plugins > API/Plugins/DMXEditor

Generic Editor Utilities. for Fixture Type, refer to DMXFixtureTypeSharedData instead.

   
Name FDMXEditorUtils
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXEditor/Public/DMXEditorUtils.h
Include Path #include "DMXEditorUtils.h"

Syntax

class FDMXEditorUtils

Constructors

Name Remarks Include Path Unreal Specifiers

FDMXEditorUtils()

 Can't instantiate this class DMXEditorUtils.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers
Compares the property values of two Fixture Types, including properties in arrays, and returns true if they are almost all the same. DMXEditorUtils.h  

static bool CanPasteEntities ( UDMXLibrary* ParentLibrary
)

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

static void ClearAllDMXPortBuffers()

 Zeros memory in all active DMX buffers of all protocols DMXEditorUtils.h  

static void ClearFixturePatchCachedData()

 Clears cached data fixture patches received DMXEditorUtils.h  

static void CopyEntities ( const TArray< UDMXEntity* >&& EntitiesToCopy
)

 Copies Entities to the operating system's clipboard. DMXEditorUtils.h  

static TArray< UDMXEntity * > CreateEntitiesFromClipboard ( UDMXLibrary* ParentLibrary
)

 Creates the copied DMX Entities from the clipboard without attempting to paste/apply them in any way DMXEditorUtils.h  

static bool DoesLibraryHaveUniverseConflicts ( UDMXLibrary* Library,
FText& OutInputPortConflictMessage,
FText& OutOutputPortConflictMessage
)

 Locate universe conflicts between libraries DMXEditorUtils.h  

static void GetAllAssetsOfClass ( UClass* Class,
TArray< UObject* >& OutObjects
)

 Retrieve all assets for a given class via the asset registry. Will load into memory if needed. DMXEditorUtils.h  

static FText GetEntityTypeNameText ( TSubclassOf< UDMXEntity > EntityClass,
bool bPlural
)

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

static UPackage * GetOrCreatePackage ( TWeakObjectPtr< UObject > Parent,
const FString& DesiredName
)

 Gets the package or creates a new one if it doesn't exist DMXEditorUtils.h  

static bool IsEntityUsed ( const UDMXLibrary* InLibrary,
const UDMXEntity* InEntity
)

 Checks if the Entity is being referenced by other objects. DMXEditorUtils.h  

static bool ParseAddress ( const FString& InputString,
int32& OutAddress
)

 Parses an Address from a String, exected format is in the form of 'universe.address', e.g. '1.1' DMXEditorUtils.h  

static TArray< FString > ParseAttributeNames ( const FString& InputString
)

 Parses Attribute Names from a String, format can be 'Dimmer', 'Dimmer, Pan, Tilt''. DMXEditorUtils.h  

static bool ParseFixtureID ( const FString& InputString,
int32& OutFixtureID
)

 Parses a Fixture ID from a String, exected format is an integral value, e.g. '1' DMXEditorUtils.h  

static TArray< int32 > ParseFixtureIDs ( const FString& InputString
)

 Parses Fixture IDs from a String. DMXEditorUtils.h  

static TArray< int32 > ParseUniverses ( const FString& InputString
)

 Parses Universes from a String, format can be '1.', 'Uni 1', 'Universe 1', 'Uni 1, 3-4'. DMXEditorUtils.h  

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

 Renames an Entity DMXEditorUtils.h  

static void UpdatePatchColors ( UDMXLibrary* Library
)

 Creates a unique color for all patches that use the default color FLinearColor(1.0f, 0.0f, 1.0f) DMXEditorUtils.h  

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. DMXEditorUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page