1. Epic GamesDeveloper
  3. UOperatorStackEditorStackCustomization

UOperatorStackEditorStackCustomization

Abstract class to represent an operator stack containing items, an item is represented by a header-body-footer, An item can contain multiple items (recursive), Children class extending this class are automatically registered

API > API/Plugins > API/Plugins/OperatorStackEditor

Abstract class to represent an operator stack containing items, an item is represented by a header-body-footer, An item can contain multiple items (recursive), Children class extending this class are automatically registered

   
Name UOperatorStackEditorStackCustomization
Type class
Header File /Engine/Plugins/VirtualProduction/OperatorStack/Source/OperatorStack/Public/Customizations/OperatorStackEditorStackCustomization.h
Include Path #include "Customizations/OperatorStackEditorStackCustomization.h"

Syntax

UCLASS (MinimalAPI, Abstract, Transient)  
class UOperatorStackEditorStackCustomization : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Customizations/OperatorStackEditorStackCustomization.h  

UOperatorStackEditorStackCustomization ( const FName& InIdentifier,
const FText& InLabel,
int32 InPriority
)

   Customizations/OperatorStackEditorStackCustomization.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Identifier FName Unique identifier of this customization Customizations/OperatorStackEditorStackCustomization.h  
Label FText Label displayed at the top to switch between customizations Customizations/OperatorStackEditorStackCustomization.h  
Priority int32 Priority for this stack in toolbar, highest numbers will result in placement before lowest number Customizations/OperatorStackEditorStackCustomization.h  
SupportedDefinitions TSet< TObjectPtr< const UStruct > > Supported definition for this customization stack Customizations/OperatorStackEditorStackCustomization.h  
SupportedFieldClasses TSet< const FFieldClass * > Supported definition for this customization stack Customizations/OperatorStackEditorStackCustomization.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CustomizeItemBody ( const FOperatorStackEditorItemPtr& InItem,
const FOperatorStackEditorTree& InItemTree,
FOperatorStackEditorBodyBuilder& InBodyBuilder
)

 Customize the body for a supported item Customizations/OperatorStackEditorStackCustomization.h  

virtual void CustomizeItemFooter ( const FOperatorStackEditorItemPtr& InItem,
const FOperatorStackEditorTree& InItemTree,
FOperatorStackEditorFooterBuilder& InFooterBuilder
)

 Customize the body for a supported item Customizations/OperatorStackEditorStackCustomization.h  

virtual void CustomizeItemHeader ( const FOperatorStackEditorItemPtr& InItem,
const FOperatorStackEditorTree& InItemTree,
FOperatorStackEditorHeaderBuilder& InHeaderBuilder
)

 Customize the header for a supported item Customizations/OperatorStackEditorStackCustomization.h  

virtual void CustomizeStackBody ( const FOperatorStackEditorTree& InItemTree,
FOperatorStackEditorBodyBuilder& InStackBodyBuilder
)

 Customize the full stack body Customizations/OperatorStackEditorStackCustomization.h  

virtual void CustomizeStackHeader ( const FOperatorStackEditorTree& InItemTree,
FOperatorStackEditorHeaderBuilder& InStackHeaderBuilder
)

 Customize the header for a context Customizations/OperatorStackEditorStackCustomization.h  

void FocusCustomization ( const UObject* InContext
) const

 Switches section of operator stack and select this customization for this context Customizations/OperatorStackEditorStackCustomization.h  

virtual bool GetChildrenItem ( const FOperatorStackEditorItemPtr& InItem,
TArray< FOperatorStackEditorItemPtr >& OutChildrenItems
) const

 Retrieves the supported children items based out of a parent item, Children classes must implement this Customizations/OperatorStackEditorStackCustomization.h  

virtual const FSlateBrush * GetIcon()

 Get the displayed icon of this customization Customizations/OperatorStackEditorStackCustomization.h  

const FName & GetIdentifier()

 Get identifier of this customization Customizations/OperatorStackEditorStackCustomization.h  

const FText & GetLabel()

 Get display label of this customization Customizations/OperatorStackEditorStackCustomization.h  

int32 GetPriority()

 Get stack priority in the toolbar Customizations/OperatorStackEditorStackCustomization.h  

virtual bool GetRootItem ( const FOperatorStackEditorContext& InContext,
FOperatorStackEditorItemPtr& OutRootItem
) const

 Retrieves root supported item out of the provided context, Children classes must implement this Customizations/OperatorStackEditorStackCustomization.h  

bool IsCustomizationSupportedFor ( const FOperatorStackEditorItemPtr& InItem
) const

 Checks if this customization is supported for this item Customizations/OperatorStackEditorStackCustomization.h  

virtual void OnDropItem ( const TArray< FOperatorStackEditorItemPtr >& InDraggedItems,
const FOperatorStackEditorItemPtr& InTargetItem,
EItemDropZone InTargetZone
)

 Handle dropped items onto target zone Customizations/OperatorStackEditorStackCustomization.h  

virtual bool OnIsItemDraggable ( const FOperatorStackEditorItemPtr& InItem
)

 Can an item be dragged Customizations/OperatorStackEditorStackCustomization.h  

virtual bool OnIsItemSelectable ( const FOperatorStackEditorItemPtr& InItem
)

 Can an item be selected Customizations/OperatorStackEditorStackCustomization.h  

virtual TOptional< EItemDropZone > OnItemCanAcceptDrop ( const TArray< FOperatorStackEditorItemPtr >& InDraggedItems,
const FOperatorStackEditorItemPtr& InTargetItem,
EItemDropZone InTargetZone
)

 Get the valid drop zone of draggable items onto a zone item Customizations/OperatorStackEditorStackCustomization.h  

void RefreshActiveSelection ( UObject* InContext,
bool bInForce
) const

 Refresh the selection linked to this context Customizations/OperatorStackEditorStackCustomization.h  

bool RegisterCustomizationFor ( const UStruct* InItemDefinition
)

 Registers items with this definition that can use this customization Customizations/OperatorStackEditorStackCustomization.h  

bool RegisterCustomizationFor ( const FFieldClass* InItemDefinition
)

   Customizations/OperatorStackEditorStackCustomization.h  

virtual bool ShouldFocusCustomization ( const FOperatorStackEditorContext& InContext
) const

 Whether new context should focus on this customization in the widget Customizations/OperatorStackEditorStackCustomization.h  

bool UnregisterCustomizationFor ( const UStruct* InItemDefinition
)

 Unregisters item definition for this customization Customizations/OperatorStackEditorStackCustomization.h  

bool UnregisterCustomizationFor ( const FFieldClass* InItemDefinition
)

   Customizations/OperatorStackEditorStackCustomization.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page