1 #ifndef DALI_PROPERTY_CONDITIONS_H
2 #define DALI_PROPERTY_CONDITIONS_H
5 * Copyright (c) 2020 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 );
76 * @brief Move constructor.
79 * @param[in] rhs A reference to the moved handle
81 PropertyCondition( PropertyCondition&& rhs );
84 * @brief Move assignment operator.
87 * @param[in] rhs A reference to the moved handle
88 * @return A reference to this handle
90 PropertyCondition& operator=( PropertyCondition&& rhs );
95 * @brief Retrieves the arguments that this condition uses.
98 * @return The arguments used for this condition
100 std::size_t GetArgumentCount() const;
103 * @brief Retrieves the arguments that this condition uses.
106 * @param[in] index The condition index to get the argument
107 * @return The arguments used for this condition
108 * @note The container will only be valid as long PropertyCondition is valid.
110 float GetArgument( std::size_t index ) const;
115 * @brief LessThanCondition compares whether property is less than arg.
118 * bool (false = 0.0f, true = 1.0f)
120 * vector2 (the 2D length)
121 * vector3 (the 3D length)
122 * vector4 (the 4D length)
124 * @param[in] arg The argument for the condition
125 * @return A property condition function object
127 DALI_CORE_API PropertyCondition LessThanCondition( float arg );
130 * @brief GreaterThanCondition compares whether property is greater than arg.
133 * bool (false = 0.0f, true = 1.0f)
135 * vector2 (the 2D length)
136 * vector3 (the 3D length)
137 * vector4 (the 4D length)
139 * @param[in] arg The argument for the condition
140 * @return A property condition function object
142 DALI_CORE_API PropertyCondition GreaterThanCondition( float arg );
145 * @brief InsideCondition compares whether property is greater than arg0 and less than arg1.
148 * bool (false = 0.0f, true = 1.0f)
150 * vector2 (the 2D length)
151 * vector3 (the 3D length)
152 * vector4 (the 4D length)
154 * @param[in] arg0 The first argument for the condition
155 * @param[in] arg1 The second argument for the condition
156 * @return A property condition function object
158 DALI_CORE_API PropertyCondition InsideCondition( float arg0, float arg1 );
161 * @brief OutsideCondition compares whether property is less than arg0 or greater than arg1.
164 * bool (false = 0.0f, true = 1.0f)
166 * vector2 (the 2D length)
167 * vector3 (the 3D length)
168 * vector4 (the 4D length)
170 * @param[in] arg0 The first argument for the condition
171 * @param[in] arg1 The second argument for the condition
172 * @return A property condition function object
174 DALI_CORE_API PropertyCondition OutsideCondition( float arg0, float arg1 );
177 * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
181 * vector2 (the 2D length)
182 * vector3 (the 3D length)
183 * vector4 (the 4D length)
185 * @param[in] stepAmount The step size required to trigger condition
186 * @param[in] initialValue The initial value to step from
187 * @return A property condition function object
189 DALI_CORE_API PropertyCondition StepCondition( float stepAmount, float initialValue = 0.0f );
192 * @brief Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
196 * vector2 (the 2D length)
197 * vector3 (the 3D length)
198 * vector4 (the 4D length)
200 * @param[in] steps List of values to receive notifications for as a property crosses them
201 * @return A property condition function object
203 DALI_CORE_API PropertyCondition VariableStepCondition( const Dali::Vector<float>& steps );
210 #endif // DALI_PROPERTY_CONDITIONS_H