Tizen Native API

Classes for the handle/body pattern and property system. More...

Classes

struct  Dali::AngleAxis
 An angle & axis pair. More...
struct  Dali::Rect< T >
 Template class to create and operate on rectangles. More...
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...
class  Dali::Property::Array
 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::Property::Map
 A Map of property values. More...
class  Dali::PropertyNotification
 This is used to issue a notification upon a condition of the property being met. More...
class  Dali::Property::Value
 A value-type representing a property value. More...
struct  Dali::Property
 An object + property pair. 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
 Register a type from type info. More...
class  Dali::SignalConnectorType
 Register a signal connector function to a registered type. More...
class  Dali::TypeAction
 Register an action function. More...
class  Dali::PropertyRegistration
 Register a property for the given type. More...
class  Dali::AnimatablePropertyRegistration
 Register an animatable property for the given type. More...
class  Dali::AnimatablePropertyComponentRegistration
 Register a component of animatable property for the given component index. More...

Functions

bool Dali::operator== (const Dali::AngleAxis &lhs, const Dali::AngleAxis &rhs)
 Compare two angle axis for equality.
template<typename T >
bool Dali::operator== (const Rect< T > &lhs, const Rect< T > &rhs)
 Equality operator.
template<typename T >
bool Dali::operator!= (const Rect< T > &lhs, const Rect< T > &rhs)
 Inequality operator.
template<>
bool Dali::operator== (const Rect< float > &lhs, const Rect< float > &rhs)
 Equality operator specialization for float.
template<typename T >
std::ostream & Dali::operator<< (std::ostream &stream, const Rect< T > &rectangle)
 Convert the value of the rectangle into a string and insert in to an output stream.
template<typename Type >
Type * Dali::AnyCast (Any *any)
 Extract 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)
 Extract 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)
 Extract 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)
 Extract 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)
 Extract 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)
 Extract 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)
 Get the implementation of a handle.
const BaseObject & Dali::GetImplementation (const Dali::BaseHandle &handle)
 Get the implementation of a handle.
PropertyCondition Dali::LessThanCondition (float arg)
 LessThanCondition compares whether property is less than arg.
PropertyCondition Dali::GreaterThanCondition (float arg)
 GreaterThanCondition compares whether property is greater than arg.
PropertyCondition Dali::InsideCondition (float arg0, float arg1)
 InsideCondition compares whether property is greater than arg0 and less than arg1.
PropertyCondition Dali::OutsideCondition (float arg0, float arg1)
 OutsideCondition compares whether property is less than arg0 or greater than arg1.
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.
PropertyCondition Dali::VariableStepCondition (const Dali::Vector< float > &steps)
 Receive notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
std::ostream & Dali::operator<< (std::ostream &ouputStream, const Property::Value &value)
 Convert the value of the property into a string and append to an output stream.

Namespaces

namespace  Dali::WeightObject
 

WeightObject namespace.


namespace  Dali::PropertyTypes
 

Template function instances for property getters.


Enumerations

enum  Dali::PropertyRanges
 These are the property index ranges. More...

Typedefs

typedef std::pair< std::string,
Property::Value > 
Dali::StringValuePair
 String and property value pair.
typedef Signal< void(PropertyNotification
&source) > 
Dali::PropertyNotifySignalType
 Signal type for Dali::PropertyNotification::NotifySignal().

Classes for the handle/body pattern and property system.


Typedef Documentation

typedef Signal< void (PropertyNotification& source) > Dali::PropertyNotifySignalType
typedef std::pair<std::string, Property::Value> Dali::StringValuePair

String and property value pair.

Since :
2.4

Enumeration Type Documentation

These are 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
Enumerator:
DEFAULT_OBJECT_PROPERTY_START_INDEX 

For all objects deriving from Handle (including Actors).

Since :
2.4
DEFAULT_ACTOR_PROPERTY_START_INDEX 

Start index for Actor.

Since :
2.4
DEFAULT_ACTOR_PROPERTY_MAX_COUNT 

Actor range: 0 to 9999.

Since :
2.4
DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX 

Property start index for classes deriving directly from Actor.

Since :
2.4
DEFAULT_PROPERTY_MAX_COUNT_PER_DERIVATION 

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

Since :
2.4
DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX 

Used by PanGestureDetector.

Since :
2.4
PROPERTY_REGISTRATION_START_INDEX 

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

Since :
2.4
DEFAULT_PROPERTY_MAX_COUNT 

Default Property Range: 0 to 9999999.

Since :
2.4
PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering a property.

Since :
2.4
ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX 

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

Since :
2.4
ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering an animatable property.

Since :
2.4
PROPERTY_CUSTOM_START_INDEX 

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

Since :
2.4

Function Documentation

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

Extract 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
Parameters:
anyPointer to an Any object
Returns:
Pointer to the Type held
template<typename Type >
const Type* Dali::AnyCast ( const Any *  any)

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

Since :
2.4
Parameters:
anyconst Pointer to an Any object
Returns:
const Pointer to the Type held
template<typename Type >
Type Dali::AnyCast ( Any &  any)

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

Since :
2.4
Parameters:
anyreference to an Any object
Returns:
Type value of type Type
template<typename Type >
Type Dali::AnyCast ( const Any &  any)

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

Since :
2.4
Parameters:
anyreference to an Any object
Returns:
Type value of type Type
template<typename Type >
Type& Dali::AnyCastReference ( Any &  any)

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

Since :
2.4
Parameters:
anyreference to an Any object
Returns:
A reference to the Type value of type Type
template<typename Type >
const Type& Dali::AnyCastReference ( const Any &  any)

Extract 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
Parameters:
anyreference 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
Parameters:
handleto 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)

Get the implementation of a handle.

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

Get the implementation of a handle.

Since :
2.4
Parameters:
[in]handleThe handle
Returns:
A reference to the object the handle points at.
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
Parameters:
[in]argThe argument for the condition
Returns:
A property condition function object
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
Parameters:
[in]arg0The first argument for the condition
[in]arg1The second argument for the condition
Returns:
A property condition function object
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
Parameters:
[in]argThe argument for the condition
Returns:
A property condition function object
template<typename T >
bool Dali::operator!= ( const Rect< T > &  lhs,
const Rect< T > &  rhs 
)

Inequality operator.

Since :
2.4
Parameters:
[in]lhsThe first rectangle
[in]rhsThe second rectangle
Returns:
true if rectangles are not identical
template<typename T >
bool Dali::operator!= ( const BaseHandle &  lhs,
const T &  rhs 
)

Equality operator.

Since :
2.4
bool Dali::operator< ( const BaseHandle &  lhs,
const BaseHandle &  rhs 
)

Less than operator.

Since :
2.4
template<typename T >
std::ostream& Dali::operator<< ( std::ostream &  stream,
const Rect< T > &  rectangle 
)

Convert the value of the rectangle into a string and insert in to an output stream.

Since :
2.4
Parameters:
[in]streamThe output stream operator.
[in]rectanglethe rectangle to output
Returns:
The output stream operator.
std::ostream& Dali::operator<< ( std::ostream &  ouputStream,
const Property::Value &  value 
)

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

output to stream

Since :
2.4
Parameters:
[in]ouputStreamThe output stream operator.
[in]valueThe value to insert
Returns:
The output stream operator.
bool Dali::operator== ( const Dali::AngleAxis lhs,
const Dali::AngleAxis rhs 
)

Compare two angle axis for equality.

Since :
2.4
Parameters:
lhsangle axis
rhsangle axis
Returns:
True if they are equal
template<typename T >
bool Dali::operator== ( const Rect< T > &  lhs,
const Rect< T > &  rhs 
)

Equality operator.

Since :
2.4
Parameters:
[in]lhsFirst operand
[in]rhsSecond operand
Returns:
true if boxes are exactly same
template<typename T >
bool Dali::operator== ( const BaseHandle &  lhs,
const T &  rhs 
)

Equality operator.

Since :
2.4
template<>
bool Dali::operator== ( const Rect< float > &  lhs,
const Rect< float > &  rhs 
)

Equality operator specialization for float.

Since :
2.4
Parameters:
[in]lhsThe first rectangle
[in]rhsThe second rectangle
Returns:
true if rectangles are exactly same
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
Parameters:
[in]arg0The first argument for the condition
[in]arg1The second argument for the condition
Returns:
A property condition function object
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
Parameters:
[in]stepAmountThe step size required to trigger condition
[in]initialValueThe initial value to step from
Returns:
A property condition function object
PropertyCondition Dali::VariableStepCondition ( const Dali::Vector< float > &  steps)

Receive 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
Parameters:
[in]stepsList of values to receive notifications for as a property crosses them
Returns:
A property condition function object