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>
35 * @brief An abstract interface for receiving property values.
37 class DALI_IMPORT_API PropertyInput
41 class Extension; ///< Forward declare future extension interface
44 * @brief Virtual destructor.
46 virtual ~PropertyInput() = 0;
49 * @brief Query the type of property input.
51 * @return The property type.
53 virtual Property::Type GetType() const = 0;
56 * @brief Retrieve a boolean value.
58 * @pre GetType() returns Property::BOOLEAN.
59 * @return The boolean value.
61 virtual const bool& GetBoolean() const = 0;
64 * @brief Retrieve a float value.
66 * @pre GetType() returns Property::FLOAT.
67 * @return The float value.
69 virtual const float& GetFloat() const = 0;
72 * @brief Retrieve an integer value.
74 * @pre GetType() returns Property::INTEGER.
75 * @return The integer value.
77 virtual const int& GetInteger() const = 0;
80 * @brief Retrieve a Vector2 value.
82 * @pre GetType() returns Property::VECTOR2.
83 * @return The Vector2 value.
85 virtual const Vector2& GetVector2() const = 0;
88 * @brief Retrieve a Vector3 value.
90 * @pre GetType() returns Property::VECTOR3.
91 * @return The Vector3 value.
93 virtual const Vector3& GetVector3() const = 0;
96 * @brief Retrieve a Vector4 value.
98 * @pre GetType() returns Property::VECTOR4.
99 * @return The Vector4 value.
101 virtual const Vector4& GetVector4() const = 0;
104 * @brief Retrieve a Matrix (3x3) value.
106 * @pre GetType() returns Property::Matrix3.
107 * @return The Matrix value.
109 virtual const Matrix3& GetMatrix3() const = 0;
112 * @brief Retrieve a Matrix (4x4) value.
114 * @pre GetType() returns Property::Matrix4.
115 * @return The Matrix value.
117 virtual const Matrix& GetMatrix() const = 0;
120 * @brief Retrieve a Quaternion value.
122 * @pre GetType() returns Property::Quaternion.
123 * @return The Quaternion value.
125 virtual const Quaternion& GetQuaternion() const = 0;
128 * Retrieve the extension for the PropertyInput
130 * @return The extension if available, NULL otherwise
132 virtual Extension* GetExtension()
140 #endif // __DALI_PROPERTY_INPUT_H__