2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/event/common/object-impl.h>
25 #include <dali/integration-api/debug.h>
26 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
27 #include <dali/internal/update/common/animatable-property.h>
28 #include <dali/internal/update/common/property-owner-messages.h>
29 #include <dali/internal/update/common/uniform-map.h>
30 #include <dali/internal/event/animation/constraint-impl.h>
31 #include <dali/internal/event/common/stage-impl.h>
32 #include <dali/internal/event/common/property-notification-impl.h>
33 #include <dali/internal/event/common/type-registry-impl.h>
35 using Dali::Internal::SceneGraph::AnimatableProperty;
36 using Dali::Internal::SceneGraph::PropertyBase;
44 namespace // unnamed namespace
46 const int SUPPORTED_CAPABILITIES = Dali::Handle::DYNAMIC_PROPERTIES; // Object provides this capability
47 typedef Dali::Vector<Object::Observer*>::Iterator ObserverIter;
48 typedef Dali::Vector<Object::Observer*>::ConstIterator ConstObserverIter;
50 #if defined(DEBUG_ENABLED)
51 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_OBJECT" );
55 } // unnamed namespace
58 : mEventThreadServices( *Stage::GetCurrent() ),
61 mPropertyNotifications( NULL )
65 void Object::AddObserver(Observer& observer)
67 // make sure an observer doesn't observe the same object twice
68 // otherwise it will get multiple calls to OnSceneObjectAdd(), OnSceneObjectRemove() and ObjectDestroyed()
69 DALI_ASSERT_DEBUG( mObservers.End() == std::find( mObservers.Begin(), mObservers.End(), &observer));
71 mObservers.PushBack( &observer );
74 void Object::RemoveObserver(Observer& observer)
76 // Find the observer...
77 const ConstObserverIter endIter = mObservers.End();
78 for( ObserverIter iter = mObservers.Begin(); iter != endIter; ++iter)
80 if( (*iter) == &observer)
82 mObservers.Erase( iter );
86 DALI_ASSERT_DEBUG(endIter != mObservers.End());
89 void Object::OnSceneObjectAdd()
91 // Notification for observers
92 for( ConstObserverIter iter = mObservers.Begin(), endIter = mObservers.End(); iter != endIter; ++iter)
94 (*iter)->SceneObjectAdded(*this);
97 // enable property notifications in scene graph
98 EnablePropertyNotifications();
101 void Object::OnSceneObjectRemove()
103 // Notification for observers
104 for( ConstObserverIter iter = mObservers.Begin(), endIter = mObservers.End(); iter != endIter; ++iter )
106 (*iter)->SceneObjectRemoved(*this);
109 // disable property notifications in scene graph
110 DisablePropertyNotifications();
113 int Object::GetPropertyComponentIndex( Property::Index index ) const
115 int componentIndex = Property::INVALID_COMPONENT_INDEX;
117 const TypeInfo* typeInfo( GetTypeInfo() );
120 componentIndex = typeInfo->GetComponentIndex(index);
123 // For animatable property, check whether it is registered already and register it if not yet.
124 if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) && ( NULL == RegisterAnimatableProperty(index) ) )
126 componentIndex = Property::INVALID_COMPONENT_INDEX;
129 return componentIndex;
132 bool Object::Supports( Capability capability ) const
134 return (capability & SUPPORTED_CAPABILITIES);
137 unsigned int Object::GetPropertyCount() const
139 unsigned int count = GetDefaultPropertyCount();
141 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Default Properties: %d\n", count );
143 const TypeInfo* typeInfo( GetTypeInfo() );
146 unsigned int manual( typeInfo->GetPropertyCount() );
149 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Manual Properties: %d\n", manual );
152 unsigned int custom( mCustomProperties.Count() );
154 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Custom Properties: %d\n", custom );
156 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Total Properties: %d\n", count );
161 std::string Object::GetPropertyName( Property::Index index ) const
163 DALI_ASSERT_ALWAYS( index > Property::INVALID_INDEX && "Property index out of bounds" );
165 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
169 const char * propertyName = GetDefaultPropertyName( index );
172 string = propertyName;
177 if ( ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
178 || ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) ) )
180 const TypeInfo* typeInfo( GetTypeInfo() );
183 return typeInfo->GetPropertyName( index );
187 DALI_ASSERT_ALWAYS( ! "Property index is invalid" );
191 CustomPropertyMetadata* custom = FindCustomProperty( index );
199 Property::Index Object::GetPropertyIndex(const std::string& name) const
201 Property::Index index = GetDefaultPropertyIndex( name );
203 if(index == Property::INVALID_INDEX)
205 const TypeInfo* typeInfo( GetTypeInfo() );
208 index = typeInfo->GetPropertyIndex( name );
209 if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
211 // check whether the animatable property is registered already, if not then register one.
212 if ( NULL == RegisterAnimatableProperty(index) )
214 index = Property::INVALID_INDEX;
220 if( (index == Property::INVALID_INDEX)&&( mCustomProperties.Count() > 0 ) )
222 Property::Index count = PROPERTY_CUSTOM_START_INDEX;
223 const PropertyMetadataLookup::ConstIterator end = mCustomProperties.End();
224 for( PropertyMetadataLookup::ConstIterator iter = mCustomProperties.Begin(); iter != end; ++iter, ++count )
226 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>(*iter);
227 if ( custom->name == name )
229 if ( custom->childPropertyIndex != Property::INVALID_INDEX )
231 // If it is a child property, return the child property index
232 index = custom->childPropertyIndex;
246 Property::Index Object::GetPropertyIndex( Property::Index key ) const
248 Property::Index index = Property::INVALID_INDEX;
250 if( mCustomProperties.Count() > 0 )
252 Property::Index count = PROPERTY_CUSTOM_START_INDEX;
253 const PropertyMetadataLookup::ConstIterator end = mCustomProperties.End();
254 for( PropertyMetadataLookup::ConstIterator iter = mCustomProperties.Begin(); iter != end; ++iter, ++count )
256 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>(*iter);
257 if( custom->key == key )
259 if( custom->childPropertyIndex != Property::INVALID_INDEX )
261 // If it is a child property, return the child property index
262 index = custom->childPropertyIndex;
276 Property::Index Object::GetPropertyIndex( Property::Key key ) const
278 Property::Index index = Property::INVALID_INDEX;
279 if( key.type == Property::Key::INDEX )
281 index = GetPropertyIndex( key.indexKey );
285 index = GetPropertyIndex( key.stringKey );
290 bool Object::IsPropertyWritable( Property::Index index ) const
292 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds");
294 bool writable = false;
296 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
298 writable = IsDefaultPropertyWritable( index );
300 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
302 const TypeInfo* typeInfo( GetTypeInfo() );
305 writable = typeInfo->IsPropertyWritable( index );
309 DALI_ASSERT_ALWAYS( ! "Invalid property index" );
312 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
314 // Type Registry scene-graph properties are writable.
319 CustomPropertyMetadata* custom = FindCustomProperty( index );
322 writable = custom->IsWritable();
329 bool Object::IsPropertyAnimatable( Property::Index index ) const
331 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds");
333 bool animatable = false;
335 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
337 animatable = IsDefaultPropertyAnimatable( index );
339 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
341 // Type Registry event-thread only properties are not animatable.
344 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
346 // Type Registry scene-graph properties are animatable.
351 CustomPropertyMetadata* custom = FindCustomProperty( index );
354 animatable = custom->IsAnimatable();
361 bool Object::IsPropertyAConstraintInput( Property::Index index ) const
363 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds");
365 bool isConstraintInput = false;
367 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
369 isConstraintInput = IsDefaultPropertyAConstraintInput( index );
371 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
373 // Type Registry event-thread only properties cannot be used as an input to a constraint.
374 isConstraintInput = false;
376 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
378 // scene graph properties can be used as input to a constraint.
379 isConstraintInput = true;
383 CustomPropertyMetadata* custom = FindCustomProperty( index );
386 // ... custom properties can be used as input to a constraint.
387 isConstraintInput = true;
391 return isConstraintInput;
394 Property::Type Object::GetPropertyType( Property::Index index ) const
396 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds" );
398 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
400 return GetDefaultPropertyType( index );
403 if ( ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
404 || ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) ) )
406 const TypeInfo* typeInfo( GetTypeInfo() );
409 return typeInfo->GetPropertyType( index );
413 DALI_ASSERT_ALWAYS( ! "Cannot find property index" );
417 CustomPropertyMetadata* custom = FindCustomProperty( index );
420 return custom->GetType();
423 return Property::NONE;
426 void Object::SetProperty( Property::Index index, const Property::Value& propertyValue )
428 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds" );
430 bool propertySet( true );
432 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
434 SetDefaultProperty( index, propertyValue );
436 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
438 const TypeInfo* typeInfo( GetTypeInfo() );
441 typeInfo->SetProperty( this, index, propertyValue );
445 DALI_LOG_ERROR("Cannot find property index\n");
449 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
451 // check whether the animatable property is registered already, if not then register one.
452 AnimatablePropertyMetadata* animatableProperty = RegisterAnimatableProperty( index );
453 if(!animatableProperty)
455 DALI_LOG_ERROR("Cannot find property index\n");
460 // update the cached property value
461 animatableProperty->SetPropertyValue( propertyValue );
463 // set the scene graph property value
464 SetSceneGraphProperty( index, *animatableProperty, propertyValue );
469 CustomPropertyMetadata* custom = FindCustomProperty( index );
471 if ( ( index >= CHILD_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= CHILD_PROPERTY_REGISTRATION_MAX_INDEX ) )
475 // If the child property is not registered yet, register it.
476 custom = new CustomPropertyMetadata( "", propertyValue, Property::READ_WRITE );
477 mCustomProperties.PushBack( custom );
480 custom->childPropertyIndex = index;
482 // Resolve name for the child property
483 Object* parent = GetParentObject();
486 const TypeInfo* parentTypeInfo( parent->GetTypeInfo() );
489 custom->name = parentTypeInfo->GetChildPropertyName( index );
496 if( custom->IsAnimatable() )
498 // update the cached property value
499 custom->SetPropertyValue( propertyValue );
501 // set the scene graph property value
502 SetSceneGraphProperty( index, *custom, propertyValue );
504 else if( custom->IsWritable() )
506 // update the cached property value
507 custom->SetPropertyValue( propertyValue );
511 // trying to set value on read only property is no-op
517 DALI_LOG_ERROR("Invalid property index\n");
522 // Let derived classes know that a property has been set
523 // TODO: We should not call this for read-only properties, SetDefaultProperty() && TypeInfo::SetProperty() should return a bool, which would be true if the property is set
526 OnPropertySet(index, propertyValue);
530 Property::Value Object::GetProperty(Property::Index index) const
532 DALI_ASSERT_ALWAYS( index > Property::INVALID_INDEX && "Property index is out of bounds" );
534 Property::Value value;
536 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
538 value = GetDefaultProperty( index );
540 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
542 const TypeInfo* typeInfo( GetTypeInfo() );
545 value = typeInfo->GetProperty( this, index );
549 DALI_LOG_ERROR("Cannot find property index\n");
552 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
554 // check whether the animatable property is registered already, if not then register one.
555 AnimatablePropertyMetadata* animatableProperty = RegisterAnimatableProperty( index );
556 if(!animatableProperty)
558 DALI_LOG_ERROR("Cannot find property index\n");
562 // get the cached animatable property value
563 value = animatableProperty->GetPropertyValue();
566 else if(mCustomProperties.Count() > 0)
568 CustomPropertyMetadata* custom = FindCustomProperty( index );
571 // get the cached custom property value
572 value = custom->GetPropertyValue();
576 DALI_LOG_ERROR("Invalid property index\n");
583 Property::Value Object::GetCurrentProperty( Property::Index index ) const
585 DALI_ASSERT_ALWAYS( index > Property::INVALID_INDEX && "Property index is out of bounds" );
587 Property::Value value;
589 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
591 value = GetDefaultPropertyCurrentValue( index );
593 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
595 const TypeInfo* typeInfo( GetTypeInfo() );
598 value = typeInfo->GetProperty( this, index );
602 DALI_LOG_ERROR("Cannot find property index\n");
605 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
607 // check whether the animatable property is registered already, if not then register one.
608 AnimatablePropertyMetadata* animatableProperty = RegisterAnimatableProperty( index );
609 if(!animatableProperty)
611 DALI_LOG_ERROR("Cannot find property index\n");
615 // get the animatable property value
616 value = GetCurrentPropertyValue( animatableProperty );
619 else if(mCustomProperties.Count() > 0)
621 CustomPropertyMetadata* custom = FindCustomProperty( index );
624 // get the custom property value
625 value = GetCurrentPropertyValue( custom );
629 DALI_LOG_ERROR("Invalid property index\n");
636 void Object::GetPropertyIndices( Property::IndexContainer& indices ) const
640 // Default Properties
641 GetDefaultPropertyIndices( indices );
644 const TypeInfo* typeInfo( GetTypeInfo() );
647 typeInfo->GetPropertyIndices( indices );
651 if ( mCustomProperties.Count() > 0 )
653 indices.Reserve( indices.Size() + mCustomProperties.Count() );
655 PropertyMetadataLookup::ConstIterator iter = mCustomProperties.Begin();
656 const PropertyMetadataLookup::ConstIterator endIter = mCustomProperties.End();
658 for ( ; iter != endIter; ++iter, ++i )
660 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>( *iter );
661 if ( custom->childPropertyIndex != Property::INVALID_INDEX )
663 // If it is a child property, add the child property index
664 indices.PushBack( custom->childPropertyIndex );
668 indices.PushBack( PROPERTY_CUSTOM_START_INDEX + i );
674 Property::Index Object::RegisterSceneGraphProperty(const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue) const
676 // Create a new property
677 Dali::Internal::OwnerPointer<PropertyBase> newProperty;
679 switch ( propertyValue.GetType() )
681 case Property::BOOLEAN:
683 newProperty = new AnimatableProperty<bool>( propertyValue.Get<bool>() );
687 case Property::INTEGER:
689 newProperty = new AnimatableProperty<int>( propertyValue.Get<int>() );
693 case Property::FLOAT:
695 newProperty = new AnimatableProperty<float>( propertyValue.Get<float>() );
699 case Property::VECTOR2:
701 newProperty = new AnimatableProperty<Vector2>( propertyValue.Get<Vector2>() );
705 case Property::VECTOR3:
707 newProperty = new AnimatableProperty<Vector3>( propertyValue.Get<Vector3>() );
711 case Property::VECTOR4:
713 newProperty = new AnimatableProperty<Vector4>( propertyValue.Get<Vector4>() );
717 case Property::MATRIX:
719 newProperty = new AnimatableProperty<Matrix>( propertyValue.Get<Matrix>() );
723 case Property::MATRIX3:
725 newProperty = new AnimatableProperty<Matrix3>( propertyValue.Get<Matrix3>() );
729 case Property::ROTATION:
731 newProperty = new AnimatableProperty<Quaternion>( propertyValue.Get<Quaternion>() );
735 case Property::RECTANGLE:
736 case Property::STRING:
737 case Property::ARRAY:
739 case Property::EXTENTS:
742 DALI_ASSERT_ALWAYS( !"PropertyType is not animatable" );
747 // get the scene property owner from derived class
748 const SceneGraph::PropertyOwner* scenePropertyOwner = GetPropertyOwner();
749 // we can only pass properties to scene graph side if there is a scene object
750 if( scenePropertyOwner )
752 // keep a local pointer to the property as the OwnerPointer will pass its copy to the message
753 const PropertyBase* property = newProperty.Get();
754 if(index >= PROPERTY_CUSTOM_START_INDEX)
756 DALI_ASSERT_ALWAYS( index <= PROPERTY_CUSTOM_MAX_INDEX && "Too many custom properties have been registered" );
758 mCustomProperties.PushBack( new CustomPropertyMetadata( name, key, propertyValue, property ) );
762 mAnimatableProperties.PushBack( new AnimatablePropertyMetadata( index, propertyValue, property ) );
765 // queue a message to add the property
766 InstallCustomPropertyMessage( const_cast<EventThreadServices&>(GetEventThreadServices()), *scenePropertyOwner, newProperty ); // Message takes ownership
768 // notify the derived class (optional) method in case it needs to do some more work on the new property
769 // note! have to use the local pointer as OwnerPointer now points to NULL as it handed over its ownership
770 NotifyScenePropertyInstalled( *property, name, index );
776 // property was orphaned and killed so return invalid index
777 return Property::INVALID_INDEX;
781 Property::Index Object::RegisterProperty( const std::string& name, const Property::Value& propertyValue )
783 return RegisterProperty( name, Property::INVALID_KEY, propertyValue, Property::ANIMATABLE );
786 Property::Index Object::RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue )
788 return RegisterProperty( name, key, propertyValue, Property::ANIMATABLE );
791 Property::Index Object::RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode )
793 return RegisterProperty( name, Property::INVALID_KEY, propertyValue, accessMode );
796 Property::Index Object::RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode )
798 // If property with the required key already exists, then just set it.
799 Property::Index index = Property::INVALID_INDEX;
800 if( key != Property::INVALID_KEY ) // Try integer key first if it's valid
802 index = GetPropertyIndex( key );
804 if( index == Property::INVALID_INDEX ) // If it wasn't valid, or doesn't exist, try name
806 index = GetPropertyIndex( name );
809 if( index != Property::INVALID_INDEX ) // If there was a valid index found by either key, set it.
811 SetProperty( index, propertyValue );
815 // Otherwise register the property
817 if( Property::ANIMATABLE == accessMode )
819 index = RegisterSceneGraphProperty( name, key, PROPERTY_CUSTOM_START_INDEX + mCustomProperties.Count(), propertyValue );
820 AddUniformMapping( index, name );
824 // Add entry to the property lookup
825 index = PROPERTY_CUSTOM_START_INDEX + mCustomProperties.Count();
827 CustomPropertyMetadata* customProperty = new CustomPropertyMetadata( name, propertyValue, accessMode );
829 // Resolve index for the child property
830 Object* parent = GetParentObject();
833 const TypeInfo* parentTypeInfo( parent->GetTypeInfo() );
836 Property::Index childPropertyIndex = parentTypeInfo->GetChildPropertyIndex( name );
837 if( childPropertyIndex != Property::INVALID_INDEX )
839 customProperty->childPropertyIndex = childPropertyIndex;
840 index = childPropertyIndex;
845 mCustomProperties.PushBack( customProperty );
852 Dali::PropertyNotification Object::AddPropertyNotification(Property::Index index,
854 const Dali::PropertyCondition& condition)
856 if ( index >= DEFAULT_PROPERTY_MAX_COUNT )
858 if ( index <= PROPERTY_REGISTRATION_MAX_INDEX )
860 DALI_ABORT( "Property notification added to event side only property." );
862 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
864 // check whether the animatable property is registered already, if not then register one.
865 AnimatablePropertyMetadata* animatable = RegisterAnimatableProperty( index );
866 DALI_ASSERT_ALWAYS( animatable && "Property index is invalid" );
868 else if ( mCustomProperties.Count() > 0 )
870 CustomPropertyMetadata* custom = FindCustomProperty( index );
871 DALI_ASSERT_ALWAYS( custom && "Invalid property index" );
872 DALI_ASSERT_ALWAYS( custom->IsAnimatable() && "Property notification added to event side only property." );
876 Dali::Handle self(this);
877 Property target( self, index );
879 PropertyNotificationPtr internal = PropertyNotification::New( target, componentIndex, condition );
880 Dali::PropertyNotification propertyNotification(internal.Get());
882 if( !mPropertyNotifications )
884 mPropertyNotifications = new PropertyNotificationContainer;
886 mPropertyNotifications->push_back(propertyNotification);
888 return propertyNotification;
891 void Object::RemovePropertyNotification(Dali::PropertyNotification propertyNotification)
893 if( mPropertyNotifications )
895 PropertyNotificationContainerIter iter = mPropertyNotifications->begin();
896 while(iter != mPropertyNotifications->end() )
898 if(*iter == propertyNotification)
900 mPropertyNotifications->erase(iter);
901 // As we can't ensure all references are removed, we can just disable
903 GetImplementation(propertyNotification).Disable();
911 void Object::RemovePropertyNotifications()
913 if( mPropertyNotifications )
915 PropertyNotificationContainerIter iter = mPropertyNotifications->begin();
916 while(iter != mPropertyNotifications->end() )
918 // As we can't ensure all references are removed, we can just disable
920 GetImplementation(*iter).Disable();
924 mPropertyNotifications->clear();
928 void Object::NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType )
930 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
932 OnNotifyDefaultPropertyAnimation( animation, index, value, animationType );
936 PropertyMetadata* propertyMetadata = NULL;
937 if( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
939 propertyMetadata = FindAnimatableProperty( index );
943 CustomPropertyMetadata* custom = FindCustomProperty( index );
944 if( custom && custom->IsAnimatable() )
946 propertyMetadata = custom;
950 if( propertyMetadata )
952 switch( animationType )
955 case Animation::BETWEEN:
957 // Update the cached property value
958 propertyMetadata->SetPropertyValue( value );
963 // Adjust the cached property value
964 propertyMetadata->AdjustPropertyValueBy( value );
972 void Object::EnablePropertyNotifications()
974 if( mPropertyNotifications )
976 PropertyNotificationContainerIter iter = mPropertyNotifications->begin();
977 PropertyNotificationContainerIter endIter = mPropertyNotifications->end();
979 for( ; iter != endIter; ++iter )
981 GetImplementation(*iter).Enable();
986 void Object::DisablePropertyNotifications()
988 if( mPropertyNotifications )
990 PropertyNotificationContainerIter iter = mPropertyNotifications->begin();
991 PropertyNotificationContainerIter endIter = mPropertyNotifications->end();
993 for( ; iter != endIter; ++iter )
995 GetImplementation(*iter).Disable();
1000 void Object::AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const
1002 // Get the address of the property if it's a scene property
1003 const PropertyInputImpl* propertyPtr = GetSceneObjectInputProperty( propertyIndex );
1005 // Check instead for newly registered properties
1006 if( propertyPtr == NULL )
1008 PropertyMetadata* animatable = FindAnimatableProperty( propertyIndex );
1009 if( animatable != NULL )
1011 propertyPtr = animatable->GetSceneGraphProperty();
1015 if( propertyPtr == NULL )
1017 PropertyMetadata* custom = FindCustomProperty( propertyIndex );
1018 if( custom != NULL )
1020 propertyPtr = custom->GetSceneGraphProperty();
1024 if( propertyPtr != NULL )
1026 const SceneGraph::PropertyOwner* sceneObject = GetPropertyOwner();
1028 if( sceneObject != NULL )
1030 OwnerPointer< SceneGraph::UniformPropertyMapping > map = new SceneGraph::UniformPropertyMapping( uniformName, propertyPtr );
1031 // Message takes ownership of Uniform map (and will delete it after copy)
1032 AddUniformMapMessage( const_cast<EventThreadServices&>(GetEventThreadServices()), *sceneObject, map );
1036 DALI_ASSERT_ALWAYS(0 && "MESH_REWORK - Need to store property whilst off-stage" );
1041 void Object::RemoveUniformMapping( const std::string& uniformName )
1043 const SceneGraph::PropertyOwner* sceneObject = GetSceneObject();
1044 RemoveUniformMapMessage( GetEventThreadServices(), *sceneObject, uniformName);
1047 Property::Value Object::GetCurrentPropertyValue( const PropertyMetadata* entry ) const
1049 Property::Value value;
1051 DALI_ASSERT_ALWAYS( entry && "Invalid property metadata" );
1053 if( !entry->IsAnimatable() )
1055 value = entry->GetPropertyValue();
1059 BufferIndex bufferIndex( GetEventThreadServices().GetEventBufferIndex() );
1061 switch ( entry->GetType() )
1063 case Property::BOOLEAN:
1065 const AnimatableProperty<bool>* property = static_cast< const AnimatableProperty<bool>* >( entry->GetSceneGraphProperty() );
1066 DALI_ASSERT_DEBUG( NULL != property );
1068 value = (*property)[ bufferIndex ];
1072 case Property::INTEGER:
1074 const AnimatableProperty<int>* property = static_cast< const AnimatableProperty<int>* >( entry->GetSceneGraphProperty() );
1075 DALI_ASSERT_DEBUG( NULL != property );
1077 value = (*property)[ bufferIndex ];
1081 case Property::FLOAT:
1083 const AnimatableProperty<float>* property = static_cast< const AnimatableProperty<float>* >( entry->GetSceneGraphProperty() );
1084 DALI_ASSERT_DEBUG( NULL != property );
1086 value = (*property)[ bufferIndex ];
1090 case Property::VECTOR2:
1092 const AnimatableProperty<Vector2>* property = static_cast< const AnimatableProperty<Vector2>* >( entry->GetSceneGraphProperty() );
1093 DALI_ASSERT_DEBUG( NULL != property );
1095 if(entry->componentIndex == 0)
1097 value = (*property)[ bufferIndex ].x;
1099 else if(entry->componentIndex == 1)
1101 value = (*property)[ bufferIndex ].y;
1105 value = (*property)[ bufferIndex ];
1110 case Property::VECTOR3:
1112 const AnimatableProperty<Vector3>* property = static_cast< const AnimatableProperty<Vector3>* >( entry->GetSceneGraphProperty() );
1113 DALI_ASSERT_DEBUG( NULL != property );
1115 if(entry->componentIndex == 0)
1117 value = (*property)[ bufferIndex ].x;
1119 else if(entry->componentIndex == 1)
1121 value = (*property)[ bufferIndex ].y;
1123 else if(entry->componentIndex == 2)
1125 value = (*property)[ bufferIndex ].z;
1129 value = (*property)[ bufferIndex ];
1134 case Property::VECTOR4:
1136 const AnimatableProperty<Vector4>* property = static_cast< const AnimatableProperty<Vector4>* >( entry->GetSceneGraphProperty() );
1137 DALI_ASSERT_DEBUG( NULL != property );
1139 if(entry->componentIndex == 0)
1141 value = (*property)[ bufferIndex ].x;
1143 else if(entry->componentIndex == 1)
1145 value = (*property)[ bufferIndex ].y;
1147 else if(entry->componentIndex == 2)
1149 value = (*property)[ bufferIndex ].z;
1151 else if(entry->componentIndex == 3)
1153 value = (*property)[ bufferIndex ].w;
1157 value = (*property)[ bufferIndex ];
1162 case Property::MATRIX:
1164 const AnimatableProperty<Matrix>* property = static_cast< const AnimatableProperty<Matrix>* >( entry->GetSceneGraphProperty() );
1165 DALI_ASSERT_DEBUG( NULL != property );
1167 value = (*property)[ bufferIndex ];
1171 case Property::MATRIX3:
1173 const AnimatableProperty<Matrix3>* property = static_cast< const AnimatableProperty<Matrix3>* >( entry->GetSceneGraphProperty() );
1174 DALI_ASSERT_DEBUG( NULL != property );
1176 value = (*property)[ bufferIndex ];
1180 case Property::ROTATION:
1182 const AnimatableProperty<Quaternion>* property = static_cast< const AnimatableProperty<Quaternion>* >( entry->GetSceneGraphProperty() );
1183 DALI_ASSERT_DEBUG( NULL != property );
1185 value = (*property)[ bufferIndex ];
1191 // unreachable code due to higher level logic
1199 void Object::SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value )
1201 switch ( entry.GetType() )
1203 case Property::BOOLEAN:
1205 const AnimatableProperty<bool>* property = dynamic_cast< const AnimatableProperty<bool>* >( entry.GetSceneGraphProperty() );
1206 DALI_ASSERT_DEBUG( NULL != property );
1208 // property is being used in a separate thread; queue a message to set the property
1209 BakeMessage<bool>( GetEventThreadServices(), *property, value.Get<bool>() );
1213 case Property::INTEGER:
1215 const AnimatableProperty<int>* property = dynamic_cast< const AnimatableProperty<int>* >( entry.GetSceneGraphProperty() );
1216 DALI_ASSERT_DEBUG( NULL != property );
1218 // property is being used in a separate thread; queue a message to set the property
1219 BakeMessage<int>( GetEventThreadServices(), *property, value.Get<int>() );
1223 case Property::FLOAT:
1225 const AnimatableProperty<float>* property = dynamic_cast< const AnimatableProperty<float>* >( entry.GetSceneGraphProperty() );
1226 DALI_ASSERT_DEBUG( NULL != property );
1228 // property is being used in a separate thread; queue a message to set the property
1229 BakeMessage<float>( GetEventThreadServices(), *property, value.Get<float>() );
1233 case Property::VECTOR2:
1235 const AnimatableProperty<Vector2>* property = dynamic_cast< const AnimatableProperty<Vector2>* >( entry.GetSceneGraphProperty() );
1236 DALI_ASSERT_DEBUG( NULL != property );
1238 // property is being used in a separate thread; queue a message to set the property
1239 if(entry.componentIndex == 0)
1241 SetXComponentMessage<Vector2>( GetEventThreadServices(), *property, value.Get<float>() );
1243 else if(entry.componentIndex == 1)
1245 SetYComponentMessage<Vector2>( GetEventThreadServices(), *property, value.Get<float>() );
1249 BakeMessage<Vector2>( GetEventThreadServices(), *property, value.Get<Vector2>() );
1254 case Property::VECTOR3:
1256 const AnimatableProperty<Vector3>* property = dynamic_cast< const AnimatableProperty<Vector3>* >( entry.GetSceneGraphProperty() );
1257 DALI_ASSERT_DEBUG( NULL != property );
1259 // property is being used in a separate thread; queue a message to set the property
1260 if(entry.componentIndex == 0)
1262 SetXComponentMessage<Vector3>( GetEventThreadServices(), *property, value.Get<float>() );
1264 else if(entry.componentIndex == 1)
1266 SetYComponentMessage<Vector3>( GetEventThreadServices(), *property, value.Get<float>() );
1268 else if(entry.componentIndex == 2)
1270 SetZComponentMessage<Vector3>( GetEventThreadServices(), *property, value.Get<float>() );
1274 BakeMessage<Vector3>( GetEventThreadServices(), *property, value.Get<Vector3>() );
1280 case Property::VECTOR4:
1282 const AnimatableProperty<Vector4>* property = dynamic_cast< const AnimatableProperty<Vector4>* >( entry.GetSceneGraphProperty() );
1283 DALI_ASSERT_DEBUG( NULL != property );
1285 // property is being used in a separate thread; queue a message to set the property
1286 if(entry.componentIndex == 0)
1288 SetXComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1290 else if(entry.componentIndex == 1)
1292 SetYComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1294 else if(entry.componentIndex == 2)
1296 SetZComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1298 else if(entry.componentIndex == 3)
1300 SetWComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1304 BakeMessage<Vector4>( GetEventThreadServices(), *property, value.Get<Vector4>() );
1309 case Property::ROTATION:
1311 const AnimatableProperty<Quaternion>* property = dynamic_cast< const AnimatableProperty<Quaternion>* >( entry.GetSceneGraphProperty() );
1312 DALI_ASSERT_DEBUG( NULL != property );
1314 // property is being used in a separate thread; queue a message to set the property
1315 BakeMessage<Quaternion>( GetEventThreadServices(), *property, value.Get<Quaternion>() );
1319 case Property::MATRIX:
1321 const AnimatableProperty<Matrix>* property = dynamic_cast< const AnimatableProperty<Matrix>* >( entry.GetSceneGraphProperty() );
1322 DALI_ASSERT_DEBUG( NULL != property );
1324 // property is being used in a separate thread; queue a message to set the property
1325 BakeMessage<Matrix>( GetEventThreadServices(), *property, value.Get<Matrix>() );
1329 case Property::MATRIX3:
1331 const AnimatableProperty<Matrix3>* property = dynamic_cast< const AnimatableProperty<Matrix3>* >( entry.GetSceneGraphProperty() );
1332 DALI_ASSERT_DEBUG( NULL != property );
1334 // property is being used in a separate thread; queue a message to set the property
1335 BakeMessage<Matrix3>( GetEventThreadServices(), *property, value.Get<Matrix3>() );
1341 // non-animatable scene graph property, do nothing
1346 const TypeInfo* Object::GetTypeInfo() const
1350 // This uses a dynamic_cast so can be quite expensive so we only really want to do it once
1351 // especially as the type-info does not change during the life-time of an application
1353 Dali::TypeInfo typeInfoHandle = TypeRegistry::Get()->GetTypeInfo( this );
1354 if ( typeInfoHandle )
1356 mTypeInfo = &GetImplementation( typeInfoHandle );
1363 void Object::ApplyConstraint( ConstraintBase& constraint )
1367 mConstraints = new ConstraintContainer;
1369 mConstraints->push_back( Dali::Constraint( &constraint ) );
1372 void Object::RemoveConstraint( ConstraintBase& constraint )
1374 // NULL if the Constraint sources are destroyed before Constraint::Apply()
1377 ConstraintIter it( std::find( mConstraints->begin(), mConstraints->end(), Dali::Constraint( &constraint ) ) );
1378 if( it != mConstraints->end() )
1380 mConstraints->erase( it );
1385 void Object::RemoveConstraints()
1387 // guard against constraint sending messages during core destruction
1388 if( mConstraints && Stage::IsInstalled() )
1390 // If we have nothing in the scene-graph, just clear constraint containers
1391 const SceneGraph::PropertyOwner* propertyOwner = GetSceneObject();
1392 if ( NULL != propertyOwner )
1394 const ConstraintConstIter endIter = mConstraints->end();
1395 for ( ConstraintIter iter = mConstraints->begin(); endIter != iter; ++iter )
1397 GetImplementation( *iter ).RemoveInternal();
1401 delete mConstraints;
1402 mConstraints = NULL;
1406 void Object::RemoveConstraints( unsigned int tag )
1408 // guard against constraint sending messages during core destruction
1409 if( mConstraints && Stage::IsInstalled() )
1411 ConstraintIter iter( mConstraints->begin() );
1412 while(iter != mConstraints->end() )
1414 ConstraintBase& constraint = GetImplementation( *iter );
1415 if( constraint.GetTag() == tag )
1417 GetImplementation( *iter ).RemoveInternal();
1418 iter = mConstraints->erase( iter );
1426 if ( mConstraints->empty() )
1428 delete mConstraints;
1429 mConstraints = NULL;
1434 void Object::SetTypeInfo( const TypeInfo* typeInfo )
1436 mTypeInfo = typeInfo;
1441 // Notification for observers
1442 for( ConstObserverIter iter = mObservers.Begin(), endIter = mObservers.End(); iter != endIter; ++iter)
1444 (*iter)->ObjectDestroyed(*this);
1447 delete mConstraints;
1448 delete mPropertyNotifications;
1451 CustomPropertyMetadata* Object::FindCustomProperty( Property::Index index ) const
1453 CustomPropertyMetadata* property( NULL );
1454 if ( ( index >= CHILD_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= CHILD_PROPERTY_REGISTRATION_MAX_INDEX ) )
1456 for ( std::size_t arrayIndex = 0; arrayIndex < mCustomProperties.Count(); arrayIndex++ )
1458 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>( mCustomProperties[ arrayIndex ] );
1459 if( custom->childPropertyIndex == index )
1467 int arrayIndex = index - PROPERTY_CUSTOM_START_INDEX;
1468 if( arrayIndex >= 0 )
1470 if( arrayIndex < static_cast<int>( mCustomProperties.Count() ) ) // we can only access the first 2 billion custom properties
1472 property = static_cast<CustomPropertyMetadata*>(mCustomProperties[ arrayIndex ]);
1479 AnimatablePropertyMetadata* Object::FindAnimatableProperty( Property::Index index ) const
1481 const PropertyMetadataLookup::SizeType count = mAnimatableProperties.Count();
1482 for ( PropertyMetadataLookup::SizeType arrayIndex = 0; arrayIndex < count; ++arrayIndex )
1484 AnimatablePropertyMetadata* property = static_cast<AnimatablePropertyMetadata*>( mAnimatableProperties[ arrayIndex ] );
1485 if( property->index == index )
1493 AnimatablePropertyMetadata* Object::RegisterAnimatableProperty(Property::Index index) const
1495 DALI_ASSERT_ALWAYS( (( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ))
1496 && "Property index is out of bounds" );
1498 // check whether the animatable property is registered already, if not then register one.
1499 AnimatablePropertyMetadata* animatableProperty = FindAnimatableProperty( index );
1500 if( !animatableProperty )
1502 const TypeInfo* typeInfo( GetTypeInfo() );
1505 Property::Index basePropertyIndex = typeInfo->GetBasePropertyIndex(index);
1506 if( basePropertyIndex == Property::INVALID_INDEX )
1508 // If the property is not a component of a base property, register the whole property itself.
1509 const std::string& propertyName = typeInfo->GetPropertyName(index);
1510 RegisterSceneGraphProperty(propertyName, Property::INVALID_KEY, index, typeInfo->GetPropertyDefaultValue(index));
1511 AddUniformMapping( index, propertyName );
1515 // Since the property is a component of a base property, check whether the base property is registered.
1516 animatableProperty = FindAnimatableProperty( basePropertyIndex );
1517 if( !animatableProperty )
1519 // If the base property is not registered yet, register the base property first.
1520 const std::string& basePropertyName = typeInfo->GetPropertyName(basePropertyIndex);
1522 if( Property::INVALID_INDEX != RegisterSceneGraphProperty( basePropertyName, Property::INVALID_KEY, basePropertyIndex, typeInfo->GetPropertyDefaultValue( basePropertyIndex ) ) )
1524 animatableProperty = static_cast<AnimatablePropertyMetadata*>(mAnimatableProperties[mAnimatableProperties.Size()-1]);
1525 AddUniformMapping( basePropertyIndex, basePropertyName );
1529 if(animatableProperty)
1531 // Create the metadata for the property component.
1532 mAnimatableProperties.PushBack( new AnimatablePropertyMetadata( index, typeInfo->GetComponentIndex(index), animatableProperty->value, animatableProperty->GetSceneGraphProperty() ) );
1536 // The metadata has just been added and therefore should be in the end of the vector.
1537 animatableProperty = static_cast<AnimatablePropertyMetadata*>(mAnimatableProperties[mAnimatableProperties.Size()-1]);
1541 return animatableProperty;
1544 void Object::ResolveChildProperties()
1546 // Resolve index for the child property
1547 Object* parent = GetParentObject();
1550 const TypeInfo* parentTypeInfo( parent->GetTypeInfo() );
1551 if( parentTypeInfo )
1553 // Go through each custom property
1554 const PropertyMetadataLookup::SizeType count = mCustomProperties.Count();
1555 for ( PropertyMetadataLookup::SizeType arrayIndex = 0; arrayIndex < count; ++arrayIndex )
1557 CustomPropertyMetadata* customProperty = static_cast<CustomPropertyMetadata*>( mCustomProperties[ arrayIndex ] );
1559 if( customProperty->name == "" )
1561 if( customProperty->childPropertyIndex != Property::INVALID_INDEX )
1563 // Resolve name for any child property with no name
1564 customProperty->name = parentTypeInfo->GetChildPropertyName( customProperty->childPropertyIndex );
1569 Property::Index childPropertyIndex = parentTypeInfo->GetChildPropertyIndex( customProperty->name );
1570 if( childPropertyIndex != Property::INVALID_INDEX )
1572 // Resolve index for any property with a name that matches the parent's child property name
1573 customProperty->childPropertyIndex = childPropertyIndex;
1581 } // namespace Internal