1 #ifndef __DALI_PROPERTY_H__
2 #define __DALI_PROPERTY_H__
5 * Copyright (c) 2016 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.
26 #include <dali/public-api/common/dali-common.h>
27 #include <dali/public-api/common/dali-vector.h>
32 * @addtogroup dali_core_object
39 * @brief An object + property pair.
42 struct DALI_IMPORT_API Property
45 * @brief A valid property index is zero or greater.
50 static const int INVALID_INDEX; ///< -1 is not a valid property index
51 static const int INVALID_KEY; ///< -1 is not a valid property key
52 static const int INVALID_COMPONENT_INDEX; ///< -1 is not a valid property index
54 typedef Dali::Vector< Index > IndexContainer; ///< A vector of property indices @SINCE_1_0.0
57 * @brief A value-type representing a property value.
62 * @brief A Key used by Map
67 * @brief A Map of property values.
72 * @brief An Array of property values.
77 * @brief Enumeration for the property types supported.
82 NONE, ///< No type @SINCE_1_0.0
84 BOOLEAN, ///< A boolean type @SINCE_1_0.0
85 FLOAT, ///< A float type @SINCE_1_0.0
86 INTEGER, ///< An integer type @SINCE_1_0.0
87 VECTOR2, ///< a vector array of size=2 with float precision @SINCE_1_0.0
88 VECTOR3, ///< a vector array of size=3 with float precision @SINCE_1_0.0
89 VECTOR4, ///< a vector array of size=4 with float precision @SINCE_1_0.0
90 MATRIX3, ///< a 3x3 matrix @SINCE_1_0.0
91 MATRIX, ///< a 4x4 matrix @SINCE_1_0.0
92 RECTANGLE, ///< an integer array of size=4 @SINCE_1_0.0
93 ROTATION, ///< either a quaternion or an axis angle rotation @SINCE_1_0.0
94 STRING, ///< A string type @SINCE_1_0.0
95 ARRAY, ///< an array of Property::Value @SINCE_1_0.0
96 MAP ///< a string key to Property:value mapping @SINCE_1_0.0
100 * @brief Enumeration for the access mode for custom properties.
105 READ_ONLY, ///< if the property is read-only @SINCE_1_0.0
106 READ_WRITE, ///< If the property is read/writeable @SINCE_1_0.0
107 ANIMATABLE, ///< If the property can be animated or constrained @SINCE_1_0.0
108 ACCESS_MODE_COUNT ///< The number of access modes @SINCE_1_0.0
113 * @brief Creates a Property instance.
116 * @param[in] object A valid handle to the target object
117 * @param[in] propertyIndex The index of a property
119 Property( Handle& object, Property::Index propertyIndex );
123 * @brief Creates a Property instance.
126 * @param[in] object A valid handle to the target object.
127 * @param[in] propertyIndex The index of a property.
128 * @param[in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
130 Property( Handle& object, Property::Index propertyIndex, int componentIndex );
133 * @brief Creates a Property instance.
136 * @param[in] object A valid handle to the target object
137 * @param[in] propertyName The property name
138 * @note This performs a property index query and is therefore slower than
139 * constructing a Property directly with the index.
141 Property( Handle& object, const std::string& propertyName );
144 * @brief Creates a Property instance.
147 * @param[in] object A valid handle to the target object
148 * @param[in] propertyName The property name
149 * @param[in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
150 * @note This performs a property index query and is therefore slower than
151 * constructing a Property directly with the index.
153 Property( Handle& object, const std::string& propertyName, int componentIndex );
156 * @brief Non-virtual destructor; Property is not intended as a base class.
161 Handle& object; ///< A valid handle to the target object.
163 Index propertyIndex; ///< The index of a property provided by object.
165 int componentIndex; ///< Index of a property sub component, for use with Vector2, Vector3 and Vector4, -1 if using main property
173 #endif // __DALI_PROPERTY_H__