Navigation
API > API/Editor > API/Editor/CurveEditor
Concrete type used as a tree item for the curve editor. No need to derive from this type - custom behaviour is implemented through ICurveEditorTreeItem. Implemented in this way to ensure that all hierarchical information can be reasoned about within the curve editor itself, and allow for mixing of tree item types from any usage domain.
| Name | FCurveEditorTreeItem |
| Type | struct |
| Header File | /Engine/Source/Editor/CurveEditor/Public/Tree/CurveEditorTree.h |
| Include Path | #include "Tree/CurveEditorTree.h" |
Syntax
struct FCurveEditorTreeItem
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Children | FSortedCurveEditorTreeItems | This item's sorted children. | Tree/CurveEditorTree.h | |
| Curves | TArray< FCurveModelID, TInlineAllocator< 1 > > | All the curves currently added to the curve editor from this tree item. | Tree/CurveEditorTree.h | |
| FCurveEditorTree | friend | Tree/CurveEditorTree.h | ||
| ParentID | FCurveEditorTreeItemID | This parent's ID or FCurveEditorTreeItemID::Invalid() for root nodes | Tree/CurveEditorTree.h | |
| StrongItemImpl | TSharedPtr< ICurveEditorTreeItem > | A strong pointer to an implementation for this tree item. Mutually exclusive to WeakItemImpl. | Tree/CurveEditorTree.h | |
| ThisID | FCurveEditorTreeItemID | This item's ID | Tree/CurveEditorTree.h | |
| UniquePathName | TOptional< FString > | Optional Unique Path Name | Tree/CurveEditorTree.h | |
| WeakItemImpl | TWeakPtr< ICurveEditorTreeItem > | A weak pointer to an externally held implementation. Mutually exclusive to StrongItemImpl. | Tree/CurveEditorTree.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DestroyCurves
(
FCurveEditor* CurveEditor |
Destroy any previously constructed curve models that this tree item owns | Tree/CurveEditorTree.h | |
void DestroyUnpinnedCurves
(
FCurveEditor* CurveEditor |
Destroy any previously constructed unpinned curve models that this tree item owns | Tree/CurveEditorTree.h | |
TArrayView< const FCurveEditorTreeItemID > GetChildren() |
Access the sorted list of children for this item | Tree/CurveEditorTree.h | |
TArrayView< const FCurveModelID > GetCurves () |
Get all the curves currently represented by this tree item. | Tree/CurveEditorTree.h | |
FCurveEditorTreeItemID GetID() |
Tree/CurveEditorTree.h | ||
TSharedPtr< ICurveEditorTreeItem > GetItem() |
Access the user-specified implementation for this tree item | Tree/CurveEditorTree.h | |
TArrayView< const FCurveModelID > GetOrCreateCurves
(
FCurveEditor* CurveEditor |
Retrieve all the curves for this tree item, creating them through ICurveEditorTreeItem::CreateCurveModels if there are none | Tree/CurveEditorTree.h | |
FCurveEditorTreeItemID GetParentID() |
Tree/CurveEditorTree.h | ||
| Get optional unique path name for the tree editor item | Tree/CurveEditorTree.h | ||
void SetStrongItem
(
TSharedPtr< ICurveEditorTreeItem > InItem |
Overwrite this item's implementation, holding a strong reference to it for the lifetime of this tree item. | Tree/CurveEditorTree.h | |
| Set optional unique path name for the tree editor item | Tree/CurveEditorTree.h | ||
void SetWeakItem
(
TWeakPtr< ICurveEditorTreeItem > InItem |
Overwrite this item's implementation with an externally held implementation to this tree item. | Tree/CurveEditorTree.h |