dali-scene3d/public-api/loader/mesh-definition.h

   1 #ifndef DALI_SCENE3D_LOADER_MESH_DEFINITION_H
   2 #define DALI_SCENE3D_LOADER_MESH_DEFINITION_H
   3 /*
   4  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   5  *
   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
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/public-api/common/vector-wrapper.h>
  22 #include <memory>
  23
  24 // INTERNAL INCLUDES
  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>
  31
  32 namespace Dali::Scene3D::Loader
  33 {
  34 /**
  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.
  38  */
  39 struct DALI_SCENE3D_API MeshDefinition
  40 {
  41   using Vector = std::vector<std::pair<MeshDefinition, MeshGeometry>>;
  42
  43   enum : uint32_t
  44   {
  45     INVALID = std::numeric_limits<uint32_t>::max()
  46   };
  47
  48   enum Flags : uint16_t
  49   {
  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),
  57   };
  58
  59   enum Attributes
  60   {
  61     INDICES           = NthBit(0),
  62     POSITIONS         = NthBit(1),
  63     NORMALS           = NthBit(2),
  64     TEX_COORDS        = NthBit(3),
  65     TANGENTS          = NthBit(4),
  66     LEGACY_BITANGENTS = NthBit(5), // these are ignored; we're calculating them in the (PBR) shader.
  67     JOINTS_0          = NthBit(6),
  68     WEIGHTS_0         = NthBit(7),
  69   };
  70
  71   /**
  72    * @brief Describes raw data in terms of its position and size in a buffer.
  73    *  All units in bytes.
  74    */
  75   struct Blob
  76   {
  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;
  83
  84     static void ComputeMinMax(std::vector<float>& min, std::vector<float>& max, uint32_t numComponents, uint32_t count, const float* values);
  85
  86     static void ApplyMinMax(const std::vector<float>& min, const std::vector<float>& max, uint32_t count, float* values);
  87
  88     Blob() = default;
  89
  90     Blob(const Blob&) = default;
  91     Blob& operator=(const Blob&) = default;
  92
  93     Blob(Blob&&)  = default;
  94     Blob& operator=(Blob&&) = default;
  95
  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 = {});
  97
  98     /**
  99      * @brief Calculates the size of a tightly-packed buffer for the elements from the blob.
 100      */
 101     uint32_t GetBufferSize() const;
 102
 103     /**
 104      * @brief Convenience method to tell whether a Blob has meaningful data.
 105      */
 106     bool IsDefined() const
 107     {
 108       return mOffset != INVALID;
 109     }
 110
 111     /**
 112      * @brief Convenience method to tell whether the elements stored in the blob follow each
 113      *  other tightly. The opposite would be interleaving.
 114      */
 115     bool IsConsecutive() const
 116     {
 117       return mStride == 0 || mStride == mElementSizeHint;
 118     }
 119
 120     /**
 121      * @brief Computes the min / max of the input value data.
 122      * The min and max are stored in mMin and mMax.
 123      *
 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.
 127      */
 128     void ComputeMinMax(uint32_t numComponents, uint32_t count, float* values);
 129
 130     /**
 131      * @brief Applies the min / max values, if they're defined in the model
 132      *
 133      * @param[in] count The number of data.
 134      * @param[in] values Data for the mesh that min / max values will be applied.
 135      */
 136     void ApplyMinMax(uint32_t count, float* values) const;
 137   };
 138
 139   /**
 140    * @brief A sparse blob describes a change in a reference Blob.
 141    * @p indices describe what positions of the reference Blob change and
 142    * @p values describe the new values.
 143    */
 144   struct SparseBlob
 145   {
 146     SparseBlob() = default;
 147
 148     SparseBlob(const SparseBlob&) = default;
 149     SparseBlob& operator=(const SparseBlob&) = default;
 150
 151     SparseBlob(SparseBlob&&) = default;
 152     SparseBlob& operator=(SparseBlob&&) = default;
 153
 154     SparseBlob(const Blob& indices, const Blob& values, uint32_t count);
 155     SparseBlob(Blob&& indices, Blob&& values, uint32_t count);
 156
 157     Blob     mIndices;
 158     Blob     mValues;
 159     uint32_t mCount = 0u;
 160   };
 161
 162   struct Accessor
 163   {
 164     Blob                        mBlob;
 165     std::unique_ptr<SparseBlob> mSparse;
 166     Index                       mBufferIdx = INVALID_INDEX;
 167
 168     Accessor() = default;
 169
 170     Accessor(const Accessor&) = delete;
 171     Accessor& operator=(const Accessor&) = delete;
 172
 173     Accessor(Accessor&&) = default;
 174     Accessor& operator=(Accessor&&) = default;
 175
 176     Accessor(const MeshDefinition::Blob&       blob,
 177              const MeshDefinition::SparseBlob& sparse,
 178              Index                             bufferIndex = INVALID_INDEX);
 179     Accessor(MeshDefinition::Blob&&       blob,
 180              MeshDefinition::SparseBlob&& sparse,
 181              Index                        bufferIndex = INVALID_INDEX);
 182
 183     bool IsDefined() const
 184     {
 185       return mBlob.IsDefined() || (mSparse && (mSparse->mIndices.IsDefined() && mSparse->mValues.IsDefined()));
 186     }
 187   };
 188
 189   /**
 190    * @brief Stores a blend shape.
 191    */
 192   struct BlendShape
 193   {
 194     std::string name;
 195     Accessor    deltas;
 196     Accessor    normals;
 197     Accessor    tangents;
 198     float       weight = 0.f;
 199   };
 200
 201   struct RawData
 202   {
 203     struct Attrib
 204     {
 205       std::string          mName;
 206       Property::Type       mType;
 207       uint32_t             mNumElements;
 208       std::vector<uint8_t> mData;
 209
 210       void AttachBuffer(Geometry& g) const;
 211     };
 212
 213     std::vector<uint16_t> mIndices;
 214     std::vector<Attrib>   mAttribs;
 215
 216     unsigned int        mBlendShapeBufferOffset{0};
 217     Dali::Vector<float> mBlendShapeUnnormalizeFactor;
 218     PixelData           mBlendShapeData;
 219   };
 220
 221   MeshDefinition() = default;
 222
 223   MeshDefinition(const MeshDefinition&) = delete;
 224   MeshDefinition& operator=(const MeshDefinition&) = delete;
 225
 226   MeshDefinition(MeshDefinition&&) = default;
 227   MeshDefinition& operator=(MeshDefinition&&) = default;
 228
 229   /**
 230    * @brief Determines whether the mesh definition is that of a quad.
 231    */
 232   bool IsQuad() const;
 233
 234   /**
 235    * @brief Determines whether the mesh is used for skeletal animation.
 236    */
 237   bool IsSkinned() const;
 238
 239   /**
 240    * @brief Whether the mesh has blend shapes.
 241    */
 242   bool HasBlendShapes() const;
 243
 244   /**
 245    * @brief Requests normals to be generated.
 246    * @note Generation happens in LoadRaw().
 247    * @note Must have Vector3 positions defined.
 248    */
 249   void RequestNormals();
 250
 251   /**
 252    * @brief Requests tangents to be generated.
 253    * @note Generation happens in LoadRaw().
 254    * @note Must have Vector3 normals defined.
 255    */
 256   void RequestTangents();
 257
 258   /**
 259    * @brief Loads raw geometry data, which includes index (optional) and
 260    *  attribute buffers, as well as blend shape data. This is then returned.
 261    * @note This can be done on any thread.
 262    */
 263   RawData LoadRaw(const std::string& modelsPath, BufferDefinition::Vector& buffers);
 264
 265   /**
 266    * @brief Creates a MeshGeometry based firstly on the value of the uri member:
 267    *  if it is "quad", a textured quad is created; otherwise it uses the
 268    *  attribute (and index) buffers and blend shape information (if available)
 269    *  from @a raw.
 270    *  If mFlipVertical was set, the UVs are flipped in Y, i.e. v = 1.0 - v.
 271    */
 272   MeshGeometry Load(RawData&& raw) const;
 273
 274   /**
 275    * @brief Retrieves what Components information is in this mesh's BlendShape.
 276    *
 277    * @param[out] hasPositions True if the BlendShape has position components
 278    * @param[out] hasNormals True if the BlendShape has normal components
 279    * @param[out] hasTangents True if the BlendShape has tangent components
 280    */
 281   void RetrieveBlendShapeComponents(bool& hasPositions, bool& hasNormals, bool& hasTangents) const;
 282
 283 public: // DATA
 284   std::shared_ptr<RawData> mRawData;
 285   uint32_t                 mFlags         = 0x0;
 286   Geometry::Type           mPrimitiveType = Geometry::TRIANGLES;
 287   std::string              mUri; // When the mesh data is loaded from embedded resources, this URI is used as a data stream.
 288   Accessor                 mIndices;
 289   Accessor                 mPositions;
 290   Accessor                 mNormals; // data can be generated based on positions
 291   Accessor                 mTexCoords;
 292   Accessor                 mColors;
 293   Accessor                 mTangents; // data can be generated based on normals and texCoords (the latter isn't mandatory; the results will be better if available)
 294   Accessor                 mJoints0;
 295   Accessor                 mWeights0;
 296   Property::Type           mTangentType{Property::VECTOR3};
 297
 298   Blob                    mBlendShapeHeader;
 299   std::vector<BlendShape> mBlendShapes;
 300   BlendShapes::Version    mBlendShapeVersion = BlendShapes::Version::INVALID;
 301
 302   Index          mSkeletonIdx = INVALID_INDEX;
 303   ModelPrimitive mModelPrimitive;
 304 };
 305
 306 } // namespace Dali::Scene3D::Loader
 307
 308 #endif //DALI_SCENE3D_LOADER_MESH_DEFINITION_H