-#ifndef __DALI_PATH_H__
-#define __DALI_PATH_H__
+#ifndef DALI_PATH_H
+#define DALI_PATH_H
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// INTERNAL INCLUDES
#include <dali/public-api/object/handle.h>
+#include <dali/public-api/object/property-index-ranges.h>
namespace Dali
{
+/**
+ * @addtogroup dali_core_animation
+ * @{
+ */
namespace Internal DALI_INTERNAL
{
class Path;
}
+
/**
- * @brief A 3D parametric curve
+ * @brief A 3D parametric curve.
*
- * Paths can be used to animate position and orientation of actors using Dali::Animate( Actor, Path, ... )
+ * Paths can be used to animate position and orientation of actors using Dali::Animate().
*
+ * @SINCE_1_0.0
*/
-class DALI_IMPORT_API Path : public Handle
+class DALI_CORE_API Path : public Handle
{
public:
+ /**
+ * @brief Enumeration for the instance of properties belonging to the Path class.
+ * @SINCE_1_0.0
+ */
+ struct Property
+ {
+ /**
+ * @brief Enumeration for the instance of properties belonging to the Path class.
+ * @SINCE_1_0.0
+ */
+ enum
+ {
+ POINTS = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "points", type Vector3 @SINCE_1_0.0
+ CONTROL_POINTS, ///< name "controlPoints", type Vector3 @SINCE_1_0.0
+ };
+ };
- static const Property::Index POINTS; ///< name "points", type ARRAY of Vector3
- static const Property::Index CONTROL_POINTS; ///< name "control-points", type ARRAY of Vector3
/**
- * @brief Create an initialized Path handle.
+ * @brief Creates an initialized Path handle.
*
- * @return a handle to a newly allocated Dali resource.
+ * @SINCE_1_0.0
+ * @return A handle to a newly allocated Dali resource
*/
static Path New();
/**
- * @brief Downcast an Object handle to Path handle.
+ * @brief Downcasts a handle to Path handle.
*
- * If handle points to a KeyFrames object the downcast produces
- * valid handle. If not the returned handle is left uninitialized.
- * @param[in] handle to An object
- * @return handle to a Path object or an uninitialized handle
+ * If handle points to a Path object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
+ * @SINCE_1_0.0
+ * @param[in] handle Handle to an object
+ * @return Handle to a Path object or an uninitialized handle
*/
- static Path DownCast( BaseHandle handle );
+ static Path DownCast(BaseHandle handle);
/**
- * @brief Create an uninitialized Path handle.
+ * @brief Creates an uninitialized Path handle.
*
- * This can be initialized with Path::New(). Calling member
- * functions with an uninitialized Dali::Object is not allowed.
+ * This can be initialized with Path::New().
+ * Calling member functions with an uninitialized Path handle is not allowed.
+ * @SINCE_1_0.0
*/
Path();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Path();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
- * @param [in] handle A reference to the copied handle
+ * @SINCE_1_0.0
+ * @param[in] handle A reference to the copied handle
*/
Path(const Path& handle);
/**
* @brief This assignment operator is required for (smart) pointer semantics.
*
- * @param [in] rhs A reference to the copied handle
+ * @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Path& operator=(const Path& rhs);
/**
- * @brief Add an interpolation point.
+ * @brief Move constructor.
+ *
+ * @SINCE_1_9.22
+ * @param[in] rhs A reference to the moved handle
+ */
+ Path(Path&& rhs) noexcept;
+
+ /**
+ * @brief Move assignment operator.
+ *
+ * @SINCE_1_9.22
+ * @param[in] rhs A reference to the moved handle
+ * @return A reference to this
+ */
+ Path& operator=(Path&& rhs) noexcept;
+
+ /**
+ * @brief Adds an interpolation point.
*
+ * @SINCE_1_0.0
* @param[in] point The new interpolation point to be added
*/
- void AddPoint(const Vector3& point );
+ void AddPoint(const Vector3& point);
/**
- * @brief Add a control point.
+ * @brief Adds a control point.
*
+ * @SINCE_1_0.0
* @param[in] point The new control point to be added
*/
- void AddControlPoint(const Vector3& point );
+ void AddControlPoint(const Vector3& point);
/**
* @brief Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment.
* The generating algorithm is as follows:
* For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1].
* Calculate the tangent vector by taking the normal of this bisector.
- * The in control point is the length of the preceding segment back along this bisector multiplied by the curvature
- * The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature
- *
- * @pre There are at least two points in the path ( one segment ).
+ * The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.
+ * The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.
*
+ * @SINCE_1_0.0
* @param[in] curvature The curvature of the spline. 0 gives straight lines between the knots,
* negative values means the spline contains loops, positive values up to
* 0.5 result in a smooth curve, positive values between 0.5 and 1 result
* in looped curves where the loops are not distinct (i.e. the curve appears
- * to be non-continuous), positive values higher than 1 result in looped curves.
+ * to be non-continuous), positive values higher than 1 result in looped curves
+ * @pre There are at least two points in the path ( one segment ).
+ *
*/
- void GenerateControlPoints( float curvature );
+ void GenerateControlPoints(float curvature);
/**
- * @brief Sample path at a given progress. Calculates position and tangent at that point of the curve
+ * @brief Sample path at a given progress. Calculates position and tangent at that point of the curve.
*
- * @param[in] progress A floating point value between 0.0 and 1.0.
- * @param[out] position The interpolated position at that progress.
- * @param[out] tangent The interpolated tangent at that progress.
+ * @SINCE_1_0.0
+ * @param[in] progress A floating point value between 0.0 and 1.0
+ * @param[out] position The interpolated position at that progress
+ * @param[out] tangent The interpolated tangent at that progress
*/
- void Sample( float progress, Vector3& position, Vector3& tangent ) const;
+ void Sample(float progress, Vector3& position, Vector3& tangent) const;
/**
* @brief Accessor for the interpolation points.
*
- * @param[in] index The index of the interpolation point.
- * @return A reference to the interpolation point.
+ * @SINCE_1_0.0
+ * @param[in] index The index of the interpolation point
+ * @return A reference to the interpolation point
*/
- Vector3& GetPoint( size_t index );
+ Vector3& GetPoint(size_t index);
/**
* @brief Accessor for the control points.
*
- * @param[in] index The index of the control point.
- * @return A reference to the control point.
+ * @SINCE_1_0.0
+ * @param[in] index The index of the control point
+ * @return A reference to the control point
*/
- Vector3& GetControlPoint( size_t index );
+ Vector3& GetControlPoint(size_t index);
/**
- * @brief Get the number of interpolation points in the path
+ * @brief Gets the number of interpolation points in the path.
*
+ * @SINCE_1_0.0
* @return The number of interpolation points in the path
*/
size_t GetPointCount() const;
public: // Not intended for application developers
+ /// @cond internal
/**
- * @brief This constructor is used by Dali::New() methods.
+ * @brief This constructor is used by Path::New() methods.
*
+ * @SINCE_1_0.0
* @param[in] path A pointer to an internal path resource
*/
explicit DALI_INTERNAL Path(Internal::Path* path);
+ /// @endcond
};
+/**
+ * @}
+ */
} // namespace Dali
-#endif // __DALI_KEY_FRAMES_H__
+#endif // DALI_PATH_H
projects / platform / core / uifw / dali-core.git / blobdiff