FDMXFixtureModeItem

Item to identify and access a DMXFixtureMode.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

DMXEditor

Header

/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXEditor/Public/DMXFixtureTypeSharedData.h

Include

#include "DMXFixtureTypeSharedData.h"

Syntax

class FDMXFixtureModeItem : public IDMXNamedType

Remarks

Item to identify and access a DMXFixtureMode.

Note, this will no longer point to the live property when:

  • The fixture types being edited change

  • The details view is destroyed (be it via refresh or otherwise)

  • The arrays that contain the property change num elements.

Variables

Name Description

Protected variable

TWeakPtr< FDMXF...

 

SharedDataPtr

Shared data that owns this

Constructors

Name Description

Public function

FDMXFixtureModeItem

(
    const TWeakPtr< FDMXFixtureTypeShar...,
    const TSharedPtr< IPropertyHandle >...
)

Constructor

Destructors

Name Description

Public function Virtual

~FDMXFixtureModeItem()

Destructor

Functions

Name Description

Public function Const

bool

 

EqualsMode

(
    const TSharedPtr< FDMXFixtureModeIt...
)

Returns true if the mode names equal

Public function Const

FString

 

GetModeName()

Gets the name of the mode

Public function Const

void

 

GetOuterFixtureTypes

(
    TArray< TWeakObjectPtr< UDMXEntityF...
)

Returns the outer fixture types of the mode name handle

Public function Const

bool

 

IsModeBeingEdited()

True if the mode is being edited by shared data

Public function Const

bool

 

IsModeSelected()

True if the mode is selected by shared data

Public function

void

 

SelectMode

(
    bool bSelected
)

Selects the mode in shared data

Public function

void

 

SetModeName

(
    const FString& InDesiredName,
    FString& OutNewName
)

Returns the current mode name

Overridden from IDMXNamedType

Name Description

Protected function Virtual Const

void

 

GetName

(
    FString& OutUniqueName
)

Returns the name

Protected function Virtual Const

bool

 

IsNameUnique

(
    const FString& TestedName
)

Returns if the name is unique

Protected function Virtual

void

 

SetName

(
    const FString& InDesiredName,
    FString& OutUniqueName
)

Sets the name, matching desired name as closely as possible
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss