A value-type representing a property value. More...

Public Member Functions
	Value ()
	Default constructor.
	Value (bool boolValue)
	Create a boolean property value.
	Value (int integerValue)
	Create an integer property value.
	Value (float floatValue)
	Create a float property value.
	Value (const Vector2 &vectorValue)
	Create a Vector2 property value.
	Value (const Vector3 &vectorValue)
	Create a Vector3 property value.
	Value (const Vector4 &vectorValue)
	Create a Vector4 property value.
	Value (const Matrix3 &matrixValue)
	Create a Matrix3 property value.
	Value (const Matrix &matrixValue)
	Create a Matrix property value.
	Value (const Rect< int > &vectorValue)
	Create a Vector4 property value.
	Value (const AngleAxis &angleAxis)
	Create an orientation property value.
	Value (const Quaternion &quaternion)
	Create an orientation property value.
	Value (const std::string &stringValue)
	Create an string property value.
	Value (const char *stringValue)
	Create an string property value.
	Value (Property::Array &arrayValue)
	Create an array property value.
	Value (Property::Map &mapValue)
	Create a map property value.
	Value (Type type)
	Explicitly set a type and initialize it.
	Value (const Value &value)
	Copy constructor.
Value &	operator= (const Value &value)
	Assign a property value.
	~Value ()
	Non-virtual destructor.
Type	GetType () const
	Query the type of this property value.
bool	Get (bool &boolValue) const
	Retrieve a boolean value.
bool	Get (float &floatValue) const
	Retrieve a floating-point value.
bool	Get (int &integerValue) const
	Retrieve an integer value.
bool	Get (Rect< int > &rect) const
	Retrieve an integer rectangle.
bool	Get (Vector2 &vectorValue) const
	Retrieve a vector value.
bool	Get (Vector3 &vectorValue) const
	Retrieve a vector value.
bool	Get (Vector4 &vectorValue) const
	Retrieve a vector value.
bool	Get (Matrix3 &matrixValue) const
	Retrieve a matrix3 value.
bool	Get (Matrix &matrixValue) const
	Retrieve a matrix value.
bool	Get (AngleAxis &angleAxisValue) const
	Retrieve an angle-axis value.
bool	Get (Quaternion &quaternionValue) const
	Retrieve a quaternion value.
bool	Get (std::string &stringValue) const
	Retrieve an string property value.
bool	Get (Property::Array &arrayValue) const
	Retrieve an array property value.
bool	Get (Property::Map &mapValue) const
	Retrieve an map property value.
Property::Array *	GetArray () const
	Retrieve the Array API of the Property::Value without copying the contents of the map.
Property::Map *	GetMap () const
	Retrieve the Map API of the Property::Value without copying the contents of the map.
Friends
std::ostream &	operator<< (std::ostream &ouputStream, const Property::Value &value)
	output to stream

Detailed Description

A value-type representing a property value.

Since :: 2.4

Constructor & Destructor Documentation

Dali::Property::Value::Value ( )

Default constructor.

This creates a property with type Property::NONE.

Since :: 2.4

Dali::Property::Value::Value ( bool boolValue )

Create a boolean property value.

Since :: 2.4

Parameters:

[in] boolValue A boolean value.

Dali::Property::Value::Value ( int integerValue )

Create an integer property value.

Since :: 2.4

Parameters:

[in] integerValue An integer value.

Dali::Property::Value::Value ( float floatValue )

Create a float property value.

Since :: 2.4

Parameters:

[in] floatValue A floating-point value.

Dali::Property::Value::Value ( const Vector2 & vectorValue )

Create a Vector2 property value.

Since :: 2.4

Parameters:

[in] vectorValue A vector of 2 floating-point values.

Dali::Property::Value::Value ( const Vector3 & vectorValue )

Create a Vector3 property value.

Since :: 2.4

Parameters:

[in] vectorValue A vector of 3 floating-point values.

Dali::Property::Value::Value ( const Vector4 & vectorValue )

Create a Vector4 property value.

Since :: 2.4

Parameters:

[in] vectorValue A vector of 4 floating-point values.

Dali::Property::Value::Value ( const Matrix3 & matrixValue )

Create a Matrix3 property value.

Since :: 2.4

Parameters:

[in] matrixValue A matrix of 3x3 floating-point values.

Dali::Property::Value::Value ( const Matrix & matrixValue )

Create a Matrix property value.

Since :: 2.4

Parameters:

[in] matrixValue A matrix of 4x4 floating-point values.

Dali::Property::Value::Value ( const Rect< int > & vectorValue )

Create a Vector4 property value.

Since :: 2.4

Parameters:

[in] vectorValue A vector of 4 integer values.

Dali::Property::Value::Value ( const AngleAxis & angleAxis )

Create an orientation property value.

Since :: 2.4

Parameters:

[in] angleAxis An angle-axis representing the rotation.

Dali::Property::Value::Value ( const Quaternion & quaternion )

Create an orientation property value.

Since :: 2.4

Parameters:

[in] quaternion A quaternion representing the rotation.

Dali::Property::Value::Value ( const std::string & stringValue )

Create an string property value.

Since :: 2.4

Parameters:

[in] stringValue A string.

Dali::Property::Value::Value ( const char * stringValue )

Create an string property value.

Since :: 2.4

Parameters:

[in] stringValue A string.

Dali::Property::Value::Value ( Property::Array & arrayValue )

Create an array property value.

Since :: 2.4

Parameters:

[in] arrayValue An array

Dali::Property::Value::Value ( Property::Map & mapValue )

Create a map property value.

Since :: 2.4

Parameters:

[in] mapValue An array

Dali::Property::Value::Value ( Type type ) [explicit]

Explicitly set a type and initialize it.

Since :: 2.4

Parameters:

[in] type The property value type.

Dali::Property::Value::Value ( const Value & value )

Copy constructor.

Since :: 2.4

Parameters:

[in] value The property value to copy.

Dali::Property::Value::~Value ( )

Non-virtual destructor.

This class is not a base class.

Since :: 2.4

Member Function Documentation

bool Dali::Property::Value::Get ( bool & boolValue ) const

Retrieve a boolean value.

Since :: 2.4

Parameters:

[out] boolValue On return, a boolean value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::BOOLEAN.

bool Dali::Property::Value::Get ( float & floatValue ) const

Retrieve a floating-point value.

Since :: 2.4

Parameters:

[out] floatValue On return, a floating-point value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::FLOAT.

bool Dali::Property::Value::Get ( int & integerValue ) const

Retrieve an integer value.

Since :: 2.4

Parameters:

[out] integerValue On return, an integer value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::INTEGER.

bool Dali::Property::Value::Get ( Rect< int > & rect ) const

Retrieve an integer rectangle.

Since :: 2.4

Parameters:

[out] rect On return, an integer rectangle.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::RECTANGLE.

bool Dali::Property::Value::Get ( Vector2 & vectorValue ) const

Retrieve a vector value.

Since :: 2.4

Parameters:

[out] vectorValue On return, a vector value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::VECTOR2.

bool Dali::Property::Value::Get ( Vector3 & vectorValue ) const

Retrieve a vector value.

Since :: 2.4

Parameters:

[out] vectorValue On return, a vector value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::VECTOR3.

bool Dali::Property::Value::Get ( Vector4 & vectorValue ) const

Retrieve a vector value.

Since :: 2.4

Parameters:

[out] vectorValue On return, a vector value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::VECTOR4.

bool Dali::Property::Value::Get ( Matrix3 & matrixValue ) const

Retrieve a matrix3 value.

Since :: 2.4

Parameters:

[out] matrixValue On return, a matrix3 value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::MATRIX3.

bool Dali::Property::Value::Get ( Matrix & matrixValue ) const

Retrieve a matrix value.

Since :: 2.4

Parameters:

[out] matrixValue On return, a matrix value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::MATRIX.

bool Dali::Property::Value::Get ( AngleAxis & angleAxisValue ) const

Retrieve an angle-axis value.

Since :: 2.4

Parameters:

[out] angleAxisValue On return, a angle-axis value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::ROTATION.

bool Dali::Property::Value::Get ( Quaternion & quaternionValue ) const

Retrieve a quaternion value.

Since :: 2.4

Parameters:

[out] quaternionValue On return, a quaternion value.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::ROTATION.

bool Dali::Property::Value::Get ( std::string & stringValue ) const

Retrieve an string property value.

Since :: 2.4

Parameters:

[out] stringValue A string.

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::STRING.

bool Dali::Property::Value::Get ( Property::Array & arrayValue ) const

Retrieve an array property value.

Since :: 2.4

Parameters:

[out] arrayValue The array as a vector Property Values

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::ARRAY.

bool Dali::Property::Value::Get ( Property::Map & mapValue ) const

Retrieve an map property value.

Since :: 2.4

Parameters:

[out] mapValue The map as vector of string and Property Value pairs

Returns:: true if the value is successfully retrieved, false if the type is not convertible

Precondition:: GetType() returns Property::MAP.

Property::Array* Dali::Property::Value::GetArray ( ) const

Retrieve the Array API of the Property::Value without copying the contents of the map.

Since :: 2.4

Returns:: the Array API of the Property::Value or NULL if not a Property::Array

Property::Map* Dali::Property::Value::GetMap ( ) const

Retrieve the Map API of the Property::Value without copying the contents of the map.

Since :: 2.4

Returns:: the Map API of the Property::Value or NULL if not a Property::Map

Type Dali::Property::Value::GetType ( ) const

Query the type of this property value.

Since :: 2.4

Returns:: The type ID.

Value& Dali::Property::Value::operator= ( const Value & value )

Assign a property value.

Since :: 2.4

Parameters:

[in] value The property value to assign from.

Returns:: a reference to this

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	ouputStream,
		const Property::Value &	value
	)		`[friend]`

output to stream

Since :: 2.4

Since :: 2.4

Parameters:

[in]	ouputStream	The output stream operator.
[in]	value	The value to insert

Returns:: The output stream operator.

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation