1. Epic GamesDeveloper
  3. FGraphActionNode

FGraphActionNode

Utility class for building menus of graph actions.

API > API/Editor > API/Editor/GraphEditor

Inheritance Hierarchy

  • TSharedFromThis< FGraphActionNode >
  • FGraphActionNode

References

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

Syntax

struct FGraphActionNode : public TSharedFromThis< FGraphActionNode >

Remarks

Utility class for building menus of graph actions.

Variables

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

Constructors

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS 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:
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode >

AddChild ( FGraphActionListBuilderBase::ActionGroup const& ActionSet
)

  
Public function TSharedPtr< FGraphActionNode >

AddChild ( const TSharedPtr< FEdGraphSchemaAction >& Action
)

 Inserts a new action node (and any accompanying category nodes) based off the provided Action.
Public function 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.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode >

AddChildAlphabetical ( FGraphActionListBuilderBase::ActionGroup const& ActionSet
)

  
Public function PRAGMA_ENABLE_DEPRECATION_WARNINGS TSharedPtr< FGraphActionNode >

AddSection ( int32 Grouping,
int32 InSectionID
)

  
Public function bool Executes the node's RenameRequestEvent if it is bound.
Public function void Clears all children (not recursively... the TSharedPtrs should clean up appropriately).
Public function void

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

 Takes the tree view and expands its elements for each child.
Public function Const void

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

 Recursively collects all child/grandchild/decendent action nodes.
Public function Const void

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

 Recursively collects all child/grandchild/decendent nodes.
Public function Const FText Walks the node chain backwards, constructing a category path (delimited by '|' characters).
Public function Const FText const & Retrieves this node's display name (for category and action nodes).
Public function Const void

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

 Recursively collects all decendent action/separator nodes (leaves out branching category-nodes).
Public function Const int32

GetLinearizedIndex ( TSharedPtr< FGraphActionNode > Node
)

 Returns the 'linearized' index of the node, including category nodes, useful for getting displayed position
Public function Const TWeakPtr< FGraphActionNode > Returns a WeakPtr to the Parent Node
Public function Const TSharedPtr< FEdGraphSchemaAction > Looks through this node's Actions array, and returns the first valid action it finds.
Public function Const int32 Returns the number of leaf nodes
Public function Const bool Checks to see if this node contains at least one valid action.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Sometimes a call to BroadcastRenameRequest() is made before the RenameRequestEvent has been bound.
Public function Const bool Query to determine this node's type (there are five distinguishable node types: root, section heading, category, action, & group-divider).
Public function Const bool  
Public function Const bool Determines if this node is a menu separator of some kind (either a "group-divider" or a "section heading").
Public function Static TSharedPtr< FGraphActionNode > Static allocator for a new root node (so external users have a starting point to build graph action trees from).
Public function FOnRenameRequestActionNode & Accessor to the node's RenameRequestEvent (for binding purposes).
Public function void

SortChildren ( bool bAlphabetically,
bool bRecursive
)

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

Operators

  Type Name Description
Public function FGraphActionNode &

operator= ( const FGraphActionNode& Node
)

  
Public function FGraphActionNode &  

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

On this page