1 #ifndef DALI_SCENE3D_MODEL_MOTION_MOTION_TRANSFORM_INDEX_H
2 #define DALI_SCENE3D_MODEL_MOTION_MOTION_TRANSFORM_INDEX_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
24 #include <dali-scene3d/public-api/model-motion/motion-index/motion-index.h>
30 //Forward declarations.
33 class MotionTransformIndex;
34 } // namespace Internal
37 * @addtogroup dali_scene3d_model_motion_motion_transform_index
42 * @brief Specialized MotionIndex to control transform.
43 * It will be used when app developer don't care about Dali::Actor::Property list,
44 * but want to change the transform properties anyway fast enough.
46 * Each TransformType has their own matched MotionValue type.
50 * MotionTransformIndex position = MotionTransformIndex::New("nodeName", MotionTransformIndex::TransformType::POSITION);
52 * // We can change the property later.
53 * MotionTransformIndex orientation = MotionTransformIndex::New();
54 * orientation.SetModelNodeId("nodeName");
55 * orientation.SetTransformType(MotionTransformIndex::TransformType::ORIENTATION);
61 class DALI_SCENE3D_API MotionTransformIndex : public MotionIndex
65 * @brief The type of Transform
68 enum class TransformType
72 POSITION = 0, ///< The position of ModelNode. MotionValue should be Vector3.
73 POSITION_X, ///< The x position of ModelNode. MotionValue should be float.
74 POSITION_Y, ///< The y position of ModelNode. MotionValue should be float.
75 POSITION_Z, ///< The z position of ModelNode. MotionValue should be float.
77 ORIENTATION, ///< The orientation of ModelNode. MotionValue should be Quaternion.
79 SCALE, ///< The scale of ModelNode. MotionValue should be Vector3.
80 SCALE_X, ///< The x scale of ModelNode. MotionValue should be float.
81 SCALE_Y, ///< The y scale of ModelNode. MotionValue should be float.
82 SCALE_Z, ///< The z scale of ModelNode. MotionValue should be float.
85 public: // Creation & Destruction
87 * @brief Create an initialized MotionTransformIndex.
90 * @return A handle to a newly allocated Dali resource
92 static MotionTransformIndex New();
95 * @brief Create an initialized MotionTransformIndex with values.
98 * @param[in] modelNodeId The id of model node what this motion index looks.
99 * @param[in] type The type of transform what this motion index looks.
100 * @return A handle to a newly allocated Dali resource
102 static MotionTransformIndex New(Property::Key modelNodeId, TransformType type);
105 * @brief Creates an uninitialized MotionTransformIndex.
107 * Only derived versions can be instantiated. Calling member
108 * functions with an uninitialized Dali::Object is not allowed.
112 MotionTransformIndex();
117 * This is non-virtual since derived Handle types must not contain data or virtual methods.
121 ~MotionTransformIndex();
124 * @brief Copy constructor.
127 * @param[in] motionTransformIndex Handle to an object
129 MotionTransformIndex(const MotionTransformIndex& motionTransformIndex);
132 * @brief Move constructor
135 * @param[in] rhs A reference to the moved handle
137 MotionTransformIndex(MotionTransformIndex&& rhs) noexcept;
140 * @brief Assignment operator.
143 * @param[in] motionTransformIndex Handle to an object
144 * @return reference to this
146 MotionTransformIndex& operator=(const MotionTransformIndex& motionTransformIndex);
149 * @brief Move assignment
152 * @param[in] rhs A reference to the moved handle
153 * @return A reference to this
155 MotionTransformIndex& operator=(MotionTransformIndex&& rhs) noexcept;
158 * @brief Downcasts an Object handle to MotionTransformIndex.
160 * If handle points to a MotionTransformIndex, the downcast produces valid handle.
161 * If not, the returned handle is left uninitialized.
164 * @param[in] handle Handle to an object
165 * @return Handle to a MotionTransformIndex or an uninitialized handle
167 static MotionTransformIndex DownCast(BaseHandle handle);
169 public: // Public Method
171 * @brief Set the type of transform what this motion index looks.
174 * @param[in] type The type of transform.
176 void SetTransformType(TransformType type);
179 * @brief Get the type of transform what this motion index looks.
182 * @return The type of transform.
184 TransformType GetTransformType() const;
186 public: // Not intended for application developers
189 * @brief Creates a handle using the Scene3D::Internal implementation.
191 * @param[in] implementation The MotionTransformIndex implementation
193 DALI_INTERNAL MotionTransformIndex(Dali::Scene3D::Internal::MotionTransformIndex* implementation);
201 } // namespace Scene3D
205 #endif // DALI_SCENE3D_MODEL_MOTION_MOTION_TRANSFORM_INDEX_H