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
42 * @brief Virtual destructor.
44 virtual ~PropertyInput() = 0;
47 * @brief Query the type of property input.
49 * @return The property type.
51 virtual Property::Type GetType() const = 0;
54 * @brief Retrieve a boolean value.
56 * @pre GetType() returns Property::BOOLEAN.
57 * @return The boolean value.
59 virtual const bool& GetBoolean() const = 0;
62 * @brief Retrieve a float value.
64 * @pre GetType() returns Property::FLOAT.
65 * @return The float value.
67 virtual const float& GetFloat() const = 0;
70 * @brief Retrieve an integer value.
72 * @pre GetType() returns Property::INTEGER.
73 * @return The integer value.
75 virtual const int& GetInteger() const = 0;
78 * @brief Retrieve a Vector2 value.
80 * @pre GetType() returns Property::VECTOR2.
81 * @return The Vector2 value.
83 virtual const Vector2& GetVector2() const = 0;
86 * @brief Retrieve a Vector3 value.
88 * @pre GetType() returns Property::VECTOR3.
89 * @return The Vector3 value.
91 virtual const Vector3& GetVector3() const = 0;
94 * @brief Retrieve a Vector4 value.
96 * @pre GetType() returns Property::VECTOR4.
97 * @return The Vector4 value.
99 virtual const Vector4& GetVector4() const = 0;
102 * @brief Retrieve a Matrix (3x3) value.
104 * @pre GetType() returns Property::Matrix3.
105 * @return The Matrix value.
107 virtual const Matrix3& GetMatrix3() const = 0;
110 * @brief Retrieve a Matrix (4x4) value.
112 * @pre GetType() returns Property::Matrix4.
113 * @return The Matrix value.
115 virtual const Matrix& GetMatrix() const = 0;
118 * @brief Retrieve a Quaternion value.
120 * @pre GetType() returns Property::Quaternion.
121 * @return The Quaternion value.
123 virtual const Quaternion& GetQuaternion() const = 0;
128 #endif // __DALI_PROPERTY_INPUT_H__