Files
UnrealEngineUWP/Engine/Source/Developer/RigVMDeveloper/Private/RigVMModel/Nodes/RigVMArrayNode.cpp
jack cai bd96706d1f RigVM: 1. Added missing execute context type patching during argument type registration.The same patching process was already in place for when arguments were initially created using FRigVMTemplateArgument 2. fixed a typo in Array node
#jira UE-161021 UE-160890
#rb Sara.Schvartzman, Helge.mathee, benoit.gadreau
#preflight tbd

#ROBOMERGE-OWNER: jack.cai
#ROBOMERGE-AUTHOR: jack.cai
#ROBOMERGE-SOURCE: CL 21425787 via CL 21430778 via CL 21431948 via CL 21432077
#ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v980-21429816)

[CL 21434623 by jack cai in ue5-main branch]
2022-08-17 19:07:05 -04:00

850 lines
28 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "RigVMModel/Nodes/RigVMArrayNode.h"
#include "RigVMModel/RigVMGraph.h"
#include "RigVMCore/RigVMStruct.h"
const FString URigVMArrayNode::ArrayName = TEXT("Array");
const FString URigVMArrayNode::NumName = TEXT("Num");
const FString URigVMArrayNode::IndexName = TEXT("Index");
const FString URigVMArrayNode::ElementName = TEXT("Element");
const FString URigVMArrayNode::SuccessName = TEXT("Success");
const FString URigVMArrayNode::OtherName = TEXT("Other");
const FString URigVMArrayNode::CloneName = TEXT("Clone");
const FString URigVMArrayNode::CountName = TEXT("Count");
const FString URigVMArrayNode::RatioName = TEXT("Ratio");
const FString URigVMArrayNode::ResultName = TEXT("Result");
const FString URigVMArrayNode::ContinueName = TEXT("Continue");
const FString URigVMArrayNode::CompletedName = TEXT("Completed");
URigVMArrayNode::URigVMArrayNode()
: OpCode(ERigVMOpCode::Invalid)
{
}
FString URigVMArrayNode::GetNodeTitle() const
{
return GetNodeTitle(OpCode);
}
FString URigVMArrayNode::GetNodeTitle(ERigVMOpCode InOpCode)
{
if(InOpCode == ERigVMOpCode::ArrayGetAtIndex)
{
static const FString ArrayGetAtIndexNodeTitle = TEXT("At");
return ArrayGetAtIndexNodeTitle;
}
else if(InOpCode == ERigVMOpCode::ArraySetAtIndex)
{
static const FString ArraySetAtIndexNodeTitle = TEXT("Set At");
return ArraySetAtIndexNodeTitle;
}
else if(InOpCode == ERigVMOpCode::ArrayGetNum)
{
static const FString ArrayGetNumNodeTitle = TEXT("Num");
return ArrayGetNumNodeTitle;
}
else if(InOpCode == ERigVMOpCode::ArrayIterator)
{
static const FString ArrayIteratorNodeTitle = TEXT("For Each");
return ArrayIteratorNodeTitle;
}
FString OpCodeString = StaticEnum<ERigVMOpCode>()->GetDisplayNameTextByValue((int64)InOpCode).ToString();
OpCodeString.RemoveFromStart(URigVMArrayNode::ArrayName);
return OpCodeString;
}
FText URigVMArrayNode::GetToolTipText() const
{
switch(OpCode)
{
case ERigVMOpCode::ArrayReset:
{
return FText::FromString(TEXT("Removes all elements from an array.\nModifies the input array."));
}
case ERigVMOpCode::ArrayGetNum:
{
return FText::FromString(TEXT("Returns the number of elements of an array"));
}
case ERigVMOpCode::ArraySetNum:
{
return FText::FromString(TEXT("Sets the numbers of elements of an array.\nModifies the input array."));
}
case ERigVMOpCode::ArrayGetAtIndex:
{
return FText::FromString(TEXT("Returns an element of an array by index."));
}
case ERigVMOpCode::ArraySetAtIndex:
{
return FText::FromString(TEXT("Sets an element of an array by index.\nModifies the input array."));
}
case ERigVMOpCode::ArrayAdd:
{
return FText::FromString(TEXT("Adds an element to an array and returns the new element's index.\nModifies the input array."));
}
case ERigVMOpCode::ArrayInsert:
{
return FText::FromString(TEXT("Inserts an element into an array at a given index.\nModifies the input array."));
}
case ERigVMOpCode::ArrayRemove:
{
return FText::FromString(TEXT("Removes an element from an array by index.\nModifies the input array."));
}
case ERigVMOpCode::ArrayFind:
{
return FText::FromString(TEXT("Searchs a potential element in an array and returns its index."));
}
case ERigVMOpCode::ArrayAppend:
{
return FText::FromString(TEXT("Appends the another array to the main one.\nModifies the input array."));
}
case ERigVMOpCode::ArrayClone:
{
return FText::FromString(TEXT("Clones an array and returns a duplicate."));
}
case ERigVMOpCode::ArrayIterator:
{
return FText::FromString(TEXT("Loops over the elements in an array."));
}
case ERigVMOpCode::ArrayUnion:
{
return FText::FromString(TEXT("Merges two arrays while ensuring unique elements.\nModifies the input array."));
}
case ERigVMOpCode::ArrayDifference:
{
return FText::FromString(TEXT("Creates a new array containing the difference between the two input arrays.\nDifference here means elements that are only contained in either A or B."));
}
case ERigVMOpCode::ArrayIntersection:
{
return FText::FromString(TEXT("Creates a new array containing the intersection between the two input arrays.\nDifference here means elements that are contained in both A and B."));
}
case ERigVMOpCode::ArrayReverse:
{
return FText::FromString(TEXT("Reverses the order of the elements of an array.\nModifies the input array."));
}
default:
{
ensure(false);
break;
}
}
return Super::GetToolTipText();
}
FName URigVMArrayNode::GetNotation() const
{
const FString TemplateName = StaticEnum<ERigVMOpCode>()->GetDisplayNameTextByValue((int64)OpCode).ToString();
switch(OpCode)
{
case ERigVMOpCode::ArrayReset:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName);
return Notation;
}
case ERigVMOpCode::ArrayGetNum:
{
static constexpr TCHAR Format[] = TEXT("%s(in %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *ArrayName, *NumName);
return Notation;
}
case ERigVMOpCode::ArraySetNum:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *NumName);
return Notation;
}
case ERigVMOpCode::ArrayGetAtIndex:
{
static constexpr TCHAR Format[] = TEXT("%s(in %s, in %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *ArrayName, *IndexName, *ElementName);
return Notation;
}
case ERigVMOpCode::ArraySetAtIndex:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s, in %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *IndexName, *ElementName);
return Notation;
}
case ERigVMOpCode::ArrayAdd:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *ElementName, *IndexName);
return Notation;
}
case ERigVMOpCode::ArrayInsert:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s, in %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *IndexName, *ElementName);
return Notation;
}
case ERigVMOpCode::ArrayRemove:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *IndexName);
return Notation;
}
case ERigVMOpCode::ArrayFind:
{
static constexpr TCHAR Format[] = TEXT("%s(in %s, in %s, out %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *ArrayName, *ElementName, *IndexName, *SuccessName);
return Notation;
}
case ERigVMOpCode::ArrayAppend:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *OtherName);
return Notation;
}
case ERigVMOpCode::ArrayClone:
{
static constexpr TCHAR Format[] = TEXT("%s(in %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *ArrayName, *CloneName);
return Notation;
}
case ERigVMOpCode::ArrayIterator:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, in %s, out %s, out %s, out %s, out %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(),
*ArrayName, *ElementName, *IndexName, *CountName, *RatioName, *CompletedName);
return Notation;
}
case ERigVMOpCode::ArrayUnion:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s, in %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName, *OtherName);
return Notation;
}
case ERigVMOpCode::ArrayDifference:
{
static constexpr TCHAR Format[] = TEXT("%s(in %s, in %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *ArrayName, *OtherName, *ResultName);
return Notation;
}
case ERigVMOpCode::ArrayIntersection:
{
static constexpr TCHAR Format[] = TEXT("%s(in %s, in %s, out %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *ArrayName, *OtherName, *ResultName);
return Notation;
}
case ERigVMOpCode::ArrayReverse:
{
static constexpr TCHAR Format[] = TEXT("%s(io %s, io %s)");
const FName Notation = *FString::Printf(Format, *TemplateName, *FRigVMStruct::ExecuteContextName.ToString(), *ArrayName);
return Notation;
}
default:
{
ensure(false);
break;
}
}
return Super::GetNotation();
}
const FRigVMTemplate* URigVMArrayNode::GetTemplate() const
{
if(const FRigVMTemplate* SuperTemplate = Super::GetTemplate())
{
return SuperTemplate;
}
if(CachedTemplate == nullptr)
{
static TArray<const FRigVMTemplate*> TemplatesPerOpCode;
static TArray<TArray<FRigVMTemplateArgument>> ArgumentsPerOpCode;
if(TemplatesPerOpCode.IsEmpty() || ArgumentsPerOpCode.IsEmpty())
{
constexpr int32 NumArrayOpCodes = int32(ERigVMOpCode::LastArrayOpCode) - int32(ERigVMOpCode::FirstArrayOpCode) + 1;
TemplatesPerOpCode.SetNumZeroed(NumArrayOpCodes);
ArgumentsPerOpCode.SetNum(NumArrayOpCodes);
}
const int32 OpCodeIndex = int32(OpCode) - int32(ERigVMOpCode::FirstArrayOpCode);
if(TemplatesPerOpCode[OpCodeIndex])
{
CachedTemplate = TemplatesPerOpCode[OpCodeIndex];
return TemplatesPerOpCode[OpCodeIndex];
}
static const FName ExecuteFName = FRigVMStruct::ExecuteContextName;
static const FName ArrayFName = *ArrayName;
static const FName NumFName = *NumName;
static const FName IndexFName = *IndexName;
static const FName ElementFName = *ElementName;
static const FName SuccessFName = *SuccessName;
static const FName OtherFName = *OtherName;
static const FName CloneFName = *CloneName;
static const FName CountFName = *CountName;
static const FName RatioFName = *RatioName;
static const FName ResultFName = *ResultName;
static const FName ContinueFName = *ContinueName;
static const FName CompletedFName = *CompletedName;
TArray<FRigVMTemplateArgument>& Arguments = ArgumentsPerOpCode[OpCodeIndex];
if(Arguments.IsEmpty())
{
Arguments.Reserve(8);
static const TArray<FRigVMTemplateArgument::ETypeCategory> SingleCategory = {FRigVMTemplateArgument::ETypeCategory_SingleAnyValue};
static const TArray<FRigVMTemplateArgument::ETypeCategory> ArrayCategory = {FRigVMTemplateArgument::ETypeCategory_ArrayAnyValue};
UScriptStruct* ExecuteStruct = GetGraph()->GetExecuteContextStruct();
const FRigVMTemplateArgumentType ExecuteType(*ExecuteStruct->GetStructCPPName(), ExecuteStruct);
const int32 ExecuteTypeIndex = FRigVMRegistry::Get().FindOrAddType(ExecuteType);
switch(OpCode)
{
case ERigVMOpCode::ArrayReset:
case ERigVMOpCode::ArrayReverse:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::IO, ArrayCategory);
break;
}
case ERigVMOpCode::ArrayGetNum:
{
Arguments.Emplace(ArrayFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(NumFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Int32);
break;
}
case ERigVMOpCode::ArraySetNum:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::IO, ArrayCategory);
Arguments.Emplace(NumFName, ERigVMPinDirection::Input, RigVMTypeUtils::TypeIndex::Int32);
break;
}
case ERigVMOpCode::ArrayGetAtIndex:
{
Arguments.Emplace(ArrayFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(IndexFName, ERigVMPinDirection::Input, RigVMTypeUtils::TypeIndex::Int32);
Arguments.Emplace(ElementFName, ERigVMPinDirection::Output, SingleCategory);
break;
}
case ERigVMOpCode::ArraySetAtIndex:
case ERigVMOpCode::ArrayInsert:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::IO, ArrayCategory);
Arguments.Emplace(IndexFName, ERigVMPinDirection::Input, RigVMTypeUtils::TypeIndex::Int32);
Arguments.Emplace(ElementFName, ERigVMPinDirection::Input, SingleCategory);
break;
}
case ERigVMOpCode::ArrayAdd:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::IO, ArrayCategory);
Arguments.Emplace(ElementFName, ERigVMPinDirection::Input, SingleCategory);
Arguments.Emplace(IndexFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Int32);
break;
}
case ERigVMOpCode::ArrayRemove:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::IO, ArrayCategory);
Arguments.Emplace(IndexFName, ERigVMPinDirection::Input, RigVMTypeUtils::TypeIndex::Int32);
break;
}
case ERigVMOpCode::ArrayFind:
{
Arguments.Emplace(ArrayFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(ElementFName, ERigVMPinDirection::Input, SingleCategory);
Arguments.Emplace(IndexFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Int32);
Arguments.Emplace(SuccessFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Bool);
break;
}
case ERigVMOpCode::ArrayAppend:
case ERigVMOpCode::ArrayUnion:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::IO, ArrayCategory);
Arguments.Emplace(OtherFName, ERigVMPinDirection::Input, ArrayCategory);
break;
}
case ERigVMOpCode::ArrayClone:
{
Arguments.Emplace(ArrayFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(CloneFName, ERigVMPinDirection::Output, ArrayCategory);
break;
}
case ERigVMOpCode::ArrayIterator:
{
Arguments.Emplace(ExecuteFName, ERigVMPinDirection::IO, ExecuteTypeIndex);
Arguments.Emplace(ArrayFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(ElementFName, ERigVMPinDirection::Output, SingleCategory);
Arguments.Emplace(IndexFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Int32);
Arguments.Emplace(CountFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Int32);
Arguments.Emplace(RatioFName, ERigVMPinDirection::Output, RigVMTypeUtils::TypeIndex::Float);
Arguments.Emplace(ContinueFName, ERigVMPinDirection::Hidden, RigVMTypeUtils::TypeIndex::Bool);
Arguments.Emplace(CompletedFName, ERigVMPinDirection::Output, ExecuteTypeIndex);
break;
}
case ERigVMOpCode::ArrayDifference:
case ERigVMOpCode::ArrayIntersection:
{
Arguments.Emplace(ArrayFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(OtherFName, ERigVMPinDirection::Input, ArrayCategory);
Arguments.Emplace(ResultFName, ERigVMPinDirection::Output, ArrayCategory);
break;
}
default:
{
ensure(false);
break;
}
}
}
const FRigVMTemplateArgumentType ExecuteType(GetGraph()->GetExecuteContextStruct());
const int32 ExecuteTypeIndex = FRigVMRegistry::Get().FindOrAddType(ExecuteType);
const FString TemplateName = StaticEnum<ERigVMOpCode>()->GetDisplayNameTextByValue((int64)OpCode).ToString();
FRigVMTemplateDelegates Delegates;
Delegates.NewArgumentTypeDelegate =
FRigVMTemplate_NewArgumentTypeDelegate::CreateLambda([OpCodeIndex, ExecuteTypeIndex](const FRigVMTemplate*, const FName& InArgumentName, int32 InTypeIndex)
{
FRigVMTemplateTypeMap Types;
const ERigVMOpCode CurrentOpCode = (ERigVMOpCode)(OpCodeIndex + int32(ERigVMOpCode::FirstArrayOpCode));
const FRigVMRegistry& Registry = FRigVMRegistry::Get();
switch(CurrentOpCode)
{
case ERigVMOpCode::ArrayReset:
case ERigVMOpCode::ArrayReverse:
{
if(InArgumentName == ArrayFName)
{
Types.Add(ExecuteFName, ExecuteTypeIndex);
Types.Add(ArrayFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArrayGetNum:
{
if(InArgumentName == ArrayFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(NumFName, RigVMTypeUtils::TypeIndex::Int32);
}
break;
}
case ERigVMOpCode::ArraySetNum:
{
if(InArgumentName == ArrayFName)
{
Types.Add(ExecuteFName, ExecuteTypeIndex);
Types.Add(ArrayFName, InTypeIndex);
Types.Add(NumFName, RigVMTypeUtils::TypeIndex::Int32);
}
break;
}
case ERigVMOpCode::ArrayGetAtIndex:
{
Types.Add(IndexFName, RigVMTypeUtils::TypeIndex::Int32);
if(InArgumentName == ArrayFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(ElementFName, Registry.GetBaseTypeFromArrayTypeIndex(InTypeIndex));
}
else if(InArgumentName == ElementFName)
{
Types.Add(ArrayFName, Registry.GetArrayTypeFromBaseTypeIndex(InTypeIndex));
Types.Add(ElementFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArraySetAtIndex:
case ERigVMOpCode::ArrayInsert:
case ERigVMOpCode::ArrayAdd:
{
Types.Add(ExecuteFName, ExecuteTypeIndex);
Types.Add(IndexFName, RigVMTypeUtils::TypeIndex::Int32);
if(InArgumentName == ArrayFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(ElementFName, Registry.GetBaseTypeFromArrayTypeIndex(InTypeIndex));
}
else if(InArgumentName == ElementFName)
{
Types.Add(ArrayFName, Registry.GetArrayTypeFromBaseTypeIndex(InTypeIndex));
Types.Add(ElementFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArrayRemove:
{
if(InArgumentName == ArrayFName)
{
Types.Add(ExecuteFName, ExecuteTypeIndex);
Types.Add(ArrayFName, InTypeIndex);
Types.Add(IndexFName, RigVMTypeUtils::TypeIndex::Int32);
}
break;
}
case ERigVMOpCode::ArrayFind:
{
Types.Add(IndexFName, RigVMTypeUtils::TypeIndex::Int32);
Types.Add(SuccessFName, RigVMTypeUtils::TypeIndex::Bool);
if(InArgumentName == ArrayFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(ElementFName, Registry.GetBaseTypeFromArrayTypeIndex(InTypeIndex));
}
else if(InArgumentName == ElementFName)
{
Types.Add(ArrayFName, Registry.GetArrayTypeFromBaseTypeIndex(InTypeIndex));
Types.Add(ElementFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArrayAppend:
case ERigVMOpCode::ArrayUnion:
{
Types.Add(ExecuteFName, ExecuteTypeIndex);
if(InArgumentName == ArrayFName || InArgumentName == OtherFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(OtherFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArrayClone:
{
if(InArgumentName == ArrayFName || InArgumentName == CloneFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(CloneFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArrayIterator:
{
Types.Add(ExecuteFName, ExecuteTypeIndex);
Types.Add(ContinueFName, RigVMTypeUtils::TypeIndex::Bool);
Types.Add(CompletedFName, ExecuteTypeIndex);
Types.Add(IndexFName, RigVMTypeUtils::TypeIndex::Int32);
Types.Add(CountFName, RigVMTypeUtils::TypeIndex::Int32);
Types.Add(RatioFName, RigVMTypeUtils::TypeIndex::Float);
if(InArgumentName == ArrayFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(ElementFName, Registry.GetBaseTypeFromArrayTypeIndex(InTypeIndex));
}
else if(InArgumentName == ElementFName)
{
Types.Add(ArrayFName, Registry.GetArrayTypeFromBaseTypeIndex(InTypeIndex));
Types.Add(ElementFName, InTypeIndex);
}
break;
}
case ERigVMOpCode::ArrayDifference:
case ERigVMOpCode::ArrayIntersection:
{
if(InArgumentName == ArrayFName || InArgumentName == OtherFName || InArgumentName == ResultFName)
{
Types.Add(ArrayFName, InTypeIndex);
Types.Add(OtherFName, InTypeIndex);
Types.Add(ResultFName, InTypeIndex);
}
break;
}
default:
{
ensure(false);
break;
}
}
return Types;
});
TemplatesPerOpCode[OpCodeIndex] = CachedTemplate = FRigVMRegistry::Get().GetOrAddTemplateFromArguments(*TemplateName, Arguments, Delegates);
}
return CachedTemplate;
}
bool URigVMArrayNode::IsLoopNode() const
{
return GetOpCode() == ERigVMOpCode::ArrayIterator;
}
FText URigVMArrayNode::GetToolTipTextForPin(const URigVMPin* InPin) const
{
switch(OpCode)
{
case ERigVMOpCode::ArrayReset:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to be cleared."));
}
break;
}
case ERigVMOpCode::ArrayGetNum:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to retrieve the size for."));
}
else if(InPin->GetName() == URigVMArrayNode::NumName)
{
return FText::FromString(TEXT("The size of the input array."));
}
break;
}
case ERigVMOpCode::ArraySetNum:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to set the size for."));
}
else if(InPin->GetName() == URigVMArrayNode::NumName)
{
return FText::FromString(TEXT("The new size of the array."));
}
break;
}
case ERigVMOpCode::ArrayGetAtIndex:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to retrieve an element from."));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index of the element to retrieve."));
}
else if(InPin->GetName() == URigVMArrayNode::ElementName)
{
return FText::FromString(TEXT("The element at the given index."));
}
break;
}
case ERigVMOpCode::ArraySetAtIndex:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to set an element for."));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index of the element to set."));
}
else if(InPin->GetName() == URigVMArrayNode::ElementName)
{
return FText::FromString(TEXT("The new value for element to set."));
}
break;
}
case ERigVMOpCode::ArrayAdd:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to add an element to."));
}
else if(InPin->GetName() == URigVMArrayNode::ElementName)
{
return FText::FromString(TEXT("The element to add to the array."));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index of the newly added element."));
}
break;
}
case ERigVMOpCode::ArrayInsert:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to insert an element into."));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index at which to insert the element."));
}
else if(InPin->GetName() == URigVMArrayNode::ElementName)
{
return FText::FromString(TEXT("The element to insert into the array."));
}
break;
}
case ERigVMOpCode::ArrayRemove:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to remove an element from."));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index at which to remove the element."));
}
break;
}
case ERigVMOpCode::ArrayFind:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to search within."));
}
else if(InPin->GetName() == URigVMArrayNode::ElementName)
{
return FText::FromString(TEXT("The element to look for."));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index of the found element (or -1)."));
}
else if(InPin->GetName() == URigVMArrayNode::SuccessName)
{
return FText::FromString(TEXT("True if the element has been found."));
}
break;
}
case ERigVMOpCode::ArrayAppend:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to append the other array to."));
}
else if(InPin->GetName() == URigVMArrayNode::OtherName)
{
return FText::FromString(TEXT("The second array to append to the first one."));
}
break;
}
case ERigVMOpCode::ArrayClone:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to clone"));
}
else if(InPin->GetName() == URigVMArrayNode::CloneName)
{
return FText::FromString(TEXT("The duplicate of the input array."));
}
break;
}
case ERigVMOpCode::ArrayIterator:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to iterate over"));
}
else if(InPin->GetName() == URigVMArrayNode::IndexName)
{
return FText::FromString(TEXT("The index of the current element."));
}
else if(InPin->GetName() == URigVMArrayNode::CountName)
{
return FText::FromString(TEXT("The count of all elements in the array."));
}
else if(InPin->GetName() == URigVMArrayNode::ElementName)
{
return FText::FromString(TEXT("The current element."));
}
else if(InPin->GetName() == URigVMArrayNode::RatioName)
{
return FText::FromString(TEXT("A float ratio from 0.0 (first element) to 1.0 (last element)."));
}
else if(InPin->GetName() == URigVMArrayNode::CompletedName)
{
return FText::FromString(TEXT("The execute block to run once the loop has completed."));
}
break;
}
case ERigVMOpCode::ArrayUnion:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array to merge the other array with."));
}
else if(InPin->GetName() == URigVMArrayNode::OtherName)
{
return FText::FromString(TEXT("The second array to merge to the first one."));
}
break;
}
case ERigVMOpCode::ArrayDifference:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The first array to compare the other array with."));
}
else if(InPin->GetName() == URigVMArrayNode::OtherName)
{
return FText::FromString(TEXT("The second array to compare the other array with."));
}
else if(InPin->GetName() == URigVMArrayNode::ResultName)
{
return FText::FromString(TEXT("The resulting difference array."));
}
break;
}
case ERigVMOpCode::ArrayIntersection:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The first array to compare the other array with."));
}
else if(InPin->GetName() == URigVMArrayNode::OtherName)
{
return FText::FromString(TEXT("The second array to compare the other array with."));
}
else if(InPin->GetName() == URigVMArrayNode::ResultName)
{
return FText::FromString(TEXT("The resulting intersecting array."));
}
break;
}
case ERigVMOpCode::ArrayReverse:
{
if(InPin->GetName() == URigVMArrayNode::ArrayName)
{
return FText::FromString(TEXT("The array reverse."));
}
break;
}
default:
{
ensure(false);
break;
}
}
return Super::GetToolTipTextForPin(InPin);
}
FLinearColor URigVMArrayNode::GetNodeColor() const
{
return FLinearColor::White;
}
ERigVMOpCode URigVMArrayNode::GetOpCode() const
{
return OpCode;
}
FString URigVMArrayNode::GetCPPType() const
{
URigVMPin* ArrayPin = FindPin(ArrayName);
if (ArrayPin == nullptr)
{
return FString();
}
return RigVMTypeUtils::BaseTypeFromArrayType(ArrayPin->GetCPPType());
}
UObject* URigVMArrayNode::GetCPPTypeObject() const
{
URigVMPin* ArrayPin = FindPin(ArrayName);
if (ArrayPin == nullptr)
{
return nullptr;
}
return ArrayPin->GetCPPTypeObject();
}