#define DALI_SCENE3D_INTERNAL_MODEL_H
/*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// EXTERNAL INCLUDES
#include <dali-toolkit/public-api/controls/control-impl.h>
+#include <dali/devel-api/common/map-wrapper.h>
+#include <dali/public-api/actors/camera-actor.h>
#include <dali/public-api/actors/layer.h>
#include <dali/public-api/animation/animation.h>
-#include <dali/public-api/rendering/texture.h>
+#include <dali/public-api/object/property-notification.h>
#include <dali/public-api/object/weak-handle.h>
+#include <dali/public-api/rendering/texture.h>
// INTERNAL INCLUDES
+#include <dali-scene3d/internal/common/environment-map-load-task.h>
+#include <dali-scene3d/internal/common/light-observer.h>
+#include <dali-scene3d/internal/common/model-load-task.h>
#include <dali-scene3d/public-api/controls/model/model.h>
#include <dali-scene3d/public-api/controls/scene-view/scene-view.h>
+#include <dali-scene3d/public-api/light/light.h>
+#include <dali-scene3d/public-api/loader/load-result.h>
+#include <dali-scene3d/public-api/model-components/model-node.h>
namespace Dali
{
/**
* @brief Impl class for Model.
*/
-class Model : public Dali::Toolkit::Internal::Control
+class Model : public Dali::Toolkit::Internal::Control, public LightObserver
{
public:
- using AnimationData = std::pair<std::string, Dali::Animation>;
+ using AnimationData = std::pair<std::string, Dali::Animation>;
+ using CameraData = Loader::CameraParameters;
+ using BlendShapeModelNodeMap = std::map<std::string, std::vector<Scene3D::ModelNode>>;
/**
- * @brief Creates a new Model.
- *
- * @return A public handle to the newly allocated Model.
+ * @copydoc Model::New()
*/
static Dali::Scene3D::Model New(const std::string& modelUrl, const std::string& resourceDirectoryUrl);
/**
* @copydoc Model::GetModelRoot()
*/
- const Actor GetModelRoot() const;
+ const Scene3D::ModelNode GetModelRoot() const;
/**
- * @copydoc Model::SetImageBasedLightSource()
+ * @copydoc Model::AddModelNode()
*/
- void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor);
+ void AddModelNode(Scene3D::ModelNode modelNode);
+
+ /**
+ * @copydoc Model::RemoveModelNode()
+ */
+ void RemoveModelNode(Scene3D::ModelNode modelNode);
+
+ /**
+ * @copydoc Model::SetChildrenSensitive()
+ */
+ void SetChildrenSensitive(bool enable);
+
+ /**
+ * @copydoc Model::GetChildrenSensitive()
+ */
+ bool GetChildrenSensitive() const;
/**
- * @copydoc Model::SetImageBasedLightTexture()
+ * @copydoc Model::SetChildrenFocusable()
*/
- void SetImageBasedLightTexture(Dali::Texture diffuseTexture, Dali::Texture specularTexture, float scaleFactor);
+ void SetChildrenFocusable(bool enable);
+
+ /**
+ * @copydoc Model::GetChildrenFocusable()
+ */
+ bool GetChildrenFocusable() const;
+
+ /**
+ * @copydoc Model::SetImageBasedLightSource()
+ */
+ void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor);
/**
* @copydoc Model::SetImageBasedLightScaleFactor()
*/
Dali::Animation GetAnimation(const std::string& name) const;
+ /**
+ * @copydoc Model::GetCameraCount()
+ */
+ uint32_t GetCameraCount() const;
+
+ /**
+ * @copydoc Model::GenerateCamera()
+ */
+ Dali::CameraActor GenerateCamera(uint32_t index) const;
+
+ /**
+ * @copydoc Model::ApplyCamera()
+ */
+ bool ApplyCamera(uint32_t index, Dali::CameraActor camera) const;
+
+ /**
+ * @copydoc Model::FindChildModelNodeByName()
+ */
+ Scene3D::ModelNode FindChildModelNodeByName(std::string_view nodeName);
+
+ /**
+ * @copydoc Model::RetrieveBlendShapeNames()
+ */
+ void RetrieveBlendShapeNames(std::vector<std::string>& blendShapeNames) const;
+
+ /**
+ * @copydoc Model::RetrieveModelNodesByBlendShapeName()
+ */
+ void RetrieveModelNodesByBlendShapeName(std::string_view blendShapeName, std::vector<Scene3D::ModelNode>& modelNodes) const;
+
protected:
/**
* @brief Constructs a new Model.
+ * @param[in] modelUrl model file path.(e.g., glTF, and DLI).
+ * @param[in] resourceDirectoryUrl resource file path that includes binary, image etc.
*/
Model(const std::string& modelUrl, const std::string& resourceDirectoryUrl);
private:
/**
+ * @copydoc Toolkit::Control::OnInitialize
+ */
+ void OnInitialize();
+
+ /**
* @copydoc CustomActorImpl::OnSceneConnection()
*/
void OnSceneConnection(int depth) override;
void OnSceneDisconnection() override;
/**
+ * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size )
+ */
+ void OnSizeSet(const Vector3& size) override;
+
+ /**
* @copydoc Toolkit::Control::GetNaturalSize
*/
Vector3 GetNaturalSize() override;
*/
bool IsResourceReady() const override;
+private:
/**
- * @brief Loads a model from file
+ * @brief Create Model Root of this Model class.
*/
- void LoadModel();
+ void CreateModelRoot();
/**
* @brief Scales the model to fit the control or to return to original size.
*/
- void ScaleModel();
+ void ScaleModel(bool useCurrentSize);
/**
* @brief Changes model anchor point to set the model at center or returns to the original model pivot.
/**
* @brief Changes IBL information of the input node.
*/
- void CollectRenderableActor(Actor actor);
+ void UpdateImageBasedLightTextureRecursively(Scene3D::ModelNode node, Dali::Texture diffuseTexture, Dali::Texture specularTexture, float iblScaleFactor, uint32_t specularMipmapLevels);
+
+ /**
+ * @brief Changes IBL factor of the input node.
+ */
+ void UpdateImageBasedLightScaleFactorRecursively(Scene3D::ModelNode node, float iblScaleFactor);
/**
* @brief Changes IBL textures of the input node.
*/
void UpdateImageBasedLightScaleFactor();
+ /**
+ * @brief Apply self transform into inputed camera.
+ * Inputed camera must be configured by CameraParameter. Mean, inputed camera coordinate depend on Model.
+ * After this API finished, CameraActor coordinate system converted as DALi coordinate system.
+ *
+ * @param[in,out] camera CameraActor who need to apply model itself's transform
+ */
+ void ApplyCameraTransform(Dali::CameraActor camera) const;
+
+public: // Overrides LightObserver Methods.
+ /**
+ * @copydoc Dali::Scene3D::Internal::LightObserver::NotifyImageBasedLightTexture()
+ */
+ void NotifyImageBasedLightTexture(Dali::Texture diffuseTexture, Dali::Texture specularTexture, float scaleFactor, uint32_t specularMipmapLevels) override;
+
+ /**
+ * @copydoc Dali::Scene3D::Internal::LightObserver::NotifyImageBasedLightScaleFactor()
+ */
+ void NotifyImageBasedLightScaleFactor(float scaleFactor) override;
+
+ /**
+ * @copydoc Dali::Scene3D::Internal::LightObserver::NotifyLightAdded()
+ */
+ void NotifyLightAdded(uint32_t lightIndex, Scene3D::Light light) override;
+
+ /**
+ * @copydoc Dali::Scene3D::Internal::LightObserver::NotifyLightRemoved()
+ */
+ void NotifyLightRemoved(uint32_t lightIndex) override;
+
+private:
+ /**
+ * @brief Asynchronously model loading finished.
+ */
+ void OnModelLoadComplete();
+
+ /**
+ * @brief Asynchronously ibl diffusel image loading finished.
+ */
+ void OnIblDiffuseLoadComplete();
+
+ /**
+ * @brief Asynchronously ibl specular image loading finished.
+ */
+ void OnIblSpecularLoadComplete();
+
+ /**
+ * @brief Asynchronously ibl loading finished.
+ */
+ void OnIblLoadComplete();
+
+ /**
+ * @brief Update model root scale when Model size property is updated.
+ */
+ void OnSizeNotification(Dali::PropertyNotification& source);
+
+ /**
+ * @brief Reset Resource loading tasks.
+ */
+ void ResetResourceTasks();
+
+ /**
+ * @brief Reset a Resource loading task.
+ */
+ void ResetResourceTask(IntrusivePtr<AsyncTask> asyncTask);
+
+ /**
+ * @brief Notify Resource Ready signal.
+ */
+ void NotifyResourceReady();
+
+ /**
+ * @brief Create Model from loaded SceneDefinition.
+ */
+ void CreateModel();
+
+ /**
+ * @brief Create Dali::Animation from loaded AnimationDefinitions.
+ */
+ void CreateAnimations(Dali::Scene3D::Loader::SceneDefinition& scene);
+
+ /**
+ * @brief Reset CameraData from loaded CameraParameters.
+ */
+ void ResetCameraParameters();
+
+ /**
+ * @brief Collect ModelNode list by blendshape name
+ */
+ void UpdateBlendShapeNodeMap();
+
private:
std::string mModelUrl;
std::string mResourceDirectoryUrl;
- Dali::Actor mModelRoot;
+ Scene3D::ModelNode mModelRoot;
std::vector<AnimationData> mAnimations;
- std::vector<WeakHandle<Actor>> mRenderableActors;
+ std::vector<CameraData> mCameraParameters;
WeakHandle<Scene3D::SceneView> mParentSceneView;
+ Dali::PropertyNotification mSizeNotification;
+
+ // Light
+ std::vector<Scene3D::Light> mLights;
+
+ // List of ModelNode for name of blend shape.
+ BlendShapeModelNodeMap mBlendShapeModelNodeMap;
+
+ // Asynchronous loading variable
+ ModelLoadTaskPtr mModelLoadTask;
+ EnvironmentMapLoadTaskPtr mIblDiffuseLoadTask;
+ EnvironmentMapLoadTaskPtr mIblSpecularLoadTask;
+
+ std::string mDiffuseIblUrl;
+ std::string mSpecularIblUrl;
+ Dali::Texture mDefaultSpecularTexture;
+ Dali::Texture mDefaultDiffuseTexture;
+ Dali::Texture mSceneSpecularTexture;
+ Dali::Texture mSceneDiffuseTexture;
Dali::Texture mSpecularTexture;
Dali::Texture mDiffuseTexture;
Vector3 mNaturalSize;
Vector3 mModelPivot;
+ float mSceneIblScaleFactor;
float mIblScaleFactor;
+ uint32_t mSceneSpecularMipmapLevels;
+ uint32_t mSpecularMipmapLevels;
+ bool mModelChildrenSensitive;
+ bool mModelChildrenFocusable;
bool mModelResourceReady;
- bool mIBLResourceReady;
+ bool mIblDiffuseResourceReady;
+ bool mIblSpecularResourceReady;
+ bool mIblDiffuseDirty;
+ bool mIblSpecularDirty;
};
} // namespace Internal