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, ArcNode& 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) {
573 auto node = scene.GetNode(id);
574 jointCount += ibms.find(id) != ibms.end();
576 for(auto i : node->mChildren)
581 visitFn(skeleton.mRootNodeIdx);
583 if(jointCount > Skinning::MAX_JOINTS)
585 mOnError(FormatString("Skeleton %d: joint count exceeds supported limit.", resources.mSkeletons.size()));
586 jointCount = Skinning::MAX_JOINTS;
589 skeleton.mJoints.reserve(jointCount);
591 visitFn = [&](Index id) {
592 auto iFind = ibms.find(id);
593 if(iFind != ibms.end() && skeleton.mJoints.size() < Skinning::MAX_JOINTS)
595 skeleton.mJoints.push_back({id, iFind->second});
598 auto node = scene.GetNode(id);
599 for(auto i : node->mChildren)
604 visitFn(skeleton.mRootNodeIdx);
606 resources.mSkeletons.push_back(std::move(skeleton));
610 ExceptionFlinger(ASSERT_LOCATION) << "skeleton " << std::distance(iStart, i0) << ": Missing required attribute '" << NODE << "'.";
616 void DliLoader::Impl::ParseEnvironments(const TreeNode* environments, ResourceBundle& resources)
618 Matrix cubeOrientation(Matrix::IDENTITY);
620 for(auto i0 = environments->CBegin(), i1 = environments->CEnd(); i0 != i1; ++i0)
622 auto& node = (*i0).second;
624 EnvironmentDefinition envDef;
625 ReadString(node.GetChild("cubeSpecular"), envDef.mSpecularMapPath);
626 ReadString(node.GetChild("cubeDiffuse"), envDef.mDiffuseMapPath);
627 ToUnixFileSeparators(envDef.mSpecularMapPath);
628 ToUnixFileSeparators(envDef.mDiffuseMapPath);
629 envDef.mIblIntensity = 1.0f;
630 ReadFloat(node.GetChild("iblIntensity"), envDef.mIblIntensity);
631 if(ReadVector(node.GetChild("cubeInitialOrientation"), cubeOrientation.AsFloat(), 16u))
633 envDef.mCubeOrientation = Quaternion(cubeOrientation);
636 resources.mEnvironmentMaps.emplace_back(std::move(envDef), EnvironmentDefinition::Textures());
639 // NOTE: guarantees environmentMaps to have an empty environment.
640 if(resources.mEnvironmentMaps.empty())
642 resources.mEnvironmentMaps.emplace_back(EnvironmentDefinition(), EnvironmentDefinition::Textures());
646 void DliLoader::Impl::ParseShaders(const TreeNode* shaders, ResourceBundle& resources)
648 uint32_t iShader = 0;
649 for(auto i0 = shaders->CBegin(), i1 = shaders->CEnd(); i0 != i1; ++i0, ++iShader)
651 auto& node = (*i0).second;
652 ShaderDefinition shaderDef;
653 ReadStringVector(node.GetChild("defines"), shaderDef.mDefines);
655 // Read shader hints. Possible values are:
656 // Don't define for No hints.
657 // "OUTPUT_IS_TRANSPARENT" Might generate transparent alpha from opaque inputs.
658 // "MODIFIES_GEOMETRY" Might change position of vertices, this option disables any culling optimizations.
660 ReadStringVector(node.GetChild(HINTS), shaderDef.mHints);
662 if(ReadString(node.GetChild("vertex"), shaderDef.mVertexShaderPath) &&
663 ReadString(node.GetChild("fragment"), shaderDef.mFragmentShaderPath))
665 ToUnixFileSeparators(shaderDef.mVertexShaderPath);
666 ToUnixFileSeparators(shaderDef.mFragmentShaderPath);
668 for(TreeNode::ConstIterator j0 = node.CBegin(), j1 = node.CEnd(); j0 != j1; ++j0)
670 const TreeNode::KeyNodePair& keyValue = *j0;
671 const std::string& key = keyValue.first;
672 const TreeNode& value = keyValue.second;
674 Property::Value uniformValue;
675 if(key.compare("vertex") == 0 || key.compare("fragment") == 0 || key.compare("defines") == 0 || key.compare(HINTS) == 0)
679 else if(key.compare("rendererState") == 0)
681 shaderDef.mRendererState = ReadRendererState(keyValue.second);
683 else if(value.GetType() == TreeNode::INTEGER || value.GetType() == TreeNode::FLOAT)
686 ReadFloat(&value, f);
689 else if(value.GetType() == TreeNode::BOOLEAN)
691 DALI_LOG_WARNING("\"bool\" uniforms are handled as floats in shader");
693 if(ReadBool(&keyValue.second, value))
695 uniformValue = value ? 1.0f : 0.0f;
699 switch(auto size = GetNumericalArraySize(&value))
704 ReadVector(&value, m.AsFloat(), size);
712 ReadVector(&value, m.AsFloat(), size);
720 ReadVector(&value, v.AsFloat(), size);
728 ReadVector(&value, v.AsFloat(), size);
736 ReadVector(&value, v.AsFloat(), size);
742 mOnError(FormatString(
743 "shader %d: Ignoring uniform '%s': failed to infer type from %d elements.",
749 if(Property::NONE != uniformValue.GetType())
751 shaderDef.mUniforms.Insert(key, uniformValue);
755 resources.mShaders.emplace_back(std::move(shaderDef), Shader());
759 ExceptionFlinger(ASSERT_LOCATION) << "shader " << iShader << ": Missing vertex / fragment shader definition.";
764 void DliLoader::Impl::ParseMeshes(const TreeNode* meshes, ResourceBundle& resources)
766 for(auto i0 = meshes->CBegin(), i1 = meshes->CEnd(); i0 != i1; ++i0)
768 auto& node = (*i0).second;
770 MeshDefinition meshDef;
771 if(!ReadString(node.GetChild(URI), meshDef.mUri))
773 ExceptionFlinger(ASSERT_LOCATION) << "mesh " << resources.mMeshes.size() << ": Missing required attribute '" << URI << "'.";
776 ToUnixFileSeparators(meshDef.mUri);
778 std::string primitive;
779 if(ReadString(node.GetChild("primitive"), primitive))
781 if(primitive == "LINES")
783 meshDef.mPrimitiveType = Geometry::LINES;
785 else if(primitive == "POINTS")
787 meshDef.mPrimitiveType = Geometry::POINTS;
789 else if(primitive != "TRIANGLES")
791 mOnError(FormatString(
792 "mesh %d: Using TRIANGLES instead of unsupported primitive type '%s'.",
793 resources.mMeshes.size(),
799 if(ReadInt(node.GetChild("attributes"), attributes))
801 if(MaskMatch(attributes, MeshDefinition::INDICES) &&
802 !ReadAttribAccessor(node.GetChild("indices"), meshDef.mIndices))
804 ExceptionFlinger(ASSERT_LOCATION) << FormatString("mesh %d: Failed to read %s.",
805 resources.mMeshes.size(),
809 if(MaskMatch(attributes, MeshDefinition::POSITIONS) &&
810 !ReadAttribAccessor(node.GetChild("positions"), meshDef.mPositions))
812 ExceptionFlinger(ASSERT_LOCATION) << FormatString("mesh %d: Failed to read %s.",
813 resources.mMeshes.size(),
817 if(MaskMatch(attributes, MeshDefinition::NORMALS) &&
818 !ReadAttribAccessor(node.GetChild("normals"), meshDef.mNormals))
820 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "normals"));
823 if(MaskMatch(attributes, MeshDefinition::TEX_COORDS) &&
824 !ReadAttribAccessor(node.GetChild("textures"), meshDef.mTexCoords))
826 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "textures"));
829 if(MaskMatch(attributes, MeshDefinition::TANGENTS) &&
830 !ReadAttribAccessor(node.GetChild("tangents"), meshDef.mTangents))
832 mOnError(FormatString("mesh %d: Failed to read %s.", resources.mMeshes.size(), "tangents"));
835 // NOTE: we're no longer reading bitangents as these are calculated in the shaders.
836 if(ReadIndex(node.GetChild("skeleton"), meshDef.mSkeletonIdx))
838 if(!MaskMatch(attributes, MeshDefinition::JOINTS_0) &&
839 !MaskMatch(attributes, MeshDefinition::WEIGHTS_0))
841 mOnError(FormatString("mesh %d: Expected joints0 / weights0 attribute(s) missing.",
842 resources.mMeshes.size()));
844 else if(!ReadAttribAccessor(node.GetChild("joints0"), meshDef.mJoints0) ||
845 !ReadAttribAccessor(node.GetChild("weights0"), meshDef.mWeights0))
847 mOnError(FormatString("mesh %d: Failed to read skinning information.",
848 resources.mMeshes.size()));
852 if(auto blendshapeHeader = node.GetChild(BLEND_SHAPE_HEADER))
854 std::string blendShapeVersion;
855 ReadString(blendshapeHeader->GetChild(VERSION), blendShapeVersion);
857 if(0u == blendShapeVersion.compare(BLEND_SHAPE_VERSION_1_0))
859 meshDef.mBlendShapeVersion = BlendShapes::Version::VERSION_1_0;
861 else if(0u == blendShapeVersion.compare(BLEND_SHAPE_VERSION_2_0))
863 meshDef.mBlendShapeVersion = BlendShapes::Version::VERSION_2_0;
866 switch(meshDef.mBlendShapeVersion)
868 case BlendShapes::Version::VERSION_1_0:
869 case BlendShapes::Version::VERSION_2_0: // FALL THROUGH
871 ReadAttribBlob(blendshapeHeader, meshDef.mBlendShapeHeader);
882 if(auto blendShapes = node.GetChild(BLEND_SHAPES))
884 meshDef.mBlendShapes.resize(blendShapes->Size());
887 for(auto it = blendShapes->CBegin(), endIt = blendShapes->CEnd(); it != endIt; ++it, ++index)
889 // Each blend shape is stored as the difference with the original mesh.
891 auto& blendShapeNode = (*it).second;
893 auto& blendShape = meshDef.mBlendShapes[index];
894 ReadString(blendShapeNode.GetChild("name"), blendShape.name);
895 if(auto position = blendShapeNode.GetChild("positions"))
897 ReadAttribAccessor(position, blendShape.deltas);
899 if(auto normals = blendShapeNode.GetChild("normals"))
901 ReadAttribAccessor(normals, blendShape.normals);
903 if(auto tangents = blendShapeNode.GetChild("tangents"))
905 ReadAttribAccessor(tangents, blendShape.tangents);
907 ReadFloat(blendShapeNode.GetChild("weight"), blendShape.weight);
912 if(ReadBool(node.GetChild("flipV"), flipV))
914 meshDef.mFlags |= flipV * MeshDefinition::FLIP_UVS_VERTICAL;
917 resources.mMeshes.emplace_back(std::move(meshDef), MeshGeometry());
922 void DliLoader::Impl::ParseMaterials(const TreeNode* materials, ConvertColorCode convertColorCode, ResourceBundle& resources)
924 for(auto i0 = materials->CBegin(), i1 = materials->CEnd(); i0 != i1; ++i0)
926 auto& node = (*i0).second;
928 MaterialDefinition materialDef;
929 if(auto eEnvironment = node.GetChild("environment"))
931 ReadIndex(eEnvironment, materialDef.mEnvironmentIdx);
932 if(static_cast<unsigned int>(materialDef.mEnvironmentIdx) >= resources.mEnvironmentMaps.size())
934 ExceptionFlinger(ASSERT_LOCATION) << "material " << resources.mMaterials.size() << ": Environment index " << materialDef.mEnvironmentIdx << " out of bounds (" << resources.mEnvironmentMaps.size() << ").";
938 //TODO : need to consider AGIF
939 std::vector<std::string> texturePaths;
940 std::string texturePath;
941 if(ReadString(node.GetChild("albedoMap"), texturePath))
943 ToUnixFileSeparators(texturePath);
944 const auto semantic = MaterialDefinition::ALBEDO;
945 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
946 materialDef.mFlags |= semantic | MaterialDefinition::TRANSPARENCY; // NOTE: only in dli does single / separate ALBEDO texture mean TRANSPARENCY.
948 if(ReadString(node.GetChild("albedoMetallicMap"), texturePath))
950 ToUnixFileSeparators(texturePath);
952 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO))
954 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "albedo"));
957 const auto semantic = MaterialDefinition::ALBEDO | MaterialDefinition::METALLIC;
958 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
959 materialDef.mFlags |= semantic;
962 if(ReadString(node.GetChild("metallicRoughnessMap"), texturePath))
964 ToUnixFileSeparators(texturePath);
966 if(MaskMatch(materialDef.mFlags, MaterialDefinition::METALLIC))
968 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "metallic"));
971 const auto semantic = MaterialDefinition::METALLIC | MaterialDefinition::ROUGHNESS;
972 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
973 materialDef.mFlags |= semantic |
974 // We have a metallic-roughhness map and the first texture did not have albedo semantics - we're in the transparency workflow.
975 (MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO) * MaterialDefinition::TRANSPARENCY);
978 if(ReadString(node.GetChild("normalMap"), texturePath))
980 ToUnixFileSeparators(texturePath);
982 const auto semantic = MaterialDefinition::NORMAL;
983 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
984 materialDef.mFlags |= semantic |
985 // We have a standalone normal map and the first texture did not have albedo semantics - we're in the transparency workflow.
986 (MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO) * MaterialDefinition::TRANSPARENCY);
989 if(ReadString(node.GetChild("normalRoughnessMap"), texturePath))
991 ToUnixFileSeparators(texturePath);
993 if(MaskMatch(materialDef.mFlags, MaterialDefinition::NORMAL))
995 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "normal"));
998 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ROUGHNESS))
1000 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "roughness"));
1003 if(MaskMatch(materialDef.mFlags, MaterialDefinition::TRANSPARENCY))
1005 mOnError(FormatString("material %d: conflicting semantics; already set %s.", resources.mMaterials.size(), "transparency"));
1008 const auto semantic = MaterialDefinition::NORMAL | MaterialDefinition::ROUGHNESS;
1009 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1010 materialDef.mFlags |= semantic;
1013 if(ReadString(node.GetChild("subsurfaceMap"), texturePath))
1015 ToUnixFileSeparators(texturePath);
1017 const auto semantic = MaterialDefinition::SUBSURFACE;
1018 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1019 materialDef.mFlags |= semantic;
1022 if(ReadString(node.GetChild("occlusionMap"), texturePath))
1024 ToUnixFileSeparators(texturePath);
1025 const auto semantic = MaterialDefinition::OCCLUSION;
1026 materialDef.mTextureStages.push_back({semantic, TextureDefinition{std::move(texturePath)}});
1027 materialDef.mFlags |= semantic;
1030 if(ReadColorCodeOrColor(&node, materialDef.mColor, convertColorCode) &&
1031 materialDef.mColor.a < 1.0f)
1033 materialDef.mFlags |= MaterialDefinition::TRANSPARENCY;
1036 ReadFloat(node.GetChild("metallic"), materialDef.mMetallic);
1037 ReadFloat(node.GetChild("roughness"), materialDef.mRoughness);
1040 if(ReadBool(node.GetChild("mipmap"), mipmaps) && mipmaps)
1042 for(auto& ts : materialDef.mTextureStages)
1044 ts.mTexture.mSamplerFlags |= SamplerFlags::FILTER_MIPMAP_LINEAR;
1048 resources.mMaterials.emplace_back(std::move(materialDef), TextureSet());
1052 void DliLoader::Impl::ParseNodes(const TreeNode* const nodes, Index index, LoadParams& params)
1054 std::vector<Index> parents;
1057 struct IndexMapper : IIndexMapper
1059 IndexMapper(size_t numNodes)
1061 mIndices.reserve(numNodes);
1064 virtual bool Map(Index iDli, Index iScene) override
1066 Entry idx{iDli, iScene};
1067 auto iInsert = std::lower_bound(mIndices.begin(), mIndices.end(), idx);
1068 if(iInsert == mIndices.end() || iInsert->iDli != iDli)
1070 mIndices.insert(iInsert, idx);
1072 else if(iInsert->iScene != iScene)
1079 virtual unsigned int Resolve(Index iDli) override
1081 auto iFind = std::lower_bound(mIndices.begin(), mIndices.end(), iDli, [](const Entry& idx, Index iDli) {
1082 return idx.iDli < iDli;
1084 DALI_ASSERT_ALWAYS(iFind != mIndices.end());
1085 return iFind->iScene;
1092 unsigned int iScene;
1094 bool operator<(const Entry& other) const
1096 return iDli < other.iDli;
1099 std::vector<Entry> mIndices;
1100 } mapper(nodes->Size());
1101 ParseNodesInternal(nodes, index, parents, params, mapper);
1103 auto& scene = params.output.mScene;
1104 for(size_t i0 = 0, i1 = scene.GetNodeCount(); i0 < i1; ++i0)
1106 for(auto& c : scene.GetNode(i0)->mConstraints)
1108 c.mSourceIdx = mapper.Resolve(c.mSourceIdx);
1113 void DliLoader::Impl::ParseNodesInternal(const TreeNode* const nodes, Index index, std::vector<Index>& inOutParentStack, LoadParams& params, IIndexMapper& mapper)
1115 // Properties that may be resolved from a JSON value with ReadInt() -- or default to 0.
1116 struct IndexProperty
1118 ResourceType::Value type;
1119 const TreeNode* source;
1122 std::vector<IndexProperty> resourceIds;
1123 resourceIds.reserve(4);
1125 if(auto node = GetNthChild(nodes, index))
1127 NodeDefinition nodeDef;
1128 nodeDef.mParentIdx = inOutParentStack.empty() ? INVALID_INDEX : inOutParentStack.back();
1131 ReadString(node->GetChild(NAME), nodeDef.mName);
1134 ReadModelTransform(node, nodeDef.mOrientation, nodeDef.mPosition, nodeDef.mScale);
1136 // Reads the size of the node.
1138 // * It can be given as 'size' or 'bounds'.
1139 // * The sdk saves the 'size' as a vector2 in some cases.
1140 // * To avoid size related issues the following code attemps
1141 // to read the 'size/bounds' as a vector3 first, if it's
1142 // not successful then reads it as a vector2.
1143 ReadVector(node->GetChild("size"), nodeDef.mSize.AsFloat(), 3) ||
1144 ReadVector(node->GetChild("size"), nodeDef.mSize.AsFloat(), 2) ||
1145 ReadVector(node->GetChild("bounds"), nodeDef.mSize.AsFloat(), 3) ||
1146 ReadVector(node->GetChild("bounds"), nodeDef.mSize.AsFloat(), 2);
1149 ReadBool(node->GetChild("visible"), nodeDef.mIsVisible);
1151 // type classification
1152 if(auto eCustomization = node->GetChild("customization")) // customization
1155 if(ReadString(eCustomization->GetChild("tag"), tag))
1157 nodeDef.mCustomization.reset(new NodeDefinition::CustomizationDefinition{tag});
1160 else // something renderable maybe
1162 std::unique_ptr<NodeDefinition::Renderable> renderable;
1163 ModelNode* modelNode = nullptr; // no ownership, aliasing renderable for the right type.
1165 const TreeNode* eRenderable = nullptr;
1166 if((eRenderable = node->GetChild("model")))
1168 // check for mesh before allocating - this can't be missing.
1169 auto eMesh = eRenderable->GetChild("mesh");
1172 ExceptionFlinger(ASSERT_LOCATION) << "node " << nodeDef.mName << ": Missing mesh definition.";
1175 modelNode = new ModelNode();
1176 renderable.reset(modelNode);
1178 resourceIds.push_back({ResourceType::Mesh, eMesh, modelNode->mMeshIdx});
1180 else if((eRenderable = node->GetChild("arc")))
1182 // check for mesh before allocating - this can't be missing.
1183 auto eMesh = eRenderable->GetChild("mesh");
1186 ExceptionFlinger(ASSERT_LOCATION) << "node " << nodeDef.mName << ": Missing mesh definition.";
1189 auto arcNode = new ArcNode;
1190 renderable.reset(arcNode);
1191 modelNode = arcNode;
1193 resourceIds.push_back({ResourceType::Mesh, eMesh, arcNode->mMeshIdx});
1195 ReadArcField(eRenderable, *arcNode);
1198 if(renderable && eRenderable != nullptr) // process common properties of all renderables + register payload
1201 renderable->mShaderIdx = 0;
1202 auto eShader = eRenderable->GetChild("shader");
1203 resourceIds.push_back({ResourceType::Shader, eShader, renderable->mShaderIdx});
1208 modelNode->mMaterialIdx = 0; // must offer default of 0
1209 auto eMaterial = eRenderable->GetChild("material");
1210 resourceIds.push_back({ResourceType::Material, eMaterial, modelNode->mMaterialIdx});
1212 if(!ReadColorCodeOrColor(eRenderable, modelNode->mColor, params.input.mConvertColorCode))
1214 ReadColorCodeOrColor(node, modelNode->mColor, params.input.mConvertColorCode);
1218 nodeDef.mRenderable = std::move(renderable);
1222 // Resolve ints - default to 0 if undefined
1223 auto& output = params.output;
1224 for(auto& idRes : resourceIds)
1229 case ResourceType::Shader:
1230 iCheck = output.mResources.mShaders.size();
1233 case ResourceType::Mesh:
1234 iCheck = output.mResources.mMeshes.size();
1237 case ResourceType::Material:
1238 iCheck = output.mResources.mMaterials.size();
1242 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": Invalid resource type: " << idRes.type << " (Programmer error)";
1249 else if(idRes.source->GetType() != TreeNode::INTEGER)
1251 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": Invalid " << GetResourceTypeName(idRes.type) << " index type.";
1255 idRes.target = idRes.source->GetInteger();
1258 if(idRes.target >= iCheck)
1260 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ": " << GetResourceTypeName(idRes.type) << " index " << idRes.target << " out of bounds (" << iCheck << ").";
1263 resourceIds.clear();
1266 if(auto eExtras = node->GetChild("extras"))
1268 auto& extras = nodeDef.mExtras;
1269 extras.reserve(eExtras->Size());
1271 for(auto i0 = eExtras->CBegin(), i1 = eExtras->CEnd(); i0 != i1; ++i0)
1273 NodeDefinition::Extra e;
1276 e.mKey = eExtra.first;
1279 mOnError(FormatString("node %d: empty string is invalid for name of extra %d; ignored.",
1285 e.mValue = ReadPropertyValue(eExtra.second);
1286 if(e.mValue.GetType() == Property::Type::NONE)
1288 mOnError(FormatString("node %d: failed to interpret value of extra '%s' : %s; ignored.",
1291 eExtra.second.GetString()));
1295 auto iInsert = std::lower_bound(extras.begin(), extras.end(), e);
1296 if(iInsert != extras.end() && iInsert->mKey == e.mKey)
1298 mOnError(FormatString("node %d: extra '%s' already defined; overriding with %s.",
1301 eExtra.second.GetString()));
1302 *iInsert = std::move(e);
1306 extras.insert(iInsert, e);
1313 if(auto eConstraints = node->GetChild("constraints"))
1315 auto& constraints = nodeDef.mConstraints;
1316 constraints.reserve(eConstraints->Size());
1318 ConstraintDefinition cDef;
1319 for(auto i0 = eConstraints->CBegin(), i1 = eConstraints->CEnd(); i0 != i1; ++i0)
1321 auto eConstraint = *i0;
1322 if(!ReadIndex(&eConstraint.second, cDef.mSourceIdx))
1324 mOnError(FormatString("node %d: node ID %s for constraint %d is invalid; ignored.",
1326 eConstraint.second.GetString(),
1327 constraints.size()));
1331 cDef.mProperty = eConstraint.first;
1333 auto iInsert = std::lower_bound(constraints.begin(), constraints.end(), cDef);
1334 if(iInsert != constraints.end() && *iInsert == cDef)
1336 mOnError(FormatString("node %d: constraint %s@%d already defined; ignoring.",
1338 cDef.mProperty.c_str(),
1343 constraints.insert(iInsert, cDef);
1349 // Determine index for mapping
1350 const unsigned int myIndex = output.mScene.GetNodeCount();
1351 if(!mapper.Map(index, myIndex))
1353 mOnError(FormatString("node %d: error mapping dli index %d: node has multiple parents. Ignoring subtree."));
1357 // if the node is a bone in a skeletal animation, it will have the inverse bind pose matrix.
1358 Matrix invBindMatrix{false};
1359 if(ReadVector(node->GetChild("inverseBindPoseMatrix"), invBindMatrix.AsFloat(), 16u)) // TODO: more robust error checking?
1361 mInverseBindMatrices[myIndex] = invBindMatrix;
1365 auto rawDef = output.mScene.AddNode(std::make_unique<NodeDefinition>(std::move(nodeDef)));
1366 if(rawDef) // NOTE: no ownership. Guaranteed to stay in scope.
1368 // ...And only then parse children.
1369 if(auto children = node->GetChild("children"))
1371 inOutParentStack.push_back(myIndex);
1373 rawDef->mChildren.reserve(children->Size());
1375 uint32_t iChild = 0;
1376 for(auto j0 = children->CBegin(), j1 = children->CEnd(); j0 != j1; ++j0, ++iChild)
1378 auto& child = (*j0).second;
1379 if(child.GetType() == TreeNode::INTEGER)
1381 ParseNodesInternal(nodes, child.GetInteger(), inOutParentStack, params, mapper); // child object is created in scene definition.
1385 ExceptionFlinger(ASSERT_LOCATION) << "node " << index << ", child " << iChild << ": invalid index type.";
1389 inOutParentStack.pop_back();
1391 else if(rawDef->mCustomization)
1393 mOnError(FormatString("node %d: not an actual customization without children.", index));
1396 if(auto proc = params.input.mNodePropertyProcessor) // optional processing
1398 // WARNING: constraint IDs are not resolved at this point.
1399 Property::Map nodeData;
1400 ParseProperties(*node, nodeData);
1401 proc(*rawDef, std::move(nodeData), mOnError);
1406 ExceptionFlinger(ASSERT_LOCATION) << "Node " << index << ": name already used.";
1411 void DliLoader::Impl::ParseAnimations(const TreeNode* tnAnimations, LoadParams& params)
1413 auto& definitions = params.output.mAnimationDefinitions;
1414 definitions.reserve(definitions.size() + tnAnimations->Size());
1416 for(TreeNode::ConstIterator iAnim = tnAnimations->CBegin(), iAnimEnd = tnAnimations->CEnd();
1420 const TreeNode& tnAnim = (*iAnim).second;
1421 AnimationDefinition animDef;
1422 ReadString(tnAnim.GetChild(NAME), animDef.mName);
1424 auto iFind = std::lower_bound(definitions.begin(), definitions.end(), animDef, [](const AnimationDefinition& ad0, const AnimationDefinition& ad1) {
1425 return ad0.mName < ad1.mName;
1427 const bool overwrite = iFind != definitions.end() && iFind->mName == animDef.mName;
1430 mOnError(FormatString("Pre-existing animation with name '%s' is being overwritten.", animDef.mName.c_str()));
1433 // Duration -- We need something that animated properties' delay / duration can
1434 // be expressed as a multiple of; 0 won't work. This is small enough (i.e. shorter
1435 // than our frame delay) to not be restrictive WRT replaying. If anything needs
1436 // to occur more frequently, then Animations are likely not your solution anyway.
1437 animDef.mDuration = AnimationDefinition::MIN_DURATION_SECONDS;
1438 if(!ReadFloat(tnAnim.GetChild("duration"), animDef.mDuration))
1440 mOnError(FormatString("Animation '%s' fails to define '%s', defaulting to %f.",
1441 animDef.mName.c_str(),
1443 animDef.mDuration));
1446 // Get loop count - # of playbacks. Default is once. 0 means repeat indefinitely.
1447 animDef.mLoopCount = 1;
1448 if(ReadInt(tnAnim.GetChild("loopCount"), animDef.mLoopCount) &&
1449 animDef.mLoopCount < 0)
1451 animDef.mLoopCount = 0;
1454 std::string endAction;
1455 if(ReadString(tnAnim.GetChild("endAction"), endAction))
1457 if("BAKE" == endAction)
1459 animDef.mEndAction = Animation::BAKE;
1461 else if("DISCARD" == endAction)
1463 animDef.mEndAction = Animation::DISCARD;
1465 else if("BAKE_FINAL" == endAction)
1467 animDef.mEndAction = Animation::BAKE_FINAL;
1471 if(ReadString(tnAnim.GetChild("disconnectAction"), endAction))
1473 if("BAKE" == endAction)
1475 animDef.mDisconnectAction = Animation::BAKE;
1477 else if("DISCARD" == endAction)
1479 animDef.mDisconnectAction = Animation::DISCARD;
1481 else if("BAKE_FINAL" == endAction)
1483 animDef.mDisconnectAction = Animation::BAKE_FINAL;
1487 if(const TreeNode* tnProperties = tnAnim.GetChild("properties"))
1489 animDef.mProperties.reserve(tnProperties->Size());
1490 for(TreeNode::ConstIterator iProperty = tnProperties->CBegin(), iPropertyEnd = tnProperties->CEnd();
1491 iProperty != iPropertyEnd;
1494 const TreeNode& tnProperty = (*iProperty).second;
1496 AnimatedProperty animProp;
1497 if(!ReadString(tnProperty.GetChild("node"), animProp.mNodeName))
1499 mOnError(FormatString("Animation '%s': Failed to read the 'node' tag.", animDef.mName.c_str()));
1503 if(!ReadString(tnProperty.GetChild("property"), animProp.mPropertyName))
1505 mOnError(FormatString("Animation '%s': Failed to read the 'property' tag", animDef.mName.c_str()));
1509 // these are the defaults
1510 animProp.mTimePeriod.delaySeconds = 0.f;
1511 animProp.mTimePeriod.durationSeconds = animDef.mDuration;
1512 if(!ReadTimePeriod(tnProperty.GetChild("timePeriod"), animProp.mTimePeriod))
1514 mOnError(FormatString("Animation '%s': timePeriod missing in Property #%d: defaulting to %f.",
1515 animDef.mName.c_str(),
1516 animDef.mProperties.size(),
1517 animProp.mTimePeriod.durationSeconds));
1520 std::string alphaFunctionValue;
1521 if(ReadString(tnProperty.GetChild("alphaFunction"), alphaFunctionValue))
1523 animProp.mAlphaFunction = GetAlphaFunction(alphaFunctionValue);
1526 if(const TreeNode* tnKeyFramesBin = tnProperty.GetChild("keyFramesBin"))
1528 DALI_ASSERT_ALWAYS(!animProp.mPropertyName.empty() && "Animation must specify a property name");
1530 std::ifstream binAniFile;
1531 std::string animationFilename;
1532 if(ReadString(tnKeyFramesBin->GetChild(URL), animationFilename))
1534 std::string animationFullPath = params.input.mAnimationsPath + animationFilename;
1535 binAniFile.open(animationFullPath, std::ios::binary);
1536 if(binAniFile.fail())
1538 ExceptionFlinger(ASSERT_LOCATION) << "Failed to open animation data '" << animationFullPath << "'";
1543 ReadInt(tnKeyFramesBin->GetChild("byteOffset"), byteOffset);
1544 DALI_ASSERT_ALWAYS(byteOffset >= 0);
1546 binAniFile.seekg(byteOffset, std::ios::beg);
1549 ReadInt(tnKeyFramesBin->GetChild("numKeys"), numKeys);
1550 DALI_ASSERT_ALWAYS(numKeys >= 0);
1552 animProp.mKeyFrames = KeyFrames::New();
1554 //In binary animation file only is saved the position, rotation, scale and blend shape weight keys.
1555 //so, if it is vector3 we assume is position or scale keys, if it is vector4 we assume is rotation,
1556 // otherwise are blend shape weight keys.
1557 // TODO support for binary header with size information
1558 Property::Type propType = Property::FLOAT; // assume blend shape weights
1559 if(animProp.mPropertyName == "orientation")
1561 propType = Property::VECTOR4;
1563 else if((animProp.mPropertyName == "position") || (animProp.mPropertyName == "scale"))
1565 propType = Property::VECTOR3;
1568 //alphafunction is reserved for future implementation
1569 // NOTE: right now we're just using AlphaFunction::LINEAR.
1570 unsigned char dummyAlphaFunction;
1573 Property::Value propValue;
1574 for(int key = 0; key < numKeys; key++)
1576 binAniFile.read(reinterpret_cast<char*>(&progress), sizeof(float));
1577 if(propType == Property::VECTOR3)
1580 binAniFile.read(reinterpret_cast<char*>(value.AsFloat()), sizeof(float) * 3);
1581 propValue = Property::Value(value);
1583 else if(propType == Property::VECTOR4)
1586 binAniFile.read(reinterpret_cast<char*>(value.AsFloat()), sizeof(float) * 4);
1587 propValue = Property::Value(Quaternion(value));
1592 binAniFile.read(reinterpret_cast<char*>(&value), sizeof(float));
1593 propValue = Property::Value(value);
1596 binAniFile.read(reinterpret_cast<char*>(&dummyAlphaFunction), sizeof(unsigned char));
1598 animProp.mKeyFrames.Add(progress, propValue, AlphaFunction::LINEAR);
1601 else if(const TreeNode* tnKeyFrames = tnProperty.GetChild("keyFrames"))
1603 DALI_ASSERT_ALWAYS(!animProp.mPropertyName.empty() && "Animation must specify a property name");
1604 animProp.mKeyFrames = KeyFrames::New();
1606 float progress = 0.0f;
1607 for(auto i0 = tnKeyFrames->CBegin(), i1 = tnKeyFrames->CEnd(); i1 != i0; ++i0)
1609 const TreeNode::KeyNodePair& kfKeyChild = *i0;
1610 bool readResult = ReadFloat(kfKeyChild.second.GetChild("progress"), progress);
1611 DALI_ASSERT_ALWAYS(readResult && "Key frame entry must have 'progress'");
1613 const TreeNode* tnValue = kfKeyChild.second.GetChild("value");
1614 DALI_ASSERT_ALWAYS(tnValue && "Key frame entry must have 'value'");
1616 // For the "orientation" property, convert from Vector4 -> Rotation value
1617 // This work-around is preferable to a null-pointer exception in the DALi update thread
1618 Property::Value propValue(ReadPropertyValue(*tnValue));
1619 if(propValue.GetType() == Property::VECTOR4 &&
1620 animProp.mPropertyName == "orientation")
1624 propValue = Property::Value(Quaternion(v.w, v.x, v.y, v.z));
1627 AlphaFunction kfAlphaFunction(AlphaFunction::DEFAULT);
1628 std::string alphaFuncStr;
1629 if(ReadString(kfKeyChild.second.GetChild("alphaFunction"), alphaFuncStr))
1631 kfAlphaFunction = GetAlphaFunction(alphaFuncStr);
1634 animProp.mKeyFrames.Add(progress, propValue, kfAlphaFunction);
1639 const TreeNode* tnValue = tnProperty.GetChild("value");
1642 animProp.mValue.reset(new AnimatedProperty::Value{ReadPropertyValue(*tnValue)});
1643 ReadBool(tnProperty.GetChild("relative"), animProp.mValue->mIsRelative);
1647 mOnError(FormatString("Property '%s' fails to define target value.",
1648 animProp.mPropertyName.c_str()));
1652 animDef.mProperties.push_back(std::move(animProp));
1658 *iFind = std::move(animDef);
1662 iFind = definitions.insert(iFind, std::move(animDef));
1665 if(auto proc = params.input.mAnimationPropertyProcessor) // optional processing
1668 ParseProperties(tnAnim, map);
1669 proc(animDef, std::move(map), mOnError);
1674 void DliLoader::Impl::ParseAnimationGroups(const Toolkit::TreeNode* tnAnimationGroups, LoadParams& params)
1676 auto& animGroups = params.output.mAnimationGroupDefinitions;
1679 for(auto iGroups = tnAnimationGroups->CBegin(), iGroupsEnd = tnAnimationGroups->CEnd();
1680 iGroups != iGroupsEnd;
1681 ++iGroups, ++numGroups)
1683 const auto& tnGroup = *iGroups;
1684 auto tnName = tnGroup.second.GetChild(NAME);
1685 std::string groupName;
1686 if(!tnName || !ReadString(tnName, groupName))
1688 mOnError(FormatString("Failed to get the name for the Animation group %d; ignoring.", numGroups));
1692 auto iFind = std::lower_bound(animGroups.begin(), animGroups.end(), groupName, [](const AnimationGroupDefinition& group, const std::string& name) {
1693 return group.mName < name;
1695 if(iFind != animGroups.end() && iFind->mName == groupName)
1697 mOnError(FormatString("Animation group with name '%s' already exists; new entries will be merged.", groupName.c_str()));
1701 iFind = animGroups.insert(iFind, AnimationGroupDefinition{});
1704 iFind->mName = groupName;
1706 auto tnAnims = tnGroup.second.GetChild("animations");
1707 if(tnAnims && tnAnims->Size() > 0)
1709 auto& anims = iFind->mAnimations;
1710 anims.reserve(anims.size() + tnAnims->Size());
1711 for(auto iAnims = tnAnims->CBegin(), iAnimsEnd = tnAnims->CEnd(); iAnims != iAnimsEnd; ++iAnims)
1713 anims.push_back((*iAnims).second.GetString());
1719 void DliLoader::Impl::GetCameraParameters(std::vector<CameraParameters>& cameras) const
1721 if(mParser.GetRoot())
1723 if(const TreeNode* jsonCameras = mParser.GetRoot()->GetChild("cameras"))
1725 cameras.resize(jsonCameras->Size());
1726 auto iCamera = cameras.begin();
1727 for(auto i0 = jsonCameras->CBegin(), i1 = jsonCameras->CEnd(); i0 != i1; ++i0)
1729 auto& jsonCamera = (*i0).second;
1731 ReadFloat(jsonCamera.GetChild("fov"), iCamera->yFov);
1732 ReadFloat(jsonCamera.GetChild("near"), iCamera->zNear);
1733 ReadFloat(jsonCamera.GetChild("far"), iCamera->zFar);
1734 if(ReadVector(jsonCamera.GetChild("orthographic"), iCamera->orthographicSize.AsFloat(), 4u))
1736 iCamera->isPerspective = false;
1739 if(auto jsonMatrix = jsonCamera.GetChild("matrix"))
1741 ReadVector(jsonMatrix, iCamera->matrix.AsFloat(), 16u);
1750 void DliLoader::Impl::GetLightParameters(std::vector<LightParameters>& lights) const
1752 if(mParser.GetRoot())
1754 if(const TreeNode* jsonLights = mParser.GetRoot()->GetChild("lights"))
1756 lights.resize(jsonLights->Size());
1757 auto iLight = lights.begin();
1758 for(auto i0 = jsonLights->CBegin(), i1 = jsonLights->CEnd(); i0 != i1; ++i0)
1760 auto& jsonLight = (*i0).second;
1761 if(!ReadVector(jsonLight.GetChild("matrix"), iLight->transform.AsFloat(), 16))
1764 FormatString("Failed to parse light %d - \"matrix\" child with 16 floats expected.\n",
1765 std::distance(jsonLights->CBegin(), i0)));
1769 int shadowMapSize = 0;
1770 if(ReadInt(jsonLight.GetChild(SHADOW_MAP_SIZE), shadowMapSize) && shadowMapSize < 0)
1773 FormatString("Failed to parse light %d - %s has an invalid value.",
1774 std::distance(jsonLights->CBegin(), i0),
1778 iLight->shadowMapSize = shadowMapSize;
1780 float orthoSize = 0.f;
1781 if(ReadFloat(jsonLight.GetChild(ORTHOGRAPHIC_SIZE), orthoSize) &&
1782 (orthoSize < .0f || std::isnan(orthoSize) || std::isinf(orthoSize)))
1785 FormatString("Failed to parse light %d - %s has an invalid value.",
1786 std::distance(jsonLights->CBegin(), i0),
1787 ORTHOGRAPHIC_SIZE));
1790 iLight->orthographicSize = orthoSize;
1792 if((iLight->shadowMapSize > 0) != (iLight->orthographicSize > .0f))
1794 mOnError(FormatString(
1795 "Light %d: Both shadow map size and orthographic size must be set for shadows to work.",
1796 std::distance(jsonLights->CBegin(), i0)));
1799 if(!ReadVector(jsonLight.GetChild("color"), iLight->color.AsFloat(), 3)) // color is optional
1801 iLight->color = Vector3::ONE; // default to white
1804 if(!ReadFloat(jsonLight.GetChild("intensity"), iLight->intensity)) // intensity is optional
1806 iLight->intensity = 1.0f; // default to 1.0
1809 if(!ReadFloat(jsonLight.GetChild("shadowIntensity"), iLight->shadowIntensity)) // intensity is optional
1811 iLight->shadowIntensity = 1.0f; // default to 1.0
1820 } // namespace Loader
1821 } // namespace Scene3D