9bd7133668789e53803e09e95b3af7a61f024c60
[platform/core/uifw/dali-toolkit.git] / dali-scene-loader / public-api / skeleton-definition.h
1 #ifndef DALI_SCENE_LOADER_SKELETON_H
2 #define DALI_SCENE_LOADER_SKELETON_H
3 /*
4  * Copyright (c) 2021 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-scene-loader/public-api/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
28 {
29 namespace SceneLoader
30 {
31 /*
32  * @brief A set of joints (stored as node indices), and an optional root node index.
33  * @note The list of joints must not be empty and must not contain INVALID_INDEX.
34  * @note Client code should not change the order of joints, as they are indexed by mesh vertex data.
35  * @note Client code should make no assumption about the relation of the joint IDs.
36  */
37 struct DALI_SCENE_LOADER_API SkeletonDefinition
38 {
39   struct Joint
40   {
41     Index  mNodeIdx;
42     Matrix mInverseBindMatrix;
43   };
44
45   using Vector = std::vector<SkeletonDefinition>;
46
47   Index              mRootNodeIdx = INVALID_INDEX;
48   std::vector<Joint> mJoints;
49 };
50
51 } // namespace SceneLoader
52 } // namespace Dali
53
54 #endif //DALI_SCENE_LOADER_SKELETON_H