Dali::PropertyInput Class Reference

An abstract interface for receiving property values. More...

Public Member Functions
virtual	~PropertyInput ()=0
	Forward declare future extension interface.
virtual Property::Type	GetType () const =0
	Queries the type of property input.
virtual const bool &	GetBoolean () const =0
	Retrieves a boolean value.
virtual const float &	GetFloat () const =0
	Retrieves a float value.
virtual const int &	GetInteger () const =0
	Retrieves an integer value.
virtual const Vector2 &	GetVector2 () const =0
	Retrieves a Vector2 value.
virtual const Vector3 &	GetVector3 () const =0
	Retrieves a Vector3 value.
virtual const Vector4 &	GetVector4 () const =0
	Retrieves a Vector4 value.
virtual const Matrix3 &	GetMatrix3 () const =0
	Retrieves a Matrix (3x3) value.
virtual const Matrix &	GetMatrix () const =0
	Retrieves a Matrix (4x4) value.
virtual const Quaternion &	GetQuaternion () const =0
	Retrieves a Quaternion value.
virtual Extension *	GetExtension ()
	Retrieves the extension for the PropertyInput.

---

Detailed Description

An abstract interface for receiving property values.

Since:

2.4, DALi version 1.0.0

---

Constructor & Destructor Documentation

virtual Dali::PropertyInput::~PropertyInput

(

)

[pure virtual]

Forward declare future extension interface.

Virtual destructor.

Since:

2.4, DALi version 1.0.0

---

Member Function Documentation

virtual const bool& Dali::PropertyInput::GetBoolean

(

)

const [pure virtual]

Retrieves a boolean value.

Since:

2.4, DALi version 1.0.0

Returns:

The boolean value

Precondition:

GetType() returns Property::BOOLEAN.

virtual Extension* Dali::PropertyInput::GetExtension

(

)

[virtual]

Retrieves the extension for the PropertyInput.

Since:

2.4, DALi version 1.0.0

Returns:

The extension if available, NULL otherwise

virtual const float& Dali::PropertyInput::GetFloat

(

)

const [pure virtual]

Retrieves a float value.

Since:

2.4, DALi version 1.0.0

Returns:

The float value

Precondition:

GetType() returns Property::FLOAT.

virtual const int& Dali::PropertyInput::GetInteger

(

)

const [pure virtual]

Retrieves an integer value.

Since:

2.4, DALi version 1.0.0

Returns:

The integer value

Precondition:

GetType() returns Property::INTEGER.

virtual const Matrix& Dali::PropertyInput::GetMatrix

(

)

const [pure virtual]

Retrieves a Matrix (4x4) value.

Since:

2.4, DALi version 1.0.0

Returns:

The Matrix value

Precondition:

GetType() returns Property::Matrix4.

virtual const Matrix3& Dali::PropertyInput::GetMatrix3

(

)

const [pure virtual]

Retrieves a Matrix (3x3) value.

Since:

2.4, DALi version 1.0.0

Returns:

The Matrix value

Precondition:

GetType() returns Property::Matrix3.

virtual const Quaternion& Dali::PropertyInput::GetQuaternion

(

)

const [pure virtual]

Retrieves a Quaternion value.

Since:

2.4, DALi version 1.0.0

Returns:

The Quaternion value

Precondition:

GetType() returns Property::Quaternion.

virtual Property::Type Dali::PropertyInput::GetType

(

)

const [pure virtual]

Queries the type of property input.

Since:

2.4, DALi version 1.0.0

Returns:

The property type

virtual const Vector2& Dali::PropertyInput::GetVector2

(

)

const [pure virtual]

Retrieves a Vector2 value.

Since:

2.4, DALi version 1.0.0

Returns:

The Vector2 value

Precondition:

GetType() returns Property::VECTOR2.

virtual const Vector3& Dali::PropertyInput::GetVector3

(

)

const [pure virtual]

Retrieves a Vector3 value.

Since:

2.4, DALi version 1.0.0

Returns:

The Vector3 value

Precondition:

GetType() returns Property::VECTOR3.

virtual const Vector4& Dali::PropertyInput::GetVector4

(

)

const [pure virtual]

Retrieves a Vector4 value.

Since:

2.4, DALi version 1.0.0

Returns:

The Vector4 value

Precondition:

GetType() returns Property::VECTOR4.