1. Epic GamesDeveloper
  3. RigVM

RigVM

API > API/Plugins

Filters

Classes

  Type Name Description
Public class FRigVMBracketScope    
Public struct UStruct FRigVMGraphFunctionHeaderArray    
Public class FRigVMModule The public interface to this module  
Public struct FRigVMObjectVersion Copyright Epic Games, Inc. All Rights Reserved.  
Public struct FRigVMUserDefinedTypeResolver    
Public class TypeIndex    
Public class UClass URigVMBlueprintGeneratedClass    
Public class UClass Meta Config URigVMEditorSettings Customize RigVM Rig Editor.  
Public class UClass Abstract editinlinenew URigVMHost    

Enums

  Type Name Description
Public enum RigVMTypeUtils::EClassArgType A UClass argument is used to signify both the object type and its class type.  

Functions

  Type Name Description
Public function bool  
Public function bool  
Public function uint32

RigVMPropertyUtils::GetPropertyHashFast ( const FProperty* InProperty,
const uint8* InMemory,
EPropertyPointerType InContainerType
)

 Given a property and a value storage for it, return a 32-bit hash value for the underlying value of tha type.
Public function uint32

RigVMPropertyUtils::GetPropertyHashStable ( const FProperty* InProperty,
const uint8* InMemory,
EPropertyPointerType InContainerType
)

 Given a property and a value storage for it, return a 32-bit hash value for the underlying value of tha type.
Public function void

RigVMPropertyUtils::GetTypeFromProperty ( const FProperty* InProperty,
FName& OutTypeName,
UObject*& OutTypeObject
)

 Given a property, return the C++ type name for it and the associated type object.
Public function FString Joins the name value pairs into a single default value string.
Public function FString

RigVMStringUtils::JoinNodePath ( const FString& Left,
const FString& Right
)

 Joins a NodePath from to segments, so for example "CollapseNodeA" and "CollapseNodeB|CollapseNodeC" becomes "CollapseNodeA|CollapseNodeB|CollapseNodeC".
Public function FString Joins a NodePath from to segments, so for example ["CollapseNodeA", "CollapseNodeB", "CollapseNodeC"] becomes "CollapseNodeA|CollapseNodeB|CollapseNodeC".
Public function FString Joins a PinPath from to segments, so for example ["Node", "Color", "R"] becomes "Node.Color.R".
Public function FString

RigVMStringUtils::JoinPinPath ( const FString& Left,
const FString& Right
)

 Joins a PinPath from to segments, so for example "Node.Color" and "R" becomes "Node.Color.R".
Public function TArray< FString >

RigVMStringUtils::SplitDefaultValue ( const FString& InDefaultValue
)

 Splits the default value into name-value pairs.
Public function bool

RigVMStringUtils::SplitNodePath ( const FString& InNodePath,
TArray< FString >& Parts
)

 Splits a NodePath into all segments, so for example "Node.Color.R" becomes ["Node", "Color", "R"].
Public function bool

RigVMStringUtils::SplitNodePathAtEnd ( const FString& InNodePath,
FString& Left,
FString& RightMost
)

 Splits a NodePath at the end, so for example "CollapseNodeA|CollapseNodeB|CollapseNodeC" becomes "CollapseNodeA|CollapseNodeB" and "CollapseNodeC".
Public function bool

RigVMStringUtils::SplitNodePathAtStart ( const FString& InNodePath,
FString& LeftMost,
FString& Right
)

 Splits a NodePath at the start, so for example "CollapseNodeA|CollapseNodeB|CollapseNodeC" becomes "CollapseNodeA" and "CollapseNodeB|CollapseNodeC".
Public function bool

RigVMStringUtils::SplitPinPath ( const FString& InPinPath,
TArray< FString >& Parts
)

 Splits a PinPath into all segments, so for example "Node.Color.R" becomes ["Node", "Color", "R"].
Public function bool

RigVMStringUtils::SplitPinPathAtEnd ( const FString& InPinPath,
FString& Left,
FString& RightMost
)

 Splits a PinPath at the start, so for example "Node.Color.R" becomes "Node.Color" and "R".
Public function bool

RigVMStringUtils::SplitPinPathAtStart ( const FString& InPinPath,
FString& LeftMost,
FString& Right
)

 Splits a PinPath at the start, so for example "Node.Color.R" becomes "Node" and "Color.R".
Public function Static bool

RigVMTypeUtils::AreCompatible ( const FProperty* InSourceProperty,
const FProperty* InTargetProperty
)

  
Public function FString  
Public function FString  
Public function const FLazyName  
Public function const FLazyName  
Public function FString

RigVMTypeUtils::CPPTypeFromEnum ( const UEnum* InEnum
)

  
Public function Static FString

RigVMTypeUtils::CPPTypeFromObject ( const UObject* InCPPTypeObject,
EClassArgType InClassArgType
)

  
Public function const FLazyName  
Public function const FLazyName  
Public function Static T *  
Public function Static UObject * Helper function to retrieve an object from a path
Public function Static UObject *

RigVMTypeUtils::FindObjectGlobally ( const TCHAR* InObjectName,
bool bUseRedirector
)

  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function FString

RigVMTypeUtils::GetUniqueStructTypeName ( const UScriptStruct* InScriptStruct
)

  
Public function FString

RigVMTypeUtils::GetUniqueStructTypeName ( const FGuid& InStructGuid
)

  
Public function Static const FString &  
Public function Static const FName &  
Public function Static const FString &  
Public function Static const FName &  
Public function Static UScriptStruct *  
Public function const FLazyName  
Public function const FLazyName  
Public function bool

RigVMTypeUtils::IsArrayType ( const FString& InCPPType
)

 Returns true if the type specified is an array.
Public function bool  
Public function bool

RigVMTypeUtils::IsUClassType ( const FString& InCPPType
)

  
Public function bool

RigVMTypeUtils::IsUObjectType ( const FString& InCPPType
)

  
Public function Static UObject *

RigVMTypeUtils::ObjectFromCPPType ( FString& InOutCPPType,
bool bUseRedirector,
const FRigVMUserDefinedTypeResolver* InTypeResolver
)

 Finds the CPPTypeObject from the CPPType. If not found, tries to use redirectors and modifies the InOutCPPType.
Public function Static FString

RigVMTypeUtils::PostProcessCPPType ( const FString& InCPPType,
UObject* InCPPTypeObject,
const FRigVMUserDefinedTypeResolver* InResolvalInfo
)

  
Public function Static bool  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function const FLazyName  
Public function UObject * Finds the CPPTypeObject from a CPP type of a potentially missing / unloaded user defined struct or enum.

Variables

  Type Name Description
Public variable const TCHAR * BoolArrayType  
Public variable const TCHAR * BoolType  
Public variable const TCHAR * DoubleArrayType  
Public variable const TCHAR * DoubleType  
Public variable const TCHAR * FloatArrayType  
Public variable const TCHAR * FloatType  
Public variable const TCHAR * FNameArrayType  
Public variable const TCHAR * FNameType  
Public variable const TCHAR * FStringArrayType  
Public variable const TCHAR * FStringType  
Public variable const TCHAR * FTextArrayType  
Public variable const TCHAR * FTextType  
Public variable const TCHAR * Int32ArrayType  
Public variable const TCHAR * Int32Type  
Public variable const TCHAR[] TArrayPrefix  
Public variable const TCHAR[] TArrayTemplate  
Public variable const TCHAR[] TObjectPtrPrefix  
Public variable const TCHAR[] TObjectPtrTemplate  
Public variable const TCHAR[] TScriptInterfacePrefix  
Public variable const TCHAR[] TScriptInterfaceTemplate  
Public variable const TCHAR[] TSubclassOfPrefix  
Public variable const TCHAR[] TSubclassOfTemplate  
Public variable const TCHAR * UInt32ArrayType  
Public variable const TCHAR * UInt32Type  
Public variable const TCHAR * UInt8ArrayType  
Public variable const TCHAR * UInt8Type  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page