2 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-scene3d/internal/loader/gltf2-util.h>
22 #include <dali/integration-api/debug.h>
24 using namespace Dali::Scene3D::Loader;
26 namespace Dali::Scene3D::Loader::Internal
30 static constexpr std::string_view MRENDERER_MODEL_IDENTIFICATION = "M-Renderer";
31 static constexpr std::string_view POSITION_PROPERTY = "position";
32 static constexpr std::string_view ORIENTATION_PROPERTY = "orientation";
33 static constexpr std::string_view SCALE_PROPERTY = "scale";
34 static constexpr std::string_view BLEND_SHAPE_WEIGHTS_UNIFORM = "uBlendShapeWeight";
35 static constexpr std::string_view ROOT_NODE_NAME = "RootNode";
36 static const Vector3 SCALE_TO_ADJUST(100.0f, 100.0f, 100.0f);
38 static const Geometry::Type GLTF2_TO_DALI_PRIMITIVES[]{
44 Geometry::TRIANGLE_STRIP,
45 Geometry::TRIANGLE_FAN}; //...because Dali swaps the last two.
47 static struct AttributeMapping
49 gltf2::Attribute::Type mType;
50 MeshDefinition::Accessor MeshDefinition::*mAccessor;
51 uint16_t mElementSizeRequired;
52 } ATTRIBUTE_MAPPINGS[]{
53 {gltf2::Attribute::NORMAL, &MeshDefinition::mNormals, sizeof(Vector3)},
54 {gltf2::Attribute::TANGENT, &MeshDefinition::mTangents, sizeof(Vector3)},
55 {gltf2::Attribute::TEXCOORD_0, &MeshDefinition::mTexCoords, sizeof(Vector2)},
56 {gltf2::Attribute::COLOR_0, &MeshDefinition::mColors, sizeof(Vector4)},
57 {gltf2::Attribute::JOINTS_0, &MeshDefinition::mJoints0, sizeof(Vector4)},
58 {gltf2::Attribute::WEIGHTS_0, &MeshDefinition::mWeights0, sizeof(Vector4)},
61 std::vector<gltf2::Animation> ReadAnimationArray(const json_value_s& j)
63 auto results = json::Read::Array<gltf2::Animation, json::ObjectReader<gltf2::Animation>::Read>(j);
65 for(auto& animation : results)
67 for(auto& channel : animation.mChannels)
69 channel.mSampler.UpdateVector(animation.mSamplers);
76 void ApplyAccessorMinMax(const gltf2::Accessor& accessor, float* values)
78 DALI_ASSERT_ALWAYS(accessor.mMax.empty() || gltf2::AccessorType::ElementCount(accessor.mType) == accessor.mMax.size());
79 DALI_ASSERT_ALWAYS(accessor.mMin.empty() || gltf2::AccessorType::ElementCount(accessor.mType) == accessor.mMin.size());
80 MeshDefinition::Blob::ApplyMinMax(accessor.mMin, accessor.mMax, accessor.mCount, values);
83 const auto BUFFER_READER = std::move(json::Reader<gltf2::Buffer>()
84 .Register(*json::MakeProperty("byteLength", json::Read::Number<uint32_t>, &gltf2::Buffer::mByteLength))
85 .Register(*json::MakeProperty("uri", json::Read::StringView, &gltf2::Buffer::mUri)));
87 const auto BUFFER_VIEW_READER = std::move(json::Reader<gltf2::BufferView>()
88 .Register(*json::MakeProperty("buffer", gltf2::RefReader<gltf2::Document>::Read<gltf2::Buffer, &gltf2::Document::mBuffers>, &gltf2::BufferView::mBuffer))
89 .Register(*json::MakeProperty("byteOffset", json::Read::Number<uint32_t>, &gltf2::BufferView::mByteOffset))
90 .Register(*json::MakeProperty("byteLength", json::Read::Number<uint32_t>, &gltf2::BufferView::mByteLength))
91 .Register(*json::MakeProperty("byteStride", json::Read::Number<uint32_t>, &gltf2::BufferView::mByteStride))
92 .Register(*json::MakeProperty("target", json::Read::Number<uint32_t>, &gltf2::BufferView::mTarget)));
94 const auto BUFFER_VIEW_CLIENT_READER = std::move(json::Reader<gltf2::BufferViewClient>()
95 .Register(*json::MakeProperty("bufferView", gltf2::RefReader<gltf2::Document>::Read<gltf2::BufferView, &gltf2::Document::mBufferViews>, &gltf2::BufferViewClient::mBufferView))
96 .Register(*json::MakeProperty("byteOffset", json::Read::Number<uint32_t>, &gltf2::BufferViewClient::mByteOffset)));
98 const auto COMPONENT_TYPED_BUFFER_VIEW_CLIENT_READER = std::move(json::Reader<gltf2::ComponentTypedBufferViewClient>()
99 .Register(*new json::Property<gltf2::ComponentTypedBufferViewClient, gltf2::Ref<gltf2::BufferView>>("bufferView", gltf2::RefReader<gltf2::Document>::Read<gltf2::BufferView, &gltf2::Document::mBufferViews>, &gltf2::ComponentTypedBufferViewClient::mBufferView))
100 .Register(*new json::Property<gltf2::ComponentTypedBufferViewClient, uint32_t>("byteOffset", json::Read::Number<uint32_t>, &gltf2::ComponentTypedBufferViewClient::mByteOffset))
101 .Register(*json::MakeProperty("componentType", json::Read::Enum<gltf2::Component::Type>, &gltf2::ComponentTypedBufferViewClient::mComponentType)));
103 const auto ACCESSOR_SPARSE_READER = std::move(json::Reader<gltf2::Accessor::Sparse>()
104 .Register(*json::MakeProperty("count", json::Read::Number<uint32_t>, &gltf2::Accessor::Sparse::mCount))
105 .Register(*json::MakeProperty("indices", json::ObjectReader<gltf2::ComponentTypedBufferViewClient>::Read, &gltf2::Accessor::Sparse::mIndices))
106 .Register(*json::MakeProperty("values", json::ObjectReader<gltf2::BufferViewClient>::Read, &gltf2::Accessor::Sparse::mValues)));
108 const auto ACCESSOR_READER = std::move(json::Reader<gltf2::Accessor>()
109 .Register(*new json::Property<gltf2::Accessor, gltf2::Ref<gltf2::BufferView>>("bufferView",
110 gltf2::RefReader<gltf2::Document>::Read<gltf2::BufferView, &gltf2::Document::mBufferViews>,
111 &gltf2::Accessor::mBufferView))
112 .Register(*new json::Property<gltf2::Accessor, uint32_t>("byteOffset",
113 json::Read::Number<uint32_t>,
114 &gltf2::Accessor::mByteOffset))
115 .Register(*new json::Property<gltf2::Accessor, gltf2::Component::Type>("componentType",
116 json::Read::Enum<gltf2::Component::Type>,
117 &gltf2::Accessor::mComponentType))
118 .Register(*new json::Property<gltf2::Accessor, std::string_view>("name", json::Read::StringView, &gltf2::Accessor::mName))
119 .Register(*json::MakeProperty("count", json::Read::Number<uint32_t>, &gltf2::Accessor::mCount))
120 .Register(*json::MakeProperty("normalized", json::Read::Boolean, &gltf2::Accessor::mNormalized))
121 .Register(*json::MakeProperty("type", gltf2::ReadStringEnum<gltf2::AccessorType>, &gltf2::Accessor::mType))
122 .Register(*json::MakeProperty("min", json::Read::Array<float, json::Read::Number>, &gltf2::Accessor::mMin))
123 .Register(*json::MakeProperty("max", json::Read::Array<float, json::Read::Number>, &gltf2::Accessor::mMax))
124 .Register(*new json::Property<gltf2::Accessor, gltf2::Accessor::Sparse>("sparse", json::ObjectReader<gltf2::Accessor::Sparse>::Read, &gltf2::Accessor::SetSparse)));
126 const auto IMAGE_READER = std::move(json::Reader<gltf2::Image>()
127 .Register(*new json::Property<gltf2::Image, std::string_view>("name", json::Read::StringView, &gltf2::Material::mName))
128 .Register(*json::MakeProperty("uri", json::Read::StringView, &gltf2::Image::mUri))
129 .Register(*json::MakeProperty("mimeType", json::Read::StringView, &gltf2::Image::mMimeType))
130 .Register(*json::MakeProperty("bufferView", gltf2::RefReader<gltf2::Document>::Read<gltf2::BufferView, &gltf2::Document::mBufferViews>, &gltf2::Image::mBufferView)));
132 const auto SAMPLER_READER = std::move(json::Reader<gltf2::Sampler>()
133 .Register(*json::MakeProperty("minFilter", json::Read::Enum<gltf2::Filter::Type>, &gltf2::Sampler::mMinFilter))
134 .Register(*json::MakeProperty("magFilter", json::Read::Enum<gltf2::Filter::Type>, &gltf2::Sampler::mMagFilter))
135 .Register(*json::MakeProperty("wrapS", json::Read::Enum<gltf2::Wrap::Type>, &gltf2::Sampler::mWrapS))
136 .Register(*json::MakeProperty("wrapT", json::Read::Enum<gltf2::Wrap::Type>, &gltf2::Sampler::mWrapT)));
138 const auto TEXURE_READER = std::move(json::Reader<gltf2::Texture>()
139 .Register(*json::MakeProperty("source", gltf2::RefReader<gltf2::Document>::Read<gltf2::Image, &gltf2::Document::mImages>, &gltf2::Texture::mSource))
140 .Register(*json::MakeProperty("sampler", gltf2::RefReader<gltf2::Document>::Read<gltf2::Sampler, &gltf2::Document::mSamplers>, &gltf2::Texture::mSampler)));
142 const auto TEXURE_INFO_READER = std::move(json::Reader<gltf2::TextureInfo>()
143 .Register(*json::MakeProperty("index", gltf2::RefReader<gltf2::Document>::Read<gltf2::Texture, &gltf2::Document::mTextures>, &gltf2::TextureInfo::mTexture))
144 .Register(*json::MakeProperty("texCoord", json::Read::Number<uint32_t>, &gltf2::TextureInfo::mTexCoord))
145 .Register(*json::MakeProperty("scale", json::Read::Number<float>, &gltf2::TextureInfo::mScale))
146 .Register(*json::MakeProperty("strength", json::Read::Number<float>, &gltf2::TextureInfo::mStrength)));
148 const auto MATERIAL_PBR_READER = std::move(json::Reader<gltf2::Material::Pbr>()
149 .Register(*json::MakeProperty("baseColorFactor", gltf2::ReadDaliVector<Vector4>, &gltf2::Material::Pbr::mBaseColorFactor))
150 .Register(*json::MakeProperty("baseColorTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::Material::Pbr::mBaseColorTexture))
151 .Register(*json::MakeProperty("metallicFactor", json::Read::Number<float>, &gltf2::Material::Pbr::mMetallicFactor))
152 .Register(*json::MakeProperty("roughnessFactor", json::Read::Number<float>, &gltf2::Material::Pbr::mRoughnessFactor))
153 .Register(*json::MakeProperty("metallicRoughnessTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::Material::Pbr::mMetallicRoughnessTexture)));
155 const auto MATERIAL_SPECULAR_READER = std::move(json::Reader<gltf2::MaterialSpecular>()
156 .Register(*json::MakeProperty("specularFactor", json::Read::Number<float>, &gltf2::MaterialSpecular::mSpecularFactor))
157 .Register(*json::MakeProperty("specularTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::MaterialSpecular::mSpecularTexture))
158 .Register(*json::MakeProperty("specularColorFactor", gltf2::ReadDaliVector<Vector3>, &gltf2::MaterialSpecular::mSpecularColorFactor))
159 .Register(*json::MakeProperty("specularColorTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::MaterialSpecular::mSpecularColorTexture)));
161 const auto MATERIAL_IOR_READER = std::move(json::Reader<gltf2::MaterialIor>()
162 .Register(*json::MakeProperty("ior", json::Read::Number<float>, &gltf2::MaterialIor::mIor)));
164 const auto MATERIAL_EXTENSION_READER = std::move(json::Reader<gltf2::MaterialExtensions>()
165 .Register(*json::MakeProperty("KHR_materials_ior", json::ObjectReader<gltf2::MaterialIor>::Read, &gltf2::MaterialExtensions::mMaterialIor))
166 .Register(*json::MakeProperty("KHR_materials_specular", json::ObjectReader<gltf2::MaterialSpecular>::Read, &gltf2::MaterialExtensions::mMaterialSpecular)));
168 const auto MATERIAL_READER = std::move(json::Reader<gltf2::Material>()
169 .Register(*new json::Property<gltf2::Material, std::string_view>("name", json::Read::StringView, &gltf2::Material::mName))
170 .Register(*json::MakeProperty("pbrMetallicRoughness", json::ObjectReader<gltf2::Material::Pbr>::Read, &gltf2::Material::mPbrMetallicRoughness))
171 .Register(*json::MakeProperty("normalTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::Material::mNormalTexture))
172 .Register(*json::MakeProperty("occlusionTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::Material::mOcclusionTexture))
173 .Register(*json::MakeProperty("emissiveTexture", json::ObjectReader<gltf2::TextureInfo>::Read, &gltf2::Material::mEmissiveTexture))
174 .Register(*json::MakeProperty("emissiveFactor", gltf2::ReadDaliVector<Vector3>, &gltf2::Material::mEmissiveFactor))
175 .Register(*json::MakeProperty("alphaMode", gltf2::ReadStringEnum<gltf2::AlphaMode>, &gltf2::Material::mAlphaMode))
176 .Register(*json::MakeProperty("alphaCutoff", json::Read::Number<float>, &gltf2::Material::mAlphaCutoff))
177 .Register(*json::MakeProperty("doubleSided", json::Read::Boolean, &gltf2::Material::mDoubleSided))
178 .Register(*json::MakeProperty("extensions", json::ObjectReader<gltf2::MaterialExtensions>::Read, &gltf2::Material::mMaterialExtensions)));
180 std::map<gltf2::Attribute::Type, gltf2::Ref<gltf2::Accessor>> ReadMeshPrimitiveAttributes(const json_value_s& j)
182 auto& jsonObject = json::Cast<json_object_s>(j);
183 std::map<gltf2::Attribute::Type, gltf2::Ref<gltf2::Accessor>> result;
185 auto element = jsonObject.start;
188 auto jsonString = *element->name;
189 result[gltf2::Attribute::FromString(jsonString.string, jsonString.string_size)] = gltf2::RefReader<gltf2::Document>::Read<gltf2::Accessor, &gltf2::Document::mAccessors>(*element->value);
190 element = element->next;
195 std::vector<std::map<gltf2::Attribute::Type, gltf2::Ref<gltf2::Accessor>>> ReadMeshPrimitiveTargets(const json_value_s& j)
197 auto& jsonObject = json::Cast<json_array_s>(j);
198 std::vector<std::map<gltf2::Attribute::Type, gltf2::Ref<gltf2::Accessor>>> result;
200 result.reserve(jsonObject.length);
202 auto element = jsonObject.start;
205 result.push_back(std::move(ReadMeshPrimitiveAttributes(*element->value)));
206 element = element->next;
212 const auto MESH_PRIMITIVE_READER = std::move(json::Reader<gltf2::Mesh::Primitive>()
213 .Register(*json::MakeProperty("attributes", ReadMeshPrimitiveAttributes, &gltf2::Mesh::Primitive::mAttributes))
214 .Register(*json::MakeProperty("indices", gltf2::RefReader<gltf2::Document>::Read<gltf2::Accessor, &gltf2::Document::mAccessors>, &gltf2::Mesh::Primitive::mIndices))
215 .Register(*json::MakeProperty("material", gltf2::RefReader<gltf2::Document>::Read<gltf2::Material, &gltf2::Document::mMaterials>, &gltf2::Mesh::Primitive::mMaterial))
216 .Register(*json::MakeProperty("mode", json::Read::Enum<gltf2::Mesh::Primitive::Mode>, &gltf2::Mesh::Primitive::mMode))
217 .Register(*json::MakeProperty("targets", ReadMeshPrimitiveTargets, &gltf2::Mesh::Primitive::mTargets)));
219 const auto MESH_READER = std::move(json::Reader<gltf2::Mesh>()
220 .Register(*new json::Property<gltf2::Mesh, std::string_view>("name", json::Read::StringView, &gltf2::Mesh::mName))
221 .Register(*json::MakeProperty("primitives",
222 json::Read::Array<gltf2::Mesh::Primitive, json::ObjectReader<gltf2::Mesh::Primitive>::Read>,
223 &gltf2::Mesh::mPrimitives))
224 .Register(*json::MakeProperty("weights", json::Read::Array<float, json::Read::Number>, &gltf2::Mesh::mWeights)));
226 const auto SKIN_READER = std::move(json::Reader<gltf2::Skin>()
227 .Register(*new json::Property<gltf2::Skin, std::string_view>("name", json::Read::StringView, &gltf2::Skin::mName))
228 .Register(*json::MakeProperty("inverseBindMatrices",
229 gltf2::RefReader<gltf2::Document>::Read<gltf2::Accessor, &gltf2::Document::mAccessors>,
230 &gltf2::Skin::mInverseBindMatrices))
231 .Register(*json::MakeProperty("skeleton",
232 gltf2::RefReader<gltf2::Document>::Read<gltf2::Node, &gltf2::Document::mNodes>,
233 &gltf2::Skin::mSkeleton))
234 .Register(*json::MakeProperty("joints",
235 json::Read::Array<gltf2::Ref<gltf2::Node>, gltf2::RefReader<gltf2::Document>::Read<gltf2::Node, &gltf2::Document::mNodes>>,
236 &gltf2::Skin::mJoints)));
238 const auto CAMERA_PERSPECTIVE_READER = std::move(json::Reader<gltf2::Camera::Perspective>()
239 .Register(*json::MakeProperty("aspectRatio", json::Read::Number<float>, &gltf2::Camera::Perspective::mAspectRatio))
240 .Register(*json::MakeProperty("yfov", json::Read::Number<float>, &gltf2::Camera::Perspective::mYFov))
241 .Register(*json::MakeProperty("zfar", json::Read::Number<float>, &gltf2::Camera::Perspective::mZFar))
242 .Register(*json::MakeProperty("znear", json::Read::Number<float>, &gltf2::Camera::Perspective::mZNear))); // TODO: infinite perspective projection, where znear is omitted
244 const auto CAMERA_ORTHOGRAPHIC_READER = std::move(json::Reader<gltf2::Camera::Orthographic>()
245 .Register(*json::MakeProperty("xmag", json::Read::Number<float>, &gltf2::Camera::Orthographic::mXMag))
246 .Register(*json::MakeProperty("ymag", json::Read::Number<float>, &gltf2::Camera::Orthographic::mYMag))
247 .Register(*json::MakeProperty("zfar", json::Read::Number<float>, &gltf2::Camera::Orthographic::mZFar))
248 .Register(*json::MakeProperty("znear", json::Read::Number<float>, &gltf2::Camera::Orthographic::mZNear)));
250 const auto CAMERA_READER = std::move(json::Reader<gltf2::Camera>()
251 .Register(*new json::Property<gltf2::Camera, std::string_view>("name", json::Read::StringView, &gltf2::Camera::mName))
252 .Register(*json::MakeProperty("type", json::Read::StringView, &gltf2::Camera::mType))
253 .Register(*json::MakeProperty("perspective", json::ObjectReader<gltf2::Camera::Perspective>::Read, &gltf2::Camera::mPerspective))
254 .Register(*json::MakeProperty("orthographic", json::ObjectReader<gltf2::Camera::Orthographic>::Read, &gltf2::Camera::mOrthographic)));
256 const auto NODE_READER = std::move(json::Reader<gltf2::Node>()
257 .Register(*new json::Property<gltf2::Node, std::string_view>("name", json::Read::StringView, &gltf2::Node::mName))
258 .Register(*json::MakeProperty("translation", gltf2::ReadDaliVector<Vector3>, &gltf2::Node::mTranslation))
259 .Register(*json::MakeProperty("rotation", gltf2::ReadQuaternion, &gltf2::Node::mRotation))
260 .Register(*json::MakeProperty("scale", gltf2::ReadDaliVector<Vector3>, &gltf2::Node::mScale))
261 .Register(*new json::Property<gltf2::Node, Matrix>("matrix", gltf2::ReadDaliVector<Matrix>, &gltf2::Node::SetMatrix))
262 .Register(*json::MakeProperty("camera", gltf2::RefReader<gltf2::Document>::Read<gltf2::Camera, &gltf2::Document::mCameras>, &gltf2::Node::mCamera))
263 .Register(*json::MakeProperty("children", json::Read::Array<gltf2::Ref<gltf2::Node>, gltf2::RefReader<gltf2::Document>::Read<gltf2::Node, &gltf2::Document::mNodes>>, &gltf2::Node::mChildren))
264 .Register(*json::MakeProperty("mesh", gltf2::RefReader<gltf2::Document>::Read<gltf2::Mesh, &gltf2::Document::mMeshes>, &gltf2::Node::mMesh))
265 .Register(*json::MakeProperty("skin", gltf2::RefReader<gltf2::Document>::Read<gltf2::Skin, &gltf2::Document::mSkins>, &gltf2::Node::mSkin)));
267 const auto ANIMATION_SAMPLER_READER = std::move(json::Reader<gltf2::Animation::Sampler>()
268 .Register(*json::MakeProperty("input", gltf2::RefReader<gltf2::Document>::Read<gltf2::Accessor, &gltf2::Document::mAccessors>, &gltf2::Animation::Sampler::mInput))
269 .Register(*json::MakeProperty("output", gltf2::RefReader<gltf2::Document>::Read<gltf2::Accessor, &gltf2::Document::mAccessors>, &gltf2::Animation::Sampler::mOutput))
270 .Register(*json::MakeProperty("interpolation", gltf2::ReadStringEnum<gltf2::Animation::Sampler::Interpolation>, &gltf2::Animation::Sampler::mInterpolation)));
272 const auto ANIMATION_TARGET_READER = std::move(json::Reader<gltf2::Animation::Channel::Target>()
273 .Register(*json::MakeProperty("node", gltf2::RefReader<gltf2::Document>::Read<gltf2::Node, &gltf2::Document::mNodes>, &gltf2::Animation::Channel::Target::mNode))
274 .Register(*json::MakeProperty("path", gltf2::ReadStringEnum<gltf2::Animation::Channel::Target>, &gltf2::Animation::Channel::Target::mPath)));
276 const auto ANIMATION_CHANNEL_READER = std::move(json::Reader<gltf2::Animation::Channel>()
277 .Register(*json::MakeProperty("target", json::ObjectReader<gltf2::Animation::Channel::Target>::Read, &gltf2::Animation::Channel::mTarget))
278 .Register(*json::MakeProperty("sampler", gltf2::RefReader<gltf2::Animation>::Read<gltf2::Animation::Sampler, &gltf2::Animation::mSamplers>, &gltf2::Animation::Channel::mSampler)));
280 const auto ANIMATION_READER = std::move(json::Reader<gltf2::Animation>()
281 .Register(*new json::Property<gltf2::Animation, std::string_view>("name", json::Read::StringView, &gltf2::Animation::mName))
282 .Register(*json::MakeProperty("samplers",
283 json::Read::Array<gltf2::Animation::Sampler, json::ObjectReader<gltf2::Animation::Sampler>::Read>,
284 &gltf2::Animation::mSamplers))
285 .Register(*json::MakeProperty("channels",
286 json::Read::Array<gltf2::Animation::Channel, json::ObjectReader<gltf2::Animation::Channel>::Read>,
287 &gltf2::Animation::mChannels)));
289 const auto SCENE_READER = std::move(json::Reader<gltf2::Scene>()
290 .Register(*new json::Property<gltf2::Scene, std::string_view>("name", json::Read::StringView, &gltf2::Scene::mName))
291 .Register(*json::MakeProperty("nodes",
292 json::Read::Array<gltf2::Ref<gltf2::Node>, gltf2::RefReader<gltf2::Document>::Read<gltf2::Node, &gltf2::Document::mNodes>>,
293 &gltf2::Scene::mNodes)));
295 const auto DOCUMENT_READER = std::move(json::Reader<gltf2::Document>()
296 .Register(*json::MakeProperty("buffers",
297 json::Read::Array<gltf2::Buffer, json::ObjectReader<gltf2::Buffer>::Read>,
298 &gltf2::Document::mBuffers))
299 .Register(*json::MakeProperty("bufferViews",
300 json::Read::Array<gltf2::BufferView, json::ObjectReader<gltf2::BufferView>::Read>,
301 &gltf2::Document::mBufferViews))
302 .Register(*json::MakeProperty("accessors",
303 json::Read::Array<gltf2::Accessor, json::ObjectReader<gltf2::Accessor>::Read>,
304 &gltf2::Document::mAccessors))
305 .Register(*json::MakeProperty("images",
306 json::Read::Array<gltf2::Image, json::ObjectReader<gltf2::Image>::Read>,
307 &gltf2::Document::mImages))
308 .Register(*json::MakeProperty("samplers",
309 json::Read::Array<gltf2::Sampler, json::ObjectReader<gltf2::Sampler>::Read>,
310 &gltf2::Document::mSamplers))
311 .Register(*json::MakeProperty("textures",
312 json::Read::Array<gltf2::Texture, json::ObjectReader<gltf2::Texture>::Read>,
313 &gltf2::Document::mTextures))
314 .Register(*json::MakeProperty("materials",
315 json::Read::Array<gltf2::Material, json::ObjectReader<gltf2::Material>::Read>,
316 &gltf2::Document::mMaterials))
317 .Register(*json::MakeProperty("meshes",
318 json::Read::Array<gltf2::Mesh, json::ObjectReader<gltf2::Mesh>::Read>,
319 &gltf2::Document::mMeshes))
320 .Register(*json::MakeProperty("skins",
321 json::Read::Array<gltf2::Skin, json::ObjectReader<gltf2::Skin>::Read>,
322 &gltf2::Document::mSkins))
323 .Register(*json::MakeProperty("cameras",
324 json::Read::Array<gltf2::Camera, json::ObjectReader<gltf2::Camera>::Read>,
325 &gltf2::Document::mCameras))
326 .Register(*json::MakeProperty("nodes",
327 json::Read::Array<gltf2::Node, json::ObjectReader<gltf2::Node>::Read>,
328 &gltf2::Document::mNodes))
329 .Register(*json::MakeProperty("animations",
331 &gltf2::Document::mAnimations))
332 .Register(*json::MakeProperty("scenes",
333 json::Read::Array<gltf2::Scene, json::ObjectReader<gltf2::Scene>::Read>,
334 &gltf2::Document::mScenes))
335 .Register(*json::MakeProperty("scene", gltf2::RefReader<gltf2::Document>::Read<gltf2::Scene, &gltf2::Document::mScenes>, &gltf2::Document::mScene)));
337 void ConvertBuffer(const gltf2::Buffer& buffer, decltype(ResourceBundle::mBuffers)& outBuffers, const std::string& resourcePath)
339 BufferDefinition bufferDefinition;
341 bufferDefinition.mResourcePath = resourcePath;
342 bufferDefinition.mUri = buffer.mUri;
343 bufferDefinition.mByteLength = buffer.mByteLength;
345 outBuffers.emplace_back(std::move(bufferDefinition));
348 void ConvertBuffers(const gltf2::Document& document, ConversionContext& context)
350 auto& outBuffers = context.mOutput.mResources.mBuffers;
351 outBuffers.reserve(document.mBuffers.size());
353 for(auto& buffer : document.mBuffers)
355 if(buffer.mUri.empty())
359 ConvertBuffer(buffer, outBuffers, context.mPath);
363 SamplerFlags::Type ConvertWrapMode(gltf2::Wrap::Type wrapMode)
367 case gltf2::Wrap::REPEAT:
368 return SamplerFlags::WRAP_REPEAT;
369 case gltf2::Wrap::CLAMP_TO_EDGE:
370 return SamplerFlags::WRAP_CLAMP;
371 case gltf2::Wrap::MIRRORED_REPEAT:
372 return SamplerFlags::WRAP_MIRROR;
374 throw std::runtime_error("Invalid wrap type.");
378 SamplerFlags::Type ConvertSampler(const gltf2::Ref<gltf2::Sampler>& sampler)
382 return ((sampler->mMinFilter < gltf2::Filter::NEAREST_MIPMAP_NEAREST) ? (sampler->mMinFilter - gltf2::Filter::NEAREST) : ((sampler->mMinFilter - gltf2::Filter::NEAREST_MIPMAP_NEAREST) + 2)) |
383 ((sampler->mMagFilter - gltf2::Filter::NEAREST) << SamplerFlags::FILTER_MAG_SHIFT) |
384 (ConvertWrapMode(sampler->mWrapS) << SamplerFlags::WRAP_S_SHIFT) |
385 (ConvertWrapMode(sampler->mWrapT) << SamplerFlags::WRAP_T_SHIFT);
389 // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#texturesampler
390 // "The index of the sampler used by this texture. When undefined, a sampler with repeat wrapping and auto filtering should be used."
391 // "What is an auto filtering", I hear you ask. Since there's nothing else to determine mipmapping from - including glTF image
392 // properties, if not in some extension -, we will simply assume linear filtering.
393 return SamplerFlags::FILTER_LINEAR | (SamplerFlags::FILTER_LINEAR << SamplerFlags::FILTER_MAG_SHIFT) |
394 (SamplerFlags::WRAP_REPEAT << SamplerFlags::WRAP_S_SHIFT) | (SamplerFlags::WRAP_REPEAT << SamplerFlags::WRAP_T_SHIFT);
398 TextureDefinition ConvertTextureInfo(const gltf2::TextureInfo& textureInfo, ConversionContext& context, const ImageMetadata& metaData = ImageMetadata())
400 TextureDefinition textureDefinition;
401 std::string uri = std::string(textureInfo.mTexture->mSource->mUri);
404 uint32_t bufferIndex = textureInfo.mTexture->mSource->mBufferView->mBuffer.GetIndex();
405 if(bufferIndex != INVALID_INDEX && context.mOutput.mResources.mBuffers[bufferIndex].IsAvailable())
407 auto& stream = context.mOutput.mResources.mBuffers[bufferIndex].GetBufferStream();
409 stream.seekg(textureInfo.mTexture->mSource->mBufferView->mByteOffset, stream.beg);
410 std::vector<uint8_t> dataBuffer;
411 dataBuffer.resize(textureInfo.mTexture->mSource->mBufferView->mByteLength);
412 stream.read(reinterpret_cast<char*>(dataBuffer.data()), static_cast<std::streamsize>(static_cast<size_t>(textureInfo.mTexture->mSource->mBufferView->mByteLength)));
413 return TextureDefinition{std::move(dataBuffer), ConvertSampler(textureInfo.mTexture->mSampler), metaData.mMinSize, metaData.mSamplingMode};
415 return TextureDefinition();
419 return TextureDefinition{uri, ConvertSampler(textureInfo.mTexture->mSampler), metaData.mMinSize, metaData.mSamplingMode};
423 void AddTextureStage(uint32_t semantic, MaterialDefinition& materialDefinition, gltf2::TextureInfo textureInfo, const Dali::Scene3D::Loader::ImageMetadata& metaData, ConversionContext& context)
425 materialDefinition.mTextureStages.push_back({semantic, ConvertTextureInfo(textureInfo, context, metaData)});
426 materialDefinition.mFlags |= semantic;
429 void ConvertMaterial(const gltf2::Material& material, const std::unordered_map<std::string, ImageMetadata>& imageMetaData, decltype(ResourceBundle::mMaterials)& outMaterials, ConversionContext& context)
431 auto getTextureMetaData = [](const std::unordered_map<std::string, ImageMetadata>& metaData, const gltf2::TextureInfo& info) {
432 if(!info.mTexture->mSource->mUri.empty())
434 if(auto search = metaData.find(info.mTexture->mSource->mUri.data()); search != metaData.end())
436 return search->second;
439 return ImageMetadata();
442 MaterialDefinition materialDefinition;
444 auto& pbr = material.mPbrMetallicRoughness;
445 if(material.mAlphaMode == gltf2::AlphaMode::BLEND)
447 materialDefinition.mIsOpaque = false;
448 materialDefinition.mFlags |= MaterialDefinition::TRANSPARENCY;
450 else if(material.mAlphaMode == gltf2::AlphaMode::MASK)
452 materialDefinition.mIsMask = true;
453 materialDefinition.SetAlphaCutoff(std::min(1.f, std::max(0.f, material.mAlphaCutoff)));
456 materialDefinition.mBaseColorFactor = pbr.mBaseColorFactor;
458 materialDefinition.mTextureStages.reserve(!!pbr.mBaseColorTexture + !!pbr.mMetallicRoughnessTexture + !!material.mNormalTexture + !!material.mOcclusionTexture + !!material.mEmissiveTexture);
459 if(pbr.mBaseColorTexture)
461 AddTextureStage(MaterialDefinition::ALBEDO, materialDefinition, pbr.mBaseColorTexture, getTextureMetaData(imageMetaData, pbr.mBaseColorTexture), context);
465 materialDefinition.mNeedAlbedoTexture = false;
468 materialDefinition.mMetallic = pbr.mMetallicFactor;
469 materialDefinition.mRoughness = pbr.mRoughnessFactor;
471 if(pbr.mMetallicRoughnessTexture)
473 AddTextureStage(MaterialDefinition::METALLIC | MaterialDefinition::ROUGHNESS | MaterialDefinition::GLTF_CHANNELS,
475 pbr.mMetallicRoughnessTexture,
476 getTextureMetaData(imageMetaData, pbr.mMetallicRoughnessTexture),
481 materialDefinition.mNeedMetallicRoughnessTexture = false;
484 materialDefinition.mNormalScale = material.mNormalTexture.mScale;
485 if(material.mNormalTexture)
487 AddTextureStage(MaterialDefinition::NORMAL, materialDefinition, material.mNormalTexture, getTextureMetaData(imageMetaData, material.mNormalTexture), context);
491 materialDefinition.mNeedNormalTexture = false;
494 if(material.mOcclusionTexture)
496 AddTextureStage(MaterialDefinition::OCCLUSION, materialDefinition, material.mOcclusionTexture, getTextureMetaData(imageMetaData, material.mOcclusionTexture), context);
497 materialDefinition.mOcclusionStrength = material.mOcclusionTexture.mStrength;
500 materialDefinition.mEmissiveFactor = material.mEmissiveFactor;
501 if(material.mEmissiveTexture)
503 AddTextureStage(MaterialDefinition::EMISSIVE, materialDefinition, material.mEmissiveTexture, getTextureMetaData(imageMetaData, material.mEmissiveTexture), context);
506 if(!Dali::Equals(material.mMaterialExtensions.mMaterialIor.mIor, gltf2::UNDEFINED_FLOAT_VALUE))
508 float ior = material.mMaterialExtensions.mMaterialIor.mIor;
509 materialDefinition.mDielectricSpecular = powf((ior - 1.0f) / (ior + 1.0f), 2.0f);
511 materialDefinition.mSpecularFactor = material.mMaterialExtensions.mMaterialSpecular.mSpecularFactor;
512 materialDefinition.mSpecularColorFactor = material.mMaterialExtensions.mMaterialSpecular.mSpecularColorFactor;
514 if(material.mMaterialExtensions.mMaterialSpecular.mSpecularTexture)
516 AddTextureStage(MaterialDefinition::SPECULAR, materialDefinition, material.mMaterialExtensions.mMaterialSpecular.mSpecularTexture, getTextureMetaData(imageMetaData, material.mMaterialExtensions.mMaterialSpecular.mSpecularTexture), context);
519 if(material.mMaterialExtensions.mMaterialSpecular.mSpecularColorTexture)
521 AddTextureStage(MaterialDefinition::SPECULAR_COLOR, materialDefinition, material.mMaterialExtensions.mMaterialSpecular.mSpecularColorTexture, getTextureMetaData(imageMetaData, material.mMaterialExtensions.mMaterialSpecular.mSpecularColorTexture), context);
524 materialDefinition.mDoubleSided = material.mDoubleSided;
526 outMaterials.emplace_back(std::move(materialDefinition), TextureSet());
529 void ConvertMaterials(const gltf2::Document& document, ConversionContext& context)
531 auto& imageMetaData = context.mOutput.mSceneMetadata.mImageMetadata;
533 auto& outMaterials = context.mOutput.mResources.mMaterials;
534 outMaterials.reserve(document.mMaterials.size());
536 for(auto& material : document.mMaterials)
538 ConvertMaterial(material, imageMetaData, outMaterials, context);
542 MeshDefinition::Accessor ConvertMeshPrimitiveAccessor(const gltf2::Accessor& accessor)
544 DALI_ASSERT_ALWAYS((accessor.mBufferView &&
545 (accessor.mBufferView->mByteStride < std::numeric_limits<uint16_t>::max())) ||
546 (accessor.mSparse && !accessor.mBufferView));
548 DALI_ASSERT_ALWAYS(!accessor.mSparse ||
549 ((accessor.mSparse->mIndices.mBufferView && (accessor.mSparse->mIndices.mBufferView->mByteStride < std::numeric_limits<uint16_t>::max())) &&
550 (accessor.mSparse->mValues.mBufferView && (accessor.mSparse->mValues.mBufferView->mByteStride < std::numeric_limits<uint16_t>::max()))));
552 MeshDefinition::SparseBlob sparseBlob;
555 const gltf2::Accessor::Sparse& sparse = *accessor.mSparse;
556 const gltf2::ComponentTypedBufferViewClient& indices = sparse.mIndices;
557 const gltf2::BufferViewClient& values = sparse.mValues;
559 MeshDefinition::Blob indicesBlob(
560 indices.mBufferView->mByteOffset + indices.mByteOffset,
561 sparse.mCount * indices.GetBytesPerComponent(),
562 static_cast<uint16_t>(indices.mBufferView->mByteStride),
563 static_cast<uint16_t>(indices.GetBytesPerComponent()),
566 MeshDefinition::Blob valuesBlob(
567 values.mBufferView->mByteOffset + values.mByteOffset,
568 sparse.mCount * accessor.GetElementSizeBytes(),
569 static_cast<uint16_t>(values.mBufferView->mByteStride),
570 static_cast<uint16_t>(accessor.GetElementSizeBytes()),
574 sparseBlob = std::move(MeshDefinition::SparseBlob(std::move(indicesBlob), std::move(valuesBlob), accessor.mSparse->mCount));
577 uint32_t bufferViewOffset = 0u;
578 uint32_t bufferViewStride = 0u;
579 if(accessor.mBufferView)
581 bufferViewOffset = accessor.mBufferView->mByteOffset;
582 bufferViewStride = accessor.mBufferView->mByteStride;
585 return MeshDefinition::Accessor{
586 std::move(MeshDefinition::Blob{bufferViewOffset + accessor.mByteOffset,
587 accessor.GetBytesLength(),
588 static_cast<uint16_t>(bufferViewStride),
589 static_cast<uint16_t>(accessor.GetElementSizeBytes()),
592 std::move(sparseBlob),
593 accessor.mBufferView ? accessor.mBufferView->mBuffer.GetIndex() : 0};
596 void ConvertMeshes(const gltf2::Document& document, ConversionContext& context)
598 uint32_t meshCount = 0;
599 context.mMeshIds.reserve(document.mMeshes.size());
600 for(auto& mesh : document.mMeshes)
602 context.mMeshIds.push_back(meshCount);
603 meshCount += mesh.mPrimitives.size();
606 auto& outMeshes = context.mOutput.mResources.mMeshes;
607 outMeshes.reserve(meshCount);
608 for(auto& mesh : document.mMeshes)
610 for(auto& primitive : mesh.mPrimitives)
612 MeshDefinition meshDefinition;
614 auto& attribs = primitive.mAttributes;
615 meshDefinition.mPrimitiveType = GLTF2_TO_DALI_PRIMITIVES[primitive.mMode];
617 auto& accPositions = *attribs.find(gltf2::Attribute::POSITION)->second;
618 meshDefinition.mPositions = ConvertMeshPrimitiveAccessor(accPositions);
619 // glTF2 support vector4 tangent for mesh.
620 // https://www.khronos.org/registry/glTF/specs/2.0/glTF-2.0.html#meshes-overview
621 meshDefinition.mTangentType = Property::VECTOR4;
623 const bool needNormalsTangents = accPositions.mType == gltf2::AccessorType::VEC3;
624 for(auto& attributeMapping : ATTRIBUTE_MAPPINGS)
626 auto iFind = attribs.find(attributeMapping.mType);
627 if(iFind != attribs.end())
629 auto& accessor = meshDefinition.*(attributeMapping.mAccessor);
630 accessor = ConvertMeshPrimitiveAccessor(*iFind->second);
632 if(iFind->first == gltf2::Attribute::JOINTS_0)
634 meshDefinition.mFlags |= (iFind->second->mComponentType == gltf2::Component::UNSIGNED_SHORT) * MeshDefinition::U16_JOINT_IDS;
635 meshDefinition.mFlags |= (iFind->second->mComponentType == gltf2::Component::UNSIGNED_BYTE) * MeshDefinition::U8_JOINT_IDS;
636 DALI_ASSERT_DEBUG(MaskMatch(meshDefinition.mFlags, MeshDefinition::U16_JOINT_IDS) || MaskMatch(meshDefinition.mFlags, MeshDefinition::U8_JOINT_IDS) || iFind->second->mComponentType == gltf2::Component::FLOAT);
639 else if(needNormalsTangents)
641 switch(attributeMapping.mType)
643 case gltf2::Attribute::NORMAL:
644 meshDefinition.RequestNormals();
647 case gltf2::Attribute::TANGENT:
648 meshDefinition.RequestTangents();
657 if(primitive.mIndices)
659 meshDefinition.mIndices = ConvertMeshPrimitiveAccessor(*primitive.mIndices);
660 meshDefinition.mFlags |= (primitive.mIndices->mComponentType == gltf2::Component::UNSIGNED_INT) * MeshDefinition::U32_INDICES;
661 meshDefinition.mFlags |= (primitive.mIndices->mComponentType == gltf2::Component::UNSIGNED_BYTE) * MeshDefinition::U8_INDICES;
662 DALI_ASSERT_DEBUG(MaskMatch(meshDefinition.mFlags, MeshDefinition::U32_INDICES) || MaskMatch(meshDefinition.mFlags, MeshDefinition::U8_INDICES) || primitive.mIndices->mComponentType == gltf2::Component::UNSIGNED_SHORT);
665 if(!primitive.mTargets.empty())
667 meshDefinition.mBlendShapes.reserve(primitive.mTargets.size());
668 meshDefinition.mBlendShapeVersion = BlendShapes::Version::VERSION_2_0;
669 for(const auto& target : primitive.mTargets)
671 MeshDefinition::BlendShape blendShape;
673 auto endIt = target.end();
674 auto it = target.find(gltf2::Attribute::POSITION);
677 blendShape.deltas = ConvertMeshPrimitiveAccessor(*it->second);
679 it = target.find(gltf2::Attribute::NORMAL);
682 blendShape.normals = ConvertMeshPrimitiveAccessor(*it->second);
684 it = target.find(gltf2::Attribute::TANGENT);
687 blendShape.tangents = ConvertMeshPrimitiveAccessor(*it->second);
690 if(!mesh.mWeights.empty())
692 blendShape.weight = mesh.mWeights[meshDefinition.mBlendShapes.size()];
695 meshDefinition.mBlendShapes.push_back(std::move(blendShape));
699 outMeshes.push_back({std::move(meshDefinition), MeshGeometry{}});
704 ModelRenderable* MakeModelRenderable(const gltf2::Mesh::Primitive& primitive, ConversionContext& context)
706 auto modelRenderable = new ModelRenderable();
708 modelRenderable->mShaderIdx = 0; // TODO: further thought
710 auto materialIdx = primitive.mMaterial.GetIndex();
711 if(INVALID_INDEX == materialIdx)
713 // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#default-material
714 if(INVALID_INDEX == context.mDefaultMaterial)
716 auto& outMaterials = context.mOutput.mResources.mMaterials;
717 context.mDefaultMaterial = outMaterials.size();
719 ConvertMaterial(gltf2::Material{}, context.mOutput.mSceneMetadata.mImageMetadata, outMaterials, context);
722 materialIdx = context.mDefaultMaterial;
725 modelRenderable->mMaterialIdx = materialIdx;
727 return modelRenderable;
730 void ConvertCamera(const gltf2::Camera& camera, CameraParameters& cameraParameters)
732 cameraParameters.isPerspective = camera.mType.compare("perspective") == 0;
733 if(cameraParameters.isPerspective)
735 auto& perspective = camera.mPerspective;
736 if(!Dali::Equals(perspective.mYFov, gltf2::UNDEFINED_FLOAT_VALUE))
738 cameraParameters.yFovDegree = Degree(Radian(perspective.mYFov));
742 cameraParameters.yFovDegree = Degree(gltf2::UNDEFINED_FLOAT_VALUE);
744 cameraParameters.zNear = perspective.mZNear;
745 cameraParameters.zFar = perspective.mZFar;
746 // TODO: yes, we seem to ignore aspectRatio in CameraParameters.
750 auto& ortho = camera.mOrthographic;
751 if(!Dali::Equals(ortho.mYMag, gltf2::UNDEFINED_FLOAT_VALUE) && !Dali::Equals(ortho.mXMag, gltf2::UNDEFINED_FLOAT_VALUE))
753 cameraParameters.orthographicSize = ortho.mYMag * .5f;
754 cameraParameters.aspectRatio = ortho.mXMag / ortho.mYMag;
758 cameraParameters.orthographicSize = gltf2::UNDEFINED_FLOAT_VALUE;
759 cameraParameters.aspectRatio = gltf2::UNDEFINED_FLOAT_VALUE;
761 cameraParameters.zNear = ortho.mZNear;
762 cameraParameters.zFar = ortho.mZFar;
766 void ConvertNode(gltf2::Node const& node, const Index gltfIndex, Index parentIndex, ConversionContext& context, bool isMRendererModel)
768 auto& output = context.mOutput;
769 auto& scene = output.mScene;
770 auto& resources = output.mResources;
772 const auto index = scene.GetNodeCount();
773 auto weakNode = scene.AddNode([&]() {
774 std::unique_ptr<NodeDefinition> nodeDefinition{new NodeDefinition()};
776 nodeDefinition->mParentIdx = parentIndex;
777 nodeDefinition->mName = node.mName;
778 if(nodeDefinition->mName.empty())
780 // TODO: Production quality generation of unique names.
781 nodeDefinition->mName = std::to_string(reinterpret_cast<uintptr_t>(nodeDefinition.get()));
784 if(!node.mSkin) // Nodes with skinned meshes are not supposed to have local transforms.
786 nodeDefinition->mPosition = node.mTranslation;
787 nodeDefinition->mOrientation = node.mRotation;
788 nodeDefinition->mScale = node.mScale;
790 if(isMRendererModel && node.mName == ROOT_NODE_NAME && node.mScale == SCALE_TO_ADJUST)
792 nodeDefinition->mScale *= 0.01f;
796 return nodeDefinition; }());
799 ExceptionFlinger(ASSERT_LOCATION) << "Node name '" << node.mName << "' is not unique; scene is invalid.";
802 context.mNodeIndices.RegisterMapping(gltfIndex, index);
804 Index skeletonIdx = node.mSkin ? node.mSkin.GetIndex() : INVALID_INDEX;
807 auto& mesh = *node.mMesh;
808 uint32_t primitiveCount = mesh.mPrimitives.size();
809 auto meshIndex = context.mMeshIds[node.mMesh.GetIndex()];
810 weakNode->mRenderables.reserve(primitiveCount);
811 for(uint32_t i = 0; i < primitiveCount; ++i)
813 std::unique_ptr<NodeDefinition::Renderable> renderable;
814 auto modelRenderable = MakeModelRenderable(mesh.mPrimitives[i], context);
815 modelRenderable->mMeshIdx = meshIndex + i;
817 DALI_ASSERT_DEBUG(resources.mMeshes[modelRenderable->mMeshIdx].first.mSkeletonIdx == INVALID_INDEX ||
818 resources.mMeshes[modelRenderable->mMeshIdx].first.mSkeletonIdx == skeletonIdx);
819 resources.mMeshes[modelRenderable->mMeshIdx].first.mSkeletonIdx = skeletonIdx;
821 renderable.reset(modelRenderable);
822 weakNode->mRenderables.push_back(std::move(renderable));
828 CameraParameters cameraParameters;
829 ConvertCamera(*node.mCamera, cameraParameters);
831 cameraParameters.matrix.SetTransformComponents(node.mScale, node.mRotation, node.mTranslation);
832 output.mCameraParameters.push_back(cameraParameters);
835 for(auto& child : node.mChildren)
837 ConvertNode(*child, child.GetIndex(), index, context, isMRendererModel);
841 void ConvertSceneNodes(const gltf2::Scene& scene, ConversionContext& context, bool isMRendererModel)
843 auto& outScene = context.mOutput.mScene;
844 Index rootIndex = outScene.GetNodeCount();
845 switch(scene.mNodes.size())
851 ConvertNode(*scene.mNodes[0], scene.mNodes[0].GetIndex(), INVALID_INDEX, context, isMRendererModel);
852 outScene.AddRootNode(rootIndex);
857 std::unique_ptr<NodeDefinition> sceneRoot{new NodeDefinition()};
858 sceneRoot->mName = "GLTF_LOADER_SCENE_ROOT_" + std::to_string(outScene.GetRoots().size());
860 outScene.AddNode(std::move(sceneRoot));
861 outScene.AddRootNode(rootIndex);
863 for(auto& node : scene.mNodes)
865 ConvertNode(*node, node.GetIndex(), rootIndex, context, isMRendererModel);
872 void ConvertNodes(const gltf2::Document& document, ConversionContext& context, bool isMRendererModel)
874 if(!document.mScenes.empty())
876 uint32_t rootSceneIndex = 0u;
879 rootSceneIndex = document.mScene.GetIndex();
881 ConvertSceneNodes(document.mScenes[rootSceneIndex], context, isMRendererModel);
883 for(uint32_t i = 0; i < rootSceneIndex; ++i)
885 ConvertSceneNodes(document.mScenes[i], context, isMRendererModel);
888 for(uint32_t i = rootSceneIndex + 1; i < document.mScenes.size(); ++i)
890 ConvertSceneNodes(document.mScenes[i], context, isMRendererModel);
896 void LoadDataFromAccessor(ConversionContext& context, uint32_t bufferIndex, Vector<T>& dataBuffer, uint32_t offset, uint32_t size)
898 if(bufferIndex >= context.mOutput.mResources.mBuffers.size())
900 DALI_LOG_ERROR("Invailid buffer index\n");
904 auto& buffer = context.mOutput.mResources.mBuffers[bufferIndex];
905 if(!buffer.IsAvailable())
907 DALI_LOG_ERROR("Failed to load from buffer stream.\n");
909 auto& stream = buffer.GetBufferStream();
911 stream.seekg(offset, stream.beg);
912 stream.read(reinterpret_cast<char*>(dataBuffer.Begin()), static_cast<std::streamsize>(static_cast<size_t>(size)));
916 float LoadDataFromAccessors(ConversionContext& context, const gltf2::Accessor& input, const gltf2::Accessor& output, Vector<float>& inputDataBuffer, Vector<T>& outputDataBuffer)
918 inputDataBuffer.Resize(input.mCount);
919 outputDataBuffer.Resize(output.mCount);
921 const uint32_t inputDataBufferSize = input.GetBytesLength();
922 const uint32_t outputDataBufferSize = output.GetBytesLength();
924 LoadDataFromAccessor<float>(context, output.mBufferView->mBuffer.GetIndex(), inputDataBuffer, input.mBufferView->mByteOffset + input.mByteOffset, inputDataBufferSize);
925 LoadDataFromAccessor<T>(context, output.mBufferView->mBuffer.GetIndex(), outputDataBuffer, output.mBufferView->mByteOffset + output.mByteOffset, outputDataBufferSize);
926 ApplyAccessorMinMax(input, reinterpret_cast<float*>(inputDataBuffer.begin()));
927 ApplyAccessorMinMax(output, reinterpret_cast<float*>(outputDataBuffer.begin()));
929 return inputDataBuffer[input.mCount - 1u];
933 float LoadKeyFrames(ConversionContext& context, const gltf2::Animation::Channel& channel, KeyFrames& keyFrames, gltf2::Animation::Channel::Target::Type type)
935 const gltf2::Accessor& input = *channel.mSampler->mInput;
936 const gltf2::Accessor& output = *channel.mSampler->mOutput;
938 Vector<float> inputDataBuffer;
939 Vector<T> outputDataBuffer;
941 const float duration = std::max(LoadDataFromAccessors<T>(context, input, output, inputDataBuffer, outputDataBuffer), AnimationDefinition::MIN_DURATION_SECONDS);
943 // Set first frame value as first keyframe (gltf animation spec)
944 if(input.mCount > 0 && !Dali::EqualsZero(inputDataBuffer[0]))
946 keyFrames.Add(0.0f, outputDataBuffer[0]);
949 for(uint32_t i = 0; i < input.mCount; ++i)
951 keyFrames.Add(inputDataBuffer[i] / duration, outputDataBuffer[i]);
957 float LoadBlendShapeKeyFrames(ConversionContext& context, const gltf2::Animation::Channel& channel, Index nodeIndex, uint32_t& propertyIndex, std::vector<Dali::Scene3D::Loader::AnimatedProperty>& properties)
959 const gltf2::Accessor& input = *channel.mSampler->mInput;
960 const gltf2::Accessor& output = *channel.mSampler->mOutput;
962 Vector<float> inputDataBuffer;
963 Vector<float> outputDataBuffer;
965 const float duration = std::max(LoadDataFromAccessors<float>(context, input, output, inputDataBuffer, outputDataBuffer), AnimationDefinition::MIN_DURATION_SECONDS);
967 char weightNameBuffer[32];
968 auto prefixSize = snprintf(weightNameBuffer, sizeof(weightNameBuffer), "%s[", BLEND_SHAPE_WEIGHTS_UNIFORM.data());
969 char* const pWeightName = weightNameBuffer + prefixSize;
970 const auto remainingSize = sizeof(weightNameBuffer) - prefixSize;
971 for(uint32_t weightIndex = 0u, endWeightIndex = channel.mSampler->mOutput->mCount / channel.mSampler->mInput->mCount; weightIndex < endWeightIndex; ++weightIndex)
973 AnimatedProperty& animatedProperty = properties[propertyIndex++];
975 animatedProperty.mNodeIndex = nodeIndex;
976 snprintf(pWeightName, remainingSize, "%d]", weightIndex);
977 animatedProperty.mPropertyName = std::string(weightNameBuffer);
979 animatedProperty.mKeyFrames = KeyFrames::New();
981 // Set first frame value as first keyframe (gltf animation spec)
982 if(input.mCount > 0 && !Dali::EqualsZero(inputDataBuffer[0]))
984 animatedProperty.mKeyFrames.Add(0.0f, outputDataBuffer[weightIndex]);
987 for(uint32_t i = 0; i < input.mCount; ++i)
989 animatedProperty.mKeyFrames.Add(inputDataBuffer[i] / duration, outputDataBuffer[i * endWeightIndex + weightIndex]);
992 animatedProperty.mTimePeriod = {0.f, duration};
999 float LoadAnimation(AnimationDefinition& animationDefinition, Index nodeIndex, Index propertyIndex, const std::string& propertyName, const gltf2::Animation::Channel& channel, ConversionContext& context)
1001 AnimatedProperty& animatedProperty = animationDefinition.mProperties[propertyIndex];
1003 animatedProperty.mNodeIndex = nodeIndex;
1004 animatedProperty.mPropertyName = propertyName;
1006 animatedProperty.mKeyFrames = KeyFrames::New();
1007 float duration = LoadKeyFrames<T>(context, channel, animatedProperty.mKeyFrames, channel.mTarget.mPath);
1008 animatedProperty.mTimePeriod = {0.f, duration};
1013 void ConvertAnimations(const gltf2::Document& document, ConversionContext& context)
1015 auto& output = context.mOutput;
1017 output.mAnimationDefinitions.reserve(output.mAnimationDefinitions.size() + document.mAnimations.size());
1019 for(const auto& animation : document.mAnimations)
1021 AnimationDefinition animationDefinition;
1023 if(!animation.mName.empty())
1025 animationDefinition.mName = animation.mName;
1028 uint32_t numberOfProperties = 0u;
1029 for(const auto& channel : animation.mChannels)
1031 if(channel.mTarget.mPath == gltf2::Animation::Channel::Target::WEIGHTS)
1033 numberOfProperties += channel.mSampler->mOutput->mCount / channel.mSampler->mInput->mCount;
1037 numberOfProperties++;
1040 animationDefinition.mProperties.resize(numberOfProperties);
1042 Index propertyIndex = 0u;
1043 for(const auto& channel : animation.mChannels)
1045 Index nodeIndex = context.mNodeIndices.GetRuntimeId(channel.mTarget.mNode.GetIndex());
1046 float duration = 0.f;
1048 switch(channel.mTarget.mPath)
1050 case gltf2::Animation::Channel::Target::TRANSLATION:
1052 duration = LoadAnimation<Vector3>(animationDefinition, nodeIndex, propertyIndex, POSITION_PROPERTY.data(), channel, context);
1055 case gltf2::Animation::Channel::Target::ROTATION:
1057 duration = LoadAnimation<Quaternion>(animationDefinition, nodeIndex, propertyIndex, ORIENTATION_PROPERTY.data(), channel, context);
1060 case gltf2::Animation::Channel::Target::SCALE:
1062 duration = LoadAnimation<Vector3>(animationDefinition, nodeIndex, propertyIndex, SCALE_PROPERTY.data(), channel, context);
1065 case gltf2::Animation::Channel::Target::WEIGHTS:
1067 duration = LoadBlendShapeKeyFrames(context, channel, nodeIndex, propertyIndex, animationDefinition.mProperties);
1073 // nothing to animate.
1078 animationDefinition.mDuration = std::max(duration, animationDefinition.mDuration);
1083 output.mAnimationDefinitions.push_back(std::move(animationDefinition));
1087 void ProcessSkins(const gltf2::Document& document, ConversionContext& context)
1089 // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#skininversebindmatrices
1090 // If an inverseBindMatrices accessor was provided, we'll load the joint data from the buffer,
1091 // otherwise we'll set identity matrices for inverse bind pose.
1092 struct IInverseBindMatrixProvider
1094 virtual ~IInverseBindMatrixProvider()
1097 virtual void Provide(Matrix& inverseBindMatrix) = 0;
1100 struct InverseBindMatrixAccessor : public IInverseBindMatrixProvider
1102 std::istream& mStream;
1103 const uint32_t mElementSizeBytes;
1105 InverseBindMatrixAccessor(const gltf2::Accessor& accessor, ConversionContext& context)
1106 : mStream(context.mOutput.mResources.mBuffers[accessor.mBufferView->mBuffer.GetIndex()].GetBufferStream()),
1107 mElementSizeBytes(accessor.GetElementSizeBytes())
1109 DALI_ASSERT_DEBUG(accessor.mType == gltf2::AccessorType::MAT4 && accessor.mComponentType == gltf2::Component::FLOAT);
1111 if(!mStream.rdbuf()->in_avail())
1113 DALI_LOG_ERROR("Failed to load from stream\n");
1116 mStream.seekg(accessor.mBufferView->mByteOffset + accessor.mByteOffset, mStream.beg);
1119 virtual void Provide(Matrix& inverseBindMatrix) override
1121 DALI_ASSERT_ALWAYS(mStream.read(reinterpret_cast<char*>(inverseBindMatrix.AsFloat()), static_cast<std::streamsize>(static_cast<size_t>(mElementSizeBytes))));
1125 struct DefaultInverseBindMatrixProvider : public IInverseBindMatrixProvider
1127 virtual void Provide(Matrix& inverseBindMatrix) override
1129 inverseBindMatrix = Matrix::IDENTITY;
1133 auto& resources = context.mOutput.mResources;
1134 resources.mSkeletons.reserve(document.mSkins.size());
1136 for(auto& skin : document.mSkins)
1138 std::unique_ptr<IInverseBindMatrixProvider> inverseBindMatrixProvider;
1139 if(skin.mInverseBindMatrices)
1141 inverseBindMatrixProvider.reset(new InverseBindMatrixAccessor(*skin.mInverseBindMatrices, context));
1145 inverseBindMatrixProvider.reset(new DefaultInverseBindMatrixProvider());
1148 SkeletonDefinition skeleton;
1149 if(skin.mSkeleton.GetIndex() != INVALID_INDEX)
1151 skeleton.mRootNodeIdx = context.mNodeIndices.GetRuntimeId(skin.mSkeleton.GetIndex());
1154 skeleton.mJoints.resize(skin.mJoints.size());
1155 auto iJoint = skeleton.mJoints.begin();
1156 for(auto& joint : skin.mJoints)
1158 iJoint->mNodeIdx = context.mNodeIndices.GetRuntimeId(joint.GetIndex());
1160 inverseBindMatrixProvider->Provide(iJoint->mInverseBindMatrix);
1165 resources.mSkeletons.push_back(std::move(skeleton));
1169 void ProduceShaders(ShaderDefinitionFactory& shaderFactory, Dali::Scene3D::Loader::SceneDefinition& scene)
1171 uint32_t nodeCount = scene.GetNodeCount();
1172 for(uint32_t i = 0; i < nodeCount; ++i)
1174 auto nodeDefinition = scene.GetNode(i);
1175 for(auto& renderable : nodeDefinition->mRenderables)
1177 if(shaderFactory.ProduceShader(*renderable) == INVALID_INDEX)
1179 DALI_LOG_ERROR("Fail to produce shader\n");
1185 void SetObjectReaders()
1187 json::SetObjectReader(BUFFER_READER);
1188 json::SetObjectReader(BUFFER_VIEW_READER);
1189 json::SetObjectReader(BUFFER_VIEW_CLIENT_READER);
1190 json::SetObjectReader(COMPONENT_TYPED_BUFFER_VIEW_CLIENT_READER);
1191 json::SetObjectReader(ACCESSOR_SPARSE_READER);
1192 json::SetObjectReader(ACCESSOR_READER);
1193 json::SetObjectReader(IMAGE_READER);
1194 json::SetObjectReader(SAMPLER_READER);
1195 json::SetObjectReader(TEXURE_READER);
1196 json::SetObjectReader(TEXURE_INFO_READER);
1197 json::SetObjectReader(MATERIAL_PBR_READER);
1198 json::SetObjectReader(MATERIAL_SPECULAR_READER);
1199 json::SetObjectReader(MATERIAL_IOR_READER);
1200 json::SetObjectReader(MATERIAL_EXTENSION_READER);
1201 json::SetObjectReader(MATERIAL_READER);
1202 json::SetObjectReader(MESH_PRIMITIVE_READER);
1203 json::SetObjectReader(MESH_READER);
1204 json::SetObjectReader(SKIN_READER);
1205 json::SetObjectReader(CAMERA_PERSPECTIVE_READER);
1206 json::SetObjectReader(CAMERA_ORTHOGRAPHIC_READER);
1207 json::SetObjectReader(CAMERA_READER);
1208 json::SetObjectReader(NODE_READER);
1209 json::SetObjectReader(ANIMATION_SAMPLER_READER);
1210 json::SetObjectReader(ANIMATION_TARGET_READER);
1211 json::SetObjectReader(ANIMATION_CHANNEL_READER);
1212 json::SetObjectReader(ANIMATION_READER);
1213 json::SetObjectReader(SCENE_READER);
1216 void SetDefaultEnvironmentMap(const gltf2::Document& document, ConversionContext& context)
1218 EnvironmentDefinition environmentDefinition;
1219 environmentDefinition.mUseBrdfTexture = true;
1220 environmentDefinition.mIblIntensity = Scene3D::Loader::EnvironmentDefinition::GetDefaultIntensity();
1221 context.mOutput.mResources.mEnvironmentMaps.push_back({std::move(environmentDefinition), EnvironmentDefinition::Textures()});
1224 void InitializeGltfLoader()
1226 static Dali::Mutex initializeMutex;
1227 // Set ObjectReader only once (for all gltf loading).
1228 static bool setObjectReadersRequired = true;
1230 Mutex::ScopedLock lock(initializeMutex);
1231 if(setObjectReadersRequired)
1233 // NOTE: only referencing own, anonymous namespace, const objects; the pointers will never need to change.
1235 setObjectReadersRequired = false;
1240 const std::string_view GetRendererModelIdentification()
1242 return MRENDERER_MODEL_IDENTIFICATION;
1245 void ReadDocument(const json_object_s& jsonObject, gltf2::Document& document)
1247 DOCUMENT_READER.Read(jsonObject, document);
1250 void ReadDocumentFromParsedData(const json_object_s& jsonObject, gltf2::Document& document)
1252 static Dali::Mutex readMutex;
1253 Mutex::ScopedLock lock(readMutex);
1254 gt::SetRefReaderObject(document);
1255 Gltf2Util::ReadDocument(jsonObject, document);
1258 bool GenerateDocument(json::unique_ptr& root, gt::Document& document, bool& isMRendererModel)
1260 auto& rootObject = js::Cast<json_object_s>(*root);
1261 auto jsonAsset = js::FindObjectChild("asset", rootObject);
1263 auto jsAssetVersion = js::FindObjectChild("version", js::Cast<json_object_s>(*jsonAsset));
1266 document.mAsset.mVersion = js::Read::StringView(*jsAssetVersion);
1269 auto jsAssetGenerator = js::FindObjectChild("generator", js::Cast<json_object_s>(*jsonAsset));
1270 if(jsAssetGenerator)
1272 document.mAsset.mGenerator = js::Read::StringView(*jsAssetGenerator);
1273 isMRendererModel = (document.mAsset.mGenerator.find(Gltf2Util::GetRendererModelIdentification().data()) != std::string_view::npos);
1276 Gltf2Util::InitializeGltfLoader();
1277 Gltf2Util::ReadDocumentFromParsedData(rootObject, document);
1282 void ConvertGltfToContext(gt::Document& document, Gltf2Util::ConversionContext& context, bool isMRendererModel)
1284 Dali::Scene3D::Loader::ShaderDefinitionFactory shaderFactory;
1285 shaderFactory.SetResources(context.mOutput.mResources);
1287 Gltf2Util::ConvertBuffers(document, context);
1288 Gltf2Util::ConvertMaterials(document, context);
1289 Gltf2Util::ConvertMeshes(document, context);
1290 Gltf2Util::ConvertNodes(document, context, isMRendererModel);
1291 Gltf2Util::ConvertAnimations(document, context);
1292 Gltf2Util::ProcessSkins(document, context);
1293 Gltf2Util::ProduceShaders(shaderFactory, context.mOutput.mScene);
1294 context.mOutput.mScene.EnsureUniqueSkinningShaderInstances(context.mOutput.mResources);
1296 // Set Default Environment map
1297 Gltf2Util::SetDefaultEnvironmentMap(document, context);
1300 } // namespace Gltf2Util
1302 } // namespace Dali::Scene3D::Loader::Internal