1 #ifndef __DALI_PROPERTY_H__
2 #define __DALI_PROPERTY_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.
26 #include <dali/public-api/common/vector-wrapper.h>
27 #include <dali/public-api/common/dali-common.h>
28 #include <dali/public-api/common/dali-vector.h>
33 * @addtogroup dali_core_object
40 * @brief An object + property pair.
43 struct DALI_IMPORT_API Property
46 * @brief A valid property index is zero or greater.
51 static const int INVALID_INDEX; ///< -1 is not a valid property index
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 Map of property values.
67 * @brief An Array of property values.
72 * @brief The property types supported.
77 NONE, ///< No type @SINCE_1_0.0
79 BOOLEAN, ///< A boolean type @SINCE_1_0.0
80 FLOAT, ///< A float type @SINCE_1_0.0
81 INTEGER, ///< An integer type @SINCE_1_0.0
82 VECTOR2, ///< a vector array of size=2 with float precision @SINCE_1_0.0
83 VECTOR3, ///< a vector array of size=3 with float precision @SINCE_1_0.0
84 VECTOR4, ///< a vector array of size=4 with float precision @SINCE_1_0.0
85 MATRIX3, ///< a 3x3 matrix @SINCE_1_0.0
86 MATRIX, ///< a 4x4 matrix @SINCE_1_0.0
87 RECTANGLE, ///< an integer array of size=4 @SINCE_1_0.0
88 ROTATION, ///< either a quaternion or an axis angle rotation @SINCE_1_0.0
89 STRING, ///< A string type @SINCE_1_0.0
90 ARRAY, ///< an array of Property::Value @SINCE_1_0.0
91 MAP ///< a string key to Property:value mapping @SINCE_1_0.0
95 * @brief The access mode for custom properties
100 READ_ONLY, ///< if the property is read-only @SINCE_1_0.0
101 READ_WRITE, ///< If the property is read/writeable @SINCE_1_0.0
102 ANIMATABLE, ///< If the property can be animated or constrained @SINCE_1_0.0
103 ACCESS_MODE_COUNT ///< The number of access modes @SINCE_1_0.0
108 * @brief Create a Property instance.
111 * @param [in] object A valid handle to the target object.
112 * @param [in] propertyIndex The index of a property.
114 Property( Handle& object, Property::Index propertyIndex );
118 * @brief Create a Property instance.
121 * @param [in] object A valid handle to the target object.
122 * @param [in] propertyIndex The index of a property.
123 * @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)
125 Property( Handle& object, Property::Index propertyIndex, int componentIndex );
128 * @brief Create a Property instance.
131 * @param [in] object A valid handle to the target object.
132 * @param [in] propertyName The property name.
133 * @note This performs a property index query and is therefore slower than
134 * constructing a Property directly with the index.
136 Property( Handle& object, const std::string& propertyName );
139 * @brief Create a Property instance.
142 * @param [in] object A valid handle to the target object.
143 * @param [in] propertyName The property name.
144 * @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)
145 * @note This performs a property index query and is therefore slower than
146 * constructing a Property directly with the index.
148 Property( Handle& object, const std::string& propertyName, int componentIndex );
151 * @brief Non-virtual destructor; Property is not intended as a base class.
156 Handle& object; ///< A valid handle to the target object.
158 Index propertyIndex; ///< The index of a property provided by object.
160 int componentIndex; ///< Index of a property sub component, for use with Vector2, Vector3 and Vector4, -1 if using main property
168 #endif // __DALI_PROPERTY_H__