Tizen Native API  5.5

Classes for the handle/body pattern and property system.

Classes

class  Dali::Any
 Stores a value of any type. More...
class  Dali::BaseHandle
 Dali::BaseHandle is a handle to an internal Dali resource. More...
class  Dali::BaseObject
 A base class for objects. More...
class  Dali::Handle
 Dali::Handle is a handle to an internal property owning Dali object that can have constraints applied to it. More...
class  Dali::ObjectRegistry
 The ObjectRegistry notifies it's observers when an object is created. More...
struct  Dali::Property
 A Array of property values. More...
class  Dali::PropertyCondition
 This represents a condition that can be evaluated on a Property::Value. More...
class  Dali::PropertyInput
 An abstract interface for receiving property values. More...
class  Dali::PropertyNotification
 This is used to issue a notification upon a condition of the property being met. More...
class  Dali::RefObject
 Base class for reference counted objects. More...
class  Dali::TypeInfo
 TypeInfo class for instantiation of registered types and introspection of their actions and signals. More...
class  Dali::TypeRegistry
 The TypeRegistry allows registration of type instance creation functions. More...
class  Dali::TypeRegistration
 Registers a type from type info. More...
class  Dali::SignalConnectorType
 Registers a signal connector function to a registered type. More...
class  Dali::TypeAction
 Registers an action function. More...
class  Dali::PropertyRegistration
 Registers a property for the given type. More...
class  Dali::AnimatablePropertyRegistration
 Registers an animatable property for the given type. More...
class  Dali::AnimatablePropertyComponentRegistration
 Registers a component of animatable property for the given component index. More...
class  Dali::ChildPropertyRegistration
 Registers a child property for the given type. More...
class  Dali::WeakHandleBase
 Base class to store a weak pointer to an internal DALi object. More...
class  Dali::WeakHandle< T >
 Weak handle for the given type of DALi object. More...

Functions

template<typename Type >
Type * Dali::AnyCast (Any *any)
 Extracts a pointer to the held type of an Any object from a pointer to that Any object (NULL if empty).
template<typename Type >
const Type * Dali::AnyCast (const Any *any)
 Extracts a const pointer to the held type of an Any object from a pointer to that Any object (NULL if empty).
template<typename Type >
Type Dali::AnyCast (Any &any)
 Extracts a held value of type Type from an Any object from a reference to that Any object.
template<typename Type >
Type Dali::AnyCast (const Any &any)
 Extracts a held value of type Type from an Any object from a const reference to that Any object.
template<typename Type >
Type & Dali::AnyCastReference (Any &any)
 Extracts a reference to the held value of type Type from an Any object from a reference to that Any object.
template<typename Type >
const Type & Dali::AnyCastReference (const Any &any)
 Extracts a const reference to the held value of type Type from an Any object from a const reference to that Any object.
template<class T >
Dali::DownCast (BaseHandle handle)
 Template wrapper to downcast a base object handle to derived class handle.
template<typename T >
bool Dali::operator== (const BaseHandle &lhs, const T &rhs)
 Equality operator.
template<typename T >
bool Dali::operator!= (const BaseHandle &lhs, const T &rhs)
 Equality operator.
bool Dali::operator< (const BaseHandle &lhs, const BaseHandle &rhs)
 Less than operator.
BaseObject & Dali::GetImplementation (Dali::BaseHandle &handle)
 Gets the implementation of a handle.
const BaseObject & Dali::GetImplementation (const Dali::BaseHandle &handle)
 Gets the implementation of a handle.
DALI_CORE_API std::ostream & Dali::operator<< (std::ostream &stream, const Property::Array &array)
 Converts the values of the property array into a string and append to an output stream.
DALI_CORE_API PropertyCondition Dali::LessThanCondition (float arg)
 LessThanCondition compares whether property is less than arg.
DALI_CORE_API PropertyCondition Dali::GreaterThanCondition (float arg)
 GreaterThanCondition compares whether property is greater than arg.
DALI_CORE_API PropertyCondition Dali::InsideCondition (float arg0, float arg1)
 InsideCondition compares whether property is greater than arg0 and less than arg1.
DALI_CORE_API PropertyCondition Dali::OutsideCondition (float arg0, float arg1)
 OutsideCondition compares whether property is less than arg0 or greater than arg1.
DALI_CORE_API PropertyCondition Dali::StepCondition (float stepAmount, float initialValue=0.0f)
 Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
DALI_CORE_API PropertyCondition Dali::VariableStepCondition (const Dali::Vector< float > &steps)
 Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
DALI_CORE_API std::ostream & Dali::operator<< (std::ostream &stream, const Property::Key &key)
 Convert the key into a string and append to an output stream.
DALI_CORE_API std::ostream & Dali::operator<< (std::ostream &stream, const Property::Map &map)
 Converts the key/value pairs of the property map into a string and append to an output stream.
DALI_CORE_API std::ostream & Dali::operator<< (std::ostream &ouputStream, const Property::Value &value)
 Converts the value of the property into a string and append to an output stream.

Namespaces

namespace  Dali::WeightObject
 

This namespace provides a convenient function to create an object with a custom "weight" property.


namespace  Dali::PropertyTypes
 

Template function instances for property getters.


Enumerations

enum  Dali::PropertyRanges
 Enumeration for the property index ranges. More...

Typedefs

typedef Signal< void(PropertyNotification
&source) > 
Dali::PropertyNotifySignalType
 Signal type for Dali::PropertyNotification::NotifySignal().

Typedef Documentation

typedef Signal< void (PropertyNotification& source) > Dali::PropertyNotifySignalType

Signal type for Dali::PropertyNotification::NotifySignal().

Since:
2.4, DALi version 1.0.0

Enumeration Type Documentation

Enumeration for the property index ranges.

Enumerations are being used here rather than static constants so that switch statements can be used to compare property indices.

Since:
2.4, DALi version 1.0.0
Enumerator:
DEFAULT_OBJECT_PROPERTY_START_INDEX 

For all objects deriving from Handle (including Actors).

Since:
2.4, DALi version 1.0.0
DEFAULT_ACTOR_PROPERTY_START_INDEX 

Start index for Actor.

Since:
2.4, DALi version 1.0.0
DEFAULT_ACTOR_PROPERTY_MAX_COUNT 

Actor range: 0 to 9999.

Since:
2.4, DALi version 1.0.0
DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX 

Property start index for classes deriving directly from Actor.

Since:
2.4, DALi version 1.0.0
DEFAULT_PROPERTY_MAX_COUNT_PER_DERIVATION 

Second-level and onwards derived objects should increment their start index by this.

Since:
2.4, DALi version 1.0.0
DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX 

Used by PanGestureDetector.

Since:
2.4, DALi version 1.0.0
DEFAULT_RENDERER_PROPERTY_START_INDEX 

Start index for Renderer.

Since:
3.0, DALi version 1.1.44
DEFAULT_RENDERER_PROPERTY_MAX_INDEX 

Renderer range: 9000000 to 9100000.

Since:
3.0, DALi version 1.1.44
PROPERTY_REGISTRATION_START_INDEX 

The index when registering a property should start from this number.

Since:
2.4, DALi version 1.0.0
DEFAULT_PROPERTY_MAX_COUNT 

Default Property Range: 0 to 9999999.

Since:
2.4, DALi version 1.0.0
PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering a property.

Since:
2.4, DALi version 1.0.0
ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX 

The index when registering an animatable property should start from this number. (SceneGraph properties per type)

Since:
2.4, DALi version 1.0.0
ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering an animatable property.

Since:
2.4, DALi version 1.0.0
CHILD_PROPERTY_REGISTRATION_START_INDEX 

The index when registering a child property should start from this number. (Event side properties per instance)

Since:
3.0, DALi version 1.1.35
CHILD_PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering a child property.

Since:
3.0, DALi version 1.1.35
PROPERTY_CUSTOM_START_INDEX 

The index at which custom properties start (SceneGraph and Event side properties per instance)

Since:
2.4, DALi version 1.0.0
PROPERTY_CUSTOM_MAX_INDEX 

The maximum index supported for custom properties.

Since:
3.0, DALi version 1.1.45
CORE_PROPERTY_MAX_INDEX 

The maximum index that Core properties can go up to.

Since:
3.0, DALi version 1.1.45

Function Documentation

template<typename Type >
Type* Dali::AnyCast ( Any *  any)

Extracts a pointer to the held type of an Any object from a pointer to that Any object (NULL if empty).

AnyCast helper functions

Since:
2.4, DALi version 1.0.0
Parameters:
[in]anyPointer to an Any object
Returns:
Pointer to the Type held
template<typename Type >
const Type* Dali::AnyCast ( const Any *  any)

Extracts a const pointer to the held type of an Any object from a pointer to that Any object (NULL if empty).

Since:
2.4, DALi version 1.0.0
Parameters:
[in]anyconst Pointer to an Any object
Returns:
const Pointer to the Type held
template<typename Type >
Type Dali::AnyCast ( Any &  any)

Extracts a held value of type Type from an Any object from a reference to that Any object.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]anyThe reference to an Any object
Returns:
Type value of type Type
template<typename Type >
Type Dali::AnyCast ( const Any &  any)

Extracts a held value of type Type from an Any object from a const reference to that Any object.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]anyThe reference to an Any object
Returns:
Type value of type Type
template<typename Type >
Type& Dali::AnyCastReference ( Any &  any)

Extracts a reference to the held value of type Type from an Any object from a reference to that Any object.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]anyThe reference to an Any object
Returns:
A reference to the Type value of type Type
template<typename Type >
const Type& Dali::AnyCastReference ( const Any &  any)

Extracts a const reference to the held value of type Type from an Any object from a const reference to that Any object.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]anyThe reference to an Any object
Returns:
A const reference to the Type value of type Type
template<class T >
T Dali::DownCast ( BaseHandle  handle)

Template wrapper to downcast a base object handle to derived class handle.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]handleHandle to a base object
Returns:
Handle pointer to either a valid deriving handle or an uninitialized handle
Precondition:
The BaseHandle has been initialized.
BaseObject& Dali::GetImplementation ( Dali::BaseHandle handle)

Gets the implementation of a handle.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]handleThe handle
Returns:
A reference to the object the handle points at
const BaseObject& Dali::GetImplementation ( const Dali::BaseHandle handle)

Gets the implementation of a handle.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]handleThe handle
Returns:
A reference to the object the handle points at
DALI_CORE_API PropertyCondition Dali::GreaterThanCondition ( float  arg)

GreaterThanCondition compares whether property is greater than arg.

property type: bool (false = 0.0f, true = 1.0f) float (float) vector2 (the 2D length) vector3 (the 3D length) vector4 (the 4D length)

Since:
2.4, DALi version 1.0.0
Parameters:
[in]argThe argument for the condition
Returns:
A property condition function object
DALI_CORE_API PropertyCondition Dali::InsideCondition ( float  arg0,
float  arg1 
)

InsideCondition compares whether property is greater than arg0 and less than arg1.

property type: bool (false = 0.0f, true = 1.0f) float (float) vector2 (the 2D length) vector3 (the 3D length) vector4 (the 4D length)

Since:
2.4, DALi version 1.0.0
Parameters:
[in]arg0The first argument for the condition
[in]arg1The second argument for the condition
Returns:
A property condition function object
DALI_CORE_API PropertyCondition Dali::LessThanCondition ( float  arg)

LessThanCondition compares whether property is less than arg.

property type: bool (false = 0.0f, true = 1.0f) float (float) vector2 (the 2D length) vector3 (the 3D length) vector4 (the 4D length)

Since:
2.4, DALi version 1.0.0
Parameters:
[in]argThe argument for the condition
Returns:
A property condition function object
template<typename T >
bool Dali::operator!= ( const BaseHandle &  lhs,
const T &  rhs 
)

Equality operator.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]lhsA reference to compare
[in]rhsA reference to compare to
Returns:
True if the handle handles point to the different Dali resources
bool Dali::operator< ( const BaseHandle &  lhs,
const BaseHandle &  rhs 
)

Less than operator.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]lhsA reference to compare
[in]rhsA reference to compare to
Returns:
True if lhs less than rhs
DALI_CORE_API std::ostream& Dali::operator<< ( std::ostream &  stream,
const Property::Key &  key 
)

Convert the key into a string and append to an output stream.

Since:
4.0, DALi version 1.2.7
Parameters:
[in]streamThe output stream operator.
[in]keythe key to convert
Returns:
The output stream operator.
DALI_CORE_API std::ostream& Dali::operator<< ( std::ostream &  stream,
const Property::Array &  array 
)

Converts the values of the property array into a string and append to an output stream.

Output to stream.

Since:
3.0, DALi version 1.1.28
Parameters:
[in]streamThe output stream operator
[in]arrayThe array to insert
Returns:
The output stream operator
DALI_CORE_API std::ostream& Dali::operator<< ( std::ostream &  stream,
const Property::Map &  map 
)

Converts the key/value pairs of the property map into a string and append to an output stream.

Output to stream.

Since:
3.0, DALi version 1.1.28
Parameters:
[in]streamThe output stream operator
[in]mapThe map to insert
Returns:
The output stream operator
DALI_CORE_API std::ostream& Dali::operator<< ( std::ostream &  ouputStream,
const Property::Value &  value 
)

Converts the value of the property into a string and append to an output stream.

Output to stream.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]ouputStreamThe output stream operator
[in]valueThe value to insert
Returns:
The output stream operator
template<typename T >
bool Dali::operator== ( const BaseHandle &  lhs,
const T &  rhs 
)

Equality operator.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]lhsA reference to compare
[in]rhsA reference to compare to
Returns:
True if the handle handles point to the same Dali resource, or if both are NULL
DALI_CORE_API PropertyCondition Dali::OutsideCondition ( float  arg0,
float  arg1 
)

OutsideCondition compares whether property is less than arg0 or greater than arg1.

property type: bool (false = 0.0f, true = 1.0f) float (float) vector2 (the 2D length) vector3 (the 3D length) vector4 (the 4D length)

Since:
2.4, DALi version 1.0.0
Parameters:
[in]arg0The first argument for the condition
[in]arg1The second argument for the condition
Returns:
A property condition function object
DALI_CORE_API PropertyCondition Dali::StepCondition ( float  stepAmount,
float  initialValue = 0.0f 
)

Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.

property type: float (float) vector2 (the 2D length) vector3 (the 3D length) vector4 (the 4D length)

Since:
2.4, DALi version 1.0.0
Parameters:
[in]stepAmountThe step size required to trigger condition
[in]initialValueThe initial value to step from
Returns:
A property condition function object
DALI_CORE_API PropertyCondition Dali::VariableStepCondition ( const Dali::Vector< float > &  steps)

Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.

property type: float (float) vector2 (the 2D length) vector3 (the 3D length) vector4 (the 4D length)

Since:
2.4, DALi version 1.0.0
Parameters:
[in]stepsList of values to receive notifications for as a property crosses them
Returns:
A property condition function object