X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Fproperty-conditions.h;h=6a4bf16eac5ef5124a4ec542bc4aa8a53dadd739;hb=eb6f5959d8f8e03bf8bfba6c3091bdb962ec0830;hp=65a997088f7de56e2c11e31324b9132c1377cbc3;hpb=e7267cff159c0ea2f919cbbe8c809f22226148d9;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/object/property-conditions.h b/dali/public-api/object/property-conditions.h index 65a9970..6a4bf16 100644 --- a/dali/public-api/object/property-conditions.h +++ b/dali/public-api/object/property-conditions.h @@ -19,12 +19,16 @@ */ // INTERNAL INCLUDES -#include +#include #include #include namespace Dali { +/** + * @addtogroup dali_core_object + * @{ + */ namespace Internal DALI_INTERNAL { @@ -33,61 +37,60 @@ class PropertyCondition; /** * @brief This represents a condition that can be evaluated on a Property::Value. + * @SINCE_1_0.0 */ class DALI_IMPORT_API PropertyCondition : public BaseHandle { public: /** - * @brief Argument container, represents the arguments to be supplied to the condition function. - */ - typedef std::vector ArgumentContainer; - typedef ArgumentContainer::iterator ArgumentIter; ///< Iterator for Dali::PropertyCondition::ArgumentContainer - typedef ArgumentContainer::const_iterator ArgumentConstIter;///< Const Iterator for Dali::PropertyCondition::ArgumentContainer - -public: - - /** * @brief Constructor for condition clause. + * @SINCE_1_0.0 */ PropertyCondition(); /** * @brief Destructor. + * @SINCE_1_0.0 */ ~PropertyCondition(); /** * @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 */ - PropertyCondition(const PropertyCondition& handle); + PropertyCondition( const PropertyCondition& 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 */ - PropertyCondition& operator=(const PropertyCondition& rhs); + PropertyCondition& operator=( const PropertyCondition& rhs ); public: /** - * @brief Retrieve the arguments that this condition uses. + * @brief Retrieves the arguments that this condition uses. * + * @SINCE_1_0.0 * @return The arguments used for this condition */ - ArgumentContainer GetArguments(); + std::size_t GetArgumentCount() const; /** - * @brief Retrieve the arguments that this condition uses. + * @brief Retrieves the arguments that this condition uses. * + * @SINCE_1_0.0 + * @param[in] index The condition index to get the argument * @return The arguments used for this condition * @note The container will only be valid as long PropertyCondition is valid. */ - const ArgumentContainer& GetArguments() const; + float GetArgument( std::size_t index ) const; }; @@ -100,10 +103,11 @@ public: * vector2 (the 2D length) * vector3 (the 3D length) * vector4 (the 4D length) + * @SINCE_1_0.0 * @param[in] arg The argument for the condition * @return A property condition function object */ -DALI_IMPORT_API PropertyCondition LessThanCondition(float arg); +DALI_IMPORT_API PropertyCondition LessThanCondition( float arg ); /** * @brief GreaterThanCondition compares whether property is greater than arg. @@ -114,10 +118,11 @@ DALI_IMPORT_API PropertyCondition LessThanCondition(float arg); * vector2 (the 2D length) * vector3 (the 3D length) * vector4 (the 4D length) + * @SINCE_1_0.0 * @param[in] arg The argument for the condition * @return A property condition function object */ -DALI_IMPORT_API PropertyCondition GreaterThanCondition(float arg); +DALI_IMPORT_API PropertyCondition GreaterThanCondition( float arg ); /** * @brief InsideCondition compares whether property is greater than arg0 and less than arg1. @@ -128,11 +133,12 @@ DALI_IMPORT_API PropertyCondition GreaterThanCondition(float arg); * vector2 (the 2D length) * vector3 (the 3D length) * vector4 (the 4D length) + * @SINCE_1_0.0 * @param[in] arg0 The first argument for the condition * @param[in] arg1 The second argument for the condition * @return A property condition function object */ -DALI_IMPORT_API PropertyCondition InsideCondition(float arg0, float arg1); +DALI_IMPORT_API PropertyCondition InsideCondition( float arg0, float arg1 ); /** * @brief OutsideCondition compares whether property is less than arg0 or greater than arg1. @@ -143,39 +149,45 @@ DALI_IMPORT_API PropertyCondition InsideCondition(float arg0, float arg1); * vector2 (the 2D length) * vector3 (the 3D length) * vector4 (the 4D length) + * @SINCE_1_0.0 * @param[in] arg0 The first argument for the condition * @param[in] arg1 The second argument for the condition * @return A property condition function object */ -DALI_IMPORT_API PropertyCondition OutsideCondition(float arg0, float arg1); +DALI_IMPORT_API PropertyCondition OutsideCondition( float arg0, float arg1 ); /** - * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount + * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount. * * property type: * float (float) * vector2 (the 2D length) * vector3 (the 3D length) * vector4 (the 4D length) + * @SINCE_1_0.0 * @param[in] stepAmount The step size required to trigger condition * @param[in] initialValue The initial value to step from * @return A property condition function object */ -DALI_IMPORT_API PropertyCondition StepCondition(float stepAmount, float initialValue = 0.0f); +DALI_IMPORT_API PropertyCondition StepCondition( float stepAmount, float initialValue = 0.0f ); /** - * @brief Receive notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending + * @brief Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending. * * property type: * float (float) * vector2 (the 2D length) * vector3 (the 3D length) * vector4 (the 4D length) + * @SINCE_1_0.0 * @param[in] steps List of values to receive notifications for as a property crosses them * @return A property condition function object */ -DALI_IMPORT_API PropertyCondition VariableStepCondition(const std::vector& steps); +DALI_IMPORT_API PropertyCondition VariableStepCondition( const Dali::Vector& steps ); +/** + * @} + */ } // namespace Dali #endif // __DALI_PROPERTY_CONDITIONS_H__