Merge "DALi Version 2.2.21" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / loader / skeleton-definition.h
1 #ifndef DALI_SCENE3D_LOADER_SKELETON_H
2 #define DALI_SCENE3D_LOADER_SKELETON_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 // INTERNAL INCLUDES
21 #include <dali-scene3d/public-api/loader/index.h>
22
23 // EXTERNAL INCLUDES
24 #include <dali/public-api/common/vector-wrapper.h>
25 #include <dali/public-api/math/matrix.h>
26
27 namespace Dali::Scene3D::Loader
28 {
29 /*
30  * @brief A set of joints (stored as node indices), and an optional root node index.
31  * @note The list of joints must not be empty and must not contain INVALID_INDEX.
32  * @note Client code should not change the order of joints, as they are indexed by mesh vertex data.
33  * @note Client code should make no assumption about the relation of the joint IDs.
34  */
35 struct DALI_SCENE3D_API SkeletonDefinition
36 {
37   struct Joint
38   {
39     Index  mNodeIdx;
40     Matrix mInverseBindMatrix;
41   };
42
43   using Vector = std::vector<SkeletonDefinition>;
44
45   Index              mRootNodeIdx = INVALID_INDEX;
46   std::vector<Joint> mJoints;
47 };
48
49 } // namespace Dali::Scene3D::Loader
50
51 #endif //DALI_SCENE3D_LOADER_SKELETON_H