2 * Copyright (c) 2022 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/public-api/loader/dli-loader.h"
27 #include "dali-toolkit/devel-api/builder/json-parser.h"
28 #include "dali/devel-api/common/map-wrapper.h"
29 #include "dali/integration-api/debug.h"
30 #include "dali/public-api/object/property-array.h"
33 #include "dali-scene3d/internal/loader/json-util.h"
34 #include "dali-scene3d/public-api/loader/alpha-function-helper.h"
35 #include "dali-scene3d/public-api/loader/animation-definition.h"
36 #include "dali-scene3d/public-api/loader/blend-shape-details.h"
37 #include "dali-scene3d/public-api/loader/camera-parameters.h"
38 #include "dali-scene3d/public-api/loader/ktx-loader.h"
39 #include "dali-scene3d/public-api/loader/light-parameters.h"
40 #include "dali-scene3d/public-api/loader/load-result.h"
41 #include "dali-scene3d/public-api/loader/parse-renderer-state.h"
42 #include "dali-scene3d/public-api/loader/scene-definition.h"
43 #include "dali-scene3d/public-api/loader/skinning-details.h"
44 #include "dali-scene3d/public-api/loader/utils.h"
46 #define DLI_0_1_COMPATIBILITY
50 using namespace Toolkit;
56 namespace rs = RendererState;
60 const std::string NODES = "nodes";
61 const std::string SCENES = "scenes";
62 const std::string NODE = "node";
63 const std::string URI = "uri";
64 const std::string URL = "url";
65 const std::string CUSTOMIZATION = "customization";
66 const std::string HINTS = "hints";
67 const std::string NAME("name");
68 const std::string BLEND_SHAPE_HEADER("blendShapeHeader");
69 const std::string BLEND_SHAPES("blendShapes");
70 const std::string BLEND_SHAPE_VERSION_1_0("1.0");
71 const std::string BLEND_SHAPE_VERSION_2_0("2.0");
72 const std::string VERSION("version");
74 const char* const SHADOW_MAP_SIZE = "shadowMapSize";
75 const char* const ORTHOGRAPHIC_SIZE = "orthographicSize";
76 const char* const PIXEL_UNITS = "px";
78 const char SLASH = '/';
80 void ReadModelTransform(const TreeNode* node, Quaternion& orientation, Vector3& translation, Vector3& scale)
82 float num[16u] = {.0f};
84 if(ReadVector(node->GetChild("matrix"), num, 16u))
87 mat.GetTransformComponents(translation, orientation, scale);
91 if(ReadVector(node->GetChild("angle"), num, 3u))
93 orientation = Quaternion(Radian(Degree(num[0u])), Radian(Degree(num[1u])), Radian(Degree(num[2u])));
96 if(ReadVector(node->GetChild("position"), num, 3u))
98 translation = Vector3(num);
103 bool ReadAttribBlob(const TreeNode* node, MeshDefinition::Blob& buffer)
105 return ReadBlob(node, buffer.mOffset, buffer.mLength);
108 bool ReadAttribAccessor(const TreeNode* node, MeshDefinition::Accessor& accessor)
110 return ReadBlob(node, accessor.mBlob.mOffset, accessor.mBlob.mLength);
113 bool ReadColorCode(const TreeNode* node, Vector4& color, DliLoader::ConvertColorCode convertColorCode)
115 if(!node || !convertColorCode)
120 color = convertColorCode(node->GetString());
125 bool ReadColorCodeOrColor(const TreeNode* node, Vector4& color, DliLoader::ConvertColorCode convertColorCode)
127 return ReadColorCode(node->GetChild("colorCode"), color, convertColorCode) ||
128 ReadColor(node->GetChild("color"), color);
131 RendererState::Type ReadRendererState(const TreeNode& tnRendererState)
133 if(tnRendererState.GetType() == TreeNode::INTEGER)
135 return static_cast<RendererState::Type>(tnRendererState.GetInteger());
137 else if(tnRendererState.GetType() == TreeNode::STRING)
139 return RendererState::Parse(tnRendererState.GetString());
147 ///@brief Reads arc properties.
148 void ReadArcField(const TreeNode* eArc, ArcRenderable& arc)
150 ReadBool(eArc->GetChild("antiAliasing"), arc.mAntiAliasing);
151 ReadInt(eArc->GetChild("arcCaps"), arc.mArcCaps);
152 ReadFloat(eArc->GetChild("radius"), arc.mRadius);
154 arc.mStartAngleDegrees = .0f;
155 ReadFloat(eArc->GetChild("startAngle"), arc.mStartAngleDegrees);
157 arc.mEndAngleDegrees = .0f;
158 ReadFloat(eArc->GetChild("endAngle"), arc.mEndAngleDegrees);
161 const TreeNode* GetNthChild(const TreeNode* node, uint32_t index)
164 for(TreeNode::ConstIterator it = (*node).CBegin(); it != (*node).CEnd(); ++it, ++i)
168 return &((*it).second);
174 const TreeNode* RequireChild(const TreeNode* node, const std::string& childName)
176 auto child = node->GetChild(childName);
179 ExceptionFlinger flinger(ASSERT_LOCATION);
180 flinger << "Failed to find child node '" << childName << "'";
181 if(auto nodeName = node->GetName())
183 flinger << " on '" << nodeName << "'";
190 void ParseProperties(const Toolkit::TreeNode& node, Property::Array& array);
192 void ParseProperties(const Toolkit::TreeNode& node, Property::Map& map)
194 DALI_ASSERT_DEBUG(node.GetType() == TreeNode::OBJECT);
195 for(auto i0 = node.CBegin(), i1 = node.CEnd(); i0 != i1; ++i0)
198 switch(kv.second.GetType())
200 case TreeNode::ARRAY:
202 Property::Array array;
203 ParseProperties(kv.second, array);
204 map.Insert(kv.first, array);
208 case TreeNode::OBJECT:
210 Property::Map innerMap;
211 ParseProperties(kv.second, innerMap);
212 map.Insert(kv.first, innerMap);
216 case TreeNode::STRING:
218 map.Insert(kv.first, kv.second.GetString());
222 case TreeNode::INTEGER:
224 map.Insert(kv.first, kv.second.GetInteger());
228 case TreeNode::BOOLEAN:
230 map.Insert(kv.first, kv.second.GetBoolean());
234 case TreeNode::FLOAT:
236 map.Insert(kv.first, kv.second.GetFloat());
240 case TreeNode::IS_NULL:
248 void ParseProperties(const Toolkit::TreeNode& node, Property::Array& array)
250 DALI_ASSERT_DEBUG(node.GetType() == TreeNode::ARRAY);
251 for(auto i0 = node.CBegin(), i1 = node.CEnd(); i0 != i1; ++i0)
254 switch(kv.second.GetType())
256 case TreeNode::ARRAY:
258 Property::Array innerArray;
259 ParseProperties(kv.second, innerArray);
260 array.PushBack(innerArray);
264 case TreeNode::OBJECT:
267 ParseProperties(kv.second, map);
272 case TreeNode::STRING:
274 array.PushBack(kv.second.GetString());
278 case TreeNode::INTEGER:
280 array.PushBack(kv.second.GetInteger());
284 case TreeNode::BOOLEAN:
286 array.PushBack(kv.second.GetBoolean());
290 case TreeNode::FLOAT:
292 array.PushBack(kv.second.GetFloat());
296 case TreeNode::IS_NULL:
306 struct DliLoader::Impl
308 StringCallback mOnError = DefaultErrorCallback;
309 Toolkit::JsonParser mParser;
311 void ParseScene(LoadParams& params);
314 std::map<Index, Matrix> mInverseBindMatrices;
317 * @brief Due to .dli nodes being processed in depth-first traversal with orphans being
318 * ignored, features that rely on node indices (which is more compact and closer to
319 * glTF) require a mapping from .dli node indices to those in the resulting SceneDefinition.
320 * The index mapper is responsible for maintaing this mapping, and resolving node IDs
321 * once the processing of the nodes has finished.
322 * @note The resolution requires the whole scene graph to finish parsing, therefore any
323 * node extensions relying on node IDs will see the dli ID in their processor.
328 * @brief Attempts to create a mapping from a node's @a dli index to its @a scene
330 * @return Whether the operation was successful.
332 virtual bool Map(Index iDli, Index iScene) = 0;
335 * @return The scene index for the node's @a dli index.
337 virtual Index Resolve(Index iDli) = 0;
341 * @brief Traverses the DOM tree created by LoadDocument() in an attempt to create
342 * an intermediate representation of resources and nodes.
344 void ParseSceneInternal(Index iScene, const Toolkit::TreeNode* tnScenes, const Toolkit::TreeNode* tnNodes, LoadParams& params);
346 void ParseSkeletons(const Toolkit::TreeNode* skeletons, SceneDefinition& scene, ResourceBundle& resources);
347 void ParseEnvironments(const Toolkit::TreeNode* environments, ResourceBundle& resources);
348 void ParseMaterials(const Toolkit::TreeNode* materials, ConvertColorCode convertColorCode, ResourceBundle& resources);
350 void ParseNodes(const Toolkit::TreeNode* nodes, Index index, LoadParams& params);
351 void ParseNodesInternal(const Toolkit::TreeNode* nodes, Index index, std::vector<Index>& inOutParentStack, LoadParams& params, IIndexMapper& indexMapper);
353 void ParseAnimations(const Toolkit::TreeNode* animations, LoadParams& params);
354 void ParseAnimationGroups(const Toolkit::TreeNode* animationGroups, LoadParams& params);
356 void ParseShaders(const Toolkit::TreeNode* shaders, ResourceBundle& resources);
357 void ParseMeshes(const Toolkit::TreeNode* meshes, ResourceBundle& resources);
359 void GetCameraParameters(std::vector<CameraParameters>& cameras) const;
360 void GetLightParameters(std::vector<LightParameters>& lights) const;
363 DliLoader::DliLoader()
368 DliLoader::~DliLoader() = default;
370 void DliLoader::SetErrorCallback(StringCallback onError)
372 mImpl->mOnError = onError;
375 bool DliLoader::LoadScene(const std::string& uri, LoadParams& params)
377 std::string daliBuffer = LoadTextFile(uri.c_str());
379 auto& parser = mImpl->mParser;
380 parser = JsonParser::New();
381 if(!parser.Parse(daliBuffer))
386 mImpl->ParseScene(params);
390 std::string DliLoader::GetParseError() const
392 std::stringstream stream;
394 auto& parser = mImpl->mParser;
395 if(parser.ParseError())
397 stream << "position: " << parser.GetErrorPosition() << ", line: " << parser.GetErrorLineNumber() << ", column: " << parser.GetErrorColumn() << ", description: " << parser.GetErrorDescription() << ".";
403 void DliLoader::Impl::ParseScene(LoadParams& params)
405 auto& input = params.input;
406 auto& output = params.output;
408 // get index of root node.
409 auto docRoot = mParser.GetRoot();
412 // Process resources first - these are shared
413 if(auto environments = docRoot->GetChild("environment"))
415 ParseEnvironments(environments, output.mResources); // NOTE: must precede parsing of materials
418 if(auto meshes = docRoot->GetChild("meshes"))
420 ParseMeshes(meshes, output.mResources);
423 if(auto shaders = docRoot->GetChild("shaders"))
425 ParseShaders(shaders, output.mResources);
428 if(auto materials = docRoot->GetChild("materials"))
430 ParseMaterials(materials, input.mConvertColorCode, output.mResources);
433 for(auto& c : input.mPreNodeCategoryProcessors)
435 if(auto node = docRoot->GetChild(c.first))
437 Property::Array array;
438 ParseProperties(*node, array);
439 c.second(std::move(array), mOnError);
444 Index iScene = 0; // default scene
445 ReadIndex(docRoot->GetChild("scene"), iScene);
447 auto tnScenes = RequireChild(docRoot, "scenes");
448 auto tnNodes = RequireChild(docRoot, "nodes");
449 ParseSceneInternal(iScene, tnScenes, tnNodes, params);
451 ParseSkeletons(docRoot->GetChild("skeletons"), output.mScene, output.mResources);
453 output.mScene.EnsureUniqueSkinningShaderInstances(output.mResources);
454 output.mScene.EnsureUniqueBlendShapeShaderInstances(output.mResources);
456 // Ger cameras and lights
457 GetCameraParameters(output.mCameraParameters);
458 GetLightParameters(output.mLightParameters);
460 // Post-node processors and animations last
461 for(auto& c : input.mPostNodeCategoryProcessors)
463 if(auto node = docRoot->GetChild(c.first))
465 Property::Array array;
466 ParseProperties(*node, array);
467 c.second(std::move(array), mOnError);
471 if(auto animations = docRoot->GetChild("animations"))
473 ParseAnimations(animations, params);
476 if(!output.mAnimationDefinitions.empty())
478 if(auto animationGroups = docRoot->GetChild("animationGroups"))
480 ParseAnimationGroups(animationGroups, params);
486 void DliLoader::Impl::ParseSceneInternal(Index iScene, const Toolkit::TreeNode* tnScenes, const Toolkit::TreeNode* tnNodes, LoadParams& params)
488 auto getSceneRootIdx = [tnScenes, tnNodes](Index iScene)
490 auto tn = GetNthChild(tnScenes, iScene); // now a "scene" object
493 ExceptionFlinger(ASSERT_LOCATION) << iScene << " is out of bounds access into " << SCENES << ".";
496 tn = RequireChild(tn, NODES); // now a "nodes" array
497 if(tn->GetType() != TreeNode::ARRAY)
499 ExceptionFlinger(ASSERT_LOCATION) << SCENES << "[" << iScene << "]." << NODES << " has an invalid type; array required.";
504 ExceptionFlinger(ASSERT_LOCATION) << SCENES << "[" << iScene << "]." << NODES << " must define a node id.";
507 tn = GetNthChild(tn, 0); // now the first element of the array
509 if(!ReadIndex(tn, iRootNode))
511 ExceptionFlinger(ASSERT_LOCATION) << SCENES << "[" << iScene << "]." << NODES << " has an invalid value for root node index: '" << iRootNode << "'.";
514 if(iRootNode >= tnNodes->Size())
516 ExceptionFlinger(ASSERT_LOCATION) << "Root node index << " << iRootNode << " of scene " << iScene << " is out of bounds.";
519 tn = GetNthChild(tnNodes, iRootNode); // now a "node" object
520 if(tn->GetType() != TreeNode::OBJECT)
522 ExceptionFlinger(ASSERT_LOCATION) << "Root node of scene " << iScene << " is of invalid JSON type; object required";
528 Index iRootNode = getSceneRootIdx(iScene);
529 ParseNodes(tnNodes, iRootNode, params);
531 auto& scene = params.output.mScene;
532 scene.AddRootNode(0);
534 for(Index i = 0; i < iScene; ++i)
536 Index iRootNode = getSceneRootIdx(i);
537 const Index iRoot = scene.GetNodeCount();
538 ParseNodes(tnNodes, iRootNode, params);
539 scene.AddRootNode(iRoot);
542 auto numScenes = tnScenes->Size();
543 for(Index i = iScene + 1; i < numScenes; ++i)
545 Index iRootNode = getSceneRootIdx(i);
546 const Index iRoot = scene.GetNodeCount();
547 ParseNodes(tnNodes, iRootNode, params);
548 scene.AddRootNode(iRoot);
552 void DliLoader::Impl::ParseSkeletons(const TreeNode* skeletons, SceneDefinition& scene, ResourceBundle& resources)
556 auto iStart = skeletons->CBegin();
557 for(auto i0 = iStart, i1 = skeletons->CEnd(); i0 != i1; ++i0)
559 auto& node = (*i0).second;
560 std::string skeletonRootName;
561 if(ReadString(node.GetChild(NODE), skeletonRootName))
563 SkeletonDefinition skeleton;
564 if(!scene.FindNode(skeletonRootName, &skeleton.mRootNodeIdx))
566 ExceptionFlinger(ASSERT_LOCATION) << FormatString("Skeleton %d: node '%s' not defined.", resources.mSkeletons.size(), skeletonRootName.c_str());
569 uint32_t jointCount = 0;
570 std::function<void(Index)> visitFn;
571 auto& ibms = mInverseBindMatrices;
572 visitFn = [&](Index id)
574 auto node = scene.GetNode(id);
575 jointCount += ibms.find(id) != ibms.end();
577 for(auto i : node->mChildren)
582 visitFn(skeleton.mRootNodeIdx);
584 if(jointCount > Skinning::MAX_JOINTS)
586 mOnError(FormatString("Skeleton %d: joint count exceeds supported limit.", resources.mSkeletons.size()));
587 jointCount = Skinning::MAX_JOINTS;
590 skeleton.mJoints.reserve(jointCount);
592 visitFn = [&](Index id)
594 auto iFind = ibms.find(id);
595 if(iFind != ibms.end() && skeleton.mJoints.size() < Skinning::MAX_JOINTS)
597 skeleton.mJoints.push_back({id, iFind->second});
600 auto node = scene.GetNode(id);
601 for(auto i : node->mChildren)
606 visitFn(skeleton.mRootNodeIdx);
608 resources.mSkeletons.push_back(std::move(skeleton));
612 ExceptionFlinger(ASSERT_LOCATION) << "skeleton " << std::distance(iStart, i0) << ": Missing required attribute '" << NODE << "'.";
618 void DliLoader::Impl::ParseEnvironments(const TreeNode* environments, ResourceBundle& resources)
620 Matrix cubeOrientation(Matrix::IDENTITY);
622 for(auto i0 = environments->CBegin(), i1 = environments->CEnd(); i0 != i1; ++i0)
624 auto& node = (*i0).second;
626 EnvironmentDefinition envDef;
627 ReadString(node.GetChild("cubeSpecular"), envDef.mSpecularMapPath);
628 ReadString(node.GetChild("cubeDiffuse"), envDef.mDiffuseMapPath);
629 ToUnixFileSeparators(envDef.mSpecularMapPath);
630 ToUnixFileSeparators(envDef.mDiffuseMapPath);
631 envDef.mIblIntensity = 1.0f;
632 ReadFloat(node.GetChild("iblIntensity"), envDef.mIblIntensity);
633 if(ReadVector(node.GetChild("cubeInitialOrientation"), cubeOrientation.AsFloat(), 16u))
635 envDef.mCubeOrientation = Quaternion(cubeOrientation);
638 resources.mEnvironmentMaps.emplace_back(std::move(envDef), EnvironmentDefinition::Textures());
641 // NOTE: guarantees environmentMaps to have an empty environment.
642 if(resources.mEnvironmentMaps.empty())
644 resources.mEnvironmentMaps.emplace_back(EnvironmentDefinition(), EnvironmentDefinition::Textures());
648 void DliLoader::Impl::ParseShaders(const TreeNode* shaders, ResourceBundle& resources)
650 uint32_t iShader = 0;
651 for(auto i0 = shaders->CBegin(), i1 = shaders->CEnd(); i0 != i1; ++i0, ++iShader)
653 auto& node = (*i0).second;
654 ShaderDefinition shaderDef;
655 ReadStringVector(node.GetChild("defines"), shaderDef.mDefines);
657 // Read shader hints. Possible values are:
658 // Don't define for No hints.
659 // "OUTPUT_IS_TRANSPARENT" Might generate transparent alpha from opaque inputs.
660 // "MODIFIES_GEOMETRY" Might change position of vertices, this option disables any culling optimizations.
662 ReadStringVector(node.GetChild(HINTS), shaderDef.mHints);
664 if(ReadString(node.GetChild("vertex"), shaderDef.mVertexShaderPath) &&
665 ReadString(node.GetChild("fragment"), shaderDef.mFragmentShaderPath))
667 ToUnixFileSeparators(shaderDef.mVertexShaderPath);
668 ToUnixFileSeparators(shaderDef.mFragmentShaderPath);
670 for(TreeNode::ConstIterator j0 = node.CBegin(), j1 = node.CEnd(); j0 != j1; ++j0)
672 const TreeNode::KeyNodePair& keyValue = *j0;
673 const std::string& key = keyValue.first;
674 const TreeNode& value = keyValue.second;
676 Property::Value uniformValue;
677 if(key.compare("vertex") == 0 || key.compare("fragment") == 0 || key.compare("defines") == 0 || key.compare(HINTS) == 0)
681 else if(key.compare("rendererState") == 0)
683 shaderDef.mRendererState = ReadRendererState(keyValue.second);
685 else if(value.GetType() == TreeNode::INTEGER || value.GetType() == TreeNode::FLOAT)
688 ReadFloat(&value, f);
691 else if(value.GetType() == TreeNode::BOOLEAN)
693 DALI_LOG_WARNING("\"bool\" uniforms are handled as floats in shader");
695 if(ReadBool(&keyValue.second, value))
697 uniformValue = value ? 1.0f : 0.0f;
701 switch(auto size = GetNumericalArraySize(&value))
706 ReadVector(&value, m.AsFloat(), size);
714 ReadVector(&value, m.AsFloat(), size);
722 ReadVector(&value, v.AsFloat(), size);
730 ReadVector(&value, v.AsFloat(), size);
738 ReadVector(&value, v.AsFloat(), size);
744 mOnError(FormatString(
745 "shader %d: Ignoring uniform '%s': failed to infer type from %d elements.",
751 if(Property::NONE != uniformValue.GetType())
753 shaderDef.mUniforms.Insert(key, uniformValue);
757 resources.mShaders.emplace_back(std::move(shaderDef), Shader());
761 ExceptionFlinger(ASSERT_LOCATION) << "shader " << iShader << ": Missing vertex / fragment shader definition.";
766 void DliLoader::Impl::ParseMeshes(const TreeNode* meshes, ResourceBundle& resources)
768 for(auto i0 = meshes->CBegin(), i1 = meshes->CEnd(); i0 != i1; ++i0)
770 auto& node = (*i0).second;
772 MeshDefinition meshDef;
773 if(!ReadString(node.GetChild(URI), meshDef.mUri))
775 ExceptionFlinger(ASSERT_LOCATION) << "mesh " << resources.mMeshes.size() << ": Missing required attribute '" << URI << "'.";
778 ToUnixFileSeparators(meshDef.mUri);
780 std::string primitive;
781 if(ReadString(node.GetChild("primitive"), primitive))
783 if(primitive == "LINES")
785 meshDef.mPrimitiveType = Geometry::LINES;
787 else if(primitive == "POINTS")
789 meshDef.mPrimitiveType = Geometry::POINTS;
791 else if(primitive != "TRIANGLES")
793 mOnError(FormatString(
794 "mesh %d: Using TRIANGLES instead of unsupported primitive type '%s'.",
795 resources.mMeshes.size(),
801 if(ReadInt(node.GetChild("attributes"), attributes))
803 if(MaskMatch(attributes, MeshDefinition::INDICES) &&
804 !ReadAttribAccessor(node.GetChild("indices"), meshDef.mIndices))
806 ExceptionFlinger(ASSERT_LOCATION) << FormatString("mesh %d: Failed to read %s.",
807 resources.mMeshes.size(),
811 if(MaskMatch(attributes, MeshDefinition::POSITIONS) &&
812 !ReadAttribAccessor(node.GetChild("positions"), meshDef.mPositions))
814 ExceptionFlinger(ASSERT_LOCATION) << FormatString("mesh %d: Failed to read %s.",
815 resources.mMeshes.size(),
819 if(MaskMatch(attributes, MeshDefinition::NORMALS) &&
820 !ReadAttribAccessor(node.GetChild("normals"), meshDef.mNormals))
822 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "normals"));
825 if(MaskMatch(attributes, MeshDefinition::TEX_COORDS) &&
826 !ReadAttribAccessor(node.GetChild("textures"), meshDef.mTexCoords))
828 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "textures"));
831 if(MaskMatch(attributes, MeshDefinition::TANGENTS) &&
832 !ReadAttribAccessor(node.GetChild("tangents"), meshDef.mTangents))
834 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "tangents"));
837 // NOTE: we're no longer reading bitangents as these are calculated in the shaders.
838 if(ReadIndex(node.GetChild("skeleton"), meshDef.mSkeletonIdx))
840 if(!MaskMatch(attributes, MeshDefinition::JOINTS_0) &&
841 !MaskMatch(attributes, MeshDefinition::WEIGHTS_0))
843 mOnError(FormatString("mesh %d: Expected joints0 / weights0 attribute(s) missing.",
844 resources.mMeshes.size()));
846 else if(!ReadAttribAccessor(node.GetChild("joints0"), meshDef.mJoints0) ||
847 !ReadAttribAccessor(node.GetChild("weights0"), meshDef.mWeights0))
849 mOnError(FormatString("mesh %d: Failed to read skinning information.",
850 resources.mMeshes.size()));
854 if(auto blendshapeHeader = node.GetChild(BLEND_SHAPE_HEADER))
856 std::string blendShapeVersion;
857 ReadString(blendshapeHeader->GetChild(VERSION), blendShapeVersion);
859 if(0u == blendShapeVersion.compare(BLEND_SHAPE_VERSION_1_0))
861 meshDef.mBlendShapeVersion = BlendShapes::Version::VERSION_1_0;
863 else if(0u == blendShapeVersion.compare(BLEND_SHAPE_VERSION_2_0))
865 meshDef.mBlendShapeVersion = BlendShapes::Version::VERSION_2_0;
868 switch(meshDef.mBlendShapeVersion)
870 case BlendShapes::Version::VERSION_1_0:
871 case BlendShapes::Version::VERSION_2_0: // FALL THROUGH
873 ReadAttribBlob(blendshapeHeader, meshDef.mBlendShapeHeader);
884 if(auto blendShapes = node.GetChild(BLEND_SHAPES))
886 meshDef.mBlendShapes.resize(blendShapes->Size());
889 for(auto it = blendShapes->CBegin(), endIt = blendShapes->CEnd(); it != endIt; ++it, ++index)
891 // Each blend shape is stored as the difference with the original mesh.
893 auto& blendShapeNode = (*it).second;
895 auto& blendShape = meshDef.mBlendShapes[index];
896 ReadString(blendShapeNode.GetChild("name"), blendShape.name);
897 if(auto position = blendShapeNode.GetChild("positions"))
899 ReadAttribAccessor(position, blendShape.deltas);
901 if(auto normals = blendShapeNode.GetChild("normals"))
903 ReadAttribAccessor(normals, blendShape.normals);
905 if(auto tangents = blendShapeNode.GetChild("tangents"))
907 ReadAttribAccessor(tangents, blendShape.tangents);
909 ReadFloat(blendShapeNode.GetChild("weight"), blendShape.weight);
914 if(ReadBool(node.GetChild("flipV"), flipV))
916 meshDef.mFlags |= flipV * MeshDefinition::FLIP_UVS_VERTICAL;
919 resources.mMeshes.emplace_back(std::move(meshDef), MeshGeometry());
924 void DliLoader::Impl::ParseMaterials(const TreeNode* materials, ConvertColorCode convertColorCode, ResourceBundle& resources)
926 for(auto i0 = materials->CBegin(), i1 = materials->CEnd(); i0 != i1; ++i0)
928 auto& node = (*i0).second;
930 MaterialDefinition materialDef;
931 if(auto eEnvironment = node.GetChild("environment"))
933 ReadIndex(eEnvironment, materialDef.mEnvironmentIdx);
934 if(static_cast<unsigned int>(materialDef.mEnvironmentIdx) >= resources.mEnvironmentMaps.size())
936 ExceptionFlinger(ASSERT_LOCATION) << "material " << resources.mMaterials.size() << ": Environment index " << materialDef.mEnvironmentIdx << " out of bounds (" << resources.mEnvironmentMaps.size() << ").";
940 // TODO : need to consider AGIF
941 std::vector<std::string> texturePaths;
942 std::string texturePath;
943 if(ReadString(node.GetChild("albedoMap"), texturePath))
945 ToUnixFileSeparators(texturePath);
946 const auto semantic = MaterialDefinition::ALBEDO;
947 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
948 materialDef.mFlags |= semantic | MaterialDefinition::TRANSPARENCY; // NOTE: only in dli does single / separate ALBEDO texture mean TRANSPARENCY.
950 if(ReadString(node.GetChild("albedoMetallicMap"), texturePath))
952 ToUnixFileSeparators(texturePath);
954 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO))
956 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "albedo"));
959 const auto semantic = MaterialDefinition::ALBEDO | MaterialDefinition::METALLIC;
960 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
961 materialDef.mFlags |= semantic;
964 if(ReadString(node.GetChild("metallicRoughnessMap"), texturePath))
966 ToUnixFileSeparators(texturePath);
968 if(MaskMatch(materialDef.mFlags, MaterialDefinition::METALLIC))
970 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "metallic"));
973 const auto semantic = MaterialDefinition::METALLIC | MaterialDefinition::ROUGHNESS;
974 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
975 materialDef.mFlags |= semantic |
976 // We have a metallic-roughhness map and the first texture did not have albedo semantics - we're in the transparency workflow.
977 (MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO) * MaterialDefinition::TRANSPARENCY);
980 if(ReadString(node.GetChild("normalMap"), texturePath))
982 ToUnixFileSeparators(texturePath);
984 const auto semantic = MaterialDefinition::NORMAL;
985 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
986 materialDef.mFlags |= semantic |
987 // We have a standalone normal map and the first texture did not have albedo semantics - we're in the transparency workflow.
988 (MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO) * MaterialDefinition::TRANSPARENCY);
991 if(ReadString(node.GetChild("normalRoughnessMap"), texturePath))
993 ToUnixFileSeparators(texturePath);
995 if(MaskMatch(materialDef.mFlags, MaterialDefinition::NORMAL))
997 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "normal"));
1000 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ROUGHNESS))
1002 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "roughness"));
1005 if(MaskMatch(materialDef.mFlags, MaterialDefinition::TRANSPARENCY))
1007 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "transparency"));
1010 const auto semantic = MaterialDefinition::NORMAL | MaterialDefinition::ROUGHNESS;
1011 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1012 materialDef.mFlags |= semantic;
1015 if(ReadString(node.GetChild("subsurfaceMap"), texturePath))
1017 ToUnixFileSeparators(texturePath);
1019 const auto semantic = MaterialDefinition::SUBSURFACE;
1020 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1021 materialDef.mFlags |= semantic;
1024 if(ReadString(node.GetChild("occlusionMap"), texturePath))
1026 ToUnixFileSeparators(texturePath);
1027 const auto semantic = MaterialDefinition::OCCLUSION;
1028 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1029 materialDef.mFlags |= semantic;
1032 if(ReadColorCodeOrColor(&node, materialDef.mColor, convertColorCode) &&
1033 materialDef.mColor.a < 1.0f)
1035 materialDef.mFlags |= MaterialDefinition::TRANSPARENCY;
1038 ReadFloat(node.GetChild("metallic"), materialDef.mMetallic);
1039 ReadFloat(node.GetChild("roughness"), materialDef.mRoughness);
1042 if(ReadBool(node.GetChild("mipmap"), mipmaps) && mipmaps)
1044 for(auto& ts : materialDef.mTextureStages)
1046 ts.mTexture.mSamplerFlags |= SamplerFlags::FILTER_MIPMAP_LINEAR;
1050 resources.mMaterials.emplace_back(std::move(materialDef), TextureSet());
1054 void DliLoader::Impl::ParseNodes(const TreeNode* const nodes, Index index, LoadParams& params)
1056 std::vector<Index> parents;
1059 struct IndexMapper : IIndexMapper
1061 IndexMapper(size_t numNodes)
1063 mIndices.reserve(numNodes);
1066 virtual bool Map(Index iDli, Index iScene) override
1068 Entry idx{iDli, iScene};
1069 auto iInsert = std::lower_bound(mIndices.begin(), mIndices.end(), idx);
1070 if(iInsert == mIndices.end() || iInsert->iDli != iDli)
1072 mIndices.insert(iInsert, idx);
1074 else if(iInsert->iScene != iScene)
1081 virtual unsigned int Resolve(Index iDli) override
1083 auto iFind = std::lower_bound(mIndices.begin(), mIndices.end(), iDli, [](const Entry& idx, Index iDli)
1084 { return idx.iDli < iDli; });
1085 DALI_ASSERT_ALWAYS(iFind != mIndices.end());
1086 return iFind->iScene;
1093 unsigned int iScene;
1095 bool operator<(const Entry& other) const
1097 return iDli < other.iDli;
1100 std::vector<Entry> mIndices;
1101 } mapper(nodes->Size());
1102 ParseNodesInternal(nodes, index, parents, params, mapper);
1104 auto& scene = params.output.mScene;
1105 for(size_t i0 = 0, i1 = scene.GetNodeCount(); i0 < i1; ++i0)
1107 for(auto& c : scene.GetNode(i0)->mConstraints)
1109 c.mSourceIdx = mapper.Resolve(c.mSourceIdx);
1114 void DliLoader::Impl::ParseNodesInternal(const TreeNode* const nodes, Index index, std::vector<Index>& inOutParentStack, LoadParams& params, IIndexMapper& mapper)
1116 // Properties that may be resolved from a JSON value with ReadInt() -- or default to 0.
1117 struct IndexProperty
1119 ResourceType::Value type;
1120 const TreeNode* source;
1123 std::vector<IndexProperty> resourceIds;
1124 resourceIds.reserve(4);
1126 if(auto node = GetNthChild(nodes, index))
1128 NodeDefinition nodeDef;
1129 nodeDef.mParentIdx = inOutParentStack.empty() ? INVALID_INDEX : inOutParentStack.back();
1132 ReadString(node->GetChild(NAME), nodeDef.mName);
1135 ReadModelTransform(node, nodeDef.mOrientation, nodeDef.mPosition, nodeDef.mScale);
1137 // Reads the size of the node.
1139 // * It can be given as 'size' or 'bounds'.
1140 // * The sdk saves the 'size' as a vector2 in some cases.
1141 // * To avoid size related issues the following code attemps
1142 // to read the 'size/bounds' as a vector3 first, if it's
1143 // not successful then reads it as a vector2.
1144 ReadVector(node->GetChild("size"), nodeDef.mSize.AsFloat(), 3) ||
1145 ReadVector(node->GetChild("size"), nodeDef.mSize.AsFloat(), 2) ||
1146 ReadVector(node->GetChild("bounds"), nodeDef.mSize.AsFloat(), 3) ||
1147 ReadVector(node->GetChild("bounds"), nodeDef.mSize.AsFloat(), 2);
1150 ReadBool(node->GetChild("visible"), nodeDef.mIsVisible);
1152 // type classification
1153 if(auto eCustomization = node->GetChild("customization")) // customization
1156 if(ReadString(eCustomization->GetChild("tag"), tag))
1158 nodeDef.mCustomization.reset(new NodeDefinition::CustomizationDefinition{tag});
1161 else // something renderable maybe
1163 std::unique_ptr<NodeDefinition::Renderable> renderable;
1164 ModelRenderable* modelRenderable = nullptr; // no ownership, aliasing renderable for the right type.
1166 const TreeNode* eRenderable = nullptr;
1167 if((eRenderable = node->GetChild("model")))
1169 // check for mesh before allocating - this can't be missing.
1170 auto eMesh = eRenderable->GetChild("mesh");
1173 ExceptionFlinger(ASSERT_LOCATION) << "node " << nodeDef.mName << ": Missing mesh definition.";
1176 modelRenderable = new ModelRenderable();
1177 renderable.reset(modelRenderable);
1179 resourceIds.push_back({ResourceType::Mesh, eMesh, modelRenderable->mMeshIdx});
1181 else if((eRenderable = node->GetChild("arc")))
1183 // check for mesh before allocating - this can't be missing.
1184 auto eMesh = eRenderable->GetChild("mesh");
1187 ExceptionFlinger(ASSERT_LOCATION) << "node " << nodeDef.mName << ": Missing mesh definition.";
1190 auto arcRenderable = new ArcRenderable;
1191 renderable.reset(arcRenderable);
1192 modelRenderable = arcRenderable;
1194 resourceIds.push_back({ResourceType::Mesh, eMesh, arcRenderable->mMeshIdx});
1196 ReadArcField(eRenderable, *arcRenderable);
1199 if(renderable && eRenderable != nullptr) // process common properties of all renderables + register payload
1202 renderable->mShaderIdx = 0;
1203 auto eShader = eRenderable->GetChild("shader");
1206 resourceIds.push_back({ResourceType::Shader, eShader, renderable->mShaderIdx});
1212 modelRenderable->mMaterialIdx = 0; // must offer default of 0
1213 auto eMaterial = eRenderable->GetChild("material");
1216 resourceIds.push_back({ResourceType::Material, eMaterial, modelRenderable->mMaterialIdx});
1219 if(!ReadColorCodeOrColor(eRenderable, modelRenderable->mColor, params.input.mConvertColorCode))
1221 ReadColorCodeOrColor(node, modelRenderable->mColor, params.input.mConvertColorCode);
1225 nodeDef.mRenderables.push_back(std::move(renderable));
1229 // Resolve ints - default to 0 if undefined
1230 auto& output = params.output;
1231 for(auto& idRes : resourceIds)
1236 case ResourceType::Shader:
1237 iCheck = output.mResources.mShaders.size();
1240 case ResourceType::Mesh:
1241 iCheck = output.mResources.mMeshes.size();
1244 case ResourceType::Material:
1245 iCheck = output.mResources.mMaterials.size();
1249 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": Invalid resource type: " << idRes.type << " (Programmer error)";
1256 else if(idRes.source->GetType() != TreeNode::INTEGER)
1258 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": Invalid " << GetResourceTypeName(idRes.type) << " index type.";
1262 idRes.target = idRes.source->GetInteger();
1265 if(idRes.target >= iCheck)
1267 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": " << GetResourceTypeName(idRes.type) << " index " << idRes.target << " out of bounds (" << iCheck << ").";
1270 resourceIds.clear();
1273 if(auto eExtras = node->GetChild("extras"))
1275 auto& extras = nodeDef.mExtras;
1276 extras.reserve(eExtras->Size());
1278 for(auto i0 = eExtras->CBegin(), i1 = eExtras->CEnd(); i0 != i1; ++i0)
1280 NodeDefinition::Extra e;
1283 e.mKey = eExtra.first;
1286 mOnError(FormatString("node %d: empty string is invalid for name of extra %d; ignored.",
1292 e.mValue = ReadPropertyValue(eExtra.second);
1293 if(e.mValue.GetType() == Property::Type::NONE)
1295 mOnError(FormatString("node %d: failed to interpret value of extra '%s' : %s; ignored.",
1298 eExtra.second.GetString()));
1302 auto iInsert = std::lower_bound(extras.begin(), extras.end(), e);
1303 if(iInsert != extras.end() && iInsert->mKey == e.mKey)
1305 mOnError(FormatString("node %d: extra '%s' already defined; overriding with %s.",
1308 eExtra.second.GetString()));
1309 *iInsert = std::move(e);
1313 extras.insert(iInsert, e);
1320 if(auto eConstraints = node->GetChild("constraints"))
1322 auto& constraints = nodeDef.mConstraints;
1323 constraints.reserve(eConstraints->Size());
1325 ConstraintDefinition cDef;
1326 for(auto i0 = eConstraints->CBegin(), i1 = eConstraints->CEnd(); i0 != i1; ++i0)
1328 auto eConstraint = *i0;
1329 if(!ReadIndex(&eConstraint.second, cDef.mSourceIdx))
1331 mOnError(FormatString("node %d: node ID %s for constraint %d is invalid; ignored.",
1333 eConstraint.second.GetString(),
1334 constraints.size()));
1338 cDef.mProperty = eConstraint.first;
1340 auto iInsert = std::lower_bound(constraints.begin(), constraints.end(), cDef);
1341 if(iInsert != constraints.end() && *iInsert == cDef)
1343 mOnError(FormatString("node %d: constraint %s@%d already defined; ignoring.",
1345 cDef.mProperty.c_str(),
1350 constraints.insert(iInsert, cDef);
1356 // Determine index for mapping
1357 const unsigned int myIndex = output.mScene.GetNodeCount();
1358 if(!mapper.Map(index, myIndex))
1360 mOnError(FormatString("node %d: error mapping dli index %d: node has multiple parents. Ignoring subtree."));
1364 // if the node is a bone in a skeletal animation, it will have the inverse bind pose matrix.
1365 Matrix invBindMatrix{false};
1366 if(ReadVector(node->GetChild("inverseBindPoseMatrix"), invBindMatrix.AsFloat(), 16u)) // TODO: more robust error checking?
1368 mInverseBindMatrices[myIndex] = invBindMatrix;
1372 auto rawDef = output.mScene.AddNode(std::make_unique<NodeDefinition>(std::move(nodeDef)));
1373 if(rawDef) // NOTE: no ownership. Guaranteed to stay in scope.
1375 // ...And only then parse children.
1376 if(auto children = node->GetChild("children"))
1378 inOutParentStack.push_back(myIndex);
1380 rawDef->mChildren.reserve(children->Size());
1382 uint32_t iChild = 0;
1383 for(auto j0 = children->CBegin(), j1 = children->CEnd(); j0 != j1; ++j0, ++iChild)
1385 auto& child = (*j0).second;
1386 if(child.GetType() == TreeNode::INTEGER)
1388 ParseNodesInternal(nodes, child.GetInteger(), inOutParentStack, params, mapper); // child object is created in scene definition.
1392 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ", child " << iChild << ": invalid index type.";
1396 inOutParentStack.pop_back();
1398 else if(rawDef->mCustomization)
1400 mOnError(FormatString("node %d: not an actual customization without children.", index));
1403 if(auto proc = params.input.mNodePropertyProcessor) // optional processing
1405 // WARNING: constraint IDs are not resolved at this point.
1406 Property::Map nodeData;
1407 ParseProperties(*node, nodeData);
1408 proc(*rawDef, std::move(nodeData), mOnError);
1413 ExceptionFlinger(ASSERT_LOCATION) << "Node " << index << ": name already used.";
1418 void DliLoader::Impl::ParseAnimations(const TreeNode* tnAnimations, LoadParams& params)
1420 auto& definitions = params.output.mAnimationDefinitions;
1421 definitions.reserve(definitions.size() + tnAnimations->Size());
1423 for(TreeNode::ConstIterator iAnim = tnAnimations->CBegin(), iAnimEnd = tnAnimations->CEnd();
1427 const TreeNode& tnAnim = (*iAnim).second;
1428 AnimationDefinition animDef;
1429 ReadString(tnAnim.GetChild(NAME), animDef.mName);
1431 auto iFind = std::lower_bound(definitions.begin(), definitions.end(), animDef, [](const AnimationDefinition& ad0, const AnimationDefinition& ad1)
1432 { return ad0.mName < ad1.mName; });
1433 const bool overwrite = iFind != definitions.end() && iFind->mName == animDef.mName;
1436 mOnError(FormatString("Pre-existing animation with name '%s' is being overwritten.", animDef.mName.c_str()));
1439 // Duration -- We need something that animated properties' delay / duration can
1440 // be expressed as a multiple of; 0 won't work. This is small enough (i.e. shorter
1441 // than our frame delay) to not be restrictive WRT replaying. If anything needs
1442 // to occur more frequently, then Animations are likely not your solution anyway.
1443 animDef.mDuration = AnimationDefinition::MIN_DURATION_SECONDS;
1444 if(!ReadFloat(tnAnim.GetChild("duration"), animDef.mDuration))
1446 mOnError(FormatString("Animation '%s' fails to define '%s', defaulting to %f.",
1447 animDef.mName.c_str(),
1449 animDef.mDuration));
1452 // Get loop count - # of playbacks. Default is once. 0 means repeat indefinitely.
1453 animDef.mLoopCount = 1;
1454 if(ReadInt(tnAnim.GetChild("loopCount"), animDef.mLoopCount) &&
1455 animDef.mLoopCount < 0)
1457 animDef.mLoopCount = 0;
1460 std::string endAction;
1461 if(ReadString(tnAnim.GetChild("endAction"), endAction))
1463 if("BAKE" == endAction)
1465 animDef.mEndAction = Animation::BAKE;
1467 else if("DISCARD" == endAction)
1469 animDef.mEndAction = Animation::DISCARD;
1471 else if("BAKE_FINAL" == endAction)
1473 animDef.mEndAction = Animation::BAKE_FINAL;
1477 if(ReadString(tnAnim.GetChild("disconnectAction"), endAction))
1479 if("BAKE" == endAction)
1481 animDef.mDisconnectAction = Animation::BAKE;
1483 else if("DISCARD" == endAction)
1485 animDef.mDisconnectAction = Animation::DISCARD;
1487 else if("BAKE_FINAL" == endAction)
1489 animDef.mDisconnectAction = Animation::BAKE_FINAL;
1493 if(const TreeNode* tnProperties = tnAnim.GetChild("properties"))
1495 animDef.mProperties.reserve(tnProperties->Size());
1496 for(TreeNode::ConstIterator iProperty = tnProperties->CBegin(), iPropertyEnd = tnProperties->CEnd();
1497 iProperty != iPropertyEnd;
1500 const TreeNode& tnProperty = (*iProperty).second;
1502 AnimatedProperty animProp;
1503 if(!ReadString(tnProperty.GetChild("node"), animProp.mNodeName))
1505 mOnError(FormatString("Animation '%s': Failed to read the 'node' tag.", animDef.mName.c_str()));
1509 if(!ReadString(tnProperty.GetChild("property"), animProp.mPropertyName))
1511 mOnError(FormatString("Animation '%s': Failed to read the 'property' tag", animDef.mName.c_str()));
1515 // these are the defaults
1516 animProp.mTimePeriod.delaySeconds = 0.f;
1517 animProp.mTimePeriod.durationSeconds = animDef.mDuration;
1518 if(!ReadTimePeriod(tnProperty.GetChild("timePeriod"), animProp.mTimePeriod))
1520 mOnError(FormatString("Animation '%s': timePeriod missing in Property #%d: defaulting to %f.",
1521 animDef.mName.c_str(),
1522 animDef.mProperties.size(),
1523 animProp.mTimePeriod.durationSeconds));
1526 std::string alphaFunctionValue;
1527 if(ReadString(tnProperty.GetChild("alphaFunction"), alphaFunctionValue))
1529 animProp.mAlphaFunction = GetAlphaFunction(alphaFunctionValue);
1532 if(const TreeNode* tnKeyFramesBin = tnProperty.GetChild("keyFramesBin"))
1534 DALI_ASSERT_ALWAYS(!animProp.mPropertyName.empty() && "Animation must specify a property name");
1536 std::ifstream binAniFile;
1537 std::string animationFilename;
1538 if(ReadString(tnKeyFramesBin->GetChild(URL), animationFilename))
1540 std::string animationFullPath = params.input.mAnimationsPath + animationFilename;
1541 binAniFile.open(animationFullPath, std::ios::binary);
1542 if(binAniFile.fail())
1544 ExceptionFlinger(ASSERT_LOCATION) << "Failed to open animation data '" << animationFullPath << "'";
1549 ReadInt(tnKeyFramesBin->GetChild("byteOffset"), byteOffset);
1550 DALI_ASSERT_ALWAYS(byteOffset >= 0);
1552 binAniFile.seekg(byteOffset, std::ios::beg);
1555 ReadInt(tnKeyFramesBin->GetChild("numKeys"), numKeys);
1556 DALI_ASSERT_ALWAYS(numKeys >= 0);
1558 animProp.mKeyFrames = KeyFrames::New();
1560 // In binary animation file only is saved the position, rotation, scale and blend shape weight keys.
1561 // so, if it is vector3 we assume is position or scale keys, if it is vector4 we assume is rotation,
1562 // otherwise are blend shape weight keys.
1563 // TODO support for binary header with size information
1564 Property::Type propType = Property::FLOAT; // assume blend shape weights
1565 if(animProp.mPropertyName == "orientation")
1567 propType = Property::VECTOR4;
1569 else if((animProp.mPropertyName == "position") || (animProp.mPropertyName == "scale"))
1571 propType = Property::VECTOR3;
1574 // alphafunction is reserved for future implementation
1575 // NOTE: right now we're just using AlphaFunction::LINEAR.
1576 unsigned char dummyAlphaFunction;
1579 Property::Value propValue;
1580 for(int key = 0; key < numKeys; key++)
1582 binAniFile.read(reinterpret_cast<char*>(&progress), sizeof(float));
1583 if(propType == Property::VECTOR3)
1586 binAniFile.read(reinterpret_cast<char*>(value.AsFloat()), sizeof(float) * 3);
1587 propValue = Property::Value(value);
1589 else if(propType == Property::VECTOR4)
1592 binAniFile.read(reinterpret_cast<char*>(value.AsFloat()), sizeof(float) * 4);
1593 propValue = Property::Value(Quaternion(value));
1598 binAniFile.read(reinterpret_cast<char*>(&value), sizeof(float));
1599 propValue = Property::Value(value);
1602 binAniFile.read(reinterpret_cast<char*>(&dummyAlphaFunction), sizeof(unsigned char));
1604 animProp.mKeyFrames.Add(progress, propValue, AlphaFunction::LINEAR);
1607 else if(const TreeNode* tnKeyFrames = tnProperty.GetChild("keyFrames"))
1609 DALI_ASSERT_ALWAYS(!animProp.mPropertyName.empty() && "Animation must specify a property name");
1610 animProp.mKeyFrames = KeyFrames::New();
1612 float progress = 0.0f;
1613 for(auto i0 = tnKeyFrames->CBegin(), i1 = tnKeyFrames->CEnd(); i1 != i0; ++i0)
1615 const TreeNode::KeyNodePair& kfKeyChild = *i0;
1616 bool readResult = ReadFloat(kfKeyChild.second.GetChild("progress"), progress);
1617 DALI_ASSERT_ALWAYS(readResult && "Key frame entry must have 'progress'");
1619 const TreeNode* tnValue = kfKeyChild.second.GetChild("value");
1620 DALI_ASSERT_ALWAYS(tnValue && "Key frame entry must have 'value'");
1622 // For the "orientation" property, convert from Vector4 -> Rotation value
1623 // This work-around is preferable to a null-pointer exception in the DALi update thread
1624 Property::Value propValue(ReadPropertyValue(*tnValue));
1625 if(propValue.GetType() == Property::VECTOR4 &&
1626 animProp.mPropertyName == "orientation")
1630 propValue = Property::Value(Quaternion(v.w, v.x, v.y, v.z));
1633 AlphaFunction kfAlphaFunction(AlphaFunction::DEFAULT);
1634 std::string alphaFuncStr;
1635 if(ReadString(kfKeyChild.second.GetChild("alphaFunction"), alphaFuncStr))
1637 kfAlphaFunction = GetAlphaFunction(alphaFuncStr);
1640 animProp.mKeyFrames.Add(progress, propValue, kfAlphaFunction);
1645 const TreeNode* tnValue = tnProperty.GetChild("value");
1648 animProp.mValue.reset(new AnimatedProperty::Value{ReadPropertyValue(*tnValue)});
1649 ReadBool(tnProperty.GetChild("relative"), animProp.mValue->mIsRelative);
1653 mOnError(FormatString("Property '%s' fails to define target value.",
1654 animProp.mPropertyName.c_str()));
1658 animDef.mProperties.push_back(std::move(animProp));
1664 *iFind = std::move(animDef);
1668 iFind = definitions.insert(iFind, std::move(animDef));
1671 if(auto proc = params.input.mAnimationPropertyProcessor) // optional processing
1674 ParseProperties(tnAnim, map);
1675 proc(animDef, std::move(map), mOnError);
1680 void DliLoader::Impl::ParseAnimationGroups(const Toolkit::TreeNode* tnAnimationGroups, LoadParams& params)
1682 auto& animGroups = params.output.mAnimationGroupDefinitions;
1685 for(auto iGroups = tnAnimationGroups->CBegin(), iGroupsEnd = tnAnimationGroups->CEnd();
1686 iGroups != iGroupsEnd;
1687 ++iGroups, ++numGroups)
1689 const auto& tnGroup = *iGroups;
1690 auto tnName = tnGroup.second.GetChild(NAME);
1691 std::string groupName;
1692 if(!tnName || !ReadString(tnName, groupName))
1694 mOnError(FormatString("Failed to get the name for the Animation group %d; ignoring.", numGroups));
1698 auto iFind = std::lower_bound(animGroups.begin(), animGroups.end(), groupName, [](const AnimationGroupDefinition& group, const std::string& name)
1699 { return group.mName < name; });
1700 if(iFind != animGroups.end() && iFind->mName == groupName)
1702 mOnError(FormatString("Animation group with name '%s' already exists; new entries will be merged.", groupName.c_str()));
1706 iFind = animGroups.insert(iFind, AnimationGroupDefinition{});
1709 iFind->mName = groupName;
1711 auto tnAnims = tnGroup.second.GetChild("animations");
1712 if(tnAnims && tnAnims->Size() > 0)
1714 auto& anims = iFind->mAnimations;
1715 anims.reserve(anims.size() + tnAnims->Size());
1716 for(auto iAnims = tnAnims->CBegin(), iAnimsEnd = tnAnims->CEnd(); iAnims != iAnimsEnd; ++iAnims)
1718 anims.push_back((*iAnims).second.GetString());
1724 void DliLoader::Impl::GetCameraParameters(std::vector<CameraParameters>& cameras) const
1726 if(mParser.GetRoot())
1728 if(const TreeNode* jsonCameras = mParser.GetRoot()->GetChild("cameras"))
1730 float dummyFloatArray[4];
1732 cameras.resize(jsonCameras->Size());
1733 auto iCamera = cameras.begin();
1734 for(auto i0 = jsonCameras->CBegin(), i1 = jsonCameras->CEnd(); i0 != i1; ++i0)
1736 auto& jsonCamera = (*i0).second;
1738 ReadFloat(jsonCamera.GetChild("fov"), iCamera->yFov);
1739 ReadFloat(jsonCamera.GetChild("near"), iCamera->zNear);
1740 ReadFloat(jsonCamera.GetChild("far"), iCamera->zFar);
1741 if(ReadVector(jsonCamera.GetChild("orthographic"), dummyFloatArray, 4u))
1743 iCamera->isPerspective = false;
1745 iCamera->orthographicSize = dummyFloatArray[2] * 0.5f;
1746 iCamera->aspectRatio = dummyFloatArray[1] / dummyFloatArray[2];
1749 if(auto jsonMatrix = jsonCamera.GetChild("matrix"))
1751 ReadVector(jsonMatrix, iCamera->matrix.AsFloat(), 16u);
1760 void DliLoader::Impl::GetLightParameters(std::vector<LightParameters>& lights) const
1762 if(mParser.GetRoot())
1764 if(const TreeNode* jsonLights = mParser.GetRoot()->GetChild("lights"))
1766 lights.resize(jsonLights->Size());
1767 auto iLight = lights.begin();
1768 for(auto i0 = jsonLights->CBegin(), i1 = jsonLights->CEnd(); i0 != i1; ++i0)
1770 auto& jsonLight = (*i0).second;
1771 if(!ReadVector(jsonLight.GetChild("matrix"), iLight->transform.AsFloat(), 16))
1774 FormatString("Failed to parse light %d - \"matrix\" child with 16 floats expected.\n",
1775 std::distance(jsonLights->CBegin(), i0)));
1779 int shadowMapSize = 0;
1780 if(ReadInt(jsonLight.GetChild(SHADOW_MAP_SIZE), shadowMapSize) && shadowMapSize < 0)
1783 FormatString("Failed to parse light %d - %s has an invalid value.",
1784 std::distance(jsonLights->CBegin(), i0),
1788 iLight->shadowMapSize = shadowMapSize;
1790 float orthoSize = 0.f;
1791 if(ReadFloat(jsonLight.GetChild(ORTHOGRAPHIC_SIZE), orthoSize) &&
1792 (orthoSize < .0f || std::isnan(orthoSize) || std::isinf(orthoSize)))
1795 FormatString("Failed to parse light %d - %s has an invalid value.",
1796 std::distance(jsonLights->CBegin(), i0),
1797 ORTHOGRAPHIC_SIZE));
1800 iLight->orthographicSize = orthoSize;
1802 if((iLight->shadowMapSize > 0) != (iLight->orthographicSize > .0f))
1804 mOnError(FormatString(
1805 "Light %d: Both shadow map size and orthographic size must be set for shadows to work.",
1806 std::distance(jsonLights->CBegin(), i0)));
1809 if(!ReadVector(jsonLight.GetChild("color"), iLight->color.AsFloat(), 3)) // color is optional
1811 iLight->color = Vector3::ONE; // default to white
1814 if(!ReadFloat(jsonLight.GetChild("intensity"), iLight->intensity)) // intensity is optional
1816 iLight->intensity = 1.0f; // default to 1.0
1819 if(!ReadFloat(jsonLight.GetChild("shadowIntensity"), iLight->shadowIntensity)) // intensity is optional
1821 iLight->shadowIntensity = 1.0f; // default to 1.0
1830 } // namespace Loader
1831 } // namespace Scene3D