Navigation
API > API/Plugins > API/Plugins/AvalancheOutliner
Base Implementation of IAvaOutlinerItem
| Name | FAvaOutlinerItem |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheOutliner/Public/Item/AvaOutlinerItem.h |
| Include Path | #include "Item/AvaOutlinerItem.h" |
Syntax
class FAvaOutlinerItem : public IAvaOutlinerItem
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAvaOutlinerItem
(
IAvaOutliner& InOutliner |
Item/AvaOutlinerItem.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAvaOutlinerItem() |
Item/AvaOutlinerItem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAvaInherits | TAvaInherits< FAvaOutlinerItem, IAvaOutlinerItem,> | Item/AvaOutlinerItem.h | |
| Super | IAvaOutlinerItem | Item/AvaOutlinerItem.h |
Functions
Public
Overridden from IAvaOutlinerItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FReply AcceptDrop
(
const FDragDropEvent& InDragDropEvent, |
Processes the Drag and Drop Event for this Item | Item/AvaOutlinerItem.h | |
virtual TArray< FAvaOutlinerItemPtr > AddChildren
(
const FAvaOutlinerAddItemParams& InAddItemParams |
Adds the items in the add items struct under this item if such items are supported. | Item/AvaOutlinerItem.h | |
virtual void AddFlags
(
EAvaOutlinerItemFlags Flags |
Item/AvaOutlinerItem.h | ||
virtual TOptional< EItemDropZone > CanAcceptDrop
(
const FDragDropEvent& InDragDropEvent, |
Determines if and where the incoming Drag Drop Event can be processed by this item | Item/AvaOutlinerItem.h | |
virtual bool CanAddChild
(
const FAvaOutlinerItemPtr& InChild |
Determines whether the given Child is supported and can be added under this Item | Item/AvaOutlinerItem.h | |
virtual bool CanAutoExpand() |
Whether the Item is able to expand when AutoExpand functionality is enabled | Item/AvaOutlinerItem.h | |
virtual bool CanBeTopLevel () |
Whether this Item can be at the Top Level just beneath the Root, or it needs to always be under some other Item E.g. | Item/AvaOutlinerItem.h | |
virtual bool CanDelete() |
Whether this Item can be deleted or not | Item/AvaOutlinerItem.h | |
virtual bool CanLock() |
Whether an Item can be Locked in any kind. E.g. Actors can be location-locked | Item/AvaOutlinerItem.h | |
virtual bool CanReceiveParentVisibilityPropagation() |
Whether a change in Parent Visibility should also affect this Item's Visibility | Item/AvaOutlinerItem.h | |
virtual bool CanRename() |
Whether this Item can be renamed or not | Item/AvaOutlinerItem.h | |
virtual bool Delete() |
The implementation to delete the item | Item/AvaOutlinerItem.h | |
virtual void FindChildren
(
TArray< FAvaOutlinerItemPtr >& OutChildren, |
Figures out the Children of this Item. | Item/AvaOutlinerItem.h | |
virtual TSharedRef< SWidget > GenerateLabelWidget
(
const TSharedRef< SAvaOutlinerTreeRow >& InRow |
Function responsible of Generating the Label Widget for this Item (i.e. the column containing the Icon and the Name) | Item/AvaOutlinerItem.h | |
virtual const TArray< FAvaOutlinerItemPtr > & GetChildren() |
Gets the current Child Items of this Item | Item/AvaOutlinerItem.h | |
virtual TArray< FAvaOutlinerItemPtr > & GetChildrenMutable() |
Gets the current Child Items of this Item | Item/AvaOutlinerItem.h | |
virtual TOptional< FAvaOutlinerColorPair > GetColor
(
bool bRecurse |
Returns the Item's Color Name and Color (either inherited if bRecurse is true, or explicit if false) | Item/AvaOutlinerItem.h | |
virtual EAvaOutlinerItemFlags GetFlags() |
Item/AvaOutlinerItem.h | ||
virtual const FSlateBrush * GetIconBrush() |
Item/AvaOutlinerItem.h | ||
virtual FLinearColor GetItemColor() |
Gets the Brush Color to use for the Item in the Outliner (e.g. Components should be grayed out a bit) | Item/AvaOutlinerItem.h | |
virtual FAvaOutlinerItemId GetItemId() |
Gets the Id of this Item | Item/AvaOutlinerItem.h | |
virtual TSharedRef< IAvaOutliner > GetOwnerOutliner() |
Gets the Outliner that owns this Item | Item/AvaOutlinerItem.h | |
virtual FAvaOutlinerItemPtr GetParent () |
Gets the Parent of this Item. | Item/AvaOutlinerItem.h | |
virtual EAvaOutlinerItemViewMode GetSupportedViewModes
(
const FAvaOutlinerView& InOutlinerView |
Gets the View Modes that this Item Supports | Item/AvaOutlinerItem.h | |
virtual bool GetVisibility
(
EAvaOutlinerVisibilityType VisibilityType |
Whether this Item is currently visible or not for the Given Type | Item/AvaOutlinerItem.h | |
virtual bool HasAllFlags
(
EAvaOutlinerItemFlags Flags |
Item/AvaOutlinerItem.h | ||
virtual bool HasAnyFlags
(
EAvaOutlinerItemFlags Flags |
Item/AvaOutlinerItem.h | ||
virtual bool IsAllowedInOutliner() |
Returns whether this Item (and what it represents) should be allowed to be registered in Outliner | Item/AvaOutlinerItem.h | |
virtual bool IsItemValid() |
Determines whether the Item properties are in a valid state | Item/AvaOutlinerItem.h | |
virtual bool IsLocked() |
Whether the Item is currently Locked | Item/AvaOutlinerItem.h | |
virtual bool IsSortable () |
Determines whether this item can be sorted by the Outliner or not. | Item/AvaOutlinerItem.h | |
virtual FOnExpansionChanged & OnExpansionChanged() |
Called when Expansion state (Expanded/Collapsed) has been changed | Item/AvaOutlinerItem.h | |
virtual FOnRenameAction & OnRenameAction() |
Broadcasts whenever a rename action takes place from a given view (e.g. when pressing "F2" to rename, or committing the rename text) | Item/AvaOutlinerItem.h | |
virtual void RefreshChildren() |
Refreshes what the Parent and Children are of this Item. (not recursive!) | Item/AvaOutlinerItem.h | |
virtual bool RemoveChild
(
const FAvaOutlinerRemoveItemParams& InRemoveItemParams |
Removes the given child from this Item if it was ever indeed a child. | Item/AvaOutlinerItem.h | |
virtual void RemoveFlags
(
EAvaOutlinerItemFlags Flags |
Item/AvaOutlinerItem.h | ||
virtual bool Rename
(
const FString& InName |
The implementation to rename the item (e.g. for AActor it will be the Actor Label that is changed) | Item/AvaOutlinerItem.h | |
virtual void SetFlags
(
EAvaOutlinerItemFlags InFlags |
Item/AvaOutlinerItem.h | ||
virtual void SetLocked
(
bool bInIsLocked |
Lock/Unlock the Item | Item/AvaOutlinerItem.h | |
virtual void SetParent
(
FAvaOutlinerItemPtr InParent |
Sets the Parent. Note that the Parent must've already have this instance as a child (check is done) | Item/AvaOutlinerItem.h | |
virtual bool ShowVisibility
(
EAvaOutlinerVisibilityType VisibilityType |
Whether this Item supports Visibility for the Given Type | Item/AvaOutlinerItem.h |
Overridden from IAvaTypeCastable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const void * CastTo_Impl
(
FAvaTypeId InCastToType |
Item/AvaOutlinerItem.h | ||
virtual FAvaTypeId GetTypeId() |
Item/AvaOutlinerItem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddChildChecked
(
const FAvaOutlinerAddItemParams& InAddItemParams |
The actual implementation of putting the given Item under the Children array | Item/AvaOutlinerItem.h | |
TArray< FAvaOutlinerItemPtr > AddChildrenInternal
(
const FAvaOutlinerAddItemParams& InAddItemParams |
The actual implementation of putting the given Item under the Children array | Item/AvaOutlinerItem.h | |
FAvaOutlinerItemId CalculateItemId() |
Gets the Item Id with the latest information (e.g. parent, object, etc) | Item/AvaOutlinerItem.h | |
FReply CreateItemsFromAssetDrop
(
const TSharedPtr< FAssetDragDropOp >& AssetDragDropOp, |
Handling when an Asset from Content Browser has been dragged on to this item | Item/AvaOutlinerItem.h | |
void HandleNewSortableChildren
(
TArray< FAvaOutlinerItemPtr > InSortableChildren |
Careful handling of multiple children being detected and added to this item children array | Item/AvaOutlinerItem.h | |
void RecalculateItemId() |
Sets the ItemId member var to what CalculateItemId returns | Item/AvaOutlinerItem.h | |
bool RemoveChildChecked
(
const FAvaOutlinerRemoveItemParams& InRemoveItemParams |
The actual implementation of removing the given item from the Children array | Item/AvaOutlinerItem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FAvaTypeId GetStaticTypeId() |
Item/AvaOutlinerItem.h |