1. Epic GamesDeveloper
  3. FDMXEditorUtils

FDMXEditorUtils

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

API > API/Plugins > API/Plugins/DMXEditor

References

   
Module DMXEditor
Header /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXEditor/Public/DMXEditorUtils.h
Include #include "DMXEditorUtils.h"

Syntax

class FDMXEditorUtils

Remarks

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

Constructors

  Type Name Description
Public function   Can't instantiate this class

Functions

  Type Name Description
Public function Static bool 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 ( UDMXLibrary* ParentLibrary
)

 Determines whether the current contents of the clipboard contain paste-able DMX Entity information
Public function Static void Zeros memory in all active DMX buffers of all protocols
Public function Static void Clears cached data fixture patches received
Public function Static void

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

 Copies Entities to the operating system's clipboard.
Public function Static TArray< UDMXEntity * > Creates the copied DMX Entities from the clipboard without attempting to paste/apply them in any way
Public function Static bool

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

 Locate universe conflicts between libraries
Public function 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.
Public function Static FText

GetEntityTypeNameText ( TSubclassOf< UDMXEntity > EntityClass,
bool bPlural
)

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

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

 Gets the package or creates a new one if it doesn't exist
Public function Static bool

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

 Checks if the Entity is being referenced by other objects.
Public function 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'
Public function Static TArray< FString >

ParseAttributeNames ( const FString& InputString
)

 Parses Attribute Names from a String, format can be 'Dimmer', 'Dimmer, Pan, Tilt''.
Public function Static bool

ParseFixtureID ( const FString& InputString,
int32& OutFixtureID
)

 Parses a Fixture ID from a String, exected format is an integral value, e.g. '1'
Public function Static TArray< int32 >

ParseFixtureIDs ( const FString& InputString
)

 Parses Fixture IDs from a String.
Public function Static TArray< int32 >

ParseUniverses ( const FString& InputString
)

 Parses Universes from a String, format can be '1.', 'Uni 1', 'Universe 1', 'Uni 1, 3-4'.
Public function Static void

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

 Renames an Entity
Public function Static void Creates a unique color for all patches that use the default color FLinearColor(1.0f, 0.0f, 1.0f)
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.

Typedefs

Name Description
FUnassignedPatchesArray  

Deprecated Functions

  Type Name Description
Public function Static bool

AddEntity ( UDMXLibrary* InLibrary,
const FString& NewEntityName,
TSubclassOf< UDMXEntity > NewEntityClass,
UDMXEntity** OutNewEntity
)

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

AutoAssignedAddresses ( UDMXEntityFixtureType* ChangedParentFixtureType
)

 The bAutoAssign property got deprecated in UDMXEntityFixturePatch, so there's no meaning to ever auto assign on Fixture Type changes. So this function is removed without replacement.
Public function Static FUnassignedPatchesArray

AutoAssignedAddresses ( const TArray< UDMXEntityFixturePatch* >& ChangedFixturePatches,
int32 MinimumAddress,
bool bCanChangePatchUniverses
)

 Simplyifing AutoAssign, just use FDMXEditorUtils::AutoAssignedChannels instead.
Public function Static void

AutoAssignedChannels ( bool bAllowDecrementUniverse,
bool bAllowDecrementChannels,
TArray< UDMXEntityFixturePatch* > FixturePatches
)

 AutoAssignedChannels is deprecated without replacement. Please create your own auto assign implementation. See FDMXFixturePatchAutoAssignUtility for an example.
Public function Static FString

FindUniqueEntityName ( const UDMXLibrary* InLibrary,
TSubclassOf< UDMXEntity > InEntityClass,
const FString& InBaseName
)

 Deprecated in favor of UDMXRuntimeUtils::FindUniqueEntityName.
Public function Static FString

GenerateUniqueNameFromExisting ( const TSet< FString >& InExistingNames,
const FString& InBaseName
)

 Moved to DMXRuntimeUtils to allow using it at runtime.
Public function Static void

GetEntitiesFromClipboard ( TArray< UDMXEntity* >& OutNewObjects
)

 Replaced with FDMXEditorUtils::CreateEntitiesFromClipboard. NOTE: GetEntitiesFromClipboard no longer returns any entities, as entities can only be created within a DMXLibrary.
Public function Static void

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

 Replaced with UDMXEntityFixtureType::RemoveFixtureTypeFromLibrary and UDMXEntityFixturePatch::RemoveFixturePatchFromLibrary to support blueprint and runtime changes.
Public function Static void Deprecated to reduce redundant code. Instead use UDMXRuntimeUtils::FindUniqueEntityName.
Public function Static bool

TryAutoAssignToUniverses ( UDMXEntityFixturePatch* Patch,
const TSet< int32 >& AllowedUniverses
)

 Simplyifing AutoAssign, just use FDMXEditorUtils::AutoAssignedAddresses instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page