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

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

   
Name URigVMSchema
Type class
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMSchema.h
Include Path #include "RigVMModel/RigVMSchema.h"

Syntax

UCLASS (MinimalAPI)  
class URigVMSchema : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor. RigVMModel/RigVMSchema.h  

URigVMSchema ( const FObjectInitializer& ObjectInitializer
)

   RigVMModel/RigVMSchema.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanAddFunction ( URigVMController* InController,
const URigVMNode* InFunctionNode
) const

 Returns true if functions definitions (not refs) can be added to the graph. RigVMModel/RigVMSchema.h  

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

 Returns true if a link can be added between two pins. RigVMModel/RigVMSchema.h  

virtual bool CanAddNode ( URigVMController* InController,
const URigVMNode* InNode
) const

 Returns true if a given node can be added the graph. RigVMModel/RigVMSchema.h  

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

 Returns true if a variable can be bound to a pin. RigVMModel/RigVMSchema.h  

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

 Returns true if a link exists between two pins and can be broken / removed. RigVMModel/RigVMSchema.h  

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

 Returns true if a set of nodes can be collapsed. RigVMModel/RigVMSchema.h  

virtual bool CanExpandNode ( URigVMController* InController,
const URigVMNode* InNodeToExpand
) const

 Returns true if a node can be expanded within a graph. RigVMModel/RigVMSchema.h  

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

 Returns true if a node can moved to a new position. RigVMModel/RigVMSchema.h  

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

 Returns true if a node can recolored to a new color. RigVMModel/RigVMSchema.h  

virtual bool CanRemoveFunction ( URigVMController* InController,
const URigVMNode* InFunctionNode
) const

 Returns true if a function can be removed. RigVMModel/RigVMSchema.h  

virtual bool CanRemoveNode ( URigVMController* InController,
const URigVMNode* InNode
) const

 Returns true if a given node can be removed from the graph. RigVMModel/RigVMSchema.h  

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

 Returns true if a given node can be added the graph. RigVMModel/RigVMSchema.h  

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

 Returns true if a node can resized to a new size. RigVMModel/RigVMSchema.h  

virtual bool CanSetNodeTitle ( URigVMController* InController,
const URigVMNode* InNode
) const

 Returns true if a node supports setting a node title. RigVMModel/RigVMSchema.h  

virtual bool CanUnbindVariable ( URigVMController* InController,
const URigVMPin* InBoundPin
) const

 Returns true if a variable can be unbound from a pin. RigVMModel/RigVMSchema.h  

virtual bool CanUnfoldPin ( URigVMController* InController,
const URigVMPin* InPinToUnfold
) const

 Returns true if a pin should be unfolded (represented by its subpins) RigVMModel/RigVMSchema.h  

UScriptStruct * GetExecuteContextStruct()

 Returns the execute context struct this schema is using. RigVMModel/RigVMSchema.h  

virtual FString GetGraphOuterName ( const URigVMGraph* InGraph
) const

   RigVMModel/RigVMSchema.h  

virtual FString GetSanitizedGraphName ( const FString& InName
) const

   RigVMModel/RigVMSchema.h  

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

   RigVMModel/RigVMSchema.h  

virtual FString GetSanitizedNodeName ( const FString& InName
) const

   RigVMModel/RigVMSchema.h  

virtual FString GetSanitizedPinName ( const FString& InName
) const

   RigVMModel/RigVMSchema.h  

virtual FString GetSanitizedPinPath ( const FString& InName
) const

   RigVMModel/RigVMSchema.h  

virtual FString GetSanitizedVariableName ( const FString& InName
) const

   RigVMModel/RigVMSchema.h  

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

   RigVMModel/RigVMSchema.h  

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

 Returns true if a node name is valid for a given graph. RigVMModel/RigVMSchema.h  

virtual bool ShouldUnfoldStruct ( URigVMController* InController,
const UStruct* InStruct
) const

 Returns true if the pin for a given struct should be unfolded into subpins for a graph. RigVMModel/RigVMSchema.h  

virtual bool SupportsDispatchFactory ( URigVMController* InController,
const FRigVMDispatchFactory* InDispatchFactory
) const

 Returns true if a graph supports a given dispatch factory. RigVMModel/RigVMSchema.h  

virtual bool SupportsExternalVariable ( URigVMController* InController,
const FRigVMExternalVariable* InExternalVariable
) const

 Returns true if a graph supports a given external variable. RigVMModel/RigVMSchema.h  

virtual bool SupportsGraphFunction ( URigVMController* InController,
const FRigVMGraphFunctionHeader* InGraphFunction
) const

 Returns true if a graph supports a given graph based function. RigVMModel/RigVMSchema.h  

virtual bool SupportsNodeLayouts ( const URigVMGraph* InGraph
) const

 Returns true if a graph supports pin categories / node layouts. RigVMModel/RigVMSchema.h  

virtual bool SupportsTemplate ( URigVMController* InController,
const FRigVMTemplate* InTemplate
) const

 Returns true if a graph supports a given template. RigVMModel/RigVMSchema.h  

virtual bool SupportsType ( URigVMController* InController,
TRigVMTypeIndex InTypeIndex
) const

 Returns true if a graph supports a given type. RigVMModel/RigVMSchema.h  

virtual bool SupportsUnitFunction ( URigVMController* InController,
const FRigVMFunction* InUnitFunction
) const

 Returns true if a graph supports a given unit function. RigVMModel/RigVMSchema.h  

Protected

Name Remarks Include Path Unreal Specifiers

TObjectPtr< URigVMNode > FindEventNode ( URigVMController* InController,
const UScriptStruct* InScriptStruct
) const

   RigVMModel/RigVMSchema.h  

bool IsGraphEditable ( const URigVMGraph* InGraph
) const

   RigVMModel/RigVMSchema.h  

void SetExecuteContextStruct ( UScriptStruct* InExecuteContextStruct
)

 Sets the execute context struct this schema is using. RigVMModel/RigVMSchema.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetMaxNameLength()

   RigVMModel/RigVMSchema.h  

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

 Returns a unique name based on a IsNameAvailable predicate. RigVMModel/RigVMSchema.h  

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

   RigVMModel/RigVMSchema.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page