2 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-scene3d/internal/loader/dli-loader-impl.h>
28 #include "dali-toolkit/devel-api/builder/json-parser.h"
29 #include "dali/devel-api/common/map-wrapper.h"
30 #include "dali/integration-api/debug.h"
31 #include "dali/public-api/object/property-array.h"
34 #include <dali-scene3d/internal/loader/json-util.h>
35 #include <dali-scene3d/public-api/loader/alpha-function-helper.h>
36 #include <dali-scene3d/public-api/loader/animation-definition.h>
37 #include <dali-scene3d/public-api/loader/blend-shape-details.h>
38 #include <dali-scene3d/public-api/loader/camera-parameters.h>
39 #include <dali-scene3d/public-api/loader/ktx-loader.h>
40 #include <dali-scene3d/public-api/loader/light-parameters.h>
41 #include <dali-scene3d/public-api/loader/load-result.h>
42 #include <dali-scene3d/public-api/loader/parse-renderer-state.h>
43 #include <dali-scene3d/public-api/loader/scene-definition.h>
44 #include <dali-scene3d/public-api/loader/skinning-details.h>
45 #include <dali-scene3d/public-api/loader/utils.h>
47 #define DLI_0_1_COMPATIBILITY
51 using namespace Toolkit;
59 namespace rs = RendererState;
63 const std::string NODES = "nodes";
64 const std::string SCENES = "scenes";
65 const std::string NODE = "node";
66 const std::string URI = "uri";
67 const std::string URL = "url";
68 const std::string CUSTOMIZATION = "customization";
69 const std::string HINTS = "hints";
70 const std::string NAME("name");
71 const std::string BLEND_SHAPE_HEADER("blendShapeHeader");
72 const std::string BLEND_SHAPES("blendShapes");
73 const std::string BLEND_SHAPE_VERSION_1_0("1.0");
74 const std::string BLEND_SHAPE_VERSION_2_0("2.0");
75 const std::string VERSION("version");
77 const char* const SHADOW_MAP_SIZE = "shadowMapSize";
78 const char* const ORTHOGRAPHIC_SIZE = "orthographicSize";
79 const char* const PIXEL_UNITS = "px";
81 const char SLASH = '/';
83 void ReadModelTransform(const TreeNode* node, Quaternion& orientation, Vector3& translation, Vector3& scale)
85 float num[16u] = {.0f};
87 if(ReadVector(node->GetChild("matrix"), num, 16u))
90 mat.GetTransformComponents(translation, orientation, scale);
94 if(ReadVector(node->GetChild("angle"), num, 3u))
96 orientation = Quaternion(Radian(Degree(num[0u])), Radian(Degree(num[1u])), Radian(Degree(num[2u])));
99 if(ReadVector(node->GetChild("position"), num, 3u))
101 translation = Vector3(num);
106 bool ReadAttribBlob(const TreeNode* node, MeshDefinition::Blob& buffer)
108 return ReadBlob(node, buffer.mOffset, buffer.mLength);
111 bool ReadAttribAccessor(const TreeNode* node, MeshDefinition::Accessor& accessor)
113 return ReadBlob(node, accessor.mBlob.mOffset, accessor.mBlob.mLength);
116 bool ReadColorCode(const TreeNode* node, Vector4& color, DliInputParameter::ConvertColorCode convertColorCode)
118 if(!node || !convertColorCode)
123 color = convertColorCode(node->GetString());
128 bool ReadColorCodeOrColor(const TreeNode* node, Vector4& color, DliInputParameter::ConvertColorCode convertColorCode)
130 return ReadColorCode(node->GetChild("colorCode"), color, convertColorCode) ||
131 ReadColor(node->GetChild("color"), color);
134 RendererState::Type ReadRendererState(const TreeNode& tnRendererState)
136 if(tnRendererState.GetType() == TreeNode::INTEGER)
138 return static_cast<RendererState::Type>(tnRendererState.GetInteger());
140 else if(tnRendererState.GetType() == TreeNode::STRING)
142 return RendererState::Parse(tnRendererState.GetString());
150 ///@brief Reads arc properties.
151 void ReadArcField(const TreeNode* eArc, ArcRenderable& arc)
153 ReadBool(eArc->GetChild("antiAliasing"), arc.mAntiAliasing);
154 ReadInt(eArc->GetChild("arcCaps"), arc.mArcCaps);
155 ReadFloat(eArc->GetChild("radius"), arc.mRadius);
157 arc.mStartAngleDegrees = .0f;
158 ReadFloat(eArc->GetChild("startAngle"), arc.mStartAngleDegrees);
160 arc.mEndAngleDegrees = .0f;
161 ReadFloat(eArc->GetChild("endAngle"), arc.mEndAngleDegrees);
164 const TreeNode* GetNthChild(const TreeNode* node, uint32_t index)
167 for(TreeNode::ConstIterator it = (*node).CBegin(); it != (*node).CEnd(); ++it, ++i)
171 return &((*it).second);
177 const TreeNode* RequireChild(const TreeNode* node, const std::string& childName)
179 auto child = node->GetChild(childName);
182 ExceptionFlinger flinger(ASSERT_LOCATION);
183 flinger << "Failed to find child node '" << childName << "'";
184 if(auto nodeName = node->GetName())
186 flinger << " on '" << nodeName << "'";
193 void ParseProperties(const Toolkit::TreeNode& node, Property::Array& array);
195 void ParseProperties(const Toolkit::TreeNode& node, Property::Map& map)
197 DALI_ASSERT_DEBUG(node.GetType() == TreeNode::OBJECT);
198 for(auto i0 = node.CBegin(), i1 = node.CEnd(); i0 != i1; ++i0)
201 switch(kv.second.GetType())
203 case TreeNode::ARRAY:
205 Property::Array array;
206 ParseProperties(kv.second, array);
207 map.Insert(kv.first, array);
211 case TreeNode::OBJECT:
213 Property::Map innerMap;
214 ParseProperties(kv.second, innerMap);
215 map.Insert(kv.first, innerMap);
219 case TreeNode::STRING:
221 map.Insert(kv.first, kv.second.GetString());
225 case TreeNode::INTEGER:
227 map.Insert(kv.first, kv.second.GetInteger());
231 case TreeNode::BOOLEAN:
233 map.Insert(kv.first, kv.second.GetBoolean());
237 case TreeNode::FLOAT:
239 map.Insert(kv.first, kv.second.GetFloat());
243 case TreeNode::IS_NULL:
251 void ParseProperties(const Toolkit::TreeNode& node, Property::Array& array)
253 DALI_ASSERT_DEBUG(node.GetType() == TreeNode::ARRAY);
254 for(auto i0 = node.CBegin(), i1 = node.CEnd(); i0 != i1; ++i0)
257 switch(kv.second.GetType())
259 case TreeNode::ARRAY:
261 Property::Array innerArray;
262 ParseProperties(kv.second, innerArray);
263 array.PushBack(innerArray);
267 case TreeNode::OBJECT:
270 ParseProperties(kv.second, map);
275 case TreeNode::STRING:
277 array.PushBack(kv.second.GetString());
281 case TreeNode::INTEGER:
283 array.PushBack(kv.second.GetInteger());
287 case TreeNode::BOOLEAN:
289 array.PushBack(kv.second.GetBoolean());
293 case TreeNode::FLOAT:
295 array.PushBack(kv.second.GetFloat());
299 case TreeNode::IS_NULL:
309 struct DliLoaderImpl::Impl
311 StringCallback mOnError = DefaultErrorCallback;
312 Toolkit::JsonParser mParser;
314 void ParseScene(LoadParams& params);
317 std::map<Index, Matrix> mInverseBindMatrices;
320 * @brief Due to .dli nodes being processed in depth-first traversal with orphans being
321 * ignored, features that rely on node indices (which is more compact and closer to
322 * glTF) require a mapping from .dli node indices to those in the resulting SceneDefinition.
323 * The index mapper is responsible for maintaing this mapping, and resolving node IDs
324 * once the processing of the nodes has finished.
325 * @note The resolution requires the whole scene graph to finish parsing, therefore any
326 * node extensions relying on node IDs will see the dli ID in their processor.
331 * @brief Attempts to create a mapping from a node's @a dli index to its @a scene
333 * @return Whether the operation was successful.
335 virtual bool Map(Index iDli, Index iScene) = 0;
338 * @return The scene index for the node's @a dli index.
340 virtual Index Resolve(Index iDli) = 0;
344 * @brief Traverses the DOM tree created by LoadDocument() in an attempt to create
345 * an intermediate representation of resources and nodes.
347 void ParseSceneInternal(Index iScene, const Toolkit::TreeNode* tnScenes, const Toolkit::TreeNode* tnNodes, LoadParams& params);
349 void ParseSkeletons(const Toolkit::TreeNode* skeletons, Dali::Scene3D::Loader::SceneDefinition& scene, Dali::Scene3D::Loader::ResourceBundle& resources);
350 void ParseEnvironments(const Toolkit::TreeNode* environments, Dali::Scene3D::Loader::ResourceBundle& resources);
351 void ParseMaterials(const Toolkit::TreeNode* materials, DliInputParameter::ConvertColorCode convertColorCode, Dali::Scene3D::Loader::ResourceBundle& resources);
353 void ParseNodes(const Toolkit::TreeNode* nodes, Index index, LoadParams& params);
354 void ParseNodesInternal(const Toolkit::TreeNode* nodes, Index index, std::vector<Index>& inOutParentStack, LoadParams& params, IIndexMapper& indexMapper);
356 void ParseAnimations(const Toolkit::TreeNode* animations, LoadParams& params);
357 void ParseAnimationGroups(const Toolkit::TreeNode* animationGroups, LoadParams& params);
359 void ParseShaders(const Toolkit::TreeNode* shaders, Dali::Scene3D::Loader::ResourceBundle& resources);
360 void ParseMeshes(const Toolkit::TreeNode* meshes, Dali::Scene3D::Loader::ResourceBundle& resources);
362 void GetCameraParameters(std::vector<Dali::Scene3D::Loader::CameraParameters>& cameras) const;
363 void GetLightParameters(std::vector<Dali::Scene3D::Loader::LightParameters>& lights) const;
366 DliLoaderImpl::DliLoaderImpl()
371 DliLoaderImpl::~DliLoaderImpl() = default;
373 void DliLoaderImpl::SetErrorCallback(StringCallback onError)
375 mImpl->mOnError = onError;
378 bool DliLoaderImpl::LoadModel(const std::string& uri, Dali::Scene3D::Loader::LoadResult& result)
380 std::string daliBuffer = LoadTextFile(uri.c_str());
382 auto& parser = mImpl->mParser;
383 parser = JsonParser::New();
384 if(!parser.Parse(daliBuffer))
389 std::filesystem::path modelPath(uri);
390 Dali::Scene3D::Loader::DliInputParameter input;
391 LoadParams loadParams;
394 loadParams.input = static_cast<DliInputParameter*>(mInputParameter);
398 input.mAnimationsPath = std::string(modelPath.parent_path()) + "/";
399 loadParams.input = &input;
401 loadParams.output = &result;
403 mImpl->ParseScene(loadParams);
407 std::string DliLoaderImpl::GetParseError() const
409 std::stringstream stream;
411 auto& parser = mImpl->mParser;
412 if(parser.ParseError())
414 stream << "position: " << parser.GetErrorPosition() << ", line: " << parser.GetErrorLineNumber() << ", column: " << parser.GetErrorColumn() << ", description: " << parser.GetErrorDescription() << ".";
420 void DliLoaderImpl::Impl::ParseScene(LoadParams& params)
422 auto& input = *params.input;
423 auto& output = *params.output;
425 // get index of root node.
426 auto docRoot = mParser.GetRoot();
429 // Process resources first - these are shared
430 if(auto environments = docRoot->GetChild("environment"))
432 ParseEnvironments(environments, output.mResources); // NOTE: must precede parsing of materials
435 if(auto meshes = docRoot->GetChild("meshes"))
437 ParseMeshes(meshes, output.mResources);
440 if(auto shaders = docRoot->GetChild("shaders"))
442 ParseShaders(shaders, output.mResources);
445 if(auto materials = docRoot->GetChild("materials"))
447 ParseMaterials(materials, input.mConvertColorCode, output.mResources);
450 for(auto& c : input.mPreNodeCategoryProcessors)
452 if(auto node = docRoot->GetChild(c.first))
454 Property::Array array;
455 ParseProperties(*node, array);
456 c.second(std::move(array), mOnError);
461 Index iScene = 0; // default scene
462 ReadIndex(docRoot->GetChild("scene"), iScene);
464 auto tnScenes = RequireChild(docRoot, "scenes");
465 auto tnNodes = RequireChild(docRoot, "nodes");
466 ParseSceneInternal(iScene, tnScenes, tnNodes, params);
468 ParseSkeletons(docRoot->GetChild("skeletons"), output.mScene, output.mResources);
470 output.mScene.EnsureUniqueSkinningShaderInstances(output.mResources);
471 output.mScene.EnsureUniqueBlendShapeShaderInstances(output.mResources);
473 // Ger cameras and lights
474 GetCameraParameters(output.mCameraParameters);
475 GetLightParameters(output.mLightParameters);
477 // Post-node processors and animations last
478 for(auto& c : input.mPostNodeCategoryProcessors)
480 if(auto node = docRoot->GetChild(c.first))
482 Property::Array array;
483 ParseProperties(*node, array);
484 c.second(std::move(array), mOnError);
488 if(auto animations = docRoot->GetChild("animations"))
490 ParseAnimations(animations, params);
493 if(!output.mAnimationDefinitions.empty())
495 if(auto animationGroups = docRoot->GetChild("animationGroups"))
497 ParseAnimationGroups(animationGroups, params);
503 void DliLoaderImpl::Impl::ParseSceneInternal(Index iScene, const Toolkit::TreeNode* tnScenes, const Toolkit::TreeNode* tnNodes, LoadParams& params)
505 auto getSceneRootIdx = [tnScenes, tnNodes](Index iScene)
507 auto tn = GetNthChild(tnScenes, iScene); // now a "scene" object
510 ExceptionFlinger(ASSERT_LOCATION) << iScene << " is out of bounds access into " << SCENES << ".";
513 tn = RequireChild(tn, NODES); // now a "nodes" array
514 if(tn->GetType() != TreeNode::ARRAY)
516 ExceptionFlinger(ASSERT_LOCATION) << SCENES << "[" << iScene << "]." << NODES << " has an invalid type; array required.";
521 ExceptionFlinger(ASSERT_LOCATION) << SCENES << "[" << iScene << "]." << NODES << " must define a node id.";
524 tn = GetNthChild(tn, 0); // now the first element of the array
526 if(!ReadIndex(tn, iRootNode))
528 ExceptionFlinger(ASSERT_LOCATION) << SCENES << "[" << iScene << "]." << NODES << " has an invalid value for root node index: '" << iRootNode << "'.";
531 if(iRootNode >= tnNodes->Size())
533 ExceptionFlinger(ASSERT_LOCATION) << "Root node index << " << iRootNode << " of scene " << iScene << " is out of bounds.";
536 tn = GetNthChild(tnNodes, iRootNode); // now a "node" object
537 if(tn->GetType() != TreeNode::OBJECT)
539 ExceptionFlinger(ASSERT_LOCATION) << "Root node of scene " << iScene << " is of invalid JSON type; object required";
545 Index iRootNode = getSceneRootIdx(iScene);
546 ParseNodes(tnNodes, iRootNode, params);
548 auto& scene = params.output->mScene;
549 scene.AddRootNode(0);
551 for(Index i = 0; i < iScene; ++i)
553 Index iRootNode = getSceneRootIdx(i);
554 const Index iRoot = scene.GetNodeCount();
555 ParseNodes(tnNodes, iRootNode, params);
556 scene.AddRootNode(iRoot);
559 auto numScenes = tnScenes->Size();
560 for(Index i = iScene + 1; i < numScenes; ++i)
562 Index iRootNode = getSceneRootIdx(i);
563 const Index iRoot = scene.GetNodeCount();
564 ParseNodes(tnNodes, iRootNode, params);
565 scene.AddRootNode(iRoot);
569 void DliLoaderImpl::Impl::ParseSkeletons(const TreeNode* skeletons, Dali::Scene3D::Loader::SceneDefinition& scene, Dali::Scene3D::Loader::ResourceBundle& resources)
573 auto iStart = skeletons->CBegin();
574 for(auto i0 = iStart, i1 = skeletons->CEnd(); i0 != i1; ++i0)
576 auto& node = (*i0).second;
577 std::string skeletonRootName;
578 if(ReadString(node.GetChild(NODE), skeletonRootName))
580 SkeletonDefinition skeleton;
581 if(!scene.FindNode(skeletonRootName, &skeleton.mRootNodeIdx))
583 ExceptionFlinger(ASSERT_LOCATION) << FormatString("Skeleton %d: node '%s' not defined.", resources.mSkeletons.size(), skeletonRootName.c_str());
586 uint32_t jointCount = 0;
587 std::function<void(Index)> visitFn;
588 auto& ibms = mInverseBindMatrices;
589 visitFn = [&](Index id)
591 auto node = scene.GetNode(id);
592 jointCount += ibms.find(id) != ibms.end();
594 for(auto i : node->mChildren)
599 visitFn(skeleton.mRootNodeIdx);
601 if(jointCount > Skinning::MAX_JOINTS)
603 mOnError(FormatString("Skeleton %d: joint count exceeds supported limit.", resources.mSkeletons.size()));
604 jointCount = Skinning::MAX_JOINTS;
607 skeleton.mJoints.reserve(jointCount);
609 visitFn = [&](Index id)
611 auto iFind = ibms.find(id);
612 if(iFind != ibms.end() && skeleton.mJoints.size() < Skinning::MAX_JOINTS)
614 skeleton.mJoints.push_back({id, iFind->second});
617 auto node = scene.GetNode(id);
618 for(auto i : node->mChildren)
623 visitFn(skeleton.mRootNodeIdx);
625 resources.mSkeletons.push_back(std::move(skeleton));
629 ExceptionFlinger(ASSERT_LOCATION) << "skeleton " << std::distance(iStart, i0) << ": Missing required attribute '" << NODE << "'.";
635 void DliLoaderImpl::Impl::ParseEnvironments(const TreeNode* environments, Dali::Scene3D::Loader::ResourceBundle& resources)
637 Matrix cubeOrientation(Matrix::IDENTITY);
639 for(auto i0 = environments->CBegin(), i1 = environments->CEnd(); i0 != i1; ++i0)
641 auto& node = (*i0).second;
643 EnvironmentDefinition envDef;
644 ReadString(node.GetChild("cubeSpecular"), envDef.mSpecularMapPath);
645 ReadString(node.GetChild("cubeDiffuse"), envDef.mDiffuseMapPath);
646 ToUnixFileSeparators(envDef.mSpecularMapPath);
647 ToUnixFileSeparators(envDef.mDiffuseMapPath);
648 envDef.mIblIntensity = 1.0f;
649 ReadFloat(node.GetChild("iblIntensity"), envDef.mIblIntensity);
650 if(ReadVector(node.GetChild("cubeInitialOrientation"), cubeOrientation.AsFloat(), 16u))
652 envDef.mCubeOrientation = Quaternion(cubeOrientation);
655 resources.mEnvironmentMaps.emplace_back(std::move(envDef), EnvironmentDefinition::Textures());
658 // NOTE: guarantees environmentMaps to have an empty environment.
659 if(resources.mEnvironmentMaps.empty())
661 resources.mEnvironmentMaps.emplace_back(EnvironmentDefinition(), EnvironmentDefinition::Textures());
665 void DliLoaderImpl::Impl::ParseShaders(const TreeNode* shaders, Dali::Scene3D::Loader::ResourceBundle& resources)
667 uint32_t iShader = 0;
668 for(auto i0 = shaders->CBegin(), i1 = shaders->CEnd(); i0 != i1; ++i0, ++iShader)
670 auto& node = (*i0).second;
671 ShaderDefinition shaderDef;
672 ReadStringVector(node.GetChild("defines"), shaderDef.mDefines);
674 // Read shader hints. Possible values are:
675 // Don't define for No hints.
676 // "OUTPUT_IS_TRANSPARENT" Might generate transparent alpha from opaque inputs.
677 // "MODIFIES_GEOMETRY" Might change position of vertices, this option disables any culling optimizations.
679 ReadStringVector(node.GetChild(HINTS), shaderDef.mHints);
681 if(ReadString(node.GetChild("vertex"), shaderDef.mVertexShaderPath) &&
682 ReadString(node.GetChild("fragment"), shaderDef.mFragmentShaderPath))
684 ToUnixFileSeparators(shaderDef.mVertexShaderPath);
685 ToUnixFileSeparators(shaderDef.mFragmentShaderPath);
687 for(TreeNode::ConstIterator j0 = node.CBegin(), j1 = node.CEnd(); j0 != j1; ++j0)
689 const TreeNode::KeyNodePair& keyValue = *j0;
690 const std::string& key = keyValue.first;
691 const TreeNode& value = keyValue.second;
693 Property::Value uniformValue;
694 if(key.compare("vertex") == 0 || key.compare("fragment") == 0 || key.compare("defines") == 0 || key.compare(HINTS) == 0)
698 else if(key.compare("rendererState") == 0)
700 shaderDef.mRendererState = ReadRendererState(keyValue.second);
702 else if(value.GetType() == TreeNode::INTEGER || value.GetType() == TreeNode::FLOAT)
705 ReadFloat(&value, f);
708 else if(value.GetType() == TreeNode::BOOLEAN)
710 DALI_LOG_WARNING("\"bool\" uniforms are handled as floats in shader");
712 if(ReadBool(&keyValue.second, value))
714 uniformValue = value ? 1.0f : 0.0f;
718 switch(auto size = GetNumericalArraySize(&value))
723 ReadVector(&value, m.AsFloat(), size);
731 ReadVector(&value, m.AsFloat(), size);
739 ReadVector(&value, v.AsFloat(), size);
747 ReadVector(&value, v.AsFloat(), size);
755 ReadVector(&value, v.AsFloat(), size);
761 mOnError(FormatString(
762 "shader %u: Ignoring uniform '%s': failed to infer type from %zu elements.",
769 if(Property::NONE != uniformValue.GetType())
771 shaderDef.mUniforms.Insert(key, uniformValue);
775 resources.mShaders.emplace_back(std::move(shaderDef), Shader());
779 ExceptionFlinger(ASSERT_LOCATION) << "shader " << iShader << ": Missing vertex / fragment shader definition.";
784 void DliLoaderImpl::Impl::ParseMeshes(const TreeNode* meshes, Dali::Scene3D::Loader::ResourceBundle& resources)
786 for(auto i0 = meshes->CBegin(), i1 = meshes->CEnd(); i0 != i1; ++i0)
788 auto& node = (*i0).second;
790 MeshDefinition meshDef;
791 if(!ReadString(node.GetChild(URI), meshDef.mUri))
793 ExceptionFlinger(ASSERT_LOCATION) << "mesh " << resources.mMeshes.size() << ": Missing required attribute '" << URI << "'.";
796 ToUnixFileSeparators(meshDef.mUri);
798 std::string primitive;
799 if(ReadString(node.GetChild("primitive"), primitive))
801 if(primitive == "LINES")
803 meshDef.mPrimitiveType = Geometry::LINES;
805 else if(primitive == "POINTS")
807 meshDef.mPrimitiveType = Geometry::POINTS;
809 else if(primitive != "TRIANGLES")
811 mOnError(FormatString(
812 "mesh %d: Using TRIANGLES instead of unsupported primitive type '%s'.",
813 resources.mMeshes.size(),
819 if(ReadInt(node.GetChild("attributes"), attributes))
821 if(MaskMatch(attributes, MeshDefinition::INDICES) &&
822 !ReadAttribAccessor(node.GetChild("indices"), meshDef.mIndices))
824 ExceptionFlinger(ASSERT_LOCATION) << FormatString("mesh %d: Failed to read %s.",
825 resources.mMeshes.size(),
829 if(MaskMatch(attributes, MeshDefinition::POSITIONS) &&
830 !ReadAttribAccessor(node.GetChild("positions"), meshDef.mPositions))
832 ExceptionFlinger(ASSERT_LOCATION) << FormatString("mesh %d: Failed to read %s.",
833 resources.mMeshes.size(),
837 if(MaskMatch(attributes, MeshDefinition::NORMALS) &&
838 !ReadAttribAccessor(node.GetChild("normals"), meshDef.mNormals))
840 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "normals"));
843 if(MaskMatch(attributes, MeshDefinition::TEX_COORDS) &&
844 !ReadAttribAccessor(node.GetChild("textures"), meshDef.mTexCoords))
846 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "textures"));
849 if(MaskMatch(attributes, MeshDefinition::TANGENTS) &&
850 !ReadAttribAccessor(node.GetChild("tangents"), meshDef.mTangents))
852 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "tangents"));
855 // NOTE: we're no longer reading bitangents as these are calculated in the shaders.
856 if(ReadIndex(node.GetChild("skeleton"), meshDef.mSkeletonIdx))
858 if(!MaskMatch(attributes, MeshDefinition::JOINTS_0) &&
859 !MaskMatch(attributes, MeshDefinition::WEIGHTS_0))
861 mOnError(FormatString("mesh %d: Expected joints0 / weights0 attribute(s) missing.",
862 resources.mMeshes.size()));
864 else if(!ReadAttribAccessor(node.GetChild("joints0"), meshDef.mJoints0) ||
865 !ReadAttribAccessor(node.GetChild("weights0"), meshDef.mWeights0))
867 mOnError(FormatString("mesh %d: Failed to read skinning information.",
868 resources.mMeshes.size()));
872 if(auto blendshapeHeader = node.GetChild(BLEND_SHAPE_HEADER))
874 std::string blendShapeVersion;
875 ReadString(blendshapeHeader->GetChild(VERSION), blendShapeVersion);
877 if(0u == blendShapeVersion.compare(BLEND_SHAPE_VERSION_1_0))
879 meshDef.mBlendShapeVersion = BlendShapes::Version::VERSION_1_0;
881 else if(0u == blendShapeVersion.compare(BLEND_SHAPE_VERSION_2_0))
883 meshDef.mBlendShapeVersion = BlendShapes::Version::VERSION_2_0;
886 switch(meshDef.mBlendShapeVersion)
888 case BlendShapes::Version::VERSION_1_0:
889 case BlendShapes::Version::VERSION_2_0: // FALL THROUGH
891 ReadAttribBlob(blendshapeHeader, meshDef.mBlendShapeHeader);
902 if(auto blendShapes = node.GetChild(BLEND_SHAPES))
904 meshDef.mBlendShapes.resize(blendShapes->Size());
907 for(auto it = blendShapes->CBegin(), endIt = blendShapes->CEnd(); it != endIt; ++it, ++index)
909 // Each blend shape is stored as the difference with the original mesh.
911 auto& blendShapeNode = (*it).second;
913 auto& blendShape = meshDef.mBlendShapes[index];
914 ReadString(blendShapeNode.GetChild("name"), blendShape.name);
915 if(auto position = blendShapeNode.GetChild("positions"))
917 ReadAttribAccessor(position, blendShape.deltas);
919 if(auto normals = blendShapeNode.GetChild("normals"))
921 ReadAttribAccessor(normals, blendShape.normals);
923 if(auto tangents = blendShapeNode.GetChild("tangents"))
925 ReadAttribAccessor(tangents, blendShape.tangents);
927 ReadFloat(blendShapeNode.GetChild("weight"), blendShape.weight);
932 if(ReadBool(node.GetChild("flipV"), flipV))
934 meshDef.mFlags |= flipV * MeshDefinition::FLIP_UVS_VERTICAL;
937 resources.mMeshes.emplace_back(std::move(meshDef), MeshGeometry());
942 void DliLoaderImpl::Impl::ParseMaterials(const TreeNode* materials, DliInputParameter::ConvertColorCode convertColorCode, Dali::Scene3D::Loader::ResourceBundle& resources)
944 for(auto i0 = materials->CBegin(), i1 = materials->CEnd(); i0 != i1; ++i0)
946 auto& node = (*i0).second;
948 MaterialDefinition materialDef;
949 if(auto eEnvironment = node.GetChild("environment"))
951 ReadIndex(eEnvironment, materialDef.mEnvironmentIdx);
952 if(static_cast<unsigned int>(materialDef.mEnvironmentIdx) >= resources.mEnvironmentMaps.size())
954 ExceptionFlinger(ASSERT_LOCATION) << "material " << resources.mMaterials.size() << ": Environment index " << materialDef.mEnvironmentIdx << " out of bounds (" << resources.mEnvironmentMaps.size() << ").";
958 // TODO : need to consider AGIF
959 std::vector<std::string> texturePaths;
960 std::string texturePath;
961 if(ReadString(node.GetChild("albedoMap"), texturePath))
963 ToUnixFileSeparators(texturePath);
964 const auto semantic = MaterialDefinition::ALBEDO;
965 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
966 materialDef.mFlags |= semantic | MaterialDefinition::TRANSPARENCY; // NOTE: only in dli does single / separate ALBEDO texture mean TRANSPARENCY.
968 if(ReadString(node.GetChild("albedoMetallicMap"), texturePath))
970 ToUnixFileSeparators(texturePath);
972 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO))
974 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "albedo"));
977 const auto semantic = MaterialDefinition::ALBEDO | MaterialDefinition::METALLIC;
978 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
979 materialDef.mFlags |= semantic;
982 if(ReadString(node.GetChild("metallicRoughnessMap"), texturePath))
984 ToUnixFileSeparators(texturePath);
986 if(MaskMatch(materialDef.mFlags, MaterialDefinition::METALLIC))
988 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "metallic"));
991 const auto semantic = MaterialDefinition::METALLIC | MaterialDefinition::ROUGHNESS;
992 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
993 materialDef.mFlags |= semantic |
994 // We have a metallic-roughhness map and the first texture did not have albedo semantics - we're in the transparency workflow.
995 (MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO) * MaterialDefinition::TRANSPARENCY);
998 if(ReadString(node.GetChild("normalMap"), texturePath))
1000 ToUnixFileSeparators(texturePath);
1002 const auto semantic = MaterialDefinition::NORMAL;
1003 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1004 materialDef.mFlags |= semantic |
1005 // We have a standalone normal map and the first texture did not have albedo semantics - we're in the transparency workflow.
1006 (MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO) * MaterialDefinition::TRANSPARENCY);
1009 if(ReadString(node.GetChild("normalRoughnessMap"), texturePath))
1011 ToUnixFileSeparators(texturePath);
1013 if(MaskMatch(materialDef.mFlags, MaterialDefinition::NORMAL))
1015 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "normal"));
1018 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ROUGHNESS))
1020 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "roughness"));
1023 if(MaskMatch(materialDef.mFlags, MaterialDefinition::TRANSPARENCY))
1025 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "transparency"));
1028 const auto semantic = MaterialDefinition::NORMAL | MaterialDefinition::ROUGHNESS;
1029 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1030 materialDef.mFlags |= semantic;
1033 if(ReadString(node.GetChild("subsurfaceMap"), texturePath))
1035 ToUnixFileSeparators(texturePath);
1037 const auto semantic = MaterialDefinition::SUBSURFACE;
1038 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1039 materialDef.mFlags |= semantic;
1042 if(ReadString(node.GetChild("occlusionMap"), texturePath))
1044 ToUnixFileSeparators(texturePath);
1045 const auto semantic = MaterialDefinition::OCCLUSION;
1046 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1047 materialDef.mFlags |= semantic;
1050 if(ReadColorCodeOrColor(&node, materialDef.mColor, convertColorCode) &&
1051 materialDef.mColor.a < 1.0f)
1053 materialDef.mFlags |= MaterialDefinition::TRANSPARENCY;
1056 ReadFloat(node.GetChild("metallic"), materialDef.mMetallic);
1057 ReadFloat(node.GetChild("roughness"), materialDef.mRoughness);
1060 if(ReadBool(node.GetChild("mipmap"), mipmaps) && mipmaps)
1062 for(auto& ts : materialDef.mTextureStages)
1064 ts.mTexture.mSamplerFlags |= SamplerFlags::FILTER_MIPMAP_LINEAR;
1068 resources.mMaterials.emplace_back(std::move(materialDef), TextureSet());
1072 void DliLoaderImpl::Impl::ParseNodes(const TreeNode* const nodes, Index index, LoadParams& params)
1074 std::vector<Index> parents;
1077 struct IndexMapper : IIndexMapper
1079 IndexMapper(size_t numNodes)
1081 mIndices.reserve(numNodes);
1084 virtual bool Map(Index iDli, Index iScene) override
1086 Entry idx{iDli, iScene};
1087 auto iInsert = std::lower_bound(mIndices.begin(), mIndices.end(), idx);
1088 if(iInsert == mIndices.end() || iInsert->iDli != iDli)
1090 mIndices.insert(iInsert, idx);
1092 else if(iInsert->iScene != iScene)
1099 virtual unsigned int Resolve(Index iDli) override
1101 auto iFind = std::lower_bound(mIndices.begin(), mIndices.end(), iDli, [](const Entry& idx, Index iDli)
1102 { return idx.iDli < iDli; });
1103 DALI_ASSERT_ALWAYS(iFind != mIndices.end());
1104 return iFind->iScene;
1111 unsigned int iScene;
1113 bool operator<(const Entry& other) const
1115 return iDli < other.iDli;
1118 std::vector<Entry> mIndices;
1119 } mapper(nodes->Size());
1120 ParseNodesInternal(nodes, index, parents, params, mapper);
1122 auto& scene = params.output->mScene;
1123 for(size_t i0 = 0, i1 = scene.GetNodeCount(); i0 < i1; ++i0)
1125 for(auto& c : scene.GetNode(i0)->mConstraints)
1127 c.mSourceIdx = mapper.Resolve(c.mSourceIdx);
1132 void DliLoaderImpl::Impl::ParseNodesInternal(const TreeNode* const nodes, Index index, std::vector<Index>& inOutParentStack, LoadParams& params, IIndexMapper& mapper)
1134 // Properties that may be resolved from a JSON value with ReadInt() -- or default to 0.
1135 struct IndexProperty
1137 ResourceType::Value type;
1138 const TreeNode* source;
1141 std::vector<IndexProperty> resourceIds;
1142 resourceIds.reserve(4);
1144 if(auto node = GetNthChild(nodes, index))
1146 Dali::Scene3D::Loader::NodeDefinition nodeDef;
1147 nodeDef.mParentIdx = inOutParentStack.empty() ? INVALID_INDEX : inOutParentStack.back();
1150 ReadString(node->GetChild(NAME), nodeDef.mName);
1153 ReadModelTransform(node, nodeDef.mOrientation, nodeDef.mPosition, nodeDef.mScale);
1155 // Reads the size of the node.
1157 // * It can be given as 'size' or 'bounds'.
1158 // * The sdk saves the 'size' as a vector2 in some cases.
1159 // * To avoid size related issues the following code attemps
1160 // to read the 'size/bounds' as a vector3 first, if it's
1161 // not successful then reads it as a vector2.
1162 ReadVector(node->GetChild("size"), nodeDef.mSize.AsFloat(), 3) ||
1163 ReadVector(node->GetChild("size"), nodeDef.mSize.AsFloat(), 2) ||
1164 ReadVector(node->GetChild("bounds"), nodeDef.mSize.AsFloat(), 3) ||
1165 ReadVector(node->GetChild("bounds"), nodeDef.mSize.AsFloat(), 2);
1168 ReadBool(node->GetChild("visible"), nodeDef.mIsVisible);
1170 // type classification
1171 if(auto eCustomization = node->GetChild("customization")) // customization
1174 if(ReadString(eCustomization->GetChild("tag"), tag))
1176 nodeDef.mCustomization.reset(new Dali::Scene3D::Loader::NodeDefinition::CustomizationDefinition{tag});
1179 else // something renderable maybe
1181 std::unique_ptr<Dali::Scene3D::Loader::NodeDefinition::Renderable> renderable;
1182 ModelRenderable* modelRenderable = nullptr; // no ownership, aliasing renderable for the right type.
1184 const TreeNode* eRenderable = nullptr;
1185 if((eRenderable = node->GetChild("model")))
1187 // check for mesh before allocating - this can't be missing.
1188 auto eMesh = eRenderable->GetChild("mesh");
1191 ExceptionFlinger(ASSERT_LOCATION) << "node " << nodeDef.mName << ": Missing mesh definition.";
1194 modelRenderable = new ModelRenderable();
1195 renderable.reset(modelRenderable);
1197 resourceIds.push_back({ResourceType::Mesh, eMesh, modelRenderable->mMeshIdx});
1199 else if((eRenderable = node->GetChild("arc")))
1201 // check for mesh before allocating - this can't be missing.
1202 auto eMesh = eRenderable->GetChild("mesh");
1205 ExceptionFlinger(ASSERT_LOCATION) << "node " << nodeDef.mName << ": Missing mesh definition.";
1208 auto arcRenderable = new ArcRenderable;
1209 renderable.reset(arcRenderable);
1210 modelRenderable = arcRenderable;
1212 resourceIds.push_back({ResourceType::Mesh, eMesh, arcRenderable->mMeshIdx});
1214 ReadArcField(eRenderable, *arcRenderable);
1217 if(renderable && eRenderable != nullptr) // process common properties of all renderables + register payload
1220 renderable->mShaderIdx = 0;
1221 auto eShader = eRenderable->GetChild("shader");
1224 resourceIds.push_back({ResourceType::Shader, eShader, renderable->mShaderIdx});
1230 modelRenderable->mMaterialIdx = 0; // must offer default of 0
1231 auto eMaterial = eRenderable->GetChild("material");
1234 resourceIds.push_back({ResourceType::Material, eMaterial, modelRenderable->mMaterialIdx});
1237 if(!ReadColorCodeOrColor(eRenderable, modelRenderable->mColor, params.input->mConvertColorCode))
1239 ReadColorCodeOrColor(node, modelRenderable->mColor, params.input->mConvertColorCode);
1243 nodeDef.mRenderables.push_back(std::move(renderable));
1247 // Resolve ints - default to 0 if undefined
1248 auto& output = params.output;
1249 for(auto& idRes : resourceIds)
1254 case ResourceType::Shader:
1255 iCheck = output->mResources.mShaders.size();
1258 case ResourceType::Mesh:
1259 iCheck = output->mResources.mMeshes.size();
1262 case ResourceType::Material:
1263 iCheck = output->mResources.mMaterials.size();
1267 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": Invalid resource type: " << idRes.type << " (Programmer error)";
1274 else if(idRes.source->GetType() != TreeNode::INTEGER)
1276 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": Invalid " << GetResourceTypeName(idRes.type) << " index type.";
1280 idRes.target = idRes.source->GetInteger();
1283 if(idRes.target >= iCheck)
1285 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": " << GetResourceTypeName(idRes.type) << " index " << idRes.target << " out of bounds (" << iCheck << ").";
1288 resourceIds.clear();
1291 if(auto eExtras = node->GetChild("extras"))
1293 auto& extras = nodeDef.mExtras;
1294 extras.reserve(eExtras->Size());
1296 for(auto i0 = eExtras->CBegin(), i1 = eExtras->CEnd(); i0 != i1; ++i0)
1298 Dali::Scene3D::Loader::NodeDefinition::Extra e;
1301 e.mKey = eExtra.first;
1304 mOnError(FormatString("node %d: empty string is invalid for name of extra %d; ignored.",
1310 e.mValue = ReadPropertyValue(eExtra.second);
1311 if(e.mValue.GetType() == Property::Type::NONE)
1313 mOnError(FormatString("node %d: failed to interpret value of extra '%s' : %s; ignored.",
1316 eExtra.second.GetString()));
1320 auto iInsert = std::lower_bound(extras.begin(), extras.end(), e);
1321 if(iInsert != extras.end() && iInsert->mKey == e.mKey)
1323 mOnError(FormatString("node %d: extra '%s' already defined; overriding with %s.",
1326 eExtra.second.GetString()));
1327 *iInsert = std::move(e);
1331 extras.insert(iInsert, e);
1338 if(auto eConstraints = node->GetChild("constraints"))
1340 auto& constraints = nodeDef.mConstraints;
1341 constraints.reserve(eConstraints->Size());
1343 ConstraintDefinition cDef;
1344 for(auto i0 = eConstraints->CBegin(), i1 = eConstraints->CEnd(); i0 != i1; ++i0)
1346 auto eConstraint = *i0;
1347 if(!ReadIndex(&eConstraint.second, cDef.mSourceIdx))
1349 mOnError(FormatString("node %d: node ID %s for constraint %d is invalid; ignored.",
1351 eConstraint.second.GetString(),
1352 constraints.size()));
1356 cDef.mProperty = eConstraint.first;
1358 auto iInsert = std::lower_bound(constraints.begin(), constraints.end(), cDef);
1359 if(iInsert != constraints.end() && *iInsert == cDef)
1361 mOnError(FormatString("node %d: constraint %s@%d already defined; ignoring.",
1363 cDef.mProperty.c_str(),
1368 constraints.insert(iInsert, cDef);
1374 // Determine index for mapping
1375 const unsigned int myIndex = output->mScene.GetNodeCount();
1376 if(!mapper.Map(index, myIndex))
1378 mOnError(FormatString("node %d: error mapping dli index %d: node has multiple parents. Ignoring subtree.", index, myIndex));
1382 // if the node is a bone in a skeletal animation, it will have the inverse bind pose matrix.
1383 Matrix invBindMatrix{false};
1384 if(ReadVector(node->GetChild("inverseBindPoseMatrix"), invBindMatrix.AsFloat(), 16u)) // TODO: more robust error checking?
1386 mInverseBindMatrices[myIndex] = invBindMatrix;
1390 auto rawDef = output->mScene.AddNode(std::make_unique<Dali::Scene3D::Loader::NodeDefinition>(std::move(nodeDef)));
1391 if(rawDef) // NOTE: no ownership. Guaranteed to stay in scope.
1393 // ...And only then parse children.
1394 if(auto children = node->GetChild("children"))
1396 inOutParentStack.push_back(myIndex);
1398 rawDef->mChildren.reserve(children->Size());
1400 uint32_t iChild = 0;
1401 for(auto j0 = children->CBegin(), j1 = children->CEnd(); j0 != j1; ++j0, ++iChild)
1403 auto& child = (*j0).second;
1404 if(child.GetType() == TreeNode::INTEGER)
1406 ParseNodesInternal(nodes, child.GetInteger(), inOutParentStack, params, mapper); // child object is created in scene definition.
1410 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ", child " << iChild << ": invalid index type.";
1414 inOutParentStack.pop_back();
1416 else if(rawDef->mCustomization)
1418 mOnError(FormatString("node %d: not an actual customization without children.", index));
1421 if(auto proc = params.input->mNodePropertyProcessor) // optional processing
1423 // WARNING: constraint IDs are not resolved at this point.
1424 Property::Map nodeData;
1425 ParseProperties(*node, nodeData);
1426 proc(*rawDef, std::move(nodeData), mOnError);
1431 ExceptionFlinger(ASSERT_LOCATION) << "Node " << index << ": name already used.";
1436 void DliLoaderImpl::Impl::ParseAnimations(const TreeNode* tnAnimations, LoadParams& params)
1438 auto& definitions = params.output->mAnimationDefinitions;
1439 definitions.reserve(definitions.size() + tnAnimations->Size());
1441 for(TreeNode::ConstIterator iAnim = tnAnimations->CBegin(), iAnimEnd = tnAnimations->CEnd();
1445 const TreeNode& tnAnim = (*iAnim).second;
1446 AnimationDefinition animDef;
1447 ReadString(tnAnim.GetChild(NAME), animDef.mName);
1449 auto iFind = std::lower_bound(definitions.begin(), definitions.end(), animDef, [](const AnimationDefinition& ad0, const AnimationDefinition& ad1)
1450 { return ad0.mName < ad1.mName; });
1451 const bool overwrite = iFind != definitions.end() && iFind->mName == animDef.mName;
1454 mOnError(FormatString("Pre-existing animation with name '%s' is being overwritten.", animDef.mName.c_str()));
1457 // Duration -- We need something that animated properties' delay / duration can
1458 // be expressed as a multiple of; 0 won't work. This is small enough (i.e. shorter
1459 // than our frame delay) to not be restrictive WRT replaying. If anything needs
1460 // to occur more frequently, then Animations are likely not your solution anyway.
1461 animDef.mDuration = AnimationDefinition::MIN_DURATION_SECONDS;
1462 if(!ReadFloat(tnAnim.GetChild("duration"), animDef.mDuration))
1464 mOnError(FormatString("Animation '%s' fails to define '%s', defaulting to %f.",
1465 animDef.mName.c_str(),
1467 animDef.mDuration));
1470 // Get loop count - # of playbacks. Default is once. 0 means repeat indefinitely.
1471 animDef.mLoopCount = 1;
1472 if(ReadInt(tnAnim.GetChild("loopCount"), animDef.mLoopCount) &&
1473 animDef.mLoopCount < 0)
1475 animDef.mLoopCount = 0;
1478 std::string endAction;
1479 if(ReadString(tnAnim.GetChild("endAction"), endAction))
1481 if("BAKE" == endAction)
1483 animDef.mEndAction = Animation::BAKE;
1485 else if("DISCARD" == endAction)
1487 animDef.mEndAction = Animation::DISCARD;
1489 else if("BAKE_FINAL" == endAction)
1491 animDef.mEndAction = Animation::BAKE_FINAL;
1495 if(ReadString(tnAnim.GetChild("disconnectAction"), endAction))
1497 if("BAKE" == endAction)
1499 animDef.mDisconnectAction = Animation::BAKE;
1501 else if("DISCARD" == endAction)
1503 animDef.mDisconnectAction = Animation::DISCARD;
1505 else if("BAKE_FINAL" == endAction)
1507 animDef.mDisconnectAction = Animation::BAKE_FINAL;
1511 if(const TreeNode* tnProperties = tnAnim.GetChild("properties"))
1513 animDef.mProperties.reserve(tnProperties->Size());
1514 for(TreeNode::ConstIterator iProperty = tnProperties->CBegin(), iPropertyEnd = tnProperties->CEnd();
1515 iProperty != iPropertyEnd;
1518 const TreeNode& tnProperty = (*iProperty).second;
1520 AnimatedProperty animProp;
1521 if(!ReadString(tnProperty.GetChild("node"), animProp.mNodeName))
1523 mOnError(FormatString("Animation '%s': Failed to read the 'node' tag.", animDef.mName.c_str()));
1527 if(!ReadString(tnProperty.GetChild("property"), animProp.mPropertyName))
1529 mOnError(FormatString("Animation '%s': Failed to read the 'property' tag", animDef.mName.c_str()));
1533 // these are the defaults
1534 animProp.mTimePeriod.delaySeconds = 0.f;
1535 animProp.mTimePeriod.durationSeconds = animDef.mDuration;
1536 if(!ReadTimePeriod(tnProperty.GetChild("timePeriod"), animProp.mTimePeriod))
1538 mOnError(FormatString("Animation '%s': timePeriod missing in Property #%d: defaulting to %f.",
1539 animDef.mName.c_str(),
1540 animDef.mProperties.size(),
1541 animProp.mTimePeriod.durationSeconds));
1544 std::string alphaFunctionValue;
1545 if(ReadString(tnProperty.GetChild("alphaFunction"), alphaFunctionValue))
1547 animProp.mAlphaFunction = GetAlphaFunction(alphaFunctionValue);
1550 if(const TreeNode* tnKeyFramesBin = tnProperty.GetChild("keyFramesBin"))
1552 DALI_ASSERT_ALWAYS(!animProp.mPropertyName.empty() && "Animation must specify a property name");
1554 std::ifstream binAniFile;
1555 std::string animationFilename;
1556 if(ReadString(tnKeyFramesBin->GetChild(URL), animationFilename))
1558 std::string animationFullPath = params.input->mAnimationsPath + animationFilename;
1559 binAniFile.open(animationFullPath, std::ios::binary);
1560 if(binAniFile.fail())
1562 ExceptionFlinger(ASSERT_LOCATION) << "Failed to open animation data '" << animationFullPath << "'";
1567 ReadInt(tnKeyFramesBin->GetChild("byteOffset"), byteOffset);
1568 DALI_ASSERT_ALWAYS(byteOffset >= 0);
1570 binAniFile.seekg(byteOffset, std::ios::beg);
1573 ReadInt(tnKeyFramesBin->GetChild("numKeys"), numKeys);
1574 DALI_ASSERT_ALWAYS(numKeys >= 0);
1576 animProp.mKeyFrames = KeyFrames::New();
1578 // In binary animation file only is saved the position, rotation, scale and blend shape weight keys.
1579 // so, if it is vector3 we assume is position or scale keys, if it is vector4 we assume is rotation,
1580 // otherwise are blend shape weight keys.
1581 // TODO support for binary header with size information
1582 Property::Type propType = Property::FLOAT; // assume blend shape weights
1583 if(animProp.mPropertyName == "orientation")
1585 propType = Property::VECTOR4;
1587 else if((animProp.mPropertyName == "position") || (animProp.mPropertyName == "scale"))
1589 propType = Property::VECTOR3;
1592 // alphafunction is reserved for future implementation
1593 // NOTE: right now we're just using AlphaFunction::LINEAR.
1594 unsigned char dummyAlphaFunction;
1597 Property::Value propValue;
1598 for(int key = 0; key < numKeys; key++)
1600 binAniFile.read(reinterpret_cast<char*>(&progress), sizeof(float));
1601 if(propType == Property::VECTOR3)
1604 binAniFile.read(reinterpret_cast<char*>(value.AsFloat()), sizeof(float) * 3);
1605 propValue = Property::Value(value);
1607 else if(propType == Property::VECTOR4)
1610 binAniFile.read(reinterpret_cast<char*>(value.AsFloat()), sizeof(float) * 4);
1611 propValue = Property::Value(Quaternion(value));
1616 binAniFile.read(reinterpret_cast<char*>(&value), sizeof(float));
1617 propValue = Property::Value(value);
1620 binAniFile.read(reinterpret_cast<char*>(&dummyAlphaFunction), sizeof(unsigned char));
1622 animProp.mKeyFrames.Add(progress, propValue, AlphaFunction::LINEAR);
1625 else if(const TreeNode* tnKeyFrames = tnProperty.GetChild("keyFrames"))
1627 DALI_ASSERT_ALWAYS(!animProp.mPropertyName.empty() && "Animation must specify a property name");
1628 animProp.mKeyFrames = KeyFrames::New();
1630 float progress = 0.0f;
1631 for(auto i0 = tnKeyFrames->CBegin(), i1 = tnKeyFrames->CEnd(); i1 != i0; ++i0)
1633 const TreeNode::KeyNodePair& kfKeyChild = *i0;
1634 bool readResult = ReadFloat(kfKeyChild.second.GetChild("progress"), progress);
1635 DALI_ASSERT_ALWAYS(readResult && "Key frame entry must have 'progress'");
1637 const TreeNode* tnValue = kfKeyChild.second.GetChild("value");
1638 DALI_ASSERT_ALWAYS(tnValue && "Key frame entry must have 'value'");
1640 // For the "orientation" property, convert from Vector4 -> Rotation value
1641 // This work-around is preferable to a null-pointer exception in the DALi update thread
1642 Property::Value propValue(ReadPropertyValue(*tnValue));
1643 if(propValue.GetType() == Property::VECTOR4 &&
1644 animProp.mPropertyName == "orientation")
1648 propValue = Property::Value(Quaternion(v.w, v.x, v.y, v.z));
1651 AlphaFunction kfAlphaFunction(AlphaFunction::DEFAULT);
1652 std::string alphaFuncStr;
1653 if(ReadString(kfKeyChild.second.GetChild("alphaFunction"), alphaFuncStr))
1655 kfAlphaFunction = GetAlphaFunction(alphaFuncStr);
1658 animProp.mKeyFrames.Add(progress, propValue, kfAlphaFunction);
1663 const TreeNode* tnValue = tnProperty.GetChild("value");
1666 animProp.mValue.reset(new AnimatedProperty::Value{ReadPropertyValue(*tnValue)});
1667 ReadBool(tnProperty.GetChild("relative"), animProp.mValue->mIsRelative);
1671 mOnError(FormatString("Property '%s' fails to define target value.",
1672 animProp.mPropertyName.c_str()));
1676 animDef.mProperties.push_back(std::move(animProp));
1682 *iFind = std::move(animDef);
1686 iFind = definitions.insert(iFind, std::move(animDef));
1689 if(auto proc = params.input->mAnimationPropertyProcessor) // optional processing
1692 ParseProperties(tnAnim, map);
1693 proc(animDef, std::move(map), mOnError);
1698 void DliLoaderImpl::Impl::ParseAnimationGroups(const Toolkit::TreeNode* tnAnimationGroups, LoadParams& params)
1700 auto& animGroups = params.output->mAnimationGroupDefinitions;
1703 for(auto iGroups = tnAnimationGroups->CBegin(), iGroupsEnd = tnAnimationGroups->CEnd();
1704 iGroups != iGroupsEnd;
1705 ++iGroups, ++numGroups)
1707 const auto& tnGroup = *iGroups;
1708 auto tnName = tnGroup.second.GetChild(NAME);
1709 std::string groupName;
1710 if(!tnName || !ReadString(tnName, groupName))
1712 mOnError(FormatString("Failed to get the name for the Animation group %d; ignoring.", numGroups));
1716 auto iFind = std::lower_bound(animGroups.begin(), animGroups.end(), groupName, [](const AnimationGroupDefinition& group, const std::string& name)
1717 { return group.mName < name; });
1718 if(iFind != animGroups.end() && iFind->mName == groupName)
1720 mOnError(FormatString("Animation group with name '%s' already exists; new entries will be merged.", groupName.c_str()));
1724 iFind = animGroups.insert(iFind, AnimationGroupDefinition{});
1727 iFind->mName = groupName;
1729 auto tnAnims = tnGroup.second.GetChild("animations");
1730 if(tnAnims && tnAnims->Size() > 0)
1732 auto& anims = iFind->mAnimations;
1733 anims.reserve(anims.size() + tnAnims->Size());
1734 for(auto iAnims = tnAnims->CBegin(), iAnimsEnd = tnAnims->CEnd(); iAnims != iAnimsEnd; ++iAnims)
1736 anims.push_back((*iAnims).second.GetString());
1742 void DliLoaderImpl::Impl::GetCameraParameters(std::vector<Dali::Scene3D::Loader::CameraParameters>& cameras) const
1744 if(mParser.GetRoot())
1746 if(const TreeNode* jsonCameras = mParser.GetRoot()->GetChild("cameras"))
1748 float dummyFloatArray[4];
1750 cameras.resize(jsonCameras->Size());
1751 auto iCamera = cameras.begin();
1752 for(auto i0 = jsonCameras->CBegin(), i1 = jsonCameras->CEnd(); i0 != i1; ++i0)
1754 auto& jsonCamera = (*i0).second;
1756 ReadFloat(jsonCamera.GetChild("fov"), iCamera->yFovDegree.degree);
1757 ReadFloat(jsonCamera.GetChild("near"), iCamera->zNear);
1758 ReadFloat(jsonCamera.GetChild("far"), iCamera->zFar);
1759 if(ReadVector(jsonCamera.GetChild("orthographic"), dummyFloatArray, 4u))
1761 iCamera->isPerspective = false;
1763 iCamera->orthographicSize = dummyFloatArray[2] * 0.5f;
1764 iCamera->aspectRatio = dummyFloatArray[1] / dummyFloatArray[2];
1767 if(auto jsonMatrix = jsonCamera.GetChild("matrix"))
1769 ReadVector(jsonMatrix, iCamera->matrix.AsFloat(), 16u);
1778 void DliLoaderImpl::Impl::GetLightParameters(std::vector<Dali::Scene3D::Loader::LightParameters>& lights) const
1780 if(mParser.GetRoot())
1782 if(const TreeNode* jsonLights = mParser.GetRoot()->GetChild("lights"))
1784 lights.resize(jsonLights->Size());
1785 auto iLight = lights.begin();
1786 for(auto i0 = jsonLights->CBegin(), i1 = jsonLights->CEnd(); i0 != i1; ++i0)
1788 auto& jsonLight = (*i0).second;
1789 if(!ReadVector(jsonLight.GetChild("matrix"), iLight->transform.AsFloat(), 16))
1792 FormatString("Failed to parse light %d - \"matrix\" child with 16 floats expected.\n",
1793 std::distance(jsonLights->CBegin(), i0)));
1797 int shadowMapSize = 0;
1798 if(ReadInt(jsonLight.GetChild(SHADOW_MAP_SIZE), shadowMapSize) && shadowMapSize < 0)
1801 FormatString("Failed to parse light %d - %s has an invalid value.",
1802 std::distance(jsonLights->CBegin(), i0),
1806 iLight->shadowMapSize = shadowMapSize;
1808 float orthoSize = 0.f;
1809 if(ReadFloat(jsonLight.GetChild(ORTHOGRAPHIC_SIZE), orthoSize) &&
1810 (orthoSize < .0f || std::isnan(orthoSize) || std::isinf(orthoSize)))
1813 FormatString("Failed to parse light %d - %s has an invalid value.",
1814 std::distance(jsonLights->CBegin(), i0),
1815 ORTHOGRAPHIC_SIZE));
1818 iLight->orthographicSize = orthoSize;
1820 if((iLight->shadowMapSize > 0) != (iLight->orthographicSize > .0f))
1822 mOnError(FormatString(
1823 "Light %d: Both shadow map size and orthographic size must be set for shadows to work.",
1824 std::distance(jsonLights->CBegin(), i0)));
1827 if(!ReadVector(jsonLight.GetChild("color"), iLight->color.AsFloat(), 3)) // color is optional
1829 iLight->color = Vector3::ONE; // default to white
1832 if(!ReadFloat(jsonLight.GetChild("intensity"), iLight->intensity)) // intensity is optional
1834 iLight->intensity = 1.0f; // default to 1.0
1837 if(!ReadFloat(jsonLight.GetChild("shadowIntensity"), iLight->shadowIntensity)) // intensity is optional
1839 iLight->shadowIntensity = 1.0f; // default to 1.0
1848 } // namespace Internal
1849 } // namespace Loader
1850 } // namespace Scene3D