Dali 3D User Interface Engine
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
Dali::Internal::PropertyMetadata Class Referenceabstract

An entry in a property metadata lookup. More...

#include <property-metadata.h>

Inheritance diagram for Dali::Internal::PropertyMetadata:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::PropertyMetadata:
Collaboration graph
[legend]

Public Member Functions

 PropertyMetadata ()
 Constructor for an uninitalized property metadata. More...
 
 PropertyMetadata (const SceneGraph::PropertyBase *newProperty)
 Constructor for property metadata. More...
 
 PropertyMetadata (Property::Value newValue)
 Constructor for property metadata. More...
 
virtual ~PropertyMetadata ()
 Destructor for property metadata. More...
 
bool IsAnimatable (void) const
 
virtual bool IsWritable (void) const =0
 
const SceneGraph::PropertyBaseGetSceneGraphProperty () const
 
Property::Type GetType () const
 

Public Attributes

Property::Value value
 The property value for a non animatable and custom property. More...
 
int componentIndex
 The index of the property component. More...
 

Protected Member Functions

 PropertyMetadata (const PropertyMetadata &)
 
PropertyMetadataoperator= (const PropertyMetadata &)
 

Protected Attributes

const SceneGraph::PropertyBasemProperty
 A pointer to a scene-graph property; should not be modified from actor-thread. More...
 

Detailed Description

An entry in a property metadata lookup.

The value type field should be queried, before accessing the scene-graph property:

void Example(PropertyEntry entry)
{
if (entry.value.GetType() == Property::VECTOR3)
{
SceneGraph::AnimatableProperty<Vector3>* property = dynamic_cast< SceneGraph::AnimatableProperty<Vector3>* >( entry.property );
...
}

Definition at line 55 of file property-metadata.h.

Constructor & Destructor Documentation

Dali::Internal::PropertyMetadata::PropertyMetadata ( )
inline

Constructor for an uninitalized property metadata.

Definition at line 62 of file property-metadata.h.

Dali::Internal::PropertyMetadata::PropertyMetadata ( const SceneGraph::PropertyBase newProperty)
inline

Constructor for property metadata.

Parameters
[in]newPropertyA pointer to the property metadata.

Definition at line 73 of file property-metadata.h.

References DALI_ASSERT_DEBUG, and mProperty.

Dali::Internal::PropertyMetadata::PropertyMetadata ( Property::Value  newValue)
inline

Constructor for property metadata.

Parameters
[in]newValueThe value of the scene-graph owned property.

Definition at line 85 of file property-metadata.h.

virtual Dali::Internal::PropertyMetadata::~PropertyMetadata ( )
inlinevirtual

Destructor for property metadata.

Definition at line 95 of file property-metadata.h.

Dali::Internal::PropertyMetadata::PropertyMetadata ( const PropertyMetadata )
protected

Member Function Documentation

const SceneGraph::PropertyBase* Dali::Internal::PropertyMetadata::GetSceneGraphProperty ( ) const
inline
Property::Type Dali::Internal::PropertyMetadata::GetType ( ) const
inline
bool Dali::Internal::PropertyMetadata::IsAnimatable ( void  ) const
inline
Returns
true if the property is animatable (i.e. if its a scene graph property)

Definition at line 102 of file property-metadata.h.

References mProperty.

Referenced by Dali::Internal::Object::AddPropertyNotification(), Dali::Internal::Object::GetPropertyValue(), Dali::Internal::Object::IsPropertyAnimatable(), and Dali::Internal::Object::SetProperty().

Here is the caller graph for this function:

virtual bool Dali::Internal::PropertyMetadata::IsWritable ( void  ) const
pure virtual
Returns
true if the property can be written to

Implemented in Dali::Internal::CustomPropertyMetadata, and Dali::Internal::AnimatablePropertyMetadata.

PropertyMetadata& Dali::Internal::PropertyMetadata::operator= ( const PropertyMetadata )
protected

Member Data Documentation

int Dali::Internal::PropertyMetadata::componentIndex
const SceneGraph::PropertyBase* Dali::Internal::PropertyMetadata::mProperty
protected
Property::Value Dali::Internal::PropertyMetadata::value

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