1. Epic GamesDeveloper
  3. URigVMSchema

URigVMSchema

The Schema is used to determine which actions are allowed on a graph.

API > API/Plugins > API/Plugins/RigVMDeveloper > API/Plugins/RigVMDeveloper/RigVMModel

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class URigVMSchema : public UObject

Remarks

The Schema is used to determine which actions are allowed on a graph. This includes any topological change.

Variables

  Type Name Description
Protected variable UProperty Transient TObjectPtr< UScriptStruct > ExecuteContextStruct  
Protected variable FRigVMRegistry * Registry  
Protected variable UProperty Transient TArray< UStruct * > ValidExecuteContextStructs  

Constructors

  Type Name Description
Public function   Default constructor.
Public function  

URigVMSchema ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool

CanAddFunction ( URigVMController* InController,
const URigVMNode* InFunctionNode
)

 Returns true if functions definitions (not refs) can be added to the graph.
Public function Virtual Const bool

CanAddLink ( URigVMController* InController,
const URigVMPin* InSourcePin,
const URigVMPin* InTargetPin,
const FRigVMByteCode* InByteCode,
ERigVMPinDirection InUserLinkDirection,
bool bInAllowWildcard,
bool bEnableTypeCasting,
FString* OutFailureReason
)

 Returns true if a link can be added between two pins.
Public function Virtual Const bool

CanAddNode ( URigVMController* InController,
const URigVMNode* InNode
)

 Returns true if a given node can be added the graph.
Public function Virtual Const bool

CanBindVariable ( URigVMController* InController,
const URigVMPin* InPinToBind,
const FRigVMExternalVariable* InVariableToBind,
const FString& InNewBoundVariablePath
)

 Returns true if a variable can be bound to a pin.
Public function Virtual Const bool

CanBreakLink ( URigVMController* InController,
const URigVMPin* InSourcePin,
const URigVMPin* InTargetPin
)

 Returns true if a link exists between two pins and can be broken / removed.
Public function Virtual Const bool

CanCollapseNodes ( URigVMController* InController,
const TArrayView< URigVMNode*const >& InNodesToCollapse
)

 Returns true if a set of nodes can be collapsed.
Public function Virtual Const bool

CanExpandNode ( URigVMController* InController,
const URigVMNode* InNodeToExpand
)

 Returns true if a node can be expanded within a graph.
Public function Virtual Const bool

CanMoveNode ( URigVMController* InController,
const URigVMNode* InNode,
const FVector2D& InNewPosition
)

 Returns true if a node can moved to a new position.
Public function Virtual Const bool

CanRecolorNode ( URigVMController* InController,
const URigVMNode* InNode,
const FLinearColor& InNewColor
)

 Returns true if a node can recolored to a new color.
Public function Virtual Const bool

CanRemoveFunction ( URigVMController* InController,
const URigVMNode* InFunctionNode
)

 Returns true if a function can be removed.
Public function Virtual Const bool

CanRemoveNode ( URigVMController* InController,
const URigVMNode* InNode
)

 Returns true if a given node can be removed from the graph.
Public function Virtual Const bool

CanRenameNode ( URigVMController* InController,
const URigVMNode* InNode,
const FName& InNewNodeName
)

 Returns true if a given node can be added the graph.
Public function Virtual Const bool

CanResizeNode ( URigVMController* InController,
const URigVMNode* InNode,
const FVector2D& InNewSize
)

 Returns true if a node can resized to a new size.
Public function Virtual Const bool

CanUnbindVariable ( URigVMController* InController,
const URigVMPin* InBoundPin
)

 Returns true if a variable can be unbound from a pin.
Public function Virtual Const bool

CanUnfoldPin ( URigVMController* InController,
const URigVMPin* InPinToUnfold
)

 Returns true if a pin should be unfolded (represented by its subpins)
Protected function Const TObjectPtr< URigVMNode >

FindEventNode ( URigVMController* InController,
const UScriptStruct* InScriptStruct
)

  
Public function Const UScriptStruct * Returns the execute context struct this schema is using.
Public function Virtual Const FString

GetGraphOuterName ( const URigVMGraph* InGraph
)

  
Public function Static int32  
Public function Virtual Const FString

GetSanitizedGraphName ( const FString& InName
)

  
Public function Virtual Const FString

GetSanitizedName ( const FString& InName,
bool bAllowPeriod,
bool bAllowSpace
)

  
Public function Virtual Const FString

GetSanitizedNodeName ( const FString& InName
)

  
Public function Virtual Const FString

GetSanitizedPinName ( const FString& InName
)

  
Public function Virtual Const FString

GetSanitizedPinPath ( const FString& InName
)

  
Public function Virtual Const FString

GetSanitizedVariableName ( const FString& InName
)

  
Public function Static FName

GetUniqueName ( const FName& InName,
TFunction< bool(const FName&)> IsNameAvailablePredicate,
bool bAllowPeriod,
bool bAllowSpace
)

 Returns a unique name based on a IsNameAvailable predicate.
Public function Virtual Const FString

GetValidNodeName ( const URigVMGraph* InGraph,
const FString& InPrefix
)

  
Protected function Const bool

IsGraphEditable ( const URigVMGraph* InGraph
)

  
Public function Virtual Const bool

IsValidNodeName ( const URigVMGraph* InGraph,
const FName& InNodeName
)

 Returns true if a node name is valid for a given graph.
Public function Static void

SanitizeName ( FString& InOutName,
bool bAllowPeriod,
bool bAllowSpace
)

  
Protected function void

SetExecuteContextStruct ( UScriptStruct* InExecuteContextStruct
)

 Sets the execute context struct this schema is using.
Public function Virtual Const bool

ShouldUnfoldStruct ( URigVMController* InController,
const UStruct* InStruct
)

 Returns true if the pin for a given struct should be unfolded into subpins for a graph.
Public function Virtual Const bool

SupportsDispatchFactory ( URigVMController* InController,
const FRigVMDispatchFactory* InDispatchFactory
)

 Returns true if a graph supports a given dispatch factory.
Public function Virtual Const bool

SupportsExternalVariable ( URigVMController* InController,
const FRigVMExternalVariable* InExternalVariable
)

 Returns true if a graph supports a given external variable.
Public function Virtual Const bool

SupportsGraphFunction ( URigVMController* InController,
const FRigVMGraphFunctionHeader* InGraphFunction
)

 Returns true if a graph supports a given graph based function.
Public function Virtual Const bool

SupportsNodeLayouts ( const URigVMGraph* InGraph
)

 Returns true if a graph supports pin categories / node layouts.
Public function Virtual Const bool

SupportsTemplate ( URigVMController* InController,
const FRigVMTemplate* InTemplate
)

 Returns true if a graph supports a given template.
Public function Virtual Const bool

SupportsType ( URigVMController* InController,
TRigVMTypeIndex InTypeIndex
)

 Returns true if a graph supports a given type.
Public function Virtual Const bool

SupportsUnitFunction ( URigVMController* InController,
const FRigVMFunction* InUnitFunction
)

 Returns true if a graph supports a given unit function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page