Navigation
API > API/Plugins > API/Plugins/AvalancheOutliner > API/Plugins/AvalancheOutliner/Item
Inheritance Hierarchy
- IAvaTypeCastable
- TSharedFromThis< IAvaOutlinerItem >
- IAvaOutlinerItem
- FAvaOutlinerItem
- FAvaOutlinerItemProxy
- FAvaOutlinerComponentProxy
- FAvaOutlinerMaterialProxy
- FAvaOutlinerObject
- FAvaOutlinerActor
- FAvaOutlinerComponent
- FAvaOutlinerObjectReference
- FAvaOutlinerMaterial
- FAvaOutlinerSharedObject
References
| Module | AvalancheOutliner |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheOutliner/Public/Item/AvaOutlinerItem.h |
| Include | #include "Item/AvaOutlinerItem.h" |
Syntax
class FAvaOutlinerItem : public IAvaOutlinerItem
Remarks
Base Implementation of IAvaOutlinerItem
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FAvaOutlinerItemPtr > | Children | Array of Shared pointers to the Child Items. | |
| EAvaOutlinerItemFlags | ItemFlags | The current flags set for this item | |
| FAvaOutlinerItemId | ItemId | ||
| FOnExpansionChanged | OnExpansionChangedDelegate | Delegate for when Expansion changes in the Item | |
| FOnRenameAction | OnRenameActionDelegate | The delegate for renaming | |
| IAvaOutliner & | Outliner | Reference to the Owning Outliner | |
| TWeakPtr< IAvaOutlinerItem > | ParentWeak | Weak pointer to the Parent Item. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FAvaOutlinerItem
(
IAvaOutliner& InOutliner |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddChildChecked
(
const FAvaOutlinerAddItemParams& InAddItemParams |
The actual implementation of putting the given Item under the Children array | |
| FAvaOutlinerItemId | Gets the Item Id with the latest information (e.g. parent, object, etc) | ||
| FReply | CreateItemsFromAssetDrop
(
const TSharedPtr< FAssetDragDropOp >& AssetDragDropOp, |
Handling when an Asset from Content Browser has been dragged on to this item | |
| void | HandleNewSortableChildren
(
TArray< FAvaOutlinerItemPtr > InSortableChildren |
Careful handling of multiple children being detected and added to this item children array | |
| void | Sets the ItemId member var to what CalculateItemId returns | ||
| bool | RemoveChildChecked
(
const FAvaOutlinerRemoveItemParams& InRemoveItemParams |
The actual implementation of removing the given item from the Children array | |
Overridden from IAvaOutlinerItem
| Type | Name | Description | |
|---|---|---|---|
| FReply | AcceptDrop
(
const FDragDropEvent& InDragDropEvent, |
Processes the Drag and Drop Event for this Item | |
| bool | AddChild
(
const FAvaOutlinerAddItemParams& InAddItemParams |
Adds another Child under this Item if such Item is supported. | |
| void | AddFlags
(
EAvaOutlinerItemFlags Flags |
||
| TOptional< EItemDropZone > | CanAcceptDrop
(
const FDragDropEvent& InDragDropEvent, |
Determines if and where the incoming Drag Drop Event can be processed by this item | |
| bool | CanAddChild
(
const FAvaOutlinerItemPtr& InChild |
Determines whether the given Child is supported and can be added under this Item | |
| bool | Whether the Item is able to expand when AutoExpand functionality is enabled | ||
| bool | 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. | ||
| bool | CanLock () |
Whether an Item can be Locked in any kind. E.g. Actors can be location-locked | |
| bool | Whether a change in Parent Visibility should also affect this Item's Visibility | ||
| bool | CanRename () |
Whether this Item can be renamed or not | |
| void | FindChildren
(
TArray< FAvaOutlinerItemPtr >& OutChildren, |
Figures out the Children of this Item. | |
| 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) | |
| const TArray< FAvaOutlinerItemPtr > & | GetChildren () |
Gets the current Child Items of this Item | |
| TArray< FAvaOutlinerItemPtr > & | Gets the current Child Items of this Item | ||
| TOptional< FAvaOutlinerColorPair > | GetColor
(
bool bRecurse |
Returns the Item's Color Name and Color (either inherited if bRecurse is true, or explicit if false) | |
| EAvaOutlinerItemFlags | GetFlags () |
||
| const FSlateBrush * | GetIconBrush () |
||
| FLinearColor | GetItemColor () |
Gets the Brush Color to use for the Item in the Outliner (e.g. Components should be grayed out a bit) | |
| FAvaOutlinerItemId | GetItemId () |
Gets the Id of this Item | |
| TSharedRef< IAvaOutliner > | Gets the Outliner that owns this Item | ||
| FAvaOutlinerItemPtr | GetParent () |
Gets the Parent of this Item. | |
| EAvaOutlinerItemViewMode | GetSupportedViewModes
(
const FAvaOutlinerView& InOutlinerView |
Gets the View Modes that this Item Supports | |
| bool | GetVisibility
(
EAvaOutlinerVisibilityType VisibilityType |
Whether this Item is currently visible or not for the Given Type | |
| bool | HasAllFlags
(
EAvaOutlinerItemFlags Flags |
||
| bool | HasAnyFlags
(
EAvaOutlinerItemFlags Flags |
||
| bool | Returns whether this Item (and what it represents) should be allowed to be registered in Outliner | ||
| bool | IsItemValid () |
Determines whether the Item properties are in a valid state | |
| bool | IsLocked () |
Whether the Item is currently Locked | |
| bool | IsSortable () |
Determines whether this item can be sorted by the Outliner or not. | |
| FOnExpansionChanged & | Called when Expansion state (Expanded/Collapsed) has been changed | ||
| FOnRenameAction & | Broadcasts whenever a rename action takes place from a given view (e.g. when pressing "F2" to rename, or committing the rename text) | ||
| void | Refreshes what the Parent and Children are of this Item. (not recursive!) | ||
| bool | RemoveChild
(
const FAvaOutlinerRemoveItemParams& InRemoveItemParams |
Removes the given child from this Item if it was ever indeed a child. | |
| void | RemoveFlags
(
EAvaOutlinerItemFlags Flags |
||
| bool | The implementation to rename the item (e.g. for AActor it will be the Actor Label that is changed) | ||
| void | SetFlags
(
EAvaOutlinerItemFlags InFlags |
||
| void | SetLocked
(
bool bInIsLocked |
Lock/Unlock the Item | |
| void | SetParent
(
FAvaOutlinerItemPtr InParent |
Sets the Parent. Note that the Parent must've already have this instance as a child (check is done) | |
| bool | ShowVisibility
(
EAvaOutlinerVisibilityType VisibilityType |
Whether this Item supports Visibility for the Given Type |