1. Epic GamesDeveloper
  3. FRigVMExprAST

FRigVMExprAST

Base class for an expression within an abstract syntax tree.

API > API/Plugins > API/Plugins/RigVMDeveloper > API/Plugins/RigVMDeveloper/RigVMCompiler

Inheritance Hierarchy

References

   
Module RigVMDeveloper
Header /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMCompiler/RigVMAST.h
Include #include "RigVMCompiler/RigVMAST.h"

Syntax

class FRigVMExprAST

Remarks

Base class for an expression within an abstract syntax tree. The base implements parent / child relationships as well as a simple typing system. An expression is a multi child / multi parent element of a directed tree (there can be no cycles). Expressions can only be constructed by an AST parser, and are also memory-owned by the parser.

Variables

  Type Name Description
Protected variable TOptional< TOptional< uint32 > > BlockCombinationHash  
Protected variable TArray< FRigVMExprAST * > Children  
Protected variable int32 Index  
Protected variable TOptional< int32 > MaximumDepth  
Protected variable FName Name  
Protected variable TArray< FRigVMExprAST * > Parents  
Protected variable const FRigVMParserAST * ParserPtr  
Protected variable TMap< FName, int32 > PinNameToChildIndex  
Protected variable EType Type  

Constructors

  Type Name Description
Public function   Disable copy constructor
Protected function  

FRigVMExprAST ( EType InType,
const FRigVMASTProxy& InProxy
)

 Default constructor (protected so that only parser can access it)

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Protected function void

AddParent ( FRigVMExprAST* InParent
)

 Adds a parent to this expression this in consequence also adds this as a child to the parent
Public function Const TArray< FRigVMExprAST * >::RangedForConstIteratorType

begin ()

 Begin iterator accessor for the children
Public function Const const FRigVMExprAST *

ChildAt ( int32 InIndex
)

 Getter to retrieve a child with a given index
Public function Const const ObjectType *

ChildAt ( int32 InIndex
)

 Templated getter to retrieve a child with a given index type checking will occur within the To method and raise
Protected function Virtual Const FString

DumpText ( const FString& InPrefix
)

 Returns a string containing an indented tree structure for debugging purposes.
Public function Const TArray< FRigVMExprAST * >::RangedForConstIteratorType

end ()

 End iterator accessor for the children
Public function Const const FRigVMBlockExprAST * Returns the block of this expression
Public function Const TOptional< uint32 > Returns the unique block combination hash for this expression (or INDEX_NONE)
Public function Const const FString & Returns the unique block combination name for this expression (or an empty string)
Public function Const FRigVMBlockArray

GetBlocks ( bool bSortByDepth
)

  
Protected function Const void

GetBlocksImpl ( FRigVMBlockArray& InOutBlocks
)

 Computes all of the block this expression is in
Public function Virtual Const const FRigVMExprAST *

GetFirstChildOfType ( EType InExprType
)

 Returns the first parent in the tree of a given type
Public function Virtual Const const FRigVMExprAST *

GetFirstParentOfType ( EType InExprType
)

 Returns the first parent in the tree of a given type
Public function Const int32 Returns the index of this expression within the parser's storage
Public function Const int32 Returns the maximum depth of the expression in tree (number of recursive parents)
Public function Const int32 Returns the lowest child index found for this expression within a parent (or INDEX_NONE)
Public function Const FName

GetName ()

 Returns the name of the expression (can be NAME_None)
Public function Const const FRigVMExprAST * Returns the parent of this expression
Public function Const const FRigVMParserAST * Returns the parser this expression is owned by
Public function Virtual Const const FRigVMASTProxy & Returns the model proxy this expression relates to
Public function Const const FRigVMBlockExprAST * Returns the root / top level block of this expression
Public function Const EType

GetType ()

 Returns the exact type of the expression
Public function Const FName Returns the name of the expression's type
Protected function void Resets the internal caches of the expression.
Protected function void

InvalidateCachesImpl ( TArray< bool >& OutProcessed
)

  
Public function Const bool

IsA ( EType InType
)

 Provides type checking for inherited types
Public function Virtual Const bool Returns true if this expressions is constant (non varying)
Public function Virtual Const bool

IsNode ()

 Returns true if the expression is a node expression
Public function Const bool

IsParentedTo ( const FRigVMExprAST* InParentExpr
)

 Returns true if a given expression is parented to another expression
Public function Const bool

IsParentOf ( const FRigVMExprAST* InChildExpr
)

 Returns true if a given expression is a parent of another expression
Public function Const bool

IsValid ()

 Returns true if the expressoin is valid
Public function Virtual Const bool

IsVar ()

 Returns true if the expression is a var expression
Public function Const bool Returns true if this expressions is varying (non constant)
Public function Const int32 Returns the number of children of this expression
Public function Const int32 Returns the number of parents of this expression
Public function Const const ObjectType *

ParentAt ( int32 InIndex
)

 Templated getter to retrieve a parent with a given index type checking will occur within the To method and raise
Public function Const const FRigVMExprAST *

ParentAt ( int32 InIndex
)

 Getter to retrieve a parent with a given index
Protected function void

RemoveChild ( FRigVMExprAST* InChild
)

 Removes a child from this expression this in consequence also removes this as a parent from the child
Protected function void

RemoveParent ( FRigVMExprAST* InParent
)

 Removes a parent from this expression this in consequence also removes this as a child from the parent
Protected function void

ReplaceBy ( FRigVMExprAST* InReplacement
)

 Replaces this expression with another one
Protected function void

ReplaceChild ( FRigVMExprAST* InCurrentChild,
FRigVMExprAST* InNewChild
)

 Replaces a child of this expression with a new one
Protected function void

ReplaceParent ( FRigVMExprAST* InCurrentParent,
FRigVMExprAST* InNewParent
)

 Replaces a parent of this expression with a new one
Public function Const const FRigVMVarExprAST *

To ()

 Specialized cast for type checking for a Var / FRigVMVarExprAST expression will raise if types are not compatible
Public function Const const FRigVMLiteralExprAST *

To ()

 Specialized cast for type checking for a Literal / FRigVMLiteralExprAST expression will raise if types are not compatible
Public function Const const FRigVMCopyExprAST *

To ()

 Specialized cast for type checking for a Copy / FRigVMCopyExprAST expression will raise if types are not compatible
Public function Const const FRigVMAssignExprAST *

To ()

 Specialized cast for type checking for a Assign / FRigVMAssignExprAST expression will raise if types are not compatible
Public function Const const FRigVMNoOpExprAST *

To ()

 Specialized cast for type checking for a NoOp / FRigVMNoOpExprAST expression will raise if types are not compatible
Public function Const const FRigVMExternalVarExprAST *

To ()

 Specialized cast for type checking for a External Variable / FRigVMExternalVarExprAST expression will raise if types are not compatible
Public function Const const FRigVMInlineFunctionExprAST *

To ()

 Specialized cast for type checking for a InlineFunction / FRigVMInlineFunctionExprAST expression will raise if types are not compatible
Public function Const const FRigVMBlockExprAST *

To ()

 Specialized cast for type checking for a Block / FRigVMBlockExprAST expression will raise if types are not compatible
Public function Const const FRigVMInvokeEntryExprAST *

To ()

 Specialized cast for type checking for a InvokeEntry / FRigVMInvokeEntryExprAST expression will raise if types are not compatible
Public function Const const FRigVMEntryExprAST *

To ()

 Specialized cast for type checking for a Entry / FRigVMEntryExprAST expression will raise if types are not compatible
Public function Const const FRigVMNodeExprAST *

To ()

 Specialized cast for type checking for a Node / FRigVMNodeExprAST expression will raise if types are not compatible
Public function ObjectType *

To ()

 Templated cast for casting between different expression types.
Public function Const const ObjectType *

To ()

 Const templated cast for casting between different expression types.
Public function Const const FRigVMCachedValueExprAST *

To ()

 Specialized cast for type checking for a CachedValue / FRigVMCachedValueExprAST expression will raise if types are not compatible
Public function Const const FRigVMCallExternExprAST *

To ()

 Specialized cast for type checking for a CallExtern / FRigVMCallExternExprAST expression will raise if types are not compatible
Public function Const const FRigVMExitExprAST *

To ()

 Specialized cast for type checking for a Exit / FRigVMExitExprAST expression will raise if types are not compatible

Operators

  Type Name Description
Public function Const const FRigVMExprAST *

operator[] ( int32 InIndex
)

 Accessor operator for a given child

Enums

  Type Name Description
Public enum EType Simple enum for differentiating expression types.  

Typedefs

Name Description
FRigVMBlockArray Returns all of the block this expression is in

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page