Dali 3D User Interface Engine
Classes | Namespaces | Typedefs | Enumerations | Functions
Dali_core_object
Collaboration diagram for Dali_core_object:

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...
 
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
 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...
 

Namespaces

namespace  Dali::DALI_INTERNAL
 
namespace  Dali::WeightObject
 
namespace  Dali::PropertyTypes
 Template function instances for property getters.
 

Typedefs

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

Enumerations

enum  Dali::PropertyRanges {
  Dali::DEFAULT_OBJECT_PROPERTY_START_INDEX = 0, Dali::DEFAULT_ACTOR_PROPERTY_START_INDEX = DEFAULT_OBJECT_PROPERTY_START_INDEX, Dali::DEFAULT_ACTOR_PROPERTY_MAX_COUNT = 10000, Dali::DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX = DEFAULT_ACTOR_PROPERTY_START_INDEX + DEFAULT_ACTOR_PROPERTY_MAX_COUNT,
  Dali::DEFAULT_PROPERTY_MAX_COUNT_PER_DERIVATION = 10000, Dali::DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, Dali::PROPERTY_REGISTRATION_START_INDEX = 10000000, Dali::DEFAULT_PROPERTY_MAX_COUNT = PROPERTY_REGISTRATION_START_INDEX,
  Dali::PROPERTY_REGISTRATION_MAX_INDEX = 19999999, Dali::ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX = 20000000, Dali::ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX = 29999999, Dali::PROPERTY_CUSTOM_START_INDEX = 50000000
}
 These are the property index ranges. More...
 

Functions

bool Dali::operator== (const Dali::AngleAxis &lhs, const Dali::AngleAxis &rhs)
 Compare two angle axis for equality. More...
 
template<typename T >
bool Dali::operator== (const Rect< T > &lhs, const Rect< T > &rhs)
 Equality operator. More...
 
template<typename T >
bool Dali::operator!= (const Rect< T > &lhs, const Rect< T > &rhs)
 Inequality operator. More...
 
template<>
bool Dali::operator== (const Rect< float > &lhs, const Rect< float > &rhs)
 Equality operator specialization for float. More...
 
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. More...
 
template<typename Type >
Type * Dali::AnyCast (Any *any)
 AnyCast helper functions. More...
 
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 ) More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
template<class T >
Dali::DownCast (BaseHandle handle)
 Template wrapper to downcast a base object handle to derived class handle. More...
 
template<typename T >
bool Dali::operator== (const BaseHandle &lhs, const T &rhs)
 Equality operator .0. More...
 
template<typename T >
bool Dali::operator!= (const BaseHandle &lhs, const T &rhs)
 Equality operator .0. More...
 
bool Dali::operator< (const BaseHandle &lhs, const BaseHandle &rhs)
 Less than operator .0. More...
 
BaseObject & Dali::GetImplementation (Dali::BaseHandle &handle)
 Get the implementation of a handle. More...
 
const BaseObject & Dali::GetImplementation (const Dali::BaseHandle &handle)
 Get the implementation of a handle. More...
 
PropertyCondition Dali::LessThanCondition (float arg)
 LessThanCondition compares whether property is less than arg. More...
 
PropertyCondition Dali::GreaterThanCondition (float arg)
 GreaterThanCondition compares whether property is greater than arg. More...
 
PropertyCondition Dali::InsideCondition (float arg0, float arg1)
 InsideCondition compares whether property is greater than arg0 and less than arg1. More...
 
PropertyCondition Dali::OutsideCondition (float arg0, float arg1)
 OutsideCondition compares whether property is less than arg0 or greater than arg1. More...
 
PropertyCondition Dali::StepCondition (float stepAmount, float initialValue=0.0f)
 Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. More...
 
PropertyCondition Dali::VariableStepCondition (const Dali::Vector< float > &steps)
 Receive notifications as a property goes above/below the inputted values. More...
 
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. More...
 

Detailed Description

Typedef Documentation

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

Definition at line 36 of file property-map.h.

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. .0

Enumerator
DEFAULT_OBJECT_PROPERTY_START_INDEX 

For all objects deriving from Handle (including Actors). .0.

DEFAULT_ACTOR_PROPERTY_START_INDEX 

Start index for Actor. .0.

DEFAULT_ACTOR_PROPERTY_MAX_COUNT 

Actor range: 0 to 9999 .0.

DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX 

Property start index for classes deriving directly from Actor. .0.

DEFAULT_PROPERTY_MAX_COUNT_PER_DERIVATION 

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

DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX 

Used by PanGestureDetector. .0.

PROPERTY_REGISTRATION_START_INDEX 

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

DEFAULT_PROPERTY_MAX_COUNT 

Default Property Range: 0 to 9999999 .0.

PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering a property .0.

ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX 

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

ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX 

The maximum index supported when registering an animatable property .0.

PROPERTY_CUSTOM_START_INDEX 

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

Definition at line 38 of file property-index-ranges.h.

Function Documentation

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

AnyCast helper functions.

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

.0

Parameters
anyPointer to an Any object
Returns
Pointer to the Type held

Definition at line 418 of file any.h.

References Dali::Any::GetPointer().

Here is the call graph for this function:

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

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

.0

Parameters
anyconst Pointer to an Any object
Returns
const Pointer to the Type held

Definition at line 432 of file any.h.

References Dali::Any::GetPointer().

Here is the call graph for this function:

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

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

.0

Parameters
anyreference to an Any object
Returns
Type value of type Type

Definition at line 446 of file any.h.

References Dali::Any::Get().

Here is the call graph for this function:

template<typename Type >
Type Dali::AnyCast ( const Any &  any)
inline

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

.0

Parameters
anyreference to an Any object
Returns
Type value of type Type

Definition at line 460 of file any.h.

References Dali::Any::Get().

Here is the call graph for this function:

template<typename Type >
Type& Dali::AnyCastReference ( Any &  any)
inline

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

.0

Parameters
anyreference to an Any object
Returns
A reference to the Type value of type Type

Definition at line 474 of file any.h.

References Dali::Any::Get().

Here is the call graph for this function:

template<typename Type >
const Type& Dali::AnyCastReference ( const Any &  any)
inline

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

.0

Parameters
anyreference to an Any object
Returns
A const reference to the Type value of type Type

Definition at line 488 of file any.h.

References Dali::Any::Get().

Here is the call graph for this function:

template<class T >
T Dali::DownCast ( BaseHandle  handle)
inline
BaseObject& Dali::GetImplementation ( Dali::BaseHandle handle)
inline

Get the implementation of a handle.

.0

Parameters
[in]handleThe handle
Returns
A reference to the object the handle points at.

Definition at line 126 of file base-object.h.

References DALI_ASSERT_ALWAYS, and Dali::BaseHandle::GetBaseObject().

Here is the call graph for this function:

const BaseObject& Dali::GetImplementation ( const Dali::BaseHandle handle)
inline

Get the implementation of a handle.

.0

Parameters
[in]handleThe handle
Returns
A reference to the object the handle points at.

Definition at line 140 of file base-object.h.

References DALI_ASSERT_ALWAYS, and Dali::BaseHandle::GetBaseObject().

Here is the call graph for this function:

DALI_IMPORT_API PropertyCondition Dali::GreaterThanCondition ( float  arg)
DALI_IMPORT_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) .0

Parameters
[in]arg0The first argument for the condition
[in]arg1The second argument for the condition
Returns
A property condition function object

Definition at line 80 of file property-conditions.cpp.

References Dali::Internal::PropertyCondition::arguments, Dali::GetImplementation(), Dali::Internal::PropertyCondition::Inside, Dali::Vector< T, IsTrivialType >::PushBack(), and Dali::Internal::PropertyCondition::type.

Referenced by Dali::Toolkit::Internal::SetupPropertyNotification(), Dali::Toolkit::Internal::ScrollOvershootEffectRipple::UpdatePropertyNotifications(), UtcDaliPropertyConditionGetArguments(), UtcDaliPropertyNotificationInside(), and UtcDaliPropertyNotificationVectorComponentInside().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_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) .0

Parameters
[in]argThe argument for the condition
Returns
A property condition function object

Definition at line 60 of file property-conditions.cpp.

References Dali::Internal::PropertyCondition::arguments, Dali::GetImplementation(), Dali::Internal::PropertyCondition::LessThan, Dali::Vector< T, IsTrivialType >::PushBack(), and Dali::Internal::PropertyCondition::type.

Referenced by Dali::Toolkit::Text::Decorator::Impl::SetupActiveLayerPropertyNotifications(), Dali::Toolkit::Internal::SetupPropertyNotification(), UtcDaliPropertyNotificationLessThan(), and UtcDaliPropertyNotificationVectorComponentLessThan().

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >
bool Dali::operator!= ( const Rect< T > &  lhs,
const Rect< T > &  rhs 
)
inline

Inequality operator.

.0

Parameters
[in]lhsThe first rectangle
[in]rhsThe second rectangle
Returns
true if rectangles are not identical

Definition at line 274 of file rect.h.

template<typename T >
bool Dali::operator!= ( const BaseHandle &  lhs,
const T &  rhs 
)
inline

Equality operator .0.

Definition at line 293 of file base-handle.h.

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

Less than operator .0.

Definition at line 303 of file base-handle.h.

References Dali::BaseHandle::GetObjectPtr().

Here is the call graph for this function:

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

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

.0

Parameters
[in]streamThe output stream operator.
[in]rectanglethe rectangle to output
Returns
The output stream operator.

Definition at line 319 of file rect.h.

DALI_IMPORT_API 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 .0

.0

Parameters
[in]ouputStreamThe output stream operator.
[in]valueThe value to insert
Returns
The output stream operator.

Definition at line 774 of file property-value.cpp.

References Dali::Property::ARRAY, Dali::Property::BOOLEAN, Dali::Property::FLOAT, Dali::Property::INTEGER, Dali::Property::MAP, Dali::Property::MATRIX, Dali::Property::MATRIX3, Dali::Property::NONE, Dali::Property::RECTANGLE, Dali::Property::ROTATION, Dali::Property::STRING, Dali::Property::VECTOR2, Dali::Property::VECTOR3, and Dali::Property::VECTOR4.

bool Dali::operator== ( const Dali::AngleAxis lhs,
const Dali::AngleAxis rhs 
)
inline

Compare two angle axis for equality.

.0

Parameters
lhsangle axis
rhsangle axis
Returns
true if they are equal

Definition at line 79 of file angle-axis.h.

References Dali::AngleAxis::angle, and Dali::AngleAxis::axis.

template<typename T >
bool Dali::operator== ( const Rect< T > &  lhs,
const Rect< T > &  rhs 
)
inline

Equality operator.

.0

Parameters
[in]lhsFirst operand
[in]rhsSecond operand
Returns
true if boxes are exactly same

Definition at line 257 of file rect.h.

References Dali::Rect< T >::height, Dali::Rect< T >::width, Dali::Rect< T >::x, and Dali::Rect< T >::y.

template<typename T >
bool Dali::operator== ( const BaseHandle &  lhs,
const T &  rhs 
)
inline

Equality operator .0.

Definition at line 282 of file base-handle.h.

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

Equality operator specialization for float.

.0

Parameters
[in]lhsThe first rectangle
[in]rhsThe second rectangle
Returns
true if rectangles are exactly same

Definition at line 288 of file rect.h.

References Dali::GetRangedEpsilon(), Dali::Rect< T >::height, Dali::Rect< T >::width, Dali::Rect< T >::x, and Dali::Rect< T >::y.

Here is the call graph for this function:

DALI_IMPORT_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) .0

Parameters
[in]arg0The first argument for the condition
[in]arg1The second argument for the condition
Returns
A property condition function object

Definition at line 91 of file property-conditions.cpp.

References Dali::Internal::PropertyCondition::arguments, Dali::GetImplementation(), Dali::Internal::PropertyCondition::Outside, Dali::Vector< T, IsTrivialType >::PushBack(), and Dali::Internal::PropertyCondition::type.

Referenced by Dali::Toolkit::Text::Decorator::Impl::SetUpPopupPositionNotifications(), Dali::Toolkit::Internal::SetupPropertyNotification(), Dali::Toolkit::Internal::ScrollOvershootEffectRipple::UpdatePropertyNotifications(), UtcDaliPropertyNotificationOutside(), and UtcDaliPropertyNotificationVectorComponentOutside().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_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) .0

Parameters
[in]stepAmountThe step size required to trigger condition
[in]initialValueThe initial value to step from
Returns
A property condition function object

Definition at line 102 of file property-conditions.cpp.

References Dali::Internal::PropertyCondition::arguments, Dali::GetImplementation(), Dali::Vector< T, IsTrivialType >::PushBack(), Dali::Internal::PropertyCondition::Step, and Dali::Internal::PropertyCondition::type.

Referenced by Dali::Toolkit::Internal::ItemView::SetRefreshInterval(), Dali::Toolkit::Internal::ScrollView::SetScrollUpdateNotification(), and UtcDaliPropertyNotificationStep().

Here is the call graph for this function:

Here is the caller graph for this function:

DALI_IMPORT_API 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) .0

Parameters
[in]stepsList of values to receive notifications for as a property crosses them
Returns
A property condition function object

Definition at line 114 of file property-conditions.cpp.

References Dali::Internal::PropertyCondition::arguments, Dali::VectorBase::Count(), Dali::GetImplementation(), Dali::Vector< T, IsTrivialType >::PushBack(), Dali::Internal::PropertyCondition::type, and Dali::Internal::PropertyCondition::VariableStep.

Referenced by Dali::Toolkit::Internal::ScrollBar::SetScrollPositionIntervals(), and UtcDaliPropertyNotificationVariableStep().

Here is the call graph for this function:

Here is the caller graph for this function:

Dali Docs Home
Read more about Dali