1. Epic GamesDeveloper
  3. FGraphActionNode

FGraphActionNode

Utility class for building menus of graph actions.

API > API/Editor > API/Editor/GraphEditor

Utility class for building menus of graph actions.

   
Name FGraphActionNode
Type struct
Header File /Engine/Source/Editor/GraphEditor/Public/GraphActionNode.h
Include Path #include "GraphActionNode.h"

Syntax

struct FGraphActionNode : public TSharedFromThis< FGraphActionNode >

Inheritance Hierarchy

  • TSharedFromThis< FGraphActionNode > → FGraphActionNode

Constructors

Name Remarks Include Path Unreal Specifiers

FGraphActionNode ( int32 Grouping,
int32 SectionID
)

   GraphActionNode.h  
  GraphActionNode.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FGraphActionNode ( const FGraphActionNode& Node
)

 We need to declare our copy constructors so that we can disable deprecation warnings around them for ClangEditor - when all of the deprecated members are deleted we can remove these: GraphActionNode.h  

FGraphActionNode ( const TSharedPtr< FEdGraphSchemaAction >& InAction,
int32 InGrouping,
int32 InSectionID
)

 Constructor for action nodes. Private so that users go through AddChild(). GraphActionNode.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FGraphActionNode()

   GraphActionNode.h  

Constants

Name Type Remarks Include Path
INVALID_SECTION_ID PRAGMA_ENABLE_DEPRECATION_WARNINGS const int32   GraphActionNode.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Action TSharedPtr< FEdGraphSchemaAction > const An action to execute when this node is picked from a menu GraphActionNode.h  
Actions TArray< TSharedPtr< FEdGraphSchemaAction > > const   GraphActionNode.h  
CategoryNodes TMap< FString, TSharedPtr< FGraphActionNode > > Lookup table for category nodes, used to speed up menu construction GraphActionNode.h  
Children TArray< TSharedPtr< FGraphActionNode > >   GraphActionNode.h  
Grouping int32 const Identifies the menu group that this node belongs to (defaults to zero) GraphActionNode.h  
SectionID int32 const Identifies the named section that this node belongs to, if any (defaults to INVALID_SECTION_ID) GraphActionNode.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bPendingRenameRequest bool When the item is first created, a rename request may occur before everything is setup for it. GraphActionNode.h  
ChildGroupings TSet< int32 > Tracks what groups have already been added (so we can easily determine what group-dividers we need) GraphActionNode.h  
ChildSections TSet< int32 > Tracks what sections have already been added (so we can easily determine what heading we need) GraphActionNode.h  
DisplayText FText The category or action name (depends on what type of node this is) GraphActionNode.h  
InsertOrder int32 For sorting, when we don't alphabetically sort (so menu items don't jump around). GraphActionNode.h  
ParentNode TWeakPtr< FGraphActionNode > The node that this is a direct child of (empty if this is a root node) GraphActionNode.h  
RenameRequestEvent FOnRenameRequestActionNode Delegate to trigger when a rename was requested on this node GraphActionNode.h  
TotalLeafs int32 Root entry only, counts the total leaf entries in this tree GraphActionNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode > AddChild ( FGraphActionListBuilderBase::ActionGroup const& ActionSet
)

   GraphActionNode.h  

TSharedPtr< FGraphActionNode > AddChild ( const TSharedPtr< FEdGraphSchemaAction >& Action
)

 Inserts a new action node (and any accompanying category nodes) based off the provided Action. GraphActionNode.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode > AddChildAlphabetical ( FGraphActionListBuilderBase::ActionGroup const& ActionSet
)

   GraphActionNode.h  

PRAGMA_ENABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode > AddChildAlphabetical ( const TSharedPtr< FEdGraphSchemaAction >& Action
)

 Inserts a new action node (and any required category nodes) based off the provided Action. GraphActionNode.h  

PRAGMA_ENABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode > AddSection ( int32 Grouping,
int32 InSectionID
)

   GraphActionNode.h  
Executes the node's RenameRequestEvent if it is bound. GraphActionNode.h  

void ClearChildren()

 Clears all children (not recursively... the TSharedPtrs should clean up appropriately). GraphActionNode.h  

void ExpandAllChildren ( TSharedPtr< STreeView< TSharedPtr< FGraphActionNode > > > TreeView,
bool bRecursive
)

 Takes the tree view and expands its elements for each child. GraphActionNode.h  

void GetAllActionNodes ( TArray< TSharedPtr< FGraphActionNode > >& OutNodeArray
) const

 Recursively collects all child/grandchild/decendent action nodes. GraphActionNode.h  

void GetAllNodes ( TArray< TSharedPtr< FGraphActionNode > >& OutNodeArray
) const

 Recursively collects all child/grandchild/decendent nodes. GraphActionNode.h  

FText GetCategoryPath ()

 Walks the node chain backwards, constructing a category path (delimited by '|' characters). GraphActionNode.h  

FText const & GetDisplayName ()

 Retrieves this node's display name (for category and action nodes). GraphActionNode.h  

void GetLeafNodes ( TArray< TSharedPtr< FGraphActionNode > >& OutLeafArray
) const

 Recursively collects all decendent action/separator nodes (leaves out branching category-nodes). GraphActionNode.h  

int32 GetLinearizedIndex ( TSharedPtr< FGraphActionNode > Node
) const

 Returns the 'linearized' index of the node, including category nodes, useful for getting displayed position GraphActionNode.h  

TWeakPtr< FGraphActionNode > GetParentNode()

 Returns a WeakPtr to the Parent Node GraphActionNode.h  

TSharedPtr< FEdGraphSchemaAction > GetPrimaryAction()

 Looks through this node's Actions array, and returns the first valid action it finds. GraphActionNode.h  

int32 GetTotalLeafNodes()

 Returns the number of leaf nodes GraphActionNode.h  

bool HasValidAction()

 Checks to see if this node contains at least one valid action. GraphActionNode.h  

bool IsActionNode()

   GraphActionNode.h  

bool IsCategoryNode()

   GraphActionNode.h  

bool IsGroupDividerNode()

   GraphActionNode.h  
Sometimes a call to BroadcastRenameRequest() is made before the RenameRequestEvent has been bound. GraphActionNode.h  

bool IsRootNode()

 Query to determine this node's type (there are five distinguishable node types: root, section heading, category, action, & group-divider). GraphActionNode.h  

bool IsSectionHeadingNode()

   GraphActionNode.h  

bool IsSeparator()

 Determines if this node is a menu separator of some kind (either a "group-divider" or a "section heading"). GraphActionNode.h  

FOnRenameRequestActionNode & OnRenameRequest ()

 Accessor to the node's RenameRequestEvent (for binding purposes). GraphActionNode.h  

void SortChildren ( bool bAlphabetically,
bool bRecursive
)

 Sorts all child nodes by section, group, and type (additionally, can sort alphabetically if wanted). GraphActionNode.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FGraphActionNode > NewActionNode ( TSharedPtr< FEdGraphSchemaAction > const& ActionNode
)

   GraphActionNode.h  

static TSharedPtr< FGraphActionNode > NewCategoryNode ( FString const& Category,
int32 Grouping,
int32 SectionID
)

   GraphActionNode.h  

static TSharedPtr< FGraphActionNode > NewGroupDividerNode ( TWeakPtr< FGraphActionNode > Parent,
int32 Grouping
)

   GraphActionNode.h  

static TSharedPtr< FGraphActionNode > NewRootNode()

 Static allocator for a new root node (so external users have a starting point to build graph action trees from). GraphActionNode.h  

static TSharedPtr< FGraphActionNode > NewSectionHeadingNode ( TWeakPtr< FGraphActionNode > Parent,
int32 Grouping,
int32 SectionID
)

   GraphActionNode.h  

Operators

Name Remarks Include Path Unreal Specifiers
  GraphActionNode.h  
  GraphActionNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page