1. Epic GamesDeveloper
  3. RigVMCore

RigVMCore

Unreal Engine C++ API Reference > Plugins > RigVM

Classes

  Type Name Description
Public struct CRigVMUClass    
Public struct CRigVMUStruct    
Public struct UStruct FRigVMBaseOp Base class for all VM operations.  
Public struct UStruct FRigVMBinaryOp Operator used for beginblock and array reset  
Public struct UStruct FRigVMBranchInfo Lazy execution.  
Public struct FRigVMBranchInfoKey    
Public struct UStruct FRigVMBreakpoint    
Public struct UStruct FRigVMByteCode The FRigVMByteCode is a container to store a list of instructions with their corresponding data.  
Public struct UStruct FRigVMByteCodeEntry    
Public struct UStruct BlueprintType FRigVMByteCodeStatistics    
Public struct UStruct FRigVMChangeTypeOp Change the type of a register  
Public struct UStruct FRigVMComparisonOp Used for equals and not equals comparisons  
Public struct UStruct FRigVMCopyOp Copy the content of one register to another  
Public struct UStruct FRigVMDebugInfo    
Public struct UStruct FRigVMDecorator The base class for all RigVM decorators.  
Public struct FRigVMDispatchContext A context used for inquiring from dispatch factories  
Public struct UStruct FRigVMDispatchFactory A factory to generate a template and its dispatch functions  
Public struct UStruct FRigVMDrawContainer    
Public struct UStruct FRigVMDrawInstruction    
Public struct UStruct FRigVMDrawInterface    
Public struct FRigVMExecuteArgument The FRigVMExecuteArgument describes an execute argument.  
Public struct UStruct BlueprintType meta FRigVMExecuteContext The execute context is used for mutable nodes to indicate execution order.  
Public struct UStruct FRigVMExecuteOp Execute a function  
Public struct UStruct blueprintable FRigVMExtendedExecuteContext The execute context is used for mutable nodes to indicate execution order.  
Public struct UStruct FRigVMExternalVariable    
Public struct UStruct BlueprintType FRigVMExternalVariableDef The external variable can be used to map external / unowned memory into the VM and back out  
Public struct FRigVMExternalVariableRuntimeData    
Public struct FRigVMFunction The FRigVMFunction is used to represent a function pointer generated by UHT for a given name.  
Public struct FRigVMFunctionArgument The FRigVMFunctionArgument describes an argument necessary for the C++ invocation of the RIGVM_METHOD backed function  
Public struct UStruct BlueprintType FRigVMFunctionCompilationData    
Public struct UStruct FRigVMFunctionCompilationPropertyDescription    
Public struct UStruct FRigVMFunctionCompilationPropertyPath    
Public struct UStruct BlueprintType FRigVMGraphFunctionArgument    
Public struct UStruct BlueprintType FRigVMGraphFunctionData    
Public struct UStruct BlueprintType FRigVMGraphFunctionHeader    
Public struct UStruct BlueprintType FRigVMGraphFunctionIdentifier    
Public struct UStruct FRigVMGraphFunctionStore A management struct containing graph functions.  
Public struct UStruct FRigVMInstruction The FRigVMInstruction represents a single instruction within the VM.  
Public struct UStruct FRigVMInstructionArray The FRigVMInstructionArray represents all current instructions within a RigVM and can be used to iterate over all operators and retrieve each instruction's data.  
Public struct UStruct FRigVMInvokeEntryOp Invoke another entry  
Public struct UStruct FRigVMJumpIfOp Jump to a new instruction index based on a condition.  
Public struct UStruct FRigVMJumpOp Jump to a new instruction index.  
Public struct UStruct FRigVMJumpToBranchOp Jump into a branch based on a name argument  
Public struct FRigVMLazyBranch A branch which can be lazily executed  
Public struct FRigVMLazyBranchInstanceData Lazy branch data required by each instance of the VM  
Public struct FRigVMLog    
Public struct UStruct FRigVMMemoryContainer The FRigVMMemoryContainer provides a heterogeneous memory container to store arbitrary data.  
Public struct FRigVMMemoryHandle Memory handle.  
Public struct UStruct BlueprintType FRigVMMemoryStatistics    
Public class FRigVMNameCache    
Public struct FRigVMNameOp    
Public struct UStruct FRigVMOperand The FRigVMOperand represents an argument used for an operator within the virtual machine.  
Public struct UStruct BlueprintType FRigVMParameter The RigVMParameter define an input or output of the RigVM.  
Public class FRigVMPeformUserWorkflowDynamicDelegate    
Public struct UStruct FRigVMPredicateBranch A description of a predicate branch in the VM's bytecode.  
Public struct FRigVMPropertyDescription Property Management.  
Public class FRigVMPropertyPath The RigVMPropertyPath is used to access a memory pointer for a tail property given the memory of the head property.  
Public struct FRigVMPropertyPathDescription The RigVMPropertyPathDescription is used to provide all of the information necessary to describe a property path for creating it.  
Public struct FRigVMPropertyPathSegment The RigVMPropertyPathSegment represents a single step needed to go from the head property of a property path to the tail.  
Public struct UStruct FRigVMQuaternaryOp Operator used for some array operations  
Public struct UStruct FRigVMQuinaryOp Operator used for some array operations  
Public struct UStruct FRigVMRegister The register represents an address with the VM's memory.  
Public struct UStruct FRigVMRegisterOffset The register offset represents a memory offset within a register's memory.  
Public struct FRigVMRegistry The FRigVMRegistry is used to manage all known function pointers for use in the RigVM.  
Public struct UStruct FRigVMRuntimeSettings    
Public struct UStruct FRigVMSenaryOp Operator used for some array operations  
Public struct UStruct FRigVMSlice    
Public struct UStruct BlueprintType FRigVMStatistics    
Public struct UStruct FRigVMStruct The base class for all RigVM enabled structs.  
Public struct UStruct FRigVMStructMutable The base mutable class for all RigVM enabled structs.  
Public class FRigVMStructTestBase    
Public struct FRigVMStructUpgradeInfo Structure used to upgrade to a new implementation of a node  
Public struct FRigVMTemplate The template is used to group multiple rigvm functions that share the same notation.  
Public struct FRigVMTemplateArgument The template argument represents a single parameter in a function call and all of its possible types  
Public struct UStruct FRigVMTemplateArgumentType    
Public struct FRigVMTemplateDelegates    
Public struct UStruct FRigVMTernaryOp Operator used for some array operations  
Public struct UStruct FRigVMUnaryOp Operator used for zero, false, true, increment, decrement  
Public struct FRigVMUnitNodeCreatedContext A context struct passed to FRigVMStruct::OnUnitNodeCreated  
Public struct UStruct meta FRigVMUnknownType The unknown type is used to identify untyped nodes  
Public struct UStruct BlueprintType FRigVMUserWorkflow    
Public class IRigVMGraphFunctionHost Interface that allows an object to host a rig VM graph function Host.  
Public struct TRigVMIsBaseStructure    
Public struct TRigVMIsBool    
Public struct TRigVMIsDouble    
Public struct TRigVMIsFloat    
Public struct TRigVMIsInt32    
Public struct TRigVMIsName    
Public struct TRigVMIsString    
Public struct TRigVMLazyValue A template container for a lazily computed value  
Public struct TRigVMLazyValueBase A template container for a lazily computed value  
Public class UClass BlueprintType UDataAssetLink Namespaced user data which provides access to a linked data asset  
Public class UClass Abstract UNameSpacedUserData User data that can be attached to assets to provide namespaced data access.  
Public class UClass BlueprintType URigVM The RigVM is the main object for evaluating FRigVMByteCode instructions.  
Public class URigVMGraphFunctionHost    
Public class UClass URigVMMemoryStorage The URigVMMemoryStorage represents an instance of heterogeneous memory.  
Public class UClass URigVMMemoryStorageGeneratorClass The URigVMMemoryStorageGeneratorClass is used to create / represent heterogeneous memory storages.  
Public class UClass Abstract BlueprintType URigVMNativized    
Public class UClass BlueprintType URigVMUserWorkflowOptions    

Typedefs

Name Description
FRigVMBindPinToExternalVariableDelegate  
FRigVMByteArray  
FRigVMCreateExternalVariableDelegate  
FRigVMFunctionArgumentArray  
FRigVMFunctionPtr  
FRigVMGetExternalVariablesDelegate Delegates used for variable introspection / creation
FRigVMMemoryHandleArray  
FRigVMNestedByteArray  
FRigVMOperandArray  
FRigVMPerformUserWorkflowDelegate  
FRigVMPredicateBranchArray  
FRigVMReportDelegate  
FRigVMTemplate_GetDispatchFactoryDelegate  
FRigVMTemplate_NewArgumentTypeDelegate  
FRigVMTemplate_RequestDispatchFunctionDelegate  
FRigVMTemplate_RequestDispatchPredicatesDelegate  
FRigVMTemplateTypeMap  
TRigVMTypeIndex  

Enums

  Type Name Description
Public enum UEnum ERigVMBreakpointAction Possible actions when the VM is halted at a breakpoint.  
Public enum UEnum ERigVMCopyType The kind of copy operation to perform.  
Public enum ERigVMDrawSettings::Primitive    
Public enum ERigVMExecuteResult    
Public enum UEnum BlueprintType ERigVMFunctionArgumentDirection The Function Argument is used to differentiate different kinds of pins in the data flow graph - inputs or outputs  
Public enum UEnum ERigVMMemoryType The ERigVMMemoryType maps to memory container index in RigVM through FRigVMOperand::GetContainerIndex() or URigVM::GetContainerIndex(...) The type of memory used.  
Public enum ERigVMNameOp    
Public enum ERigVMNodeCreatedReason Context as of why the node was created  
Public enum UEnum ERigVMOpCode The code for a single operation within the RigVM.  
Public enum UEnum BlueprintType ERigVMParameterType The type of parameter for a VM.  
Public enum UEnum BlueprintType ERigVMPinDirection The Pin Direction is used to differentiate different kinds of pins in the data flow graph - inputs, outputs etc.  
Public enum ERigVMPropertyPathSegmentType The RigVMPropertyPathSegmentType is used to differentiate segments under a property path.  
Public enum UEnum ERigVMRegisterType The type of register within the memory.  
Public enum UEnum BlueprintType ERigVMUserWorkflowType Types of workflows offered by a rigvm struct node.  

Functions

  Type Name Description
Public function void

RigVMCopy ( void* InTargetPtr,
const void* InSourcePtr,
int32 InCount
)

  
Public function void

RigVMDestroy ( void* InPtr,
int32 InCount
)

  
Public function void

RigVMInitialize ( void* InPtr,
int32 InCount
)

  
Public function FRigVMExternalVariable  
Public function FRigVMExternalVariable

RigVMTypeUtils::ExternalVariableFromBPVariableDescription ( const FBPVariableDescription& InVariableDescription,
void* Container
)

  
Public function FRigVMExternalVariable

RigVMTypeUtils::ExternalVariableFromCPPType ( const FName& InName,
const FString& InCPPType,
UObject* InCPPTypeObject,
bool bInPublic,
bool bInReadonly
)

  
Public function FRigVMExternalVariable

RigVMTypeUtils::ExternalVariableFromCPPTypePath ( const FName& InName,
const FString& InCPPTypePath,
bool bInPublic,
bool bInReadonly
)

  
Public function FRigVMExternalVariable

RigVMTypeUtils::ExternalVariableFromPinType ( const FName& InName,
const FEdGraphPinType& InPinType,
bool bInPublic,
bool bInReadonly
)

  
Public function TArray< FRigVMExternalVariableDef >  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page