Dali::Property Struct Reference

An object + property pair. More...

Classes
class	Array
	A Array of property values. More...
struct	Key
	A key type which can be either a std::string or a Property::Index. More...
class	Map
	A Map of property values, the key type could be String or Property::Index. More...
class	Value
	A value-type representing a property value. More...
Public Types
enum	Type
	Enumeration for the property types supported. More...
enum	AccessMode
	Enumeration for the access mode for custom properties. More...
typedef int	Index
	A valid property index is zero or greater.
typedef Dali::Vector< Index >	IndexContainer
	A vector of property indices.
Public Member Functions
	Property (Handle &object, Property::Index propertyIndex)
	Creates a Property instance.
	Property (Handle &object, Property::Index propertyIndex, int componentIndex)
	Creates a Property instance.
	Property (Handle &object, const std::string &propertyName)
	Creates a Property instance.
	Property (Handle &object, const std::string &propertyName, int componentIndex)
	Creates a Property instance.
	~Property ()
	Non-virtual destructor; Property is not intended as a base class.
Public Attributes
Handle &	object
	A valid handle to the target object.
Index	propertyIndex
	The index of a property provided by object.
int	componentIndex
	Index of a property sub component, for use with Vector2, Vector3 and Vector4, -1 if using main property.
Static Public Attributes
static const int	INVALID_INDEX
static const int	INVALID_KEY
static const int	INVALID_COMPONENT_INDEX

---

Detailed Description

An object + property pair.

Since:

2.4, DALi version 1.0.0

---

Member Typedef Documentation

typedef int Dali::Property::Index

A valid property index is zero or greater.

Since:

2.4, DALi version 1.0.0

typedef Dali::Vector< Index > Dali::Property::IndexContainer

A vector of property indices.

Since:

2.4, DALi version 1.0.0

---

Member Enumeration Documentation

enum Dali::Property::AccessMode

Enumeration for the access mode for custom properties.

Since:

2.4, DALi version 1.0.0

Enumerator:

READ_ONLY	if the property is read-only Since: 2.4, DALi version 1.0.0
READ_WRITE	If the property is read/writeable. Since: 2.4, DALi version 1.0.0
ANIMATABLE	If the property can be animated or constrained. Since: 2.4, DALi version 1.0.0
ACCESS_MODE_COUNT	The number of access modes. Since: 2.4, DALi version 1.0.0

enum Dali::Property::Type

Enumeration for the property types supported.

Since:

2.4, DALi version 1.0.0

Enumerator:

NONE	No type. Since: 2.4, DALi version 1.0.0
BOOLEAN	A boolean type. Since: 2.4, DALi version 1.0.0
FLOAT	A float type. Since: 2.4, DALi version 1.0.0
INTEGER	An integer type. Since: 2.4, DALi version 1.0.0
VECTOR2	a vector array of size=2 with float precision Since: 2.4, DALi version 1.0.0
VECTOR3	a vector array of size=3 with float precision Since: 2.4, DALi version 1.0.0
VECTOR4	a vector array of size=4 with float precision Since: 2.4, DALi version 1.0.0
MATRIX3	a 3x3 matrix Since: 2.4, DALi version 1.0.0
MATRIX	a 4x4 matrix Since: 2.4, DALi version 1.0.0
RECTANGLE	an integer array of size=4 Since: 2.4, DALi version 1.0.0
ROTATION	either a quaternion or an axis angle rotation Since: 2.4, DALi version 1.0.0
STRING	A string type. Since: 2.4, DALi version 1.0.0
ARRAY	an array of Property::Value Since: 2.4, DALi version 1.0.0
MAP	a string key to Property:value mapping Since: 2.4, DALi version 1.0.0
EXTENTS	a collection of 4 x uint16_t Since: 4.0, DALi version 1.2.62

---

Constructor & Destructor Documentation

Dali::Property::Property	(	Handle &	object,
		Property::Index	propertyIndex
	)

Creates a Property instance.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]	object	A valid handle to the target object
[in]	propertyIndex	The index of a property

Dali::Property::Property	(	Handle &	object,
		Property::Index	propertyIndex,
		int	componentIndex
	)

Creates a Property instance.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]	object	A valid handle to the target object.
[in]	propertyIndex	The index of a property.
[in]	componentIndex	Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)

Dali::Property::Property	(	Handle &	object,
		const std::string &	propertyName
	)

Creates a Property instance.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]	object	A valid handle to the target object
[in]	propertyName	The property name

Note:

This performs a property index query and is therefore slower than constructing a Property directly with the index.

Dali::Property::Property	(	Handle &	object,
		const std::string &	propertyName,
		int	componentIndex
	)

Creates a Property instance.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]	object	A valid handle to the target object
[in]	propertyName	The property name
[in]	componentIndex	Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)

Note:

This performs a property index query and is therefore slower than constructing a Property directly with the index.

Dali::Property::~Property

(

)

Non-virtual destructor; Property is not intended as a base class.

Since:

2.4, DALi version 1.0.0

---

Member Data Documentation

const int Dali::Property::INVALID_COMPONENT_INDEX [static]

-1 is not a valid property index

const int Dali::Property::INVALID_INDEX [static]

-1 is not a valid property index

const int Dali::Property::INVALID_KEY [static]

-1 is not a valid property key