#define __DALI_KEY_FRAMES_H__
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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/animation/alpha-functions.h>
+#include <dali/public-api/animation/alpha-function.h>
#include <dali/public-api/object/base-handle.h>
#include <dali/public-api/object/property-value.h>
#include <dali/public-api/object/property-types.h>
namespace Dali
{
+/**
+ * @addtogroup dali_core_animation
+ * @{
+ */
namespace Internal DALI_INTERNAL
{
* Property::Values. The type of the key frame is specified by the
* type of the first value to be added. Adding key frames with a
* different Property::Value type will result in a run time assert.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API KeyFrames : public BaseHandle
{
public:
/**
- * @brief Create an initialized KeyFrame handle.
+ * @brief Creates an initialized KeyFrames handle.
*
- * @return a handle to a newly allocated Dali resource.
+ * @SINCE_1_0.0
+ * @return A handle to a newly allocated Dali resource
*/
static KeyFrames New();
/**
- * @brief Downcast an Object handle to KeyFrames handle.
+ * @brief Downcasts a handle to KeyFrames 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 KeyFrames object or an uninitialized handle
+ * If handle points to a KeyFrames 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 KeyFrames object or an uninitialized handle
*/
static KeyFrames DownCast( BaseHandle handle );
/**
- * @brief Create an uninitialized KeyFrame handle.
+ * @brief Creates an uninitialized KeyFrame handle.
*
- * This can be initialized with KeyFrame::New(). Calling member
- * functions with an uninitialized Dali::Object is not allowed.
+ * This can be initialized with KeyFrame::New().
+ * Calling member functions with an uninitialized KeyFrames handle is not allowed.
+ * @SINCE_1_0.0
*/
KeyFrames();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~KeyFrames();
/**
* @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
*/
KeyFrames(const KeyFrames& 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
*/
KeyFrames& operator=(const KeyFrames& rhs);
/**
- * @brief This method is defined to allow assignment of the NULL value,
- * and will throw an exception if passed any other value.
- *
- * Assigning to NULL is an alias for Reset().
- * @param [in] rhs A NULL pointer
- * @return A reference to this handle
- */
- KeyFrames& operator=(BaseHandle::NullType* rhs);
-
- /**
* @brief Gets the type of the key frame.
*
* If no key frames have been added, this returns Property::NONE.
- * @return The key frame property type.
+ * @SINCE_1_0.0
+ * @return The key frame property type
*/
Property::Type GetType() const;
/**
- * @brief Add a key frame.
+ * @brief Adds a key frame.
*
* The key frames should be added in time order.
- * @param[in] progress A value between 0.0 and 1.0.
- * @param[in] value A value.
+ * @SINCE_1_0.0
+ * @param[in] progress A progress value between 0.0 and 1.0
+ * @param[in] value A value
*/
void Add(float progress, Property::Value value);
/**
- * @brief Add a key frame.
+ * @brief Adds a key frame.
*
* The key frames should be added in time order.
- * @param[in] progress A value between 0.0 and 1.0.
- * @param[in] value A value.
+ * @SINCE_1_0.0
+ * @param[in] progress A progress value between 0.0 and 1.0
+ * @param[in] value A value
* @param[in] alpha The alpha function used to blend to the next keyframe
*/
void Add(float progress, Property::Value value, AlphaFunction alpha);
public: // Not intended for application developers
/**
- * @brief This constructor is used by Dali::New() methods.
+ * @internal
+ * @brief This constructor is used by KeyFrames::New() methods.
*
+ * @SINCE_1_0.0
* @param[in] keyFrames A pointer to an internal KeyFrame resource
*/
explicit DALI_INTERNAL KeyFrames(Internal::KeyFrames* keyFrames);
};
+/**
+ * @}
+ */
} // namespace Dali
#endif // __DALI_KEY_FRAMES_H__