FStateTreeViewModel

ModelView for editing StateTreeEditorData.

API > API/Plugins > API/Plugins/StateTreeEditorModule

ModelView for editing StateTreeEditorData.

   
Name FStateTreeViewModel
Type class
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeEditorModule/Public/StateTreeViewModel.h
Include Path #include "StateTreeViewModel.h"

Syntax

class FStateTreeViewModel :  
    public FEditorUndoClient ,  
    public TSharedFromThis< FStateTreeViewModel >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FStateTreeViewModel()

   StateTreeViewModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FStateTreeViewModel()

   StateTreeViewModel.h  

Typedefs

Name Type Remarks Include Path
FOnAssetChanged TMulticastDelegate_NoParams< void >   StateTreeViewModel.h
FOnBringBindingPathToFocus TMulticastDelegate_TwoParams< void, const UStateTreeState *, const FPropertyBindingPath & >   StateTreeViewModel.h
FOnBringNodeToFocus TMulticastDelegate_TwoParams< void, const UStateTreeState *, const FGuid >   StateTreeViewModel.h
FOnSelectionChanged TMulticastDelegate_OneParam< void, const TArray< TWeakObjectPtr< UStateTreeState > > & >   StateTreeViewModel.h
FOnStateAdded TMulticastDelegate_TwoParams< void, UStateTreeState *, UStateTreeState * >   StateTreeViewModel.h
FOnStateNodesChanged TMulticastDelegate_OneParam< void, const UStateTreeState * >   StateTreeViewModel.h
FOnStatesChanged TMulticastDelegate_TwoParams< void, const TSet< UStateTreeState * > &, const FPropertyChangedEvent & >   StateTreeViewModel.h
FOnStatesMoved TMulticastDelegate_TwoParams< void, const TSet< UStateTreeState * > &, const TSet< UStateTreeState * > & >   StateTreeViewModel.h
FOnStatesRemoved TMulticastDelegate_OneParam< void, const TSet< UStateTreeState * > & >   StateTreeViewModel.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddChildState ( UStateTreeState* ParentState
)

   StateTreeViewModel.h  

void AddState ( UStateTreeState* AfterState
)

 State manipulation. StateTreeViewModel.h  

FStateTreeTransition & AddTransition ( TNotNull< UStateTreeState* > State,
const EStateTreeTransitionTrigger InTrigger,
const FGameplayTag InEventTag,
const EStateTreeTransitionType InType,
const UStateTreeState* InState
) const

   StateTreeViewModel.h  

FStateTreeTransition & AddTransition ( TNotNull< UStateTreeState* > State,
const EStateTreeTransitionTrigger InTrigger,
const EStateTreeTransitionType InType,
const UStateTreeState* InState
) const

 Transition Manipulation. StateTreeViewModel.h  

void BringBindingPathToFocus ( const FPropertyBindingPath& InBindingPath
)

   StateTreeViewModel.h  

void BringNodeToFocus ( UStateTreeState* State,
const FGuid NodeID
)

   StateTreeViewModel.h  

bool CanDisableStates()

   StateTreeViewModel.h  

bool CanEnableStates()

   StateTreeViewModel.h  

bool CanPasteNodesToSelectedStates()

   StateTreeViewModel.h  

bool CanPasteStatesFromClipboard()

   StateTreeViewModel.h  

void ClearSelection()

 Selection handling. StateTreeViewModel.h  

void CopyAllNodes ( TWeakObjectPtr< UStateTreeState > State,
const FGuid& ID
)

   StateTreeViewModel.h  

void CopyNode ( TWeakObjectPtr< UStateTreeState > State,
const FGuid& ID
)

   StateTreeViewModel.h  

void CopySelectedStates()

   StateTreeViewModel.h  

void DeleteAllNodes ( TWeakObjectPtr< UStateTreeState > State,
const FGuid& ID
)

   StateTreeViewModel.h  

void DeleteNode ( TWeakObjectPtr< UStateTreeState > State,
const FGuid& ID
)

 EditorNode and Transition manipulation StateTreeViewModel.h  

void DuplicateNode ( TWeakObjectPtr< UStateTreeState > State,
const FGuid& ID
)

   StateTreeViewModel.h  

void DuplicateSelectedStates()

   StateTreeViewModel.h  

void ForEachChild ( TNotNull< UStateTreeState* > State,
TFunctionRef< EStateTreeVisitor(UStateTreeState&ChildState)> InFunc
) const

   StateTreeViewModel.h  

void ForEachInTransition ( TNotNull< UStateTreeState* > State,
TFunctionRef< EStateTreeVisitor(FStateTreeTransition&TransitionToState)> InFunc
) const

   StateTreeViewModel.h  

void ForEachOutTransition ( TNotNull< UStateTreeState* > State,
TFunctionRef< EStateTreeVisitor(FStateTreeTransition&TransitionFromState)> InFunc
) const

   StateTreeViewModel.h  

void ForEachParent ( TNotNull< UStateTreeState* > State,
TFunctionRef< EStateTreeVisitor(UStateTreeState&ParentState)> InFunc
) const

 State utility methods. StateTreeViewModel.h  

FLinearColor GetColorAdjusted ( const FLinearColor& InColor,
EStateTreeViewModelColorAdjustment ColorAdjustment
) const

   StateTreeViewModel.h  

FLinearColor GetHierarchyBasedBackgroundColor ( TNotNull< const UStateTreeState* > State,
EStateTreeViewModelColorAdjustment ColorAdjustment
) const

   StateTreeViewModel.h  

FLinearColor GetHierarchyBasedHighlightColor ( TNotNull< const UStateTreeState* > State,
EStateTreeViewModelColorAdjustment ColorAdjustment
) const

   StateTreeViewModel.h  

UStateTreeState * GetLastSelectedState()

   StateTreeViewModel.h  

void GetLinkStates ( FGuid StateID,
TArray< FGuid >& LinkingIn,
TArray< FGuid >& LinkedOut
) const

 Find the states that are linked to the provided StateID. StateTreeViewModel.h  

UStateTreeState * GetMutableStateByID ( const FGuid StateID
) const

   StateTreeViewModel.h  

FStateTreeTransition * GetMutableTransitionByID ( const FGuid TransitionID
) const

   StateTreeViewModel.h  

FText GetNodeDescription ( const FStateTreeEditorNode& Node,
const EStateTreeNodeFormatting Formatting
) const

   StateTreeViewModel.h  

FOnAssetChanged & GetOnAssetChanged()

 Called when the whole asset is updated (i.e. undo/redo). StateTreeViewModel.h  

FOnBringBindingPathToFocus & GetOnBringBindingPathToFocus()

   StateTreeViewModel.h  

FOnBringNodeToFocus & GetOnBringNodeToFocus()

   StateTreeViewModel.h  

FOnSelectionChanged & GetOnSelectionChanged()

 Called each time the selection changes. StateTreeViewModel.h  

FOnStateAdded & GetOnStateAdded()

 Called each time a state is added. StateTreeViewModel.h  

FOnStateNodesChanged & GetOnStateNodesChanged()

 Called each time a state's Editor nodes or transitions are changed except from the DetailsView. StateTreeViewModel.h  

FOnStatesChanged & GetOnStatesChanged()

 Called when States are changed (i.e. change name or properties). StateTreeViewModel.h  

FOnStatesMoved & GetOnStatesMoved()

 Called each time a state is removed. StateTreeViewModel.h  

FOnStatesRemoved & GetOnStatesRemoved()

 Called each time a states are removed. StateTreeViewModel.h  

void GetPersistentExpandedStates ( TSet< TWeakObjectPtr< UStateTreeState > >& OutExpandedStates
)

   StateTreeViewModel.h  

void GetSelectedStates ( TArray< TWeakObjectPtr< UStateTreeState > >& OutSelectedStates
) const

   StateTreeViewModel.h  

void GetSelectedStates ( TArray< UStateTreeState* >& OutSelectedStates
) const

   StateTreeViewModel.h  

const FSlateBrush * GetSelectorIcon ( TNotNull< const UStateTreeState* > State
) const

   StateTreeViewModel.h  

const UStateTreeState * GetSourceParentStateFromTransition ( TNotNull< const FStateTreeTransition* > Transition
) const

   StateTreeViewModel.h  

const UStateTreeState * GetSourceStateFromTransition ( TNotNull< const FStateTreeTransition* > Transition
) const

   StateTreeViewModel.h  

const UStateTreeState * GetStateByID ( const FGuid StateID
) const

   StateTreeViewModel.h  

TArray< UStateTreeState * > GetStateChildren ( TNotNull< UStateTreeState* > State
) const

   StateTreeViewModel.h  

FLinearColor GetStateColor ( TNotNull< const UStateTreeState* > State,
EStateTreeViewModelColorAdjustment ColorAdjustment
) const

 Color manipulation. StateTreeViewModel.h  

TArray< FStateTreeTransition * > GetStateInTransitions ( TNotNull< UStateTreeState* > State
) const

   StateTreeViewModel.h  

TArray< FStateTreeTransition * > GetStateOutTransitions ( TNotNull< UStateTreeState* > State
) const

   StateTreeViewModel.h  

TArray< UStateTreeState * > GetStateParents ( TNotNull< UStateTreeState* > State
) const

   StateTreeViewModel.h  

const UStateTree * GetStateTree()

 Returns associated state tree asset. StateTreeViewModel.h  

const UStateTreeEditorData * GetStateTreeEditorData()

   StateTreeViewModel.h  

const UStateTreeSchema * GetStateTreeSchema()

   StateTreeViewModel.h  

int32 GetSubTreeCount()

   StateTreeViewModel.h  

void GetSubTrees ( TArray< TWeakObjectPtr< UStateTreeState > >& OutSubtrees
) const

   StateTreeViewModel.h  
Returns array of subtrees to edit. StateTreeViewModel.h  

const UStateTreeState * GetTargetParentStateFromTransition ( TNotNull< const FStateTreeTransition* > Transition
) const

   StateTreeViewModel.h  

const UStateTreeState * GetTargetStateFromTransition ( TNotNull< const FStateTreeTransition* > Transition
) const

   StateTreeViewModel.h  

const FStateTreeTransition * GetTransitionByID ( const FGuid TransitionID
) const

   StateTreeViewModel.h  

UStateTreeState * GetTransitionToState ( TNotNull< const UStateTreeState* > TransitionOwningState,
FGuid TransitionID
) const

 Find the states that the transition go to. StateTreeViewModel.h  
  StateTreeViewModel.h  
Get View Model for transitions. Holds various callbacks for transtions added / modified / etc. StateTreeViewModel.h  

UStateTreeState * GetViewState()

 The view state is the last selected state, or first root if that is invalid. Nullptr if neither of those exist. StateTreeViewModel.h  

bool HasSelection()

   StateTreeViewModel.h  

void Init ( UStateTreeEditorData* InTreeData
)

   StateTreeViewModel.h  

bool IsChildOfSelection ( const UStateTreeState* State
) const

   StateTreeViewModel.h  

bool IsSelected ( const UStateTreeState* State
) const

   StateTreeViewModel.h  

bool IsStateActiveInDebugger ( const UStateTreeState& State
) const

 Debugging. StateTreeViewModel.h  

void MoveNode ( TWeakObjectPtr< UStateTreeState > From,
TWeakObjectPtr< UStateTreeState > To,
const FGuid& ID
)

   StateTreeViewModel.h  

void MoveSelectedStatesAfter ( UStateTreeState* TargetState
)

   StateTreeViewModel.h  

void MoveSelectedStatesBefore ( UStateTreeState* TargetState
)

   StateTreeViewModel.h  

void MoveSelectedStatesInto ( UStateTreeState* TargetState
)

   StateTreeViewModel.h  

void NotifyAssetChangedExternally()

 Force to update the view externally. StateTreeViewModel.h  

void NotifyStatesChangedExternally ( const TSet< UStateTreeState* >& ChangedStates,
const FPropertyChangedEvent& PropertyChangedEvent
) const

   StateTreeViewModel.h  

void PasteNode ( TWeakObjectPtr< UStateTreeState > State,
const FGuid& ID
)

   StateTreeViewModel.h  

void PasteNodesToSelectedStates()

   StateTreeViewModel.h  

void PasteNodesToStates ( TConstArrayView< UStateTreeState* > States
)

   StateTreeViewModel.h  

void PasteStatesAsChildrenFromClipboard ( UStateTreeState* ParentState
)

   StateTreeViewModel.h  

void PasteStatesFromClipboard ( UStateTreeState* AfterState
)

   StateTreeViewModel.h  

void RemoveSelectedStates()

   StateTreeViewModel.h  

void RemoveTransition ( TNotNull< UStateTreeState* > State,
const FGuid TransitionID
)

   StateTreeViewModel.h  

void RenameState ( UStateTreeState* State,
FName NewName
)

   StateTreeViewModel.h  

void SetPersistentExpandedStates ( TSet< TWeakObjectPtr< UStateTreeState > >& InExpandedStates
)

 Gets and sets StateTree view expansion state store in the asset. StateTreeViewModel.h  

void SetSelectedStatesEnabled ( bool bEnable
)

   StateTreeViewModel.h  

void SetSelection ( UStateTreeState* Selected
)

   StateTreeViewModel.h  

void SetSelection ( const TArray< TWeakObjectPtr< UStateTreeState > >& InSelection
)

   StateTreeViewModel.h  

Public Virtual

Overridden from FEditorUndoClient

Name Remarks Include Path Unreal Specifiers

virtual void PostRedo ( bool bSuccess
)

   StateTreeViewModel.h  

virtual void PostUndo ( bool bSuccess
)

   StateTreeViewModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BindToDebuggerDelegates()

   StateTreeViewModel.h  

void GetExpandedStatesRecursive ( UStateTreeState* State,
TSet< TWeakObjectPtr< UStateTreeState > >& ExpandedStates
)

   StateTreeViewModel.h  

void HandleIdentifierChanged ( const UStateTree& StateTree
) const

   StateTreeViewModel.h  

void MoveSelectedStates ( UStateTreeState* TargetState,
const EStateTreeViewModelInsert RelativeLocation
)

   StateTreeViewModel.h  

void PasteNodesToState ( TNotNull< UStateTreeEditorData* > InEditorData,
TNotNull< UStateTreeState* > InState,
UE::StateTreeEditor::FClipboardEditorData& InProcessedClipboard
)

   StateTreeViewModel.h  

void PasteStatesAsChildrenFromText ( const FString& TextToImport,
UStateTreeState* ParentState,
const int32 IndexToInsertAt
)

   StateTreeViewModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page