1 #ifndef __DALI_PROPERTY_INPUT_H__
2 #define __DALI_PROPERTY_INPUT_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.
22 #include <dali/public-api/object/property.h>
27 * @addtogroup dali-core-object
39 * @brief An abstract interface for receiving property values.
41 class DALI_IMPORT_API PropertyInput
45 class Extension; ///< Forward declare future extension interface
48 * @brief Virtual destructor.
50 virtual ~PropertyInput() = 0;
53 * @brief Query the type of property input.
55 * @return The property type.
57 virtual Property::Type GetType() const = 0;
60 * @brief Retrieve a boolean value.
62 * @pre GetType() returns Property::BOOLEAN.
63 * @return The boolean value.
65 virtual const bool& GetBoolean() const = 0;
68 * @brief Retrieve a float value.
70 * @pre GetType() returns Property::FLOAT.
71 * @return The float value.
73 virtual const float& GetFloat() const = 0;
76 * @brief Retrieve an integer value.
78 * @pre GetType() returns Property::INTEGER.
79 * @return The integer value.
81 virtual const int& GetInteger() const = 0;
84 * @brief Retrieve a Vector2 value.
86 * @pre GetType() returns Property::VECTOR2.
87 * @return The Vector2 value.
89 virtual const Vector2& GetVector2() const = 0;
92 * @brief Retrieve a Vector3 value.
94 * @pre GetType() returns Property::VECTOR3.
95 * @return The Vector3 value.
97 virtual const Vector3& GetVector3() const = 0;
100 * @brief Retrieve a Vector4 value.
102 * @pre GetType() returns Property::VECTOR4.
103 * @return The Vector4 value.
105 virtual const Vector4& GetVector4() const = 0;
108 * @brief Retrieve a Matrix (3x3) value.
110 * @pre GetType() returns Property::Matrix3.
111 * @return The Matrix value.
113 virtual const Matrix3& GetMatrix3() const = 0;
116 * @brief Retrieve a Matrix (4x4) value.
118 * @pre GetType() returns Property::Matrix4.
119 * @return The Matrix value.
121 virtual const Matrix& GetMatrix() const = 0;
124 * @brief Retrieve a Quaternion value.
126 * @pre GetType() returns Property::Quaternion.
127 * @return The Quaternion value.
129 virtual const Quaternion& GetQuaternion() const = 0;
132 * Retrieve the extension for the PropertyInput
134 * @return The extension if available, NULL otherwise
136 virtual Extension* GetExtension()
147 #endif // __DALI_PROPERTY_INPUT_H__