Navigation
API > API/Plugins > API/Plugins/AvalancheOutliner
Item Proxies are Outliner Items that have as only purpose to group and hold common items together. The description or name of such commonality between these Items should be the name of the Proxy that holds them.
NOTE: Although Item Proxies by default require to have a Parent to Show in Outliner, they can be created without parent as means to get overriden behavior (e.g. DisplayName, Icon, etc)
| Name | FAvaOutlinerItemProxy |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheOutliner/Public/Item/AvaOutlinerItemProxy.h |
| Include Path | #include "Item/AvaOutlinerItemProxy.h" |
Syntax
class FAvaOutlinerItemProxy : public FAvaOutlinerItem
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAvaOutlinerItemProxy
(
IAvaOutliner& InOutliner, |
Item/AvaOutlinerItemProxy.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAvaInherits | TAvaInherits< FAvaOutlinerItemProxy, FAvaOutlinerItem,> | Item/AvaOutlinerItemProxy.h | |
| Super | FAvaOutlinerItem | Item/AvaOutlinerItemProxy.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Priority | uint32 | This Item Proxy's Order Priority (i.e. Highest priority is placed topmost or leftmost (depending on Orientation). Priority 0 is lowest priority | Item/AvaOutlinerItemProxy.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetPriority() |
Item/AvaOutlinerItemProxy.h | ||
void GetProxiedItems
(
const TSharedRef< IAvaOutlinerItem >& InParent, |
Gets the Items that this Item Proxy is representing / holding (i.e. children) | Item/AvaOutlinerItemProxy.h | |
void SetPriority
(
uint32 InPriority |
Item/AvaOutlinerItemProxy.h |
Overridden from IAvaOutlinerItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAutoExpand() |
Whether the Item is able to expand when AutoExpand functionality is enabled | Item/AvaOutlinerItemProxy.h | |
virtual void FindChildren
(
TArray< FAvaOutlinerItemPtr >& OutChildren, |
Figures out the Children of this Item. | Item/AvaOutlinerItemProxy.h | |
virtual FText GetClassName() |
Gets the Class/Type of this Item (e.g. for Items that represent UObjects, it will be the UObject class) | Item/AvaOutlinerItemProxy.h | |
virtual EAvaOutlinerItemViewMode GetSupportedViewModes
(
const FAvaOutlinerView& InOutlinerView |
Gets the View Modes that this Item Supports | Item/AvaOutlinerItemProxy.h | |
virtual bool IsItemValid() |
Determines whether the Item properties are in a valid state | Item/AvaOutlinerItemProxy.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/AvaOutlinerItemProxy.h |
Overridden from IAvaTypeCastable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const void * CastTo_Impl
(
FAvaTypeId InCastToType |
Item/AvaOutlinerItemProxy.h | ||
virtual FAvaTypeId GetTypeId() |
Item/AvaOutlinerItemProxy.h |
Protected
Overridden from FAvaOutlinerItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FAvaOutlinerItemId CalculateItemId() |
Gets the Item Id with the latest information (e.g. parent, object, etc) | Item/AvaOutlinerItemProxy.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FAvaTypeId GetStaticTypeId() |
Item/AvaOutlinerItemProxy.h |