1 #ifndef DALI_SCENE3D_MODEL_COMPONENTS_MODEL_NODE_IMPL_H
2 #define DALI_SCENE3D_MODEL_COMPONENTS_MODEL_NODE_IMPL_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/actors/custom-actor-impl.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <memory> // for std::unique_ptr
27 #include <dali-scene3d/internal/model-components/model-primitive-modify-observer.h>
28 #include <dali-scene3d/public-api/light/light.h>
29 #include <dali-scene3d/public-api/loader/mesh-definition.h>
30 #include <dali-scene3d/public-api/loader/skinning-details.h>
31 #include <dali-scene3d/public-api/model-components/model-node.h>
32 #include <dali-scene3d/public-api/model-components/model-primitive.h>
39 * @addtogroup dali_toolkit_controls_model
46 * @brief This is the internal base class for custom node of model.
50 class DALI_SCENE3D_API ModelNode : public CustomActorImpl, public ModelPrimitiveModifyObserver
53 using ModelPrimitiveContainer = std::vector<Scene3D::ModelPrimitive>;
54 using BoneDataContainer = std::vector<Dali::Scene3D::Loader::Skinning::BoneData>;
56 // Creation & Destruction
58 * @brief Creates a new ModelNodeImpl instance that does not require touch by default.
60 * If touch is required, then the user can connect to this class' touch signal.
62 * @return A handle to the ModelNode instance
64 static Scene3D::ModelNode New();
68 * @brief Virtual destructor.
73 protected: // From CustomActorImpl
75 * @copydoc CustomActorImpl::OnSceneConnection()
76 * @note If overridden, then an up-call to ModelNode::OnSceneConnection MUST be made at the end.
78 void OnSceneConnection(int depth) override;
81 * @copydoc CustomActorImpl::OnSceneDisconnection()
82 * @note If overridden, then an up-call to ModelNode::OnSceneDisconnection MUST be made at the end.
84 void OnSceneDisconnection() override;
87 * @copydoc CustomActorImpl::OnChildAdd()
88 * @note If overridden, then an up-call to ModelNode::OnChildAdd MUST be made at the end.
90 void OnChildAdd(Actor& child) override;
93 * @copydoc CustomActorImpl::OnChildRemove()
94 * @note If overridden, then an up-call to ModelNode::OnChildRemove MUST be made at the end.
96 void OnChildRemove(Actor& child) override;
99 * @copydoc CustomActorImpl::OnPropertySet()
100 * @note If overridden, then an up-call to ModelNode::OnChildRemove MUST be made at the end.
102 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
105 * @copydoc CustomActorImpl::OnSizeSet()
106 * @note If overridden, then an up-call to ModelNode::OnSizeSet MUST be made at the end.
108 void OnSizeSet(const Vector3& targetSize) override;
111 * @copydoc CustomActorImpl::OnSizeAnimation()
112 * @note If overridden, then an up-call to ModelNode::OnSizeAnimation MUST be made at the end.
114 void OnSizeAnimation(Animation& animation, const Vector3& targetSize) override;
117 * @copydoc CustomActorImpl::OnRelayout()
119 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
122 * @copydoc CustomActorImpl::OnSetResizePolicy()
124 void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override;
127 * @copydoc CustomActorImpl::GetNaturalSize()
129 Vector3 GetNaturalSize() override;
132 * @copydoc CustomActorImpl::CalculateChildSize()
134 float CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension) override;
137 * @copydoc CustomActorImpl::GetHeightForWidth()
139 float GetHeightForWidth(float width) override;
142 * @copydoc CustomActorImpl::GetWidthForHeight()
144 float GetWidthForHeight(float height) override;
147 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
149 bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) override;
152 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
154 void OnCalculateRelayoutSize(Dimension::Type dimension) override;
157 * @copydoc CustomActorImpl::OnLayoutNegotiated()
159 void OnLayoutNegotiated(float size, Dimension::Type dimension) override;
165 * @brief ModelNode constructor.
172 * @brief Second phase initialization.
177 public: // API for derived classes to override
181 * @brief This method is called after the Node has been initialized.
183 * Derived classes should do any second phase initialization by overriding this method.
186 virtual void OnInitialize();
188 public: // Public Method
190 * @copydoc Dali::Scene3D::ModelNode::GetModelPrimitiveCount()
192 uint32_t GetModelPrimitiveCount() const;
195 * @copydoc Dali::Scene3D::ModelNode::AddModelPrimitive()
197 void AddModelPrimitive(Dali::Scene3D::ModelPrimitive modelPrimitive);
200 * @copydoc Dali::Scene3D::ModelNode::RemoveModelPrimitive(Dali::Scene3D::ModelPrimitive modelPrimitive)
202 void RemoveModelPrimitive(Dali::Scene3D::ModelPrimitive modelPrimitive);
205 * @copydoc Dali::Scene3D::ModelNode::RemoveModelPrimitive(uint32_t index)
207 void RemoveModelPrimitive(uint32_t index);
210 * @copydoc Dali::Scene3D::ModelNode::GetModelPrimitive()
212 Dali::Scene3D::ModelPrimitive GetModelPrimitive(uint32_t index) const;
215 * @copydoc Dali::Scene3D::ModelNode::FindChildModelNodeByName()
217 Scene3D::ModelNode FindChildModelNodeByName(std::string_view nodeName);
220 * @brief Sets the diffuse and specular image-based lighting textures for a ModelPrimitive.
222 * @param[in] diffuseTexture The diffuse texture.
223 * @param[in] specularTexture The specular texture.
224 * @param[in] iblScaleFactor The scale factor for the image-based lighting.
225 * @param[in] specularMipmapLevels The number of mipmap levels for the specular texture.
227 void SetImageBasedLightTexture(Dali::Texture diffuseTexture, Dali::Texture specularTexture, float iblScaleFactor, uint32_t specularMipmapLevels);
230 * @brief Sets the scale factor for image-based lighting.
232 * @param[in] iblScaleFactor The scale factor for image-based lighting.
234 void SetImageBasedLightScaleFactor(float iblScaleFactor);
236 void AddLight(Scene3D::Light light, uint32_t lightIndex);
237 void RemoveLight(uint32_t lightIndex);
240 * @brief Sets the blend shape data for a ModelPrimitive.
242 * @param[in] data The blend shape data.
243 * @param[in] primitive The ModelPrimitive to set the blend shape data for.
245 void SetBlendShapeData(Scene3D::Loader::BlendShapes::BlendShapeData& data, Scene3D::ModelPrimitive primitive);
248 * @brief Sets the bone matrix for a ModelPrimitive and bone index.
250 * @param[in] inverseMatrix The inverse matrix of the bone.
251 * @param[in] primitive The ModelPrimitive to set the bone matrix for.
252 * @param[in] boneIndex The index of the bone to set the matrix for.
254 void SetBoneMatrix(const Matrix& inverseMatrix, Scene3D::ModelPrimitive primitive, Scene3D::Loader::Index& boneIndex);
257 * @brief Called when a Renderer of ModelPrimitive is created.
259 * @param[in] renderer The Renderer that is created.
261 void OnRendererCreated(Renderer renderer) override;
265 * @brief Updates the bone matrix for a ModelPrimitive.
267 * @param[in] primitive The ModelPrimitive to set the bone matrix for.
269 void UpdateBoneMatrix(Scene3D::ModelPrimitive primitive);
274 // Not copyable or movable
275 DALI_INTERNAL ModelNode(const ModelNode&) = delete; ///< Deleted copy constructor.
276 DALI_INTERNAL ModelNode(ModelNode&&) = delete; ///< Deleted move constructor.
277 DALI_INTERNAL ModelNode& operator=(const ModelNode&) = delete; ///< Deleted copy assignment operator.
278 DALI_INTERNAL ModelNode& operator=(ModelNode&&) = delete; ///< Deleted move assignment operator.
281 ModelPrimitiveContainer mModelPrimitiveContainer; ///< List of model primitives
282 BoneDataContainer mBoneDataContainer;
283 Dali::Texture mSpecularTexture;
284 Dali::Texture mDiffuseTexture;
285 float mIblScaleFactor{1.0f};
286 uint32_t mSpecularMipmapLevels{1u};
289 std::vector<Scene3D::Light> mLights;
294 * @brief Gets implementation from the handle.
298 * @return Implementation
299 * @pre handle is initialized and points to a node
301 DALI_SCENE3D_API Internal::ModelNode& GetImplementation(Dali::Scene3D::ModelNode& handle);
304 * @brief Gets implementation from the handle.
308 * @return Implementation
309 * @pre Handle is initialized and points to a node.
311 DALI_SCENE3D_API const Internal::ModelNode& GetImplementation(const Dali::Scene3D::ModelNode& handle);
313 } // namespace Internal
318 } // namespace Scene3D
322 #endif // DALI_SCENE3D_MODEL_COMPONENTS_MODEL_NODE_IMPL_H