FGraphActionNode

Utility class for building menus of graph actions.

Unreal Engine C++ API Reference > Editor > GraphEditor

Inheritance Hierarchy

References

   
Module GraphEditor
Header /Engine/Source/Editor/GraphEditor/Public/GraphActionNode.h
Include #include "GraphActionNode.h"

Syntax

struct FGraphActionNode : public [TSharedFromThis< FGraphActionNode >](API\Runtime\Core\Templates\TSharedFromThis)  

Remarks

Utility class for building menus of graph actions.

Variables

Type Name Description
TArray< TShared... Actions A set of actions to execute when this node is picked from a menu
TMap< FString, ... CategoryNodes Lookup table for category nodes, used to speed up menu construction
TArray< TShared... Children  
int32 const Grouping Identifies the menu group that this node belongs to (defaults to zero)
int32 const SectionID Identifies the named section that this node belongs to, if any (defaults to INVALID_SECTION_ID)

Constructors

No constructors are accessible with public or protected access.

Functions

Type Name Description
TSharedPtr< ... AddChild ( FGraphActionListBuilderBase::Action... ) Inserts a new action node (and any accompanying category nodes) based off the provided ActionSet.
void AddChildAlphabetical ( FGraphActionListBuilderBase::Action... ) Inserts a new action node (and any required category nodes) based off the provided ActionSet.
TSharedPtr< ... AddSection ( int32 Grouping, int32 InSectionID )  
bool BroadcastRenameRequest () Executes the node's RenameRequestEvent if it is bound.
void ClearChildren () Clears all children (not recursively... the TSharedPtrs should clean up appropriately).
void ExpandAllChildren ( TSharedPtr< STreeView< TSharedPtr< ..., bool bRecursive ) Takes the tree view and expands its elements for each child.
void GetAllNodes ( TArray< TSharedPtr< FGraphActionNod... ) Recursively collects all child/grandchild/decendent nodes.
FText GetCategoryPath () Walks the node chain backwards, constructing a category path (delimited by '|' characters).
FText const ... GetDisplayName () Retrieves this node's display name (for category and action nodes).
void GetLeafNodes ( TArray< TSharedPtr< FGraphActionNod... ) Recursively collects all decendent action/separator nodes (leaves out branching category-nodes).
TWeakPtr< FG... GetParentNode () Returns a WeakPtr to the Parent Node
TSharedPtr< ... GetPrimaryAction () Looks through this node's Actions array, and returns the first valid action it finds.
bool HasValidAction () Checks to see if this node contains at least one valid action.
bool IsActionNode ()  
bool IsCategoryNode ()  
bool IsGroupDividerNode ()  
bool IsRenameRequestPending () Sometimes a call to BroadcastRenameRequest() is made before the RenameRequestEvent has been bound.
bool IsRootNode () Query to determine this node's type (there are five distinguishable node types: root, section heading, category, action, & group-divider).
bool IsSectionHeadingNode ()  
bool IsSeparator () Determines if this node is a menu separator of some kind (either a "group-divider" or a "section heading").
TSharedPtr< ... NewRootNode () Static allocator for a new root node (so external users have a starting point to build graph action trees from).
FOnRenameReq... OnRenameRequest () Accessor to the node's RenameRequestEvent (for binding purposes).
void SortChildren ( bool bAlphabetically, bool bRecursive ) Sorts all child nodes by section, group, and type (additionally, can sort alphabetically if wanted).

Constants

Name Description
INVALID_SECTION_ID  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library