1 #ifndef DALI_SCENE3D_LOADER_MESH_DEFINITION_H
2 #define DALI_SCENE3D_LOADER_MESH_DEFINITION_H
4 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include <dali/public-api/common/vector-wrapper.h>
25 #include <dali-scene3d/public-api/api.h>
26 #include <dali-scene3d/public-api/loader/blend-shape-details.h>
27 #include <dali-scene3d/public-api/loader/buffer-definition.h>
28 #include <dali-scene3d/public-api/loader/index.h>
29 #include <dali-scene3d/public-api/loader/mesh-geometry.h>
30 #include <dali-scene3d/public-api/loader/utils.h>
32 namespace Dali::Scene3D::Loader
35 * @brief Defines a mesh with its attributes, the primitive type to render it as,
36 * and the file to load it from with the offset and length information for the
37 * individual attribute buffers.
39 struct DALI_SCENE3D_API MeshDefinition
41 using Vector = std::vector<std::pair<MeshDefinition, MeshGeometry>>;
45 INVALID = std::numeric_limits<uint32_t>::max()
50 FLIP_UVS_VERTICAL = NthBit(0),
51 U32_INDICES = NthBit(1), // default is unsigned short
52 U8_INDICES = NthBit(2), // default is unsigned short
53 U16_JOINT_IDS = NthBit(3), // default is floats
54 U8_JOINT_IDS = NthBit(4),
55 U16_WEIGHT = NthBit(5), // default is floats
56 U8_WEIGHT = NthBit(6),
62 POSITIONS = NthBit(1),
64 TEX_COORDS = NthBit(3),
66 LEGACY_BITANGENTS = NthBit(5), // these are ignored; we're calculating them in the (PBR) shader.
68 WEIGHTS_0 = NthBit(7),
72 * @brief Describes raw data in terms of its position and size in a buffer.
77 uint32_t mOffset = INVALID; // the default means that the blob is undefined.
78 uint32_t mLength = 0; // if the blob is undefined, its data may still be generated. This is enabled by setting length to some non-0 value. Refer to MeshDefinition for details.
79 uint16_t mStride = 0; // ignore if 0
80 uint16_t mElementSizeHint = 0; // ignore if 0 or stride == 0
81 std::vector<float> mMin;
82 std::vector<float> mMax;
84 static void ComputeMinMax(std::vector<float>& min, std::vector<float>& max, uint32_t numComponents, uint32_t count, const float* values);
86 static void ApplyMinMax(const std::vector<float>& min, const std::vector<float>& max, uint32_t count, float* values, std::vector<uint32_t>* sparseIndices = nullptr);
90 Blob(const Blob&) = default;
91 Blob& operator=(const Blob&) = default;
93 Blob(Blob&&) = default;
94 Blob& operator=(Blob&&) = default;
96 Blob(uint32_t offset, uint32_t length, uint16_t stride = 0, uint16_t elementSizeHint = 0, const std::vector<float>& min = {}, const std::vector<float>& max = {});
99 * @brief Calculates the size of a tightly-packed buffer for the elements from the blob.
101 uint32_t GetBufferSize() const;
104 * @brief Convenience method to tell whether a Blob has meaningful data.
106 bool IsDefined() const
108 return mOffset != INVALID;
112 * @brief Convenience method to tell whether the elements stored in the blob follow each
113 * other tightly. The opposite would be interleaving.
115 bool IsConsecutive() const
117 return mStride == 0 || mStride == mElementSizeHint;
121 * @brief Computes the min / max of the input value data.
122 * The min and max are stored in mMin and mMax.
124 * @param[in] numComponents number of components of data type. e.g., 3 for Vector3.
125 * @param[in] count The number of data.
126 * @param[in] values Data for the mesh.
128 void ComputeMinMax(uint32_t numComponents, uint32_t count, float* values);
131 * @brief Applies the min / max values, if they're defined in the model
133 * @param[in] count The number of data.
134 * @param[in] values Data for the mesh that min / max values will be applied.
135 * @param[in] sparseIndices Pointer to array of sparse indices (or nullptr if not provided)
138 void ApplyMinMax(uint32_t count, float* values, std::vector<uint32_t>* sparseIndices = nullptr) const;
142 * @brief A sparse blob describes a change in a reference Blob.
143 * @p indices describe what positions of the reference Blob change and
144 * @p values describe the new values.
148 SparseBlob() = default;
150 SparseBlob(const SparseBlob&) = default;
151 SparseBlob& operator=(const SparseBlob&) = default;
153 SparseBlob(SparseBlob&&) = default;
154 SparseBlob& operator=(SparseBlob&&) = default;
156 SparseBlob(const Blob& indices, const Blob& values, uint32_t count);
157 SparseBlob(Blob&& indices, Blob&& values, uint32_t count);
161 uint32_t mCount = 0u;
167 std::unique_ptr<SparseBlob> mSparse;
168 Index mBufferIdx = INVALID_INDEX;
170 Accessor() = default;
172 Accessor(const Accessor&) = delete;
173 Accessor& operator=(const Accessor&) = delete;
175 Accessor(Accessor&&) = default;
176 Accessor& operator=(Accessor&&) = default;
178 Accessor(const MeshDefinition::Blob& blob,
179 const MeshDefinition::SparseBlob& sparse,
180 Index bufferIndex = INVALID_INDEX);
181 Accessor(MeshDefinition::Blob&& blob,
182 MeshDefinition::SparseBlob&& sparse,
183 Index bufferIndex = INVALID_INDEX);
185 bool IsDefined() const
187 return mBlob.IsDefined() || (mSparse && (mSparse->mIndices.IsDefined() && mSparse->mValues.IsDefined()));
192 * @brief Stores a blend shape.
208 Property::Type mType;
209 uint32_t mNumElements;
210 std::vector<uint8_t> mData;
212 void AttachBuffer(Geometry& g) const;
215 std::vector<uint16_t> mIndices;
216 std::vector<Attrib> mAttribs;
218 unsigned int mBlendShapeBufferOffset{0};
219 Dali::Vector<float> mBlendShapeUnnormalizeFactor;
220 PixelData mBlendShapeData;
223 MeshDefinition() = default;
225 MeshDefinition(const MeshDefinition&) = delete;
226 MeshDefinition& operator=(const MeshDefinition&) = delete;
228 MeshDefinition(MeshDefinition&&) = default;
229 MeshDefinition& operator=(MeshDefinition&&) = default;
232 * @brief Determines whether the mesh definition is that of a quad.
237 * @brief Determines whether the mesh is used for skeletal animation.
239 bool IsSkinned() const;
242 * @brief Whether the mesh has blend shapes.
244 bool HasBlendShapes() const;
247 * @brief Requests normals to be generated.
248 * @note Generation happens in LoadRaw().
249 * @note Must have Vector3 positions defined.
251 void RequestNormals();
254 * @brief Requests tangents to be generated.
255 * @note Generation happens in LoadRaw().
256 * @note Must have Vector3 normals defined.
258 void RequestTangents();
261 * @brief Loads raw geometry data, which includes index (optional) and
262 * attribute buffers, as well as blend shape data. This is then returned.
263 * @note This can be done on any thread.
265 RawData LoadRaw(const std::string& modelsPath, BufferDefinition::Vector& buffers);
268 * @brief Creates a MeshGeometry based firstly on the value of the uri member:
269 * if it is "quad", a textured quad is created; otherwise it uses the
270 * attribute (and index) buffers and blend shape information (if available)
272 * If mFlipVertical was set, the UVs are flipped in Y, i.e. v = 1.0 - v.
274 MeshGeometry Load(RawData&& raw) const;
277 * @brief Retrieves what Components information is in this mesh's BlendShape.
279 * @param[out] hasPositions True if the BlendShape has position components
280 * @param[out] hasNormals True if the BlendShape has normal components
281 * @param[out] hasTangents True if the BlendShape has tangent components
283 void RetrieveBlendShapeComponents(bool& hasPositions, bool& hasNormals, bool& hasTangents) const;
286 std::shared_ptr<RawData> mRawData;
287 uint32_t mFlags = 0x0;
288 Geometry::Type mPrimitiveType = Geometry::TRIANGLES;
289 std::string mUri; // When the mesh data is loaded from embedded resources, this URI is used as a data stream.
292 Accessor mNormals; // data can be generated based on positions
295 Accessor mTangents; // data can be generated based on normals and texCoords (the latter isn't mandatory; the results will be better if available)
298 Property::Type mTangentType{Property::VECTOR3};
300 Blob mBlendShapeHeader;
301 std::vector<BlendShape> mBlendShapes;
302 BlendShapes::Version mBlendShapeVersion = BlendShapes::Version::INVALID;
304 Index mSkeletonIdx = INVALID_INDEX;
305 ModelPrimitive mModelPrimitive;
308 } // namespace Dali::Scene3D::Loader
310 #endif //DALI_SCENE3D_LOADER_MESH_DEFINITION_H