dali-scene3d/internal/controls/model-view/model-view-impl.cpp

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "model-view-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/dali-toolkit.h>
  23 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  24 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/public-api/object/type-registry-helper.h>
  27 #include <dali/public-api/object/type-registry.h>
  28 #include <filesystem>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-scene3d/internal/controls/scene-view/scene-view-impl.h>
  32 #include <dali-scene3d/public-api/controls/model-view/model-view.h>
  33 #include <dali-scene3d/public-api/loader/animation-definition.h>
  34 #include <dali-scene3d/public-api/loader/camera-parameters.h>
  35 #include <dali-scene3d/public-api/loader/cube-map-loader.h>
  36 #include <dali-scene3d/public-api/loader/dli-loader.h>
  37 #include <dali-scene3d/public-api/loader/gltf2-loader.h>
  38 #include <dali-scene3d/public-api/loader/light-parameters.h>
  39 #include <dali-scene3d/public-api/loader/load-result.h>
  40 #include <dali-scene3d/public-api/loader/node-definition.h>
  41 #include <dali-scene3d/public-api/loader/scene-definition.h>
  42 #include <dali-scene3d/public-api/loader/shader-definition-factory.h>
  43
  44 using namespace Dali;
  45
  46 namespace Dali
  47 {
  48 namespace Scene3D
  49 {
  50 namespace Internal
  51 {
  52 namespace
  53 {
  54 BaseHandle Create()
  55 {
  56   return Scene3D::ModelView::New(std::string());
  57 }
  58
  59 // Setup properties, signals and actions using the type-registry.
  60 DALI_TYPE_REGISTRATION_BEGIN(Scene3D::ModelView, Toolkit::Control, Create);
  61 DALI_TYPE_REGISTRATION_END()
  62
  63 static constexpr uint32_t OFFSET_FOR_DIFFUSE_CUBE_TEXTURE  = 2u;
  64 static constexpr uint32_t OFFSET_FOR_SPECULAR_CUBE_TEXTURE = 1u;
  65
  66 static constexpr Vector3 Y_DIRECTION(1.0f, -1.0f, 1.0f);
  67
  68 static constexpr std::string_view KTX_EXTENSION  = ".ktx";
  69 static constexpr std::string_view OBJ_EXTENSION  = ".obj";
  70 static constexpr std::string_view GLTF_EXTENSION = ".gltf";
  71 static constexpr std::string_view DLI_EXTENSION  = ".dli";
  72
  73 struct BoundingVolume
  74 {
  75   void Init()
  76   {
  77     pointMin = Vector3(std::numeric_limits<float>::max(), std::numeric_limits<float>::max(), std::numeric_limits<float>::max());
  78     pointMax = Vector3(std::numeric_limits<float>::min(), std::numeric_limits<float>::min(), std::numeric_limits<float>::min());
  79   }
  80
  81   void ConsiderNewPointInVolume(const Vector3& position)
  82   {
  83     pointMin.x = std::min(position.x, pointMin.x);
  84     pointMin.y = std::min(position.y, pointMin.y);
  85     pointMin.z = std::min(position.z, pointMin.z);
  86
  87     pointMax.x = std::max(position.x, pointMax.x);
  88     pointMax.y = std::max(position.y, pointMax.y);
  89     pointMax.z = std::max(position.z, pointMax.z);
  90   }
  91
  92   Vector3 CalculateSize()
  93   {
  94     return pointMax - pointMin;
  95   }
  96
  97   Vector3 CalculatePivot()
  98   {
  99     Vector3 pivot = pointMin / (pointMin - pointMax);
 100     for(uint32_t i = 0; i < 3; ++i)
 101     {
 102       // To avoid divid by zero
 103       if(pointMin[i] == pointMax[i])
 104       {
 105         pivot[i] = 0.5f;
 106       }
 107     }
 108     return pivot;
 109   }
 110
 111   Vector3 pointMin;
 112   Vector3 pointMax;
 113 };
 114
 115 void ConfigureBlendShapeShaders(
 116   Dali::Scene3D::Loader::ResourceBundle& resources, const Dali::Scene3D::Loader::SceneDefinition& scene, Actor root, std::vector<Dali::Scene3D::Loader::BlendshapeShaderConfigurationRequest>&& requests)
 117 {
 118   std::vector<std::string> errors;
 119   auto                     onError = [&errors](const std::string& msg) { errors.push_back(msg); };
 120   if(!scene.ConfigureBlendshapeShaders(resources, root, std::move(requests), onError))
 121   {
 122     Dali::Scene3D::Loader::ExceptionFlinger flinger(ASSERT_LOCATION);
 123     for(auto& msg : errors)
 124     {
 125       flinger << msg << '\n';
 126     }
 127   }
 128 }
 129
 130 void AddModelTreeToAABB(BoundingVolume& AABB, const Dali::Scene3D::Loader::SceneDefinition& scene, const Dali::Scene3D::Loader::Customization::Choices& choices, Dali::Scene3D::Loader::Index iNode, Dali::Scene3D::Loader::NodeDefinition::CreateParams& nodeParams, Matrix parentMatrix)
 131 {
 132   static constexpr uint32_t BOX_POINT_COUNT             = 8;
 133   static uint32_t           BBIndex[BOX_POINT_COUNT][3] = {{0, 0, 0}, {0, 1, 0}, {1, 0, 0}, {1, 1, 0}, {0, 0, 1}, {0, 1, 1}, {1, 0, 1}, {1, 1, 1}};
 134
 135   Matrix                                       nodeMatrix;
 136   const Dali::Scene3D::Loader::NodeDefinition* node        = scene.GetNode(iNode);
 137   Matrix                                       localMatrix = node->GetLocalSpace();
 138   Matrix::Multiply(nodeMatrix, localMatrix, parentMatrix);
 139
 140   Vector3 volume[2];
 141   if(node->GetExtents(nodeParams.mResources, volume[0], volume[1]))
 142   {
 143     for(uint32_t i = 0; i < BOX_POINT_COUNT; ++i)
 144     {
 145       Vector4 position       = Vector4(volume[BBIndex[i][0]].x, volume[BBIndex[i][1]].y, volume[BBIndex[i][2]].z, 1.0f);
 146       Vector4 objectPosition = nodeMatrix * position;
 147       objectPosition /= objectPosition.w;
 148
 149       AABB.ConsiderNewPointInVolume(Vector3(objectPosition));
 150     }
 151   }
 152
 153   if(node->mCustomization)
 154   {
 155     if(!node->mChildren.empty())
 156     {
 157       auto                         choice = choices.Get(node->mCustomization->mTag);
 158       Dali::Scene3D::Loader::Index i      = std::min(choice != Dali::Scene3D::Loader::Customization::NONE ? choice : 0, static_cast<Dali::Scene3D::Loader::Index>(node->mChildren.size() - 1));
 159
 160       AddModelTreeToAABB(AABB, scene, choices, node->mChildren[i], nodeParams, nodeMatrix);
 161     }
 162   }
 163   else
 164   {
 165     for(auto i : node->mChildren)
 166     {
 167       AddModelTreeToAABB(AABB, scene, choices, i, nodeParams, nodeMatrix);
 168     }
 169   }
 170 }
 171
 172 } // anonymous namespace
 173
 174 ModelView::ModelView(const std::string& modelPath, const std::string& resourcePath)
 175 : Control(ControlBehaviour(DISABLE_SIZE_NEGOTIATION | DISABLE_STYLE_CHANGE_SIGNALS)),
 176   mModelPath(modelPath),
 177   mResourcePath(resourcePath),
 178   mModelRoot(),
 179   mNaturalSize(Vector3::ZERO),
 180   mModelPivot(AnchorPoint::CENTER),
 181   mIblScaleFactor(1.0f),
 182   mFitSize(true),
 183   mFitCenter(true),
 184   mModelResourceReady(false),
 185   mIBLResourceReady(true)
 186 {
 187 }
 188
 189 ModelView::~ModelView()
 190 {
 191 }
 192
 193 Dali::Scene3D::ModelView ModelView::New(const std::string& modelPath, const std::string& resourcePath)
 194 {
 195   ModelView* impl = new ModelView(modelPath, resourcePath);
 196
 197   Dali::Scene3D::ModelView handle = Dali::Scene3D::ModelView(*impl);
 198
 199   // Second-phase init of the implementation
 200   // This can only be done after the CustomActor connection has been made...
 201   impl->Initialize();
 202
 203   return handle;
 204 }
 205
 206 const Actor ModelView::GetModelRoot()
 207 {
 208   return mModelRoot;
 209 }
 210
 211 void ModelView::FitSize(bool fit)
 212 {
 213   mFitSize = fit;
 214   ScaleModel();
 215 }
 216
 217 void ModelView::FitCenter(bool fit)
 218 {
 219   mFitCenter = fit;
 220   FitModelPosition();
 221 }
 222
 223 void ModelView::SetImageBasedLightSource(const std::string& diffuse, const std::string& specular, float scaleFactor)
 224 {
 225   mIBLResourceReady = false;
 226   Texture diffuseTexture  = Dali::Scene3D::Loader::LoadCubeMap(diffuse);
 227   Texture specularTexture = Dali::Scene3D::Loader::LoadCubeMap(specular);
 228   SetImageBasedLightTexture(diffuseTexture, specularTexture, scaleFactor);
 229   mIBLResourceReady = true;
 230
 231   // If Model resource is already ready, then set resource ready.
 232   // If Model resource is still not ready, wait for model resource ready.
 233   if(IsResourceReady())
 234   {
 235     SetResourceReady(false);
 236   }
 237 }
 238
 239 void ModelView::SetImageBasedLightTexture(Dali::Texture diffuse, Dali::Texture specular, float scaleFactor)
 240 {
 241   if(diffuse && specular)
 242   {
 243     mDiffuseTexture  = diffuse;
 244     mSpecularTexture = specular;
 245     mIblScaleFactor  = scaleFactor;
 246
 247     UpdateImageBasedLight();
 248   }
 249 }
 250
 251 uint32_t ModelView::GetAnimationCount()
 252 {
 253   return mAnimations.size();
 254 }
 255
 256 Dali::Animation ModelView::GetAnimation(uint32_t index)
 257 {
 258   Dali::Animation animation;
 259   if(mAnimations.size() > index)
 260   {
 261     animation = mAnimations[index].second;
 262   }
 263   return animation;
 264 }
 265
 266 Dali::Animation ModelView::GetAnimation(const std::string& name)
 267 {
 268   Dali::Animation animation;
 269   if(!name.empty())
 270   {
 271     for(auto&& animationData : mAnimations)
 272     {
 273       if(animationData.first == name)
 274       {
 275         animation = animationData.second;
 276         break;
 277       }
 278     }
 279   }
 280   return animation;
 281 }
 282
 283 ///////////////////////////////////////////////////////////
 284 //
 285 // Private methods
 286 //
 287
 288 void ModelView::OnSceneConnection(int depth)
 289 {
 290   if(!mModelRoot)
 291   {
 292     LoadModel();
 293   }
 294
 295   Actor parent = Self().GetParent();
 296   while(parent)
 297   {
 298     Scene3D::SceneView sceneView = Scene3D::SceneView::DownCast(parent);
 299     if(sceneView)
 300     {
 301       GetImpl(sceneView).RegisterModelView(Scene3D::ModelView::DownCast(Self()));
 302       mParentSceneView = sceneView;
 303       break;
 304     }
 305     parent = parent.GetParent();
 306   }
 307
 308   Control::OnSceneConnection(depth);
 309 }
 310
 311 void ModelView::OnSceneDisconnection()
 312 {
 313   Scene3D::SceneView sceneView = mParentSceneView.GetHandle();
 314   if(sceneView)
 315   {
 316     GetImpl(sceneView).UnregisterModelView(Scene3D::ModelView::DownCast(Self()));
 317     mParentSceneView.Reset();
 318   }
 319   Control::OnSceneDisconnection();
 320 }
 321
 322 Vector3 ModelView::GetNaturalSize()
 323 {
 324   if(!mModelRoot)
 325   {
 326     LoadModel();
 327   }
 328
 329   return mNaturalSize;
 330 }
 331
 332 float ModelView::GetHeightForWidth(float width)
 333 {
 334   Extents padding;
 335   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 336   return Control::GetHeightForWidth(width) + padding.top + padding.bottom;
 337 }
 338
 339 float ModelView::GetWidthForHeight(float height)
 340 {
 341   Extents padding;
 342   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 343   return Control::GetWidthForHeight(height) + padding.start + padding.end;
 344 }
 345
 346 void ModelView::OnRelayout(const Vector2& size, RelayoutContainer& container)
 347 {
 348   Control::OnRelayout(size, container);
 349   ScaleModel();
 350 }
 351
 352 bool ModelView::IsResourceReady() const
 353 {
 354   return mModelResourceReady && mIBLResourceReady;
 355 }
 356
 357 void ModelView::LoadModel()
 358 {
 359   std::filesystem::path modelPath(mModelPath);
 360   if(mResourcePath.empty())
 361   {
 362     mResourcePath = std::string(modelPath.parent_path()) + "/";
 363   }
 364   std::string extension = modelPath.extension();
 365   std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
 366
 367   Dali::Scene3D::Loader::ResourceBundle::PathProvider pathProvider = [&](Dali::Scene3D::Loader::ResourceType::Value type) {
 368     return mResourcePath;
 369   };
 370
 371   Dali::Scene3D::Loader::ResourceBundle                        resources;
 372   Dali::Scene3D::Loader::SceneDefinition                       scene;
 373   std::vector<Dali::Scene3D::Loader::AnimationGroupDefinition> animGroups;
 374   std::vector<Dali::Scene3D::Loader::CameraParameters>         cameraParameters;
 375   std::vector<Dali::Scene3D::Loader::LightParameters>          lights;
 376
 377   std::vector<Dali::Scene3D::Loader::AnimationDefinition> animations;
 378   animations.clear();
 379
 380   Dali::Scene3D::Loader::LoadResult output{resources, scene, animations, animGroups, cameraParameters, lights};
 381
 382   if(extension == DLI_EXTENSION)
 383   {
 384     Dali::Scene3D::Loader::DliLoader              loader;
 385     Dali::Scene3D::Loader::DliLoader::InputParams input{
 386       pathProvider(Dali::Scene3D::Loader::ResourceType::Mesh),
 387       nullptr,
 388       {},
 389       {},
 390       nullptr,
 391       {}};
 392     Dali::Scene3D::Loader::DliLoader::LoadParams loadParams{input, output};
 393     if(!loader.LoadScene(mModelPath, loadParams))
 394     {
 395       Dali::Scene3D::Loader::ExceptionFlinger(ASSERT_LOCATION) << "Failed to load scene from '" << mModelPath << "': " << loader.GetParseError();
 396     }
 397   }
 398   else if(extension == GLTF_EXTENSION)
 399   {
 400     Dali::Scene3D::Loader::ShaderDefinitionFactory sdf;
 401     sdf.SetResources(resources);
 402     Dali::Scene3D::Loader::LoadGltfScene(mModelPath, sdf, output);
 403
 404     resources.mEnvironmentMaps.push_back({});
 405   }
 406   else
 407   {
 408     DALI_LOG_ERROR("Unsupported model type.\n");
 409   }
 410
 411   Dali::Scene3D::Loader::Transforms                   xforms{Dali::Scene3D::Loader::MatrixStack{}, Dali::Scene3D::Loader::ViewProjection{}};
 412   Dali::Scene3D::Loader::NodeDefinition::CreateParams nodeParams{resources, xforms, {}, {}, {}};
 413   Dali::Scene3D::Loader::Customization::Choices       choices;
 414
 415   mModelRoot = Actor::New();
 416
 417   BoundingVolume AABB;
 418   for(auto iRoot : scene.GetRoots())
 419   {
 420     auto resourceRefs = resources.CreateRefCounter();
 421     scene.CountResourceRefs(iRoot, choices, resourceRefs);
 422     resources.CountEnvironmentReferences(resourceRefs);
 423
 424     resources.LoadResources(resourceRefs, pathProvider);
 425
 426     // glTF Mesh is defined in right hand coordinate system, with positive Y for Up direction.
 427     // Because DALi uses left hand system, Y direciton will be flipped for environment map sampling.
 428     for(auto&& env : resources.mEnvironmentMaps)
 429     {
 430       env.first.mYDirection = Y_DIRECTION;
 431     }
 432
 433     if(auto actor = scene.CreateNodes(iRoot, choices, nodeParams))
 434     {
 435       scene.ConfigureSkeletonJoints(iRoot, resources.mSkeletons, actor);
 436       scene.ConfigureSkinningShaders(resources, actor, std::move(nodeParams.mSkinnables));
 437       ConfigureBlendShapeShaders(resources, scene, actor, std::move(nodeParams.mBlendshapeRequests));
 438
 439       scene.ApplyConstraints(actor, std::move(nodeParams.mConstrainables));
 440
 441       mModelRoot.Add(actor);
 442     }
 443
 444     AddModelTreeToAABB(AABB, scene, choices, iRoot, nodeParams, Matrix::IDENTITY);
 445   }
 446
 447   if(!animations.empty())
 448   {
 449     auto getActor = [&](const std::string& name) {
 450       return mModelRoot.FindChildByName(name);
 451     };
 452
 453     mAnimations.clear();
 454     for(auto&& animation : animations)
 455     {
 456       Dali::Animation anim = animation.ReAnimate(getActor);
 457
 458       mAnimations.push_back({animation.mName, anim});
 459     }
 460   }
 461
 462   mRenderableActors.clear();
 463   CollectRenderableActor(mModelRoot);
 464   UpdateImageBasedLight();
 465
 466   mNaturalSize = AABB.CalculateSize();
 467   mModelPivot  = AABB.CalculatePivot();
 468   mModelRoot.SetProperty(Dali::Actor::Property::SIZE, mNaturalSize);
 469   Vector3 controlSize = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
 470   if(controlSize.x == 0.0f || controlSize.y == 0.0f)
 471   {
 472     Self().SetProperty(Dali::Actor::Property::SIZE, mNaturalSize);
 473   }
 474
 475   FitModelPosition();
 476   ScaleModel();
 477
 478   Self().Add(mModelRoot);
 479
 480   Self().SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
 481   Self().SetProperty(Dali::Actor::Property::ANCHOR_POINT, Vector3(mModelPivot.x, 1.0f - mModelPivot.y, mModelPivot.z));
 482
 483   mModelResourceReady = true;
 484
 485   Control::SetResourceReady(false);
 486 }
 487
 488 void ModelView::ScaleModel()
 489 {
 490   if(mModelRoot)
 491   {
 492     Vector3 size = Self().GetProperty<Vector3>(Dali::Actor::Property::SIZE);
 493     if(mFitSize && size.x > 0.0f && size.y > 0.0f)
 494     {
 495       float scaleFactor = MAXFLOAT;
 496       scaleFactor       = std::min(size.x / mNaturalSize.x, scaleFactor);
 497       scaleFactor       = std::min(size.y / mNaturalSize.y, scaleFactor);
 498       // Models in glTF and dli are defined as right hand coordinate system.
 499       // DALi uses left hand coordinate system. Scaling negative is for change winding order.
 500       mModelRoot.SetProperty(Dali::Actor::Property::SCALE, Y_DIRECTION * scaleFactor);
 501     }
 502     else
 503     {
 504       // Models in glTF and dli are defined as right hand coordinate system.
 505       // DALi uses left hand coordinate system. Scaling negative is for change winding order.
 506       mModelRoot.SetProperty(Dali::Actor::Property::SCALE, Y_DIRECTION);
 507     }
 508   }
 509 }
 510
 511 void ModelView::FitModelPosition()
 512 {
 513   if(mModelRoot)
 514   {
 515     if(mFitCenter)
 516     {
 517       // Loaded model pivot is not the model center.
 518       mModelRoot.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
 519       mModelRoot.SetProperty(Dali::Actor::Property::ANCHOR_POINT, Vector3::ONE - mModelPivot);
 520     }
 521     else
 522     {
 523       mModelRoot.SetProperty(Dali::Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
 524       mModelRoot.SetProperty(Dali::Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
 525     }
 526   }
 527 }
 528
 529 void ModelView::CollectRenderableActor(Actor actor)
 530 {
 531   uint32_t rendererCount = actor.GetRendererCount();
 532   if(rendererCount)
 533   {
 534     mRenderableActors.push_back(actor);
 535   }
 536
 537   uint32_t childrenCount = actor.GetChildCount();
 538   for(uint32_t i = 0; i < childrenCount; ++i)
 539   {
 540     CollectRenderableActor(actor.GetChildAt(i));
 541   }
 542 }
 543
 544 void ModelView::UpdateImageBasedLight()
 545 {
 546   if(!mDiffuseTexture || !mSpecularTexture)
 547   {
 548     return;
 549   }
 550
 551   for(auto&& actor : mRenderableActors)
 552   {
 553     Actor renderableActor = actor.GetHandle();
 554     if(renderableActor)
 555     {
 556       renderableActor.RegisterProperty(Dali::Scene3D::Loader::NodeDefinition::GetIblScaleFactorUniformName().data(), mIblScaleFactor);
 557
 558       uint32_t rendererCount = renderableActor.GetRendererCount();
 559       for(uint32_t i = 0; i < rendererCount; ++i)
 560       {
 561         Dali::Renderer renderer = renderableActor.GetRendererAt(i);
 562         if(renderer)
 563         {
 564           Dali::TextureSet textures = renderer.GetTextures();
 565           if(textures)
 566           {
 567             uint32_t textureCount = textures.GetTextureCount();
 568             // EnvMap requires at least 2 texture, diffuse and specular
 569             if(textureCount > 2u)
 570             {
 571               textures.SetTexture(textureCount - OFFSET_FOR_DIFFUSE_CUBE_TEXTURE, mDiffuseTexture);
 572               textures.SetTexture(textureCount - OFFSET_FOR_SPECULAR_CUBE_TEXTURE, mSpecularTexture);
 573             }
 574           }
 575         }
 576       }
 577     }
 578   }
 579 }
 580
 581 } // namespace Internal
 582 } // namespace Scene3D
 583 } // namespace Dali