Dali 3D User Interface Engine
List of all members | Public Member Functions | Private Member Functions | Private Attributes
Dali::Internal::PropertyAccessor< PropertyType > Class Template Reference

A wrapper class for getting/setting a property. More...

#include <property-accessor.h>

Collaboration diagram for Dali::Internal::PropertyAccessor< PropertyType >:
Collaboration graph
[legend]

Public Member Functions

 PropertyAccessor (SceneGraph::PropertyBase *property)
 Create a property component. More...
 
 ~PropertyAccessor ()
 Non-virtual destructor; PropertyAccessor is not suitable as a base class. More...
 
bool IsSet () const
 Query whether the accessor is set. More...
 
void Reset ()
 Reset the property accessor. More...
 
bool IsClean () const
 Query whether the property has changed. More...
 
const PropertyType & Get (BufferIndex bufferIndex) const
 Read access to the property. More...
 
void Set (BufferIndex bufferIndex, const PropertyType &value) const
  More...
 
void Bake (BufferIndex bufferIndex, const PropertyType &value) const
  More...
 

Private Member Functions

 PropertyAccessor (const PropertyAccessor &property)
 
PropertyAccessoroperator= (const PropertyAccessor &rhs)
 

Private Attributes

SceneGraph::AnimatableProperty
< PropertyType > * 
mProperty
 The real property. More...
 

Detailed Description

template<typename PropertyType>
class Dali::Internal::PropertyAccessor< PropertyType >

A wrapper class for getting/setting a property.

Animators use this instead of accessing properties directly.

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

Constructor & Destructor Documentation

template<typename PropertyType >
Dali::Internal::PropertyAccessor< PropertyType >::PropertyAccessor ( SceneGraph::PropertyBase property)
inline

Create a property component.

Parameters
[in]propertyThe property to access.

Definition at line 44 of file property-accessor.h.

template<typename PropertyType >
Dali::Internal::PropertyAccessor< PropertyType >::~PropertyAccessor ( )
inline

Non-virtual destructor; PropertyAccessor is not suitable as a base class.

Definition at line 52 of file property-accessor.h.

template<typename PropertyType >
Dali::Internal::PropertyAccessor< PropertyType >::PropertyAccessor ( const PropertyAccessor< PropertyType > &  property)
private

Member Function Documentation

template<typename PropertyType >
void Dali::Internal::PropertyAccessor< PropertyType >::Bake ( BufferIndex  bufferIndex,
const PropertyType &  value 
) const
inline
template<typename PropertyType >
const PropertyType& Dali::Internal::PropertyAccessor< PropertyType >::Get ( BufferIndex  bufferIndex) const
inline

Read access to the property.

Parameters
[in]bufferIndexThe current update buffer index.

Definition at line 86 of file property-accessor.h.

References DALI_ASSERT_DEBUG, and Dali::Internal::PropertyAccessor< PropertyType >::mProperty.

template<typename PropertyType >
bool Dali::Internal::PropertyAccessor< PropertyType >::IsClean ( ) const
inline

Query whether the property has changed.

Returns
True if the property has not changed.

Definition at line 77 of file property-accessor.h.

References Dali::Internal::PropertyAccessor< PropertyType >::mProperty.

template<typename PropertyType >
bool Dali::Internal::PropertyAccessor< PropertyType >::IsSet ( ) const
inline

Query whether the accessor is set.

Returns
True if set.

Definition at line 60 of file property-accessor.h.

References Dali::Internal::PropertyAccessor< PropertyType >::mProperty.

template<typename PropertyType >
PropertyAccessor& Dali::Internal::PropertyAccessor< PropertyType >::operator= ( const PropertyAccessor< PropertyType > &  rhs)
private
template<typename PropertyType >
void Dali::Internal::PropertyAccessor< PropertyType >::Reset ( )
inline

Reset the property accessor.

Postcondition
Calling any other PropertyAccessor is invalid.

Definition at line 69 of file property-accessor.h.

References Dali::Internal::PropertyAccessor< PropertyType >::mProperty.

template<typename PropertyType >
void Dali::Internal::PropertyAccessor< PropertyType >::Set ( BufferIndex  bufferIndex,
const PropertyType &  value 
) const
inline

Member Data Documentation

template<typename PropertyType >
SceneGraph::AnimatableProperty<PropertyType>* Dali::Internal::PropertyAccessor< PropertyType >::mProperty
private

The documentation for this class was generated from the following file:
Dali Docs Home
Read more about Dali