Code/CryEngine/CrySchematyc2/Script/Elements/ScriptClass.cpp

   1 // Copyright 2001-2019 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #include "StdAfx.h"
   4 #include "Script/Elements/ScriptClass.h"
   5
   6 #include <CrySerialization/BlackBox.h>
   7 #include <CrySerialization/IArchiveHost.h>
   8 #include <CrySerialization/STL.h>
   9 #include <CrySchematyc2/GUIDRemapper.h>
  10 #include <CrySchematyc2/Deprecated/DocUtils.h>
  11 #include <CrySchematyc2/Env/IEnvRegistry.h>
  12 #include <CrySchematyc2/Serialization/ISerializationContext.h>
  13 #include <CrySchematyc2/Serialization/SerializationUtils.h>
  14
  15 namespace Schematyc2
  16 {
  17         //////////////////////////////////////////////////////////////////////////
  18         CScriptClass::CScriptClass(IScriptFile& file, const SGUID& guid, const SGUID& scopeGUID, const char* szName, const SGUID& foundationGUID)
  19                 : CScriptElementBase(EScriptElementType::Class, file)
  20                 , m_guid(guid)
  21                 , m_scopeGUID(scopeGUID)
  22                 , m_name(szName)
  23                 , m_foundationGUID(foundationGUID)
  24         {}
  25
  26         //////////////////////////////////////////////////////////////////////////
  27         EAccessor CScriptClass::GetAccessor() const
  28         {
  29                 return EAccessor::Private;
  30         }
  31
  32         //////////////////////////////////////////////////////////////////////////
  33         SGUID CScriptClass::GetGUID() const
  34         {
  35                 return m_guid;
  36         }
  37
  38         //////////////////////////////////////////////////////////////////////////
  39         SGUID CScriptClass::GetScopeGUID() const
  40         {
  41                 return m_scopeGUID;
  42         }
  43
  44         //////////////////////////////////////////////////////////////////////////
  45         bool CScriptClass::SetName(const char* szName)
  46         {
  47                 m_name = szName;
  48                 return true;
  49         }
  50
  51         //////////////////////////////////////////////////////////////////////////
  52         const char* CScriptClass::GetName() const
  53         {
  54                 return m_name.c_str();
  55         }
  56
  57         //////////////////////////////////////////////////////////////////////////
  58         void CScriptClass::EnumerateDependencies(const ScriptDependancyEnumerator& enumerator) const {}
  59
  60         //////////////////////////////////////////////////////////////////////////
  61         void CScriptClass::Refresh(const SScriptRefreshParams& params)
  62         {
  63                 switch(params.reason)
  64                 {
  65                 case EScriptRefreshReason::EditorAdd:
  66                         {
  67                                 RefreshFoundationProperties();
  68                                 m_userDocumentation.SetCurrentUserAsAuthor();
  69                         }
  70                 case EScriptRefreshReason::EditorFixUp:
  71                 case EScriptRefreshReason::EditorPaste:
  72                 case EScriptRefreshReason::EditorEnvModified:
  73                 case EScriptRefreshReason::EditorDependencyModified:
  74                         {
  75                                 RefreshFoundationComponents();
  76                                 break;
  77                         }
  78                 }
  79         }
  80
  81         //////////////////////////////////////////////////////////////////////////
  82         void CScriptClass::Serialize(Serialization::IArchive& archive)
  83         {
  84                 CRY_PROFILE_FUNCTION(PROFILE_LOADING_ONLY);
  85
  86                 CScriptElementBase::Serialize(archive);
  87
  88                 SerializationContext::SetValidatorLink(archive, SValidatorLink(m_guid)); // #SchematycTODO : Can we set this from CScriptElementBase?
  89                 switch(SerializationContext::GetPass(archive))
  90                 {
  91                 case ESerializationPass::PreLoad:
  92                 case ESerializationPass::Save:
  93                         {
  94                                 Serialization::SContext fileContext(archive, static_cast<IScriptFile*>(&CScriptElementBase::GetFile())); // #SchematycTODO : Do we still need this?
  95                                 Serialization::SContext context(archive, static_cast<IScriptClass*>(this)); // #SchematycTODO : Do we still need this?
  96
  97                                 archive(m_guid, "guid");
  98                                 archive(m_scopeGUID, "scope_guid");
  99                                 archive(m_name, "name");
 100                                 archive(m_foundationGUID, "foundation_guid");
 101                                 if(archive.isInput())
 102                                 {
 103                                         RefreshFoundationProperties();
 104                                 }
 105                                 if(m_pFoundationProperties)
 106                                 {
 107                                         archive(*m_pFoundationProperties, "foundation_properties", "Foundation Properties");
 108                                 }
 109                                 archive(m_userDocumentation, "userDocumentation", "Documentation");
 110                                 break;
 111                         }
 112                 case ESerializationPass::Edit:
 113                         {
 114                                 Serialization::SContext fileContext(archive, static_cast<IScriptFile*>(&CScriptElementBase::GetFile())); // #SchematycTODO : Do we still need this?
 115                                 Serialization::SContext context(archive, static_cast<IScriptClass*>(this)); // #SchematycTODO : Do we still need this?
 116
 117                                 if(m_pFoundationProperties)
 118                                 {
 119                                         archive(*m_pFoundationProperties, "foundation_properties", "Foundation Properties");
 120                                 }
 121                                 archive(m_userDocumentation, "userDocumentation", "Documentation");
 122                                 break;
 123                         }
 124                 case ESerializationPass::Validate:
 125                         {
 126                                 Validate(archive);
 127                                 break;
 128                         }
 129                 }
 130         }
 131
 132         //////////////////////////////////////////////////////////////////////////
 133         void CScriptClass::RemapGUIDs(IGUIDRemapper& guidRemapper)
 134         {
 135                 m_guid      = guidRemapper.Remap(m_guid);
 136                 m_scopeGUID = guidRemapper.Remap(m_scopeGUID);
 137         }
 138
 139         //////////////////////////////////////////////////////////////////////////
 140         const char* CScriptClass::GetAuthor() const
 141         {
 142                 return m_userDocumentation.author.c_str();
 143         }
 144
 145         //////////////////////////////////////////////////////////////////////////
 146         const char* CScriptClass::GetDescription() const
 147         {
 148                 return m_userDocumentation.description.c_str();
 149         }
 150
 151         //////////////////////////////////////////////////////////////////////////
 152         SGUID CScriptClass::GetFoundationGUID() const
 153         {
 154                 return m_foundationGUID;
 155         }
 156
 157         //////////////////////////////////////////////////////////////////////////
 158         IPropertiesConstPtr CScriptClass::GetFoundationProperties() const
 159         {
 160                 return m_pFoundationProperties;
 161         }
 162
 163         //////////////////////////////////////////////////////////////////////////
 164         void CScriptClass::RefreshFoundationProperties()
 165         {
 166                 m_pFoundationProperties.reset();
 167                 if(m_foundationGUID)
 168                 {
 169                         IFoundationConstPtr pFoundation = gEnv->pSchematyc2->GetEnvRegistry().GetFoundation(m_foundationGUID);
 170                         SCHEMATYC2_SYSTEM_ASSERT(pFoundation);
 171                         if(pFoundation)
 172                         {
 173                                 IPropertiesConstPtr pFoundationProperties = pFoundation->GetProperties();
 174                                 if(pFoundationProperties)
 175                                 {
 176                                         m_pFoundationProperties = pFoundationProperties->Clone();
 177                                 }
 178                         }
 179                 }
 180         }
 181
 182         //////////////////////////////////////////////////////////////////////////
 183         void CScriptClass::RefreshFoundationComponents()
 184         {
 185                 // #SchematycTODO : If component has 'HIDE_IN_EDITOR' flag set we don't need to serialize it!!!
 186                 GUIDVector          requiredComponentGUIDs;
 187                 IFoundationConstPtr pFoundation = gEnv->pSchematyc2->GetEnvRegistry().GetFoundation(m_foundationGUID);
 188                 if(pFoundation)
 189                 {
 190                         for(size_t foundationComponentIdx = 0, foundationComponentCount = pFoundation->GetComponentCount(); foundationComponentIdx < foundationComponentCount; ++ foundationComponentIdx)
 191                         {
 192                                 requiredComponentGUIDs.push_back(pFoundation->GetComponentGUID(foundationComponentIdx));
 193                         }
 194                 }
 195                 IEnvRegistry&                       envRegistry = gEnv->pSchematyc2->GetEnvRegistry();
 196                 IScriptFile&                        file = CScriptElementBase::GetFile();
 197                 TScriptComponentInstanceConstVector componentInstances;
 198                 DocUtils::CollectComponentInstances(file, m_guid, true, componentInstances);
 199                 for(const IScriptComponentInstance* pComponentInstance : componentInstances)
 200                 {
 201                         IComponentFactoryConstPtr pComponentFactory = envRegistry.GetComponentFactory(pComponentInstance->GetComponentGUID());
 202                         SCHEMATYC2_SYSTEM_ASSERT(pComponentFactory);
 203                         if(pComponentFactory)
 204                         {
 205                                 for(size_t componentDependencyIdx = 0, componentDependencyCount = pComponentFactory->GetDependencyCount(); componentDependencyIdx < componentDependencyCount; ++ componentDependencyIdx)
 206                                 {
 207                                         if(pComponentFactory->GetDependencyType(componentDependencyIdx) == EComponentDependencyType::Hard)
 208                                         {
 209                                                 requiredComponentGUIDs.push_back(pComponentFactory->GetDependencyGUID(componentDependencyIdx));
 210                                         }
 211                                 }
 212                         }
 213                 }
 214                 for(size_t requiredComponentIdx = 0, requiredComponentCount = requiredComponentGUIDs.size(); requiredComponentIdx < requiredComponentCount; ++ requiredComponentIdx)
 215                 {
 216                         const SGUID               componentGUID = requiredComponentGUIDs[requiredComponentIdx];
 217                         IComponentFactoryConstPtr pComponentFactory = envRegistry.GetComponentFactory(componentGUID);
 218                         SCHEMATYC2_SYSTEM_ASSERT(pComponentFactory);
 219                         if(pComponentFactory)
 220                         {
 221                                 TScriptComponentInstanceConstVector componentInstances;
 222                                 DocUtils::CollectComponentInstances(file, m_guid, true, componentInstances);
 223                                 bool bComponentExists = false;
 224                                 for(const IScriptComponentInstance* pComponentInstance : componentInstances)
 225                                 {
 226                                         if(pComponentInstance->GetComponentGUID() == componentGUID)
 227                                         {
 228                                                 bComponentExists = true;
 229                                                 break;
 230                                         }
 231                                 }
 232                                 if(!bComponentExists)
 233                                 {
 234                                         file.AddComponentInstance(m_guid, pComponentFactory->GetName(), componentGUID, EScriptComponentInstanceFlags::Foundation);
 235                                 }
 236                         }
 237                 }
 238         }
 239
 240         //////////////////////////////////////////////////////////////////////////
 241         void CScriptClass::Validate(Serialization::IArchive& archive)
 242         {
 243                 if(m_foundationGUID)
 244                 {
 245                         IFoundationConstPtr pFoundation = gEnv->pSchematyc2->GetEnvRegistry().GetFoundation(m_foundationGUID);
 246                         if(!pFoundation)
 247                         {
 248                                 archive.error(*this, "Unable to retrieve foundation!");
 249                         }
 250                 }
 251         }
 252 }