1 #ifndef __DALI_HANDLE_H__
2 #define __DALI_HANDLE_H__
5 * Copyright (c) 2015 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.
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/object/property-types.h>
28 #include <dali/public-api/object/property-value.h>
29 #include <dali/public-api/object/property-notification-declarations.h>
30 #include <dali/public-api/object/ref-object.h>
36 class PropertyNotification;
37 class PropertyCondition;
39 namespace Internal DALI_INTERNAL
45 * @brief Dali::Handle is a handle to an internal property owning Dali object that can have constraints applied to it.
47 class DALI_IMPORT_API Handle : public BaseHandle
52 * @brief An Handle's capabilities can be queried using Handle::Supports()
57 * @brief Some objects support dynamic property creation at run-time.
59 * New properties are registered by calling RegisterProperty() with an unused property name.
61 DYNAMIC_PROPERTIES = 0x01,
67 * @brief This constructor is used by Dali New() methods.
69 * @param [in] handle A pointer to a newly allocated Dali resource
71 Handle( Dali::Internal::Object* handle );
74 * @brief This constructor provides an uninitialized Dali::Handle.
76 * This should be initialized with a Dali New() method before use.
77 * Methods called on an uninitialized Dali::Handle will assert.
79 * Handle handle; // uninitialized
80 * handle.SomeMethod(); // unsafe! This will assert
82 * handle = SomeClass::New(); // now initialized
83 * handle.SomeMethod(); // safe
89 * @brief Create a new object.
91 * @return A handle to a newly allocated object.
96 * @brief Dali::Handle is intended as a base class
98 * This is non-virtual since derived Handle types must not contain data or virtual methods.
103 * @brief This copy constructor is required for (smart) pointer semantics.
105 * @param [in] handle A reference to the copied handle
107 Handle( const Handle& handle );
110 * @brief This assignment operator is required for (smart) pointer semantics.
112 * @param [in] rhs A reference to the copied handle
113 * @return A reference to this
115 Handle& operator=( const Handle& rhs );
118 * @brief Downcast to a handle.
120 * If not the returned handle is left uninitialized.
121 * @param[in] handle to An object
122 * @return handle or an uninitialized handle
124 static Handle DownCast( BaseHandle handle );
127 * @brief Query whether an handle supports a given capability.
129 * @param[in] capability The queried capability.
130 * @return True if the capability is supported.
132 bool Supports( Capability capability ) const;
137 * @brief Query how many properties are provided by an handle.
139 * This may vary between instances of a class, if dynamic properties are supported.
140 * @return The number of properties.
142 unsigned int GetPropertyCount() const;
145 * @brief Query the name of a property.
147 * @param [in] index The index of the property.
148 * @return The name of the property.
150 std::string GetPropertyName( Property::Index index ) const;
153 * @brief Query the index of a property.
154 * Returns the first property index that matches the given name exactly.
156 * @param [in] name The name of the property.
157 * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name.
159 Property::Index GetPropertyIndex( const std::string& name ) const;
162 * @brief Query whether a property can be set using SetProperty().
164 * @pre Property::INVALID_INDEX < index.
165 * @param [in] index The index of the property.
166 * @return True if the property is writable.
168 bool IsPropertyWritable( Property::Index index ) const;
171 * @brief Query whether a writable property can be the target of an animation or constraint.
173 * @param [in] index The index of the property.
174 * @return True if the property is animatable.
176 bool IsPropertyAnimatable( Property::Index index ) const;
179 * @brief Query whether a property can be used as in input to a constraint.
181 * @param [in] index The index of the property.
182 * @return True if the property can be used as a constraint input.
184 bool IsPropertyAConstraintInput( Property::Index index ) const;
187 * @brief Query the type of a property.
189 * @param [in] index The index of the property.
190 * @return The type of the property.
192 Property::Type GetPropertyType( Property::Index index ) const;
195 * @brief Set the value of an existing property.
197 * Property should be write-able. Setting a read-only property is a no-op.
198 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
199 * @param [in] index The index of the property.
200 * @param [in] propertyValue The new value of the property.
202 void SetProperty( Property::Index index, const Property::Value& propertyValue );
205 * @brief Register a new animatable property.
207 * @pre The object supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
208 * Property names are expected to be unique, but this is not enforced.
209 * Property indices are unique to each registered custom property in a given object.
210 * returns Property::INVALID_INDEX if registration failed. This can happen if you try to register
211 * animatable property on an object that does not have scene graph object.
212 * @note Only the following types can be animated:
213 * - Property::BOOLEAN
215 * - Property::INTEGER
216 * - Property::VECTOR2
217 * - Property::VECTOR3
218 * - Property::VECTOR4
219 * - Property::MATRIX3
221 * - Property::ROTATION
222 * @param [in] name The name of the property.
223 * @param [in] propertyValue The new value of the property.
224 * @return The index of the property or Property::INVALID_INDEX if registration failed
226 Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
229 * @brief Register a new property.
231 * Properties can be set as non animatable using property attributes.
232 * @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
233 * @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
234 * @note Only the following types can be animated:
235 * - Property::BOOLEAN
237 * - Property::INTEGER
238 * - Property::VECTOR2
239 * - Property::VECTOR3
240 * - Property::VECTOR4
241 * - Property::MATRIX3
243 * - Property::ROTATION
244 * @param [in] name The name of the property.
245 * @param [in] propertyValue The new value of the property.
246 * @param [in] accessMode The property access mode (writable, animatable etc).
247 * @return The index of the property
249 Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
252 * @brief Retrieve a property value.
254 * @param [in] index The index of the property.
255 * @return The property value.
257 Property::Value GetProperty( Property::Index index ) const;
260 * @brief Convenience function for obtaining a property of a known type.
262 * @pre The property types match i.e. PropertyTypes::Get<T>() is equal to GetPropertyType(index).
263 * @param [in] index The index of the property.
264 * @return The property value.
266 template <typename T>
267 T GetProperty( Property::Index index ) const
269 Property::Value value = GetProperty(index);
271 return T( value.Get<T>() );
275 * @brief Retrieve all the property indices for this object (including custom properties).
277 * @param[out] indices A container of property indices for this object.
278 * @note the added container is cleared
280 void GetPropertyIndices( Property::IndexContainer& indices ) const;
283 * @brief Add a property notification to this object.
285 * @param [in] index The index of the property.
286 * @param [in] condition The notification will be triggered when this condition is satisfied.
288 * @return A handle to the newly created PropertyNotification
290 PropertyNotification AddPropertyNotification( Property::Index index,
291 const PropertyCondition& condition );
294 * @brief Add a property notification to this object.
296 * @param [in] index The index of the property.
297 * @param [in] componentIndex Index to the component of a complex property such as a Vector
298 * @param [in] condition The notification will be triggered when this condition is satisfied.
300 * @return A handle to the newly created PropertyNotification
302 PropertyNotification AddPropertyNotification( Property::Index index,
304 const PropertyCondition& condition );
307 * @brief Remove a property notification from this object.
309 * @param [in] propertyNotification The propertyNotification to be removed.
311 void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
314 * @brief Remove all property notifications from this object.
316 void RemovePropertyNotifications();
321 * @brief Remove all constraints from an Object.
323 * @pre The object has been initialized.
325 void RemoveConstraints();
328 * @brief Remove all the constraint from the Object with a matching tag.
330 * @pre The Object has been initialized.
331 * @param[in] tag The tag of the constraints which will be removed
333 void RemoveConstraints( unsigned int tag );
336 namespace WeightObject
339 DALI_IMPORT_API extern const Property::Index WEIGHT; ///< name "weight", type FLOAT
342 * @brief Convenience function to create an object with a custom "weight" property.
344 * @return A handle to a newly allocated object.
346 DALI_IMPORT_API Handle New();
348 } // namespace WeightObject
352 #endif // __DALI_HANDLE_H__