FCurveEditorTree

API > API/Editor > API/Editor/CurveEditor > API/Editor/CurveEditor/Tree

References


Module	CurveEditor
Header	/Engine/Source/Editor/CurveEditor/Public/Tree/CurveEditorTree.h
Include	#include "Tree/CurveEditorTree.h"

Syntax

class FCurveEditorTree

Remarks

Complete implementation of a curve editor tree. Only really defines the hierarchy and selection states for tree items.

Variables

	Type	Name	Description
	FCurveEditorTreeEvents	Events	Structure containing all the events for this tree

Constructors

	Type	Name	Description
		FCurveEditorTree ()

Functions

Type	Name	Description
void	AddFilter ( TWeakPtr< FCurveEditorTreeFilter > NewFilter )	Add a new filter to this tree.
FCurveEditorTreeItem *	AddItem ( FCurveEditorTreeItemID ParentID )	Add a new empty item to the tree
void	ClearFilters ()	Clear all filters from the tree
void	Compact ()	Compact the memory used by this tree (does not modify any meaningful state)
const FCurveEditorTreeFilter *	FindFilterByType ( ECurveEditorTreeFilterType Type )	Attempt to locate a filter by its type
const FCurveEditorTreeItem *	FindItem ( FCurveEditorTreeItemID ItemID )	Retrieve an item from its ID or nullptr if the ID is not valid
FCurveEditorTreeItem *	FindItem ( FCurveEditorTreeItemID ItemID )	Retrieve an item from its ID or nullptr if the ID is not valid
const TMap< FCurveEditorTreeItemID, FCurveEditorTreeItem > &	GetAllItems ()	Retrieve all the items stored in this tree irrespective of filter state
TArrayView< const TWeakPtr< FCurveEditorTreeFilter > >	GetFilters ()	Direct access to all current filters (potentially including expired ones)
ECurveEditorTreeFilterState	GetFilterState ( FCurveEditorTreeItemID InTreeItemID )	Check a specific tree item's filter state
const FCurveEditorFilterStates &	GetFilterStates ()	Access the filter state for this tree.
const FCurveEditorTreeItem &	GetItem ( FCurveEditorTreeItemID ItemID )	Retrieve an item from its ID, assuming it is definitely valid
FCurveEditorTreeItem &	GetItem ( FCurveEditorTreeItemID ItemID )	Retrieve an item from its ID, assuming it is definitely valid
const TArray< FCurveEditorTreeItemID > &	GetRootItems ()	Retrieve this curve editor's root items irrespective of filter state
const TMap< FCurveEditorTreeItemID, ECurveEditorTreeSelectionState > &	GetSelection ()	Access the selection state for this tree.
ECurveEditorTreeSelectionState	GetSelectionState ( FCurveEditorTreeItemID InTreeItemID )	Check a specific tree item's selection state
FOnCurveEditorToggleExpansionState &	GetToggleExpansionState ()
bool	IsDoingDirectSelection ()	Whether or not we are are doign a direct selection, could be used to see why a curve model is being created or destroyed, by direct selection or by sequencer filtering?
void	RecreateModelsFromExistingSelection ( FCurveEditor* CurveEditor )	Recreate the curve models from the existing selection, this may be needed in case of a setting change.
void	RemoveFilter ( TWeakPtr< FCurveEditorTreeFilter > FilterToRemove )	Remove an existing filter from this tree.
void	RemoveFromSelection ( TArrayView< const FCurveEditorTreeItemID > TreeItems, FCurveEditor* InCurveEditor )	Removes tree items from the current selection.
void	RemoveItem ( FCurveEditorTreeItemID ItemID, FCurveEditor* CurveEditor )	Remove an item and all its children from this tree, destroying any curves it may have created.
void	RunFilters ()	Run all the filters on this tree, updating filter state for all tree items
FScopedCurveEditorTreeEventGuard	ScopedEventGuard ()	Retrieve a scoped event guard that will block broadcast of events until the last guard on the stack goes out of scope Can be used to defer broadcasts in situations where many changes are made to the tree at a time.
void	SetDirectSelection ( TArray< FCurveEditorTreeItemID >&& TreeItems, FCurveEditor* InCurveEditor )	Inform this tree that the specified tree item IDs have been directly selected on the UI.
void	SetSortPredicate ( FTreeItemSortPredicate InSortPredicate )	Sets a predicate which will be used to sort tree items after they're been marked as needing sort.
void	SortTreeItems ()	Sorts all tree items which have been marked for sorting if the sort predicate has been set.
void	ToggleExpansionState ( bool bRecursive )	Toggle the expansion state of the selected nodes or all nodes if none selected