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