1 #ifndef __DALI_PROPERTY_VALUE_H__
2 #define __DALI_PROPERTY_VALUE_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/object/property.h>
26 #include <dali/public-api/math/rect.h>
40 * @brief A value-type representing a property value.
42 class DALI_IMPORT_API Property::Value
47 * @brief Default constructor.
49 * This creates a property with type Property::NONE.
54 * @brief Create a boolean property value.
56 * @param [in] boolValue A boolean value.
58 Value( bool boolValue );
61 * @brief Create an integer property value.
63 * @param [in] integerValue An integer value.
65 Value( int integerValue );
68 * @brief Create an unsigned integer property value.
70 * @param [in] unsignedIntegerValue An unsigned integer value.
72 Value( unsigned int unsignedIntegerValue );
75 * @brief Create a float property value.
77 * @param [in] floatValue A floating-point value.
79 Value( float floatValue );
82 * @brief Create a Vector2 property value.
84 * @param [in] vectorValue A vector of 2 floating-point values.
86 Value( const Vector2& vectorValue );
89 * @brief Create a Vector3 property value.
91 * @param [in] vectorValue A vector of 3 floating-point values.
93 Value( const Vector3& vectorValue );
96 * @brief Create a Vector4 property value.
98 * @param [in] vectorValue A vector of 4 floating-point values.
100 Value( const Vector4& vectorValue );
103 * @brief Create a Matrix3 property value.
105 * @param [in] matrixValue A matrix of 3x3 floating-point values.
107 Value( const Matrix3& matrixValue );
110 * @brief Create a Matrix property value.
112 * @param [in] matrixValue A matrix of 4x4 floating-point values.
114 Value( const Matrix& matrixValue );
117 * @brief Create a Vector4 property value.
119 * @param [in] vectorValue A vector of 4 integer values.
121 Value( const Rect<int>& vectorValue );
124 * @brief Create an orientation property value.
126 * @param [in] angleAxis An angle-axis representing the rotation.
128 Value( const AngleAxis& angleAxis );
131 * @brief Create an orientation property value.
133 * @param [in] quaternion A quaternion representing the rotation.
135 Value( const Quaternion& quaternion );
138 * @brief Create an string property value.
140 * @param [in] stringValue A string.
142 Value( const std::string& stringValue );
145 * @brief Create an string property value.
147 * @param [in] stringValue A string.
149 Value( const char* stringValue );
152 * @brief Copy a property value.
154 * @param [in] value The property value to copy.
156 Value( const Value& value );
159 * @brief Create an array property value.
161 * @param [in] arrayValue An array
163 Value( Property::Array& arrayValue );
166 * @brief Create a map property value.
168 * @param [in] mapValue An array
170 Value( Property::Map& mapValue );
173 * @brief Explicitly set a type and initialize it.
175 * @param [in] type The property value type.
177 explicit Value( Type type );
180 * @brief Assign a property value.
182 * @param [in] value The property value to assign from.
183 * @return a reference to this
185 Value& operator=( const Value& value );
188 * @brief Non-virtual destructor.
193 * @brief Query the type of this property value.
195 * @return The type ID.
197 Type GetType() const;
200 * @brief Retrieve a specific value.
202 * @pre GetType() returns the Property::Type for type T.
203 * @return A value of type T.
205 template <typename T>
206 T DALI_INTERNAL Get() const
214 * @brief Retrieve a boolean value.
216 * @pre GetType() returns Property::BOOLEAN.
217 * @param [out] boolValue On return, a boolean value.
219 void Get( bool& boolValue ) const;
222 * @brief Retrieve a floating-point value.
224 * @pre GetType() returns Property::FLOAT.
225 * @param [out] floatValue On return, a floating-point value.
227 void Get( float& floatValue ) const;
230 * @brief Retrieve an integer value.
232 * @pre GetType() returns Property::INTEGER.
233 * @param [out] integerValue On return, an integer value.
235 void Get( int& integerValue ) const;
238 * @brief Retrieve an unsigned integer value.
240 * @pre GetType() returns Property::UNSIGNED_INTEGER.
241 * @param [out] unsignedIntegerValue On return, an unsigned integer value.
243 void Get( unsigned int& unsignedIntegerValue ) const;
246 * @brief Retrieve an integer rectangle.
248 * @pre GetType() returns Property::RECTANGLE.
249 * @param [out] rect On return, an integer rectangle.
251 void Get( Rect<int>& rect ) const;
254 * @brief Retrieve a vector value.
256 * @pre GetType() returns Property::VECTOR2.
257 * @param [out] vectorValue On return, a vector value.
259 void Get( Vector2& vectorValue ) const;
262 * @brief Retrieve a vector value.
264 * @pre GetType() returns Property::VECTOR3.
265 * @param [out] vectorValue On return, a vector value.
267 void Get( Vector3& vectorValue ) const;
270 * @brief Retrieve a vector value.
272 * @pre GetType() returns Property::VECTOR4.
273 * @param [out] vectorValue On return, a vector value.
275 void Get( Vector4& vectorValue ) const;
278 * @brief Retrieve a matrix3 value.
280 * @pre GetType() returns Property::MATRIX3.
281 * @param [out] matrixValue On return, a matrix3 value.
283 void Get( Matrix3& matrixValue ) const;
286 * @brief Retrieve a matrix value.
288 * @pre GetType() returns Property::MATRIX.
289 * @param [out] matrixValue On return, a matrix value.
291 void Get( Matrix& matrixValue ) const;
294 * @brief Retrieve an angle-axis value.
296 * @pre GetType() returns Property::ROTATION.
297 * @param [out] angleAxisValue On return, a angle-axis value.
299 void Get( AngleAxis& angleAxisValue ) const;
302 * @brief Retrieve a quaternion value.
304 * @pre GetType() returns Property::ROTATION.
305 * @param [out] quaternionValue On return, a quaternion value.
307 void Get( Quaternion& quaternionValue ) const;
310 * @brief Retrieve an string property value.
312 * @pre GetType() returns Property::STRING.
313 * @param [out] stringValue A string.
315 void Get( std::string& stringValue ) const;
318 * @brief Retrieve an array property value.
320 * @pre GetType() returns Property::ARRAY.
321 * @param [out] arrayValue The array as a vector Property Values
323 void Get( Property::Array& arrayValue ) const;
326 * @brief Retrieve an map property value.
328 * @pre GetType() returns Property::MAP.
329 * @param [out] mapValue The map as vector of string and Property Value pairs
331 void Get( Property::Map& mapValue ) const;
334 * @brief return true if this property is a Property::MAP.
336 * @return return true if this property is a Property::MAP
340 return GetMap() != NULL;
344 * @brief Retrieve the Map API of the Property::Value without copying the contents of the map
346 * @return the Map API of the Property::Value or NULL if not a Property::Map
348 Property::Map* GetMap() const;
351 * @brief return true if this property is a Property::ARRAY.
353 * @return return true if this property is a Property::ARRAY
357 return GetArray() != NULL;
361 * @brief Retrieve the Array API of the Property::Value without copying the contents of the map
363 * @return the Array API of the Property::Value or NULL if not a Property::Array
365 Property::Array* GetArray() const;
370 friend std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
374 struct DALI_INTERNAL Impl;
375 Impl* mImpl; ///< Pointer to the implementation
380 * @brief Convert the value of the property into a string and append to an output stream.
382 * @param [in] ouputStream The output stream operator.
383 * @param [in] value The value to insert
384 * @return The output stream operator.
386 DALI_IMPORT_API std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
390 #endif // __DALI_PROPERTY_VALUE_H__