Navigation
API > API/Plugins > API/Plugins/DMXEditor
Generic list of Fixture Patches in a DMX library for read only purposes
| Name | SDMXReadOnlyFixturePatchList |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXEditor/Public/Widgets/SDMXReadOnlyFixturePatchList.h |
| Include Path | #include "Widgets/SDMXReadOnlyFixturePatchList.h" |
Syntax
class SDMXReadOnlyFixturePatchList :
public SCompoundWidget ,
public FGCObject
Inheritance Hierarchy
- FGCObject → SDMXReadOnlyFixturePatchList
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SDMXReadOnlyFixturePatchList
- FSlateControlledConstruction → SWidget → SCompoundWidget → SDMXReadOnlyFixturePatchList
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDMXFixturePatchListRowDelegate | TBaseDelegate_OneParam< void, TSharedPtr< FDMXReadOnlyFixturePatchListItem > > | Widgets/SDMXReadOnlyFixturePatchList.h | |
| FDMXFixturePatchListRowRetValDelegate | TBaseDelegate_OneParam< bool, TSharedPtr< FDMXReadOnlyFixturePatchListItem > > | Widgets/SDMXReadOnlyFixturePatchList.h | |
| FDMXFixturePatchListRowSelectionDelegate | TBaseDelegate_TwoParams< void, TSharedPtr< FDMXReadOnlyFixturePatchListItem >, ESelectInfo::Type > | Widgets/SDMXReadOnlyFixturePatchList.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColumnIDToShowStateMap | TMap< FName, bool > | Map for storing the show state of each column by name ID | Widgets/SDMXReadOnlyFixturePatchList.h | |
| ExcludedFixturePatches | TArray< TObjectPtr< UDMXEntityFixturePatch > > | Slate Arguments. | Widgets/SDMXReadOnlyFixturePatchList.h | |
| IsRowEnabledDelegate | FDMXFixturePatchListRowRetValDelegate | Widgets/SDMXReadOnlyFixturePatchList.h | ||
| IsRowVisibleDelegate | FDMXFixturePatchListRowRetValDelegate | Widgets/SDMXReadOnlyFixturePatchList.h | ||
| ListItems | TArray< TSharedPtr< FDMXReadOnlyFixturePatchListItem > > | The list source, an array of read only fixture patch list items | Widgets/SDMXReadOnlyFixturePatchList.h | |
| ListRefreshTimerHandle | FTimerHandle | Timer handle for the Request List Refresh method | Widgets/SDMXReadOnlyFixturePatchList.h | |
| ListRows | TArray< TSharedRef< SDMXReadOnlyFixturePatchListRow > > | Rows of Mode widgets in the List | Widgets/SDMXReadOnlyFixturePatchList.h | |
| ListView | TSharedPtr< SListView< TSharedPtr< FDMXReadOnlyFixturePatchListItem > > > | The actual fixture patch list | Widgets/SDMXReadOnlyFixturePatchList.h | |
| OnRowDragDetectedDelegate | FOnDragDetected | Widgets/SDMXReadOnlyFixturePatchList.h | ||
| SearchBox | TSharedPtr< SSearchBox > | The Header Row of the List | Widgets/SDMXReadOnlyFixturePatchList.h | |
| SortedByColumnID | FName | By which column ID the List is sorted | Widgets/SDMXReadOnlyFixturePatchList.h | |
| SortMode | EColumnSortMode::Type | The current Sort Mode | Widgets/SDMXReadOnlyFixturePatchList.h | |
| WeakDMXLibrary | TWeakObjectPtr< UDMXLibrary > | Current displayed DMX Library | Widgets/SDMXReadOnlyFixturePatchList.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs this widget | Widgets/SDMXReadOnlyFixturePatchList.h | |
UDMXLibrary * GetDMXLibrary() |
Gets the current displayed DMX library | Widgets/SDMXReadOnlyFixturePatchList.h | |
TArray< UDMXEntityFixturePatch * > GetFixturePatchesInDMXLibrary() |
Gets all fixture patches in the DMX Library | Widgets/SDMXReadOnlyFixturePatchList.h | |
| Gets all fixture patches displayed in the list. | Widgets/SDMXReadOnlyFixturePatchList.h | ||
TArray< TSharedPtr< FDMXReadOnlyFixturePatchListItem > > GetListItems() |
Returns the items displayed int his list | Widgets/SDMXReadOnlyFixturePatchList.h | |
TArray< UDMXEntityFixturePatch * > GetSelectedFixturePatches() |
Gets current selected fixture patches in the list | Widgets/SDMXReadOnlyFixturePatchList.h | |
TArray< TSharedPtr< FDMXReadOnlyFixturePatchListItem > > GetSelectedItems() |
Returns the selected items | Widgets/SDMXReadOnlyFixturePatchList.h | |
FDMXReadOnlyFixturePatchListDescriptor MakeListDescriptor() |
Gets the a descriptor for the current parameters for this list | Widgets/SDMXReadOnlyFixturePatchList.h | |
void RequestRefresh() |
Updates the List on the next tick | Widgets/SDMXReadOnlyFixturePatchList.h | |
void SelectItems
(
const TArray< TSharedPtr< FDMXReadOnlyFixturePatchListItem > >& ItemsToSelect, |
Selects specified items in the list | Widgets/SDMXReadOnlyFixturePatchList.h | |
void SetDMXLibrary
(
UDMXLibrary* InDMXLibrary |
Sets the displayed DMX library. | Widgets/SDMXReadOnlyFixturePatchList.h | |
void SetExcludedFixturePatches
(
const TArray< UDMXEntityFixturePatch* >& NewExcludedFixturePatches |
Sets the excluded fixture patches. | Widgets/SDMXReadOnlyFixturePatchList.h | |
void SetItemSelection
(
TSharedPtr< FDMXReadOnlyFixturePatchListItem > SelectedItem, |
Sets the selection state of the given item, if valid | Widgets/SDMXReadOnlyFixturePatchList.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ForceRefresh() |
Refreshes the Fixture Patch List | Widgets/SDMXReadOnlyFixturePatchList.h | |
virtual TSharedRef< SHeaderRow > GenerateHeaderRow() |
Called to generate the header row of the list | Widgets/SDMXReadOnlyFixturePatchList.h | |
virtual FName GetHeaderRowFilterMenuName () |
Returns the menu name of the header row filter menu. | Widgets/SDMXReadOnlyFixturePatchList.h | |
virtual TSharedRef< ITableRow > OnGenerateRow
(
TSharedPtr< FDMXReadOnlyFixturePatchListItem > InItem, |
Called to generate a row in the list | Widgets/SDMXReadOnlyFixturePatchList.h | |
virtual void ToggleColumnShowState
(
const FName ColumnID |
Toggles show state of the column with the given ID | Widgets/SDMXReadOnlyFixturePatchList.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Widgets/SDMXReadOnlyFixturePatchList.h | ||
virtual FString GetReferencerName() |
Widgets/SDMXReadOnlyFixturePatchList.h |