1. Epic GamesDeveloper
  3. SDMXReadOnlyFixturePatchList

SDMXReadOnlyFixturePatchList

Generic list of Fixture Patches in a DMX library for read only purposes

API > API/Plugins > API/Plugins/DMXEditor > API/Plugins/DMXEditor/Widgets

Inheritance Hierarchy

References

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

Syntax

class SDMXReadOnlyFixturePatchList : public SCompoundWidget

Remarks

Generic list of Fixture Patches in a DMX library for read only purposes

Variables

  Type Name Description
Protected variable TMap< FName, bool > ColumnIDToShowStateMap Map for storing the show state of each column by name ID
Protected variable TArray< FDMXEntityFixturePatchRef > ExcludedFixturePatches Slate Arguments.
Protected variable TSharedPtr< SHeaderRow > HeaderRow The Header Row of the List
Protected variable FDMXFixturePatchListRowRetValDelegate IsRowEnabledDelegate  
Protected variable FDMXFixturePatchListRowRetValDelegate IsRowVisibleDelegate  
Protected variable TArray< TSharedPtr< FDMXEntityFixturePatchRef > > ListItems Array of current Fixture Patch Ref list items
Protected variable FTimerHandle ListRefreshTimerHandle Timer handle for the Request List Refresh method
Protected variable TArray< TSharedPtr< SDMXReadOnlyFixturePatchListRow > > ListRows Rows of Mode widgets in the List
Protected variable TSharedPtr< SListView< TSharedPtr< FDMXEntityFixturePatchRef > > > ListView The list of Fixture Patch references
Protected variable FOnDragDetected OnRowDragDetectedDelegate  
Protected variable TSharedPtr< SSearchBox > SearchBox The Header Row of the List
Protected variable EDMXReadOnlyFixturePatchListShowMode ShowMode The current Show Mode
Protected variable FName SortedByColumnID By which column ID the List is sorted
Protected variable EColumnSortMode::Type SortMode The current Sort Mode
Protected variable TWeakObjectPtr< UDMXLibrary > WeakDMXLibrary Current displayed DMX Library

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

 Constructs this widget
Protected function TArray< TSharedPtr< FDMXEntityFixturePatchRef > >

FilterListItems ( const FText& SearchText
)

 Filters ListItems array by the given search text
Protected function Virtual TSharedRef< SHeaderRow > Generates the Header Row of the List
Protected function TSharedRef< SWidget > Generates a visibility menu fot the Header Row of the List
Protected function Const EColumnSortMode::Type

GetColumnSortMode ( const FName ColumnID
)

 Returns the column sort mode for the list
Public function Const UDMXLibrary * Gets the current displayed DMX library
Public function Const TArray< TSharedPtr< FDMXEntityFixturePatchRef > > Returns the items displayed int his list
Protected function Virtual Const EVisibility

GetRowVisibility ( const TSharedPtr< FDMXEntityFixturePatchRef > InFixturePatchRef
)

 Called to get wheter a row of the list is visible or not
Public function Const TArray< TSharedPtr< FDMXEntityFixturePatchRef > > Gets current selected Fixture Patches from the list
Public function Const TArray< TSharedPtr< FDMXEntityFixturePatchRef > > Gets all visible Fixture Patches from the list
Protected function Virtual void Initializes the list parameters using the given ListDescriptor
Protected function Const bool

IsColumnShown ( const FName ColumnID
)

 Gets show state of the column with the given ID
Protected function Virtual Const bool

IsRowEnabled ( const TSharedPtr< FDMXEntityFixturePatchRef > InFixturePatchRef
)

 Called to get wheter a row of the list is enabled or not
Protected function Const bool Returns true if the ShowModeToCheck is the one this widget uses
Public function Const FDMXReadOnlyFixturePatchListDescriptor Gets the a descriptor for the current parameters for this list
Protected function void

OnEntityAddedOrRemoved ( UDMXLibrary* InDMXLibrary,
TArray< UDMXEntity* > Entities
)

 Called when entities were added or removed from the DMX Library
Protected function void Called when a Fixture Patch changed
Protected function void Called when a Fixture Type changed
Protected function Virtual TSharedRef< ITableRow > Called when a row in the List gets generated
Protected function void

OnSearchTextChanged ( const FText& SearchText
)

 Called when text from searchbox is changed
Protected function Virtual void Refreshes the Fixture Patch List
Public function void Updates the List on the next tick
Public function void

SelectItems ( const TArray< TSharedPtr< FDMXEntityFixturePatchRef >>& ItemsToSelect,
ESelectInfo::Type SelectInfo
)

 Selects specified items in the list
Public function void

SetDMXLibrary ( UDMXLibrary* InDMXLibrary
)

 Sets the displayed DMX library
Public function void

SetExcludedFixturePatches ( const TArray< FDMXEntityFixturePatchRef >& NewExcludedFixturePatches
)

 Sets the excluded fixture patches
Protected function void Sets the current ShowMode
Protected function void

SortByColumnID ( const EColumnSortPriority::Type SortPriority,
const FName& ColumnId,
const EColumnSortMode::Type InSortMode
)

 Sort the list by ColumnId
Protected function void

ToggleColumnShowState ( const FName ColumnID
)

 Toggles show state of the column with the given ID
Protected function void Updates ListItems array

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
FDMXFixturePatchListRowDelegate  
FDMXFixturePatchListRowRetValDelegate  
FDMXFixturePatchListRowSelectionDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page