1 #ifndef DALI_PROPERTY_CONDITIONS_H
2 #define DALI_PROPERTY_CONDITIONS_H
5 * Copyright (c) 2019 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.
22 #include <dali/public-api/common/dali-vector.h>
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/object/property.h>
29 * @addtogroup dali_core_object
33 namespace Internal DALI_INTERNAL
35 class PropertyCondition;
39 * @brief This represents a condition that can be evaluated on a Property::Value.
42 class DALI_CORE_API PropertyCondition : public BaseHandle
47 * @brief Constructor for condition clause.
59 * @brief This copy constructor is required for (smart) pointer semantics.
62 * @param[in] handle A reference to the copied handle
64 PropertyCondition( const PropertyCondition& handle );
67 * @brief This assignment operator is required for (smart) pointer semantics.
70 * @param[in] rhs A reference to the copied handle
71 * @return A reference to this
73 PropertyCondition& operator=( const PropertyCondition& rhs );
78 * @brief Retrieves the arguments that this condition uses.
81 * @return The arguments used for this condition
83 std::size_t GetArgumentCount() const;
86 * @brief Retrieves the arguments that this condition uses.
89 * @param[in] index The condition index to get the argument
90 * @return The arguments used for this condition
91 * @note The container will only be valid as long PropertyCondition is valid.
93 float GetArgument( std::size_t index ) const;
98 * @brief LessThanCondition compares whether property is less than arg.
101 * bool (false = 0.0f, true = 1.0f)
103 * vector2 (the 2D length)
104 * vector3 (the 3D length)
105 * vector4 (the 4D length)
107 * @param[in] arg The argument for the condition
108 * @return A property condition function object
110 DALI_CORE_API PropertyCondition LessThanCondition( float arg );
113 * @brief GreaterThanCondition compares whether property is greater than arg.
116 * bool (false = 0.0f, true = 1.0f)
118 * vector2 (the 2D length)
119 * vector3 (the 3D length)
120 * vector4 (the 4D length)
122 * @param[in] arg The argument for the condition
123 * @return A property condition function object
125 DALI_CORE_API PropertyCondition GreaterThanCondition( float arg );
128 * @brief InsideCondition compares whether property is greater than arg0 and less than arg1.
131 * bool (false = 0.0f, true = 1.0f)
133 * vector2 (the 2D length)
134 * vector3 (the 3D length)
135 * vector4 (the 4D length)
137 * @param[in] arg0 The first argument for the condition
138 * @param[in] arg1 The second argument for the condition
139 * @return A property condition function object
141 DALI_CORE_API PropertyCondition InsideCondition( float arg0, float arg1 );
144 * @brief OutsideCondition compares whether property is less than arg0 or greater than arg1.
147 * bool (false = 0.0f, true = 1.0f)
149 * vector2 (the 2D length)
150 * vector3 (the 3D length)
151 * vector4 (the 4D length)
153 * @param[in] arg0 The first argument for the condition
154 * @param[in] arg1 The second argument for the condition
155 * @return A property condition function object
157 DALI_CORE_API PropertyCondition OutsideCondition( float arg0, float arg1 );
160 * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
164 * vector2 (the 2D length)
165 * vector3 (the 3D length)
166 * vector4 (the 4D length)
168 * @param[in] stepAmount The step size required to trigger condition
169 * @param[in] initialValue The initial value to step from
170 * @return A property condition function object
172 DALI_CORE_API PropertyCondition StepCondition( float stepAmount, float initialValue = 0.0f );
175 * @brief Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
179 * vector2 (the 2D length)
180 * vector3 (the 3D length)
181 * vector4 (the 4D length)
183 * @param[in] steps List of values to receive notifications for as a property crosses them
184 * @return A property condition function object
186 DALI_CORE_API PropertyCondition VariableStepCondition( const Dali::Vector<float>& steps );
193 #endif // DALI_PROPERTY_CONDITIONS_H