birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #232 from aws-lumberyard-dev/carlitosan-sc-type-any

Browse Source 
Fixes for allowable Node/Variable palette types. LYN-3090
This commit is contained in:
carlitosan
2021-04-22 09:41:30 -07:00
committed by GitHub
parent 61fd73b467 f9799293c1
commit 77c79e4078
9 changed files with 140 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/ScriptCanvas/Code/Editor/View/Widgets/NodePalette/NodePaletteModel.cpp
+19 -41
View File
@@ -57,7 +57,7 @@ namespace
{
if (excludeAttributeData)
{
AZ::u64 exclusionFlags = AZ::Script::Attributes::ExcludeFlags::List | AZ::Script::Attributes::ExcludeFlags::ListOnly | AZ::ScriptCanvasAttributes::VariableCreationForbidden;
AZ::u64 exclusionFlags = AZ::Script::Attributes::ExcludeFlags::List | AZ::Script::Attributes::ExcludeFlags::ListOnly;
if (typeId == AzToolsFramework::Components::EditorComponentBase::TYPEINFO_Uuid())
{
@@ -143,11 +143,6 @@ namespace
{
return;
}
if (!ScriptCanvas::Data::IsAllowedBehaviorClassVariableType(behaviorClass->m_typeId))
{
return;
}
}
const auto isExposableOutcome = ScriptCanvas::IsExposable(method);
@@ -479,38 +474,24 @@ namespace
continue;
}
// Only bind Behavior Classes marked with the Scope type of Launcher
if (auto excludeFromPointer = AZ::FindAttribute(AZ::Script::Attributes::ExcludeFrom, behaviorClass->m_attributes))
{
AZ::Script::Attributes::ExcludeFlags excludeFlags{};
AZ::AttributeReader(nullptr, excludeFromPointer).Read<AZ::Script::Attributes::ExcludeFlags>(excludeFlags);
if ((excludeFlags & (AZ::Script::Attributes::ExcludeFlags::List | AZ::Script::Attributes::ExcludeFlags::ListOnly)) != 0)
{
continue;
}
}
if (!AZ::Internal::IsInScope(behaviorClass->m_attributes, AZ::Script::Attributes::ScopeFlags::Launcher))
{
continue; // skip this class
continue;
}
// Objects and Object methods
{
bool canCreate = serializeContext->FindClassData(behaviorClass->m_typeId) != nullptr &&
!HasAttribute(behaviorClass, AZ::ScriptCanvasAttributes::VariableCreationForbidden);
// In order to create variables, the class must have full memory support
canCreate = canCreate &&
(behaviorClass->m_allocate
&& behaviorClass->m_cloner
&& behaviorClass->m_mover
&& behaviorClass->m_destructor
&& behaviorClass->m_deallocate);
if (canCreate)
{
// Do not allow variable creation for data that derives from AZ::Component
for (auto base : behaviorClass->m_baseClasses)
{
if (AZ::Component::TYPEINFO_Uuid() == base)
{
canCreate = false;
break;
}
}
}
AZStd::string categoryPath;
AZStd::string translationContext = ScriptCanvasEditor::TranslationHelper::GetContextName(ScriptCanvasEditor::TranslationContextGroup::ClassMethod, behaviorClass->m_name);
@@ -530,17 +511,14 @@ namespace
}
}
if (canCreate)
{
auto dataRegistry = ScriptCanvas::GetDataRegistry();
ScriptCanvas::Data::Type type = dataRegistry->m_typeIdTraitMap[ScriptCanvas::Data::eType::BehaviorContextObject].m_dataTraits.GetSCType(behaviorClass->m_typeId);
auto dataRegistry = ScriptCanvas::GetDataRegistry();
ScriptCanvas::Data::Type type = dataRegistry->m_typeIdTraitMap[ScriptCanvas::Data::eType::BehaviorContextObject].m_dataTraits.GetSCType(behaviorClass->m_typeId);
if (type.IsValid())
if (type.IsValid())
{
if (dataRegistry->m_creatableTypes.contains(type))
{
if (!AZ::FindAttribute(AZ::ScriptCanvasAttributes::AllowInternalCreation, behaviorClass->m_attributes))
{
ScriptCanvasEditor::VariablePaletteRequestBus::Broadcast(&ScriptCanvasEditor::VariablePaletteRequests::RegisterVariableType, type);
}
ScriptCanvasEditor::VariablePaletteRequestBus::Broadcast(&ScriptCanvasEditor::VariablePaletteRequests::RegisterVariableType, type);
}
}
Gems/ScriptCanvas/Code/Editor/View/Widgets/VariablePanel/VariablePaletteTableView.cpp
+2 -2
View File
@@ -122,8 +122,8 @@ namespace ScriptCanvasEditor
for (const AZ::Uuid& objectId : objectTypes)
{
// Verify whether this is an allowed BC variable type
if (!ScriptCanvas::Data::IsAllowedBehaviorClassVariableType(objectId))
ScriptCanvas::Data::Type type = dataRegistry->m_typeIdTraitMap[ScriptCanvas::Data::eType::BehaviorContextObject].m_dataTraits.GetSCType(objectId);
if (!type.IsValid() || !dataRegistry->m_creatableTypes.contains(type))
{
continue;
}
Gems/ScriptCanvas/Code/Include/ScriptCanvas/Core/SlotConfigurations.cpp
+2 -4
View File
@@ -105,11 +105,9 @@ namespace ScriptCanvas
void DataSlotConfiguration::SetType(const AZ::BehaviorParameter& typeDesc)
{
auto dataRegistry = GetDataRegistry();
Data::Type scType = !AZ::BehaviorContextHelper::IsStringParameter(typeDesc) ? Data::FromAZType(typeDesc.m_typeId) : Data::Type::String();
auto typeIter = dataRegistry->m_creatableTypes.find(scType);
if (typeIter != dataRegistry->m_creatableTypes.end())
auto dataRegistry = GetDataRegistry();
if (dataRegistry->IsUseableInSlot(scType))
{
m_datum.SetType(scType);
}
Gems/ScriptCanvas/Code/Include/ScriptCanvas/Data/Data.cpp
-23
View File
@@ -389,29 +389,6 @@ namespace ScriptCanvas
return AZ::Utils::IsVectorContainerType(ToAZType(type));
}
bool IsAllowedBehaviorClassVariableType(const AZ::Uuid& id)
{
AZ::BehaviorContext* behaviorContext = nullptr;
AZ::ComponentApplicationBus::BroadcastResult(behaviorContext, &AZ::ComponentApplicationRequests::GetBehaviorContext);
AZ_Assert(behaviorContext, "Unable to retrieve behavior context.");
const auto& classIterator = behaviorContext->m_typeToClassMap.find(id);
if (classIterator != behaviorContext->m_typeToClassMap.end())
{
AZ::BehaviorClass* behaviorClass = classIterator->second;
if (behaviorClass->FindAttribute(AZ::ScriptCanvasAttributes::VariableCreationForbidden))
{
return false;
}
}
else
{
return false;
}
return true;
}
bool IsSetContainerType(const AZ::Uuid& type)
{
return AZ::Utils::IsSetContainerType(type);
Gems/ScriptCanvas/Code/Include/ScriptCanvas/Data/Data.h
-2
View File
@@ -197,8 +197,6 @@ namespace ScriptCanvas
bool IsVectorContainerType(const AZ::Uuid& type);
bool IsVectorContainerType(const Type& type);
bool IsAllowedBehaviorClassVariableType(const AZ::Uuid& id);
AZStd::vector<AZ::Uuid> GetContainedTypes(const AZ::Uuid& type);
AZStd::vector<Type> GetContainedTypes(const Type& type);
AZStd::pair<AZ::Uuid, AZ::Uuid> GetOutcomeTypes(const AZ::Uuid& type);
Gems/ScriptCanvas/Code/Include/ScriptCanvas/Data/DataRegistry.cpp
+25 -4
View File
@@ -105,14 +105,24 @@ namespace ScriptCanvas
AZ_Error("Script Canvas", it.second, "Cannot register a second Trait struct with the same ScriptCanvas type(%u)", it.first->first);
}
void DataRegistry::RegisterType(const AZ::TypeId& typeId, TypeProperties typeProperties)
void DataRegistry::RegisterType(const AZ::TypeId& typeId, TypeProperties typeProperties, Createability registration)
{
Data::Type behaviorContextType = Data::FromAZType(typeId);
if (behaviorContextType.GetType() == Data::eType::BehaviorContextObject && !behaviorContextType.GetAZType().IsNull())
{
if (m_creatableTypes.find(behaviorContextType) == m_creatableTypes.end())
if (registration == Createability::SlotAndVariable)
{
m_creatableTypes[behaviorContextType] = typeProperties;
if (m_creatableTypes.find(behaviorContextType) == m_creatableTypes.end())
{
m_creatableTypes[behaviorContextType] = typeProperties;
}
}
else if (registration == Createability::SlotOnly)
{
if (m_slottableTypes.find(behaviorContextType) == m_slottableTypes.end())
{
m_slottableTypes[behaviorContextType] = typeProperties;
}
}
}
}
@@ -125,4 +135,15 @@ namespace ScriptCanvas
m_creatableTypes.erase(behaviorContextType);
}
}
}
bool DataRegistry::IsUseableInSlot(const Data::Type& scType) const
{
return m_creatableTypes.contains(scType) || m_slottableTypes.contains(scType);
}
bool DataRegistry::IsUseableInSlot(const AZ::TypeId& typeId) const
{
Data::Type scType = Data::FromAZType(typeId);
return IsUseableInSlot(scType);
}
}
Gems/ScriptCanvas/Code/Include/ScriptCanvas/Data/DataRegistry.h
+11 -1
View File
@@ -34,11 +34,21 @@ namespace ScriptCanvas
AZ_TYPE_INFO(DataRegistry, "{41049FA8-EA56-401F-9720-6FE9028A1C01}");
AZ_CLASS_ALLOCATOR(DataRegistry, AZ::SystemAllocator, 0);
void RegisterType(const AZ::TypeId& typeId, TypeProperties typeProperties);
enum class Createability
{
None,
SlotAndVariable,
SlotOnly,
};
void RegisterType(const AZ::TypeId& typeId, TypeProperties typeProperties, Createability registration);
void UnregisterType(const AZ::TypeId& typeId);
bool IsUseableInSlot(const AZ::TypeId& typeId) const;
bool IsUseableInSlot(const Data::Type& type) const;
AZStd::unordered_map<Data::eType, Data::TypeErasedTraits> m_typeIdTraitMap; // Creates a mapping of the Data::eType TypeId to the trait structure
AZStd::unordered_map<Data::Type, TypeProperties> m_creatableTypes;
AZStd::unordered_map<Data::Type, TypeProperties> m_slottableTypes;
};
void InitDataRegistry();
Gems/ScriptCanvas/Code/Include/ScriptCanvas/SystemComponent.h
+3
View File
@@ -22,6 +22,7 @@
#include <ScriptCanvas/Core/ScriptCanvasBus.h>
#include <ScriptCanvas/Variable/VariableCore.h>
#include <ScriptCanvas/PerformanceTracker.h>
#include <ScriptCanvas/Data/DataRegistry.h>
namespace AZ
{
@@ -65,6 +66,8 @@ namespace ScriptCanvas
inline bool IsAnyScriptInterpreted() const { return true; }
AZStd::pair<DataRegistry::Createability, TypeProperties> GetCreatibility(AZ::SerializeContext* serializeContext, AZ::BehaviorClass* behaviorClass);
// SystemRequestBus::Handler...
bool IsScriptUnitTestingInProgress() override;
void MarkScriptUnitTestBegin() override;
Gems/ScriptCanvas/Code/Source/SystemComponent.cpp
+78 -56
View File
@@ -23,7 +23,6 @@
#include <ScriptCanvas/Core/Node.h>
#include <ScriptCanvas/Core/Nodeable.h>
#include <ScriptCanvas/Core/Slot.h>
#include <ScriptCanvas/Data/DataRegistry.h>
#include <ScriptCanvas/Execution/ExecutionPerformanceTimer.h>
#include <ScriptCanvas/Execution/Interpreted/ExecutionInterpretedAPI.h>
#include <ScriptCanvas/Execution/RuntimeComponent.h>
@@ -285,6 +284,72 @@ namespace ScriptCanvas
m_ownedObjectsByAddress.erase(object);
}
AZStd::pair<DataRegistry::Createability, TypeProperties> SystemComponent::GetCreatibility(AZ::SerializeContext* serializeContext, AZ::BehaviorClass* behaviorClass)
{
TypeProperties typeProperties;
bool canCreate{};
// BehaviorContext classes with the ExcludeFrom attribute with a value of the ExcludeFlags::List is not creatable
const AZ::u64 exclusionFlags = AZ::Script::Attributes::ExcludeFlags::List;
auto excludeClassAttributeData = azrtti_cast<const AZ::Edit::AttributeData<AZ::Script::Attributes::ExcludeFlags>*>(AZ::FindAttribute(AZ::Script::Attributes::ExcludeFrom, behaviorClass->m_attributes));
const AZ::u64 flags = excludeClassAttributeData ? excludeClassAttributeData->Get(nullptr) : 0;
bool listOnly = ((flags & AZ::Script::Attributes::ExcludeFlags::ListOnly) == AZ::Script::Attributes::ExcludeFlags::ListOnly); // ListOnly exclusions may create variables
canCreate = listOnly || (!excludeClassAttributeData || (!(flags & exclusionFlags)));
canCreate = canCreate && (serializeContext->FindClassData(behaviorClass->m_typeId));
canCreate = canCreate && !ScriptCanvasSystemComponentCpp::IsDeprecated(behaviorClass->m_attributes);
if (canCreate)
{
for (auto base : behaviorClass->m_baseClasses)
{
if (AZ::Component::TYPEINFO_Uuid() == base)
{
canCreate = false;
break; // only out of the for : base classes loop. DO NOT break out of the parent loop.
}
}
}
// Assets are not safe enough for variable creation, yet. They can be created with one Az type (Data::Asset<T>), but set to nothing.
// When read back in, they will (if lucky) just be Data::Asset<Data>, which breaks type safety at best, and requires a lot of sanity checking.
// This is NOT blacked at the createable types or BehaviorContext level, since they could be used to at least pass information through,
// and may be used other scripting contexts.
AZ::IRttiHelper* rttiHelper = behaviorClass->m_azRtti;
if (rttiHelper && rttiHelper->GetGenericTypeId() == azrtti_typeid<AZ::Data::Asset>())
{
canCreate = false;
}
if (AZ::FindAttribute(AZ::ScriptCanvasAttributes::AllowInternalCreation, behaviorClass->m_attributes))
{
canCreate = true;
typeProperties.m_isTransient = true;
}
// create able variables must have full memory support
canCreate = canCreate &&
(behaviorClass->m_allocate
&& behaviorClass->m_cloner
&& behaviorClass->m_mover
&& behaviorClass->m_destructor
&& behaviorClass->m_deallocate) &&
AZStd::none_of(behaviorClass->m_baseClasses.begin(), behaviorClass->m_baseClasses.end(), [](const AZ::TypeId& base) { return azrtti_typeid<AZ::Component>() == base; });
if (!canCreate)
{
return { DataRegistry::Createability::None , TypeProperties{} };
}
else if (!AZ::FindAttribute(AZ::ScriptCanvasAttributes::VariableCreationForbidden, behaviorClass->m_attributes))
{
return { DataRegistry::Createability::SlotAndVariable, typeProperties };
}
else
{
return { DataRegistry::Createability::SlotOnly, typeProperties };
}
}
void SystemComponent::RegisterCreatableTypes()
{
AZ::SerializeContext* serializeContext{};
@@ -297,40 +362,11 @@ namespace ScriptCanvas
auto dataRegistry = ScriptCanvas::GetDataRegistry();
for (const auto& classIter : behaviorContext->m_classes)
{
TypeProperties typeProperties;
bool canCreate{};
const AZ::BehaviorClass* behaviorClass = classIter.second;
// BehaviorContext classes with the ExcludeFrom attribute with a value of the ExcludeFlags::List is not creatable
const AZ::u64 exclusionFlags = AZ::Script::Attributes::ExcludeFlags::List;
auto excludeClassAttributeData = azrtti_cast<const AZ::Edit::AttributeData<AZ::Script::Attributes::ExcludeFlags>*>(AZ::FindAttribute(AZ::Script::Attributes::ExcludeFrom, behaviorClass->m_attributes));
const AZ::u64 flags = excludeClassAttributeData ? excludeClassAttributeData->Get(nullptr) : 0;
bool listOnly = ((flags & AZ::Script::Attributes::ExcludeFlags::ListOnly) == AZ::Script::Attributes::ExcludeFlags::ListOnly); // ListOnly exclusions may create variables
canCreate = listOnly || (!excludeClassAttributeData || (!(flags & exclusionFlags)));
canCreate = canCreate && (serializeContext->FindClassData(behaviorClass->m_typeId));
canCreate = canCreate && !ScriptCanvasSystemComponentCpp::IsDeprecated(behaviorClass->m_attributes);
if (AZ::FindAttribute(AZ::ScriptCanvasAttributes::AllowInternalCreation, behaviorClass->m_attributes))
{
canCreate = true;
typeProperties.m_isTransient = true;
}
// create able variables must have full memory support
canCreate = canCreate &&
( behaviorClass->m_allocate
&& behaviorClass->m_cloner
&& behaviorClass->m_mover
&& behaviorClass->m_destructor
&& behaviorClass->m_deallocate) &&
AZStd::none_of(behaviorClass->m_baseClasses.begin(), behaviorClass->m_baseClasses.end(), [](const AZ::TypeId& base) { return azrtti_typeid<AZ::Component>() == base; });
if (canCreate)
{
dataRegistry->RegisterType(behaviorClass->m_typeId, typeProperties);
}
auto createability = GetCreatibility(serializeContext, classIter.second);
if (createability.first != DataRegistry::Createability::None)
{
dataRegistry->RegisterType(classIter.second->m_typeId, createability.second, createability.first);
}
}
}
@@ -339,33 +375,19 @@ namespace ScriptCanvas
auto dataRegistry = ScriptCanvas::GetDataRegistry();
if (!dataRegistry)
{
AZ_Warning("ScriptCanvas", false, "Data registry not available. Can't register new class.");
return;
}
AZ::SerializeContext* serializeContext{};
AZ::ComponentApplicationBus::BroadcastResult(serializeContext, &AZ::ComponentApplicationRequests::GetSerializeContext);
AZ_Assert(serializeContext, "Serialize Context should not be missing at this point");
AZ_Assert(serializeContext, "Serialize Context missing. Can't register new class.");
TypeProperties typeProperties;
// BehaviorContext classes with the ExcludeFrom attribute with a value of the ExcludeFlags::List is not creatable
const AZ::u64 exclusionFlags = AZ::Script::Attributes::ExcludeFlags::List;
auto excludeClassAttributeData = azrtti_cast<const AZ::Edit::AttributeData<AZ::Script::Attributes::ExcludeFlags>*>(AZ::FindAttribute(AZ::Script::Attributes::ExcludeFrom, behaviorClass->m_attributes));
bool canCreate = !excludeClassAttributeData || !(excludeClassAttributeData->Get(nullptr) & exclusionFlags);
canCreate = canCreate && (serializeContext->FindClassData(behaviorClass->m_typeId) || AZ::FindAttribute(AZ::ScriptCanvasAttributes::AllowInternalCreation, behaviorClass->m_attributes));
canCreate = canCreate && !ScriptCanvasSystemComponentCpp::IsDeprecated(behaviorClass->m_attributes);
// create able variables must have full memory support
canCreate = canCreate &&
(behaviorClass->m_allocate
&& behaviorClass->m_cloner
&& behaviorClass->m_mover
&& behaviorClass->m_destructor
&& behaviorClass->m_deallocate) &&
AZStd::none_of(behaviorClass->m_baseClasses.begin(), behaviorClass->m_baseClasses.end(), [](const AZ::TypeId& base) { return azrtti_typeid<AZ::Component>() == base; });
if (canCreate)
auto createability = GetCreatibility(serializeContext, behaviorClass);
if (createability.first != DataRegistry::Createability::None)
{
dataRegistry->RegisterType(behaviorClass->m_typeId, typeProperties);
dataRegistry->RegisterType(behaviorClass->m_typeId, createability.second, createability.first);
}
}