2 * Copyright (c) 2018 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/devel-api/object/handle-devel.h>
27 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
28 #include <dali/internal/update/common/animatable-property.h>
29 #include <dali/internal/update/common/property-owner.h>
30 #include <dali/internal/update/common/property-owner-messages.h>
31 #include <dali/internal/update/common/uniform-map.h>
32 #include <dali/internal/event/animation/constraint-impl.h>
33 #include <dali/internal/event/common/property-helper.h>
34 #include <dali/internal/event/common/property-notification-impl.h>
35 #include <dali/internal/event/common/stage-impl.h>
36 #include <dali/internal/event/common/type-registry-impl.h>
38 using Dali::Internal::SceneGraph::AnimatableProperty;
39 using Dali::Internal::SceneGraph::PropertyBase;
47 namespace // unnamed namespace
49 const int32_t SUPPORTED_CAPABILITIES = Dali::Handle::DYNAMIC_PROPERTIES; // Object provides this capability
51 #if defined(DEBUG_ENABLED)
52 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_OBJECT" );
55 constexpr Property::Index MAX_PER_CLASS_PROPERTY_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX;
57 } // unnamed namespace
59 IntrusivePtr<Object> Object::New()
61 return new Object( nullptr ); // no scene object by default
64 void Object::AddObserver(Observer& observer)
66 // make sure an observer doesn't observe the same object twice
67 // otherwise it will get multiple calls to OnSceneObjectAdd(), OnSceneObjectRemove() and ObjectDestroyed()
68 DALI_ASSERT_DEBUG( mObservers.End() == std::find( mObservers.Begin(), mObservers.End(), &observer));
70 mObservers.PushBack( &observer );
73 void Object::RemoveObserver(Observer& observer)
75 // Find the observer...
76 const auto endIter = mObservers.End();
77 for( auto iter = mObservers.Begin(); iter != endIter; ++iter)
79 if( (*iter) == &observer)
81 mObservers.Erase( iter );
85 DALI_ASSERT_DEBUG(endIter != mObservers.End());
88 bool Object::Supports( Capability capability ) const
90 return (capability & SUPPORTED_CAPABILITIES);
93 uint32_t Object::GetPropertyCount() const
96 const TypeInfo* typeInfo( GetTypeInfo() );
99 count = typeInfo->GetPropertyCount();
101 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Registered Properties: %d\n", count );
104 uint32_t custom = static_cast<uint32_t>( mCustomProperties.Count() );
106 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Custom Properties: %d\n", custom );
108 DALI_LOG_INFO( gLogFilter, Debug::Concise, "Total Properties: %d\n", count );
113 std::string Object::GetPropertyName( Property::Index index ) const
115 DALI_ASSERT_ALWAYS( index > Property::INVALID_INDEX && "Property index out of bounds" );
117 // is this a per class or per instance property
118 if ( index < MAX_PER_CLASS_PROPERTY_INDEX )
120 const TypeInfo* typeInfo( GetTypeInfo() );
123 return typeInfo->GetPropertyName( index );
126 else // child property or custom property
128 CustomPropertyMetadata* custom = FindCustomProperty( index );
135 DALI_LOG_ERROR( "Property index %d not found\n", index );
136 return std::string();
139 Property::Index Object::GetPropertyIndex( const std::string& name ) const
141 Property::Index index = Property::INVALID_INDEX;
143 const TypeInfo* typeInfo( GetTypeInfo() );
146 index = typeInfo->GetPropertyIndex( name );
148 if( (index == Property::INVALID_INDEX)&&( mCustomProperties.Count() > 0 ) )
150 Property::Index count = PROPERTY_CUSTOM_START_INDEX;
151 const auto end = mCustomProperties.End();
152 for( auto iter = mCustomProperties.Begin(); iter != end; ++iter, ++count )
154 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>(*iter);
155 if ( custom->name == name )
157 if ( custom->childPropertyIndex != Property::INVALID_INDEX )
159 // If it is a child property, return the child property index
160 index = custom->childPropertyIndex;
174 Property::Index Object::GetPropertyIndex( Property::Index key ) const
176 Property::Index index = Property::INVALID_INDEX;
178 if( mCustomProperties.Count() > 0 )
180 Property::Index count = PROPERTY_CUSTOM_START_INDEX;
181 const auto end = mCustomProperties.End();
182 for( auto iter = mCustomProperties.Begin(); iter != end; ++iter, ++count )
184 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>(*iter);
185 if( custom->key == key )
187 if( custom->childPropertyIndex != Property::INVALID_INDEX )
189 // If it is a child property, return the child property index
190 index = custom->childPropertyIndex;
204 Property::Index Object::GetPropertyIndex( Property::Key key ) const
206 Property::Index index = Property::INVALID_INDEX;
207 if( key.type == Property::Key::INDEX )
209 index = GetPropertyIndex( key.indexKey );
213 index = GetPropertyIndex( key.stringKey );
218 bool Object::IsPropertyWritable( Property::Index index ) const
220 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds");
222 bool writable = false;
224 // is this a per class or per instance property
225 if ( index < MAX_PER_CLASS_PROPERTY_INDEX )
227 const TypeInfo* typeInfo( GetTypeInfo() );
230 writable = typeInfo->IsPropertyWritable( index );
235 CustomPropertyMetadata* custom = FindCustomProperty( index );
238 writable = custom->IsWritable();
245 bool Object::IsPropertyAnimatable( Property::Index index ) const
247 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds");
249 bool animatable = false;
251 // is this a per class or per instance property
252 if ( index < MAX_PER_CLASS_PROPERTY_INDEX )
254 const TypeInfo* typeInfo( GetTypeInfo() );
257 animatable = typeInfo->IsPropertyAnimatable( index );
262 CustomPropertyMetadata* custom = FindCustomProperty( index );
265 animatable = custom->IsAnimatable();
272 bool Object::IsPropertyAConstraintInput( Property::Index index ) const
274 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds");
276 bool isConstraintInput = false;
278 // is this a per class or per instance property
279 if ( index < MAX_PER_CLASS_PROPERTY_INDEX )
281 const TypeInfo* typeInfo( GetTypeInfo() );
284 isConstraintInput = typeInfo->IsPropertyAConstraintInput( index );
289 CustomPropertyMetadata* custom = FindCustomProperty( index );
292 // ... custom properties can be used as input to a constraint.
293 isConstraintInput = true;
297 return isConstraintInput;
300 Property::Type Object::GetPropertyType( Property::Index index ) const
302 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds" );
304 // is this a per class or per instance property
305 if ( index < MAX_PER_CLASS_PROPERTY_INDEX )
307 const TypeInfo* typeInfo( GetTypeInfo() );
310 return typeInfo->GetPropertyType( index );
314 CustomPropertyMetadata* custom = FindCustomProperty( index );
317 return custom->GetType();
320 return Property::NONE;
323 void Object::SetProperty( Property::Index index, const Property::Value& propertyValue )
325 DALI_ASSERT_ALWAYS(index > Property::INVALID_INDEX && "Property index is out of bounds" );
327 bool propertySet( true );
329 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
331 SetDefaultProperty( index, propertyValue );
333 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
335 const TypeInfo* typeInfo( GetTypeInfo() );
338 typeInfo->SetProperty( this, index, propertyValue );
342 // cannot register this property as there is no setter for it.
343 // event side properties must have a setter for now so need to be registered
344 DALI_LOG_ERROR( "Property index %d not found\n", index );
348 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
350 // check whether the animatable property is registered already, if not then register one.
351 AnimatablePropertyMetadata* animatableProperty = GetSceneAnimatableProperty( index, &propertyValue );
352 if( !animatableProperty )
354 DALI_LOG_ERROR( "Property index %d not found\n", index );
359 // update the cached property value
360 animatableProperty->SetPropertyValue( propertyValue );
362 // set the scene graph property value
363 SetSceneGraphProperty( index, *animatableProperty, propertyValue );
368 CustomPropertyMetadata* custom = FindCustomProperty( index );
370 if ( ( index >= CHILD_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= CHILD_PROPERTY_REGISTRATION_MAX_INDEX ) )
374 // If the child property is not registered yet, register it.
375 custom = new CustomPropertyMetadata( "", propertyValue, Property::READ_WRITE );
376 mCustomProperties.PushBack( custom );
379 custom->childPropertyIndex = index;
381 // Resolve name for the child property
382 Object* parent = GetParentObject();
385 const TypeInfo* parentTypeInfo( parent->GetTypeInfo() );
388 custom->name = parentTypeInfo->GetChildPropertyName( index );
395 if( custom->IsAnimatable() )
397 // update the cached property value
398 custom->SetPropertyValue( propertyValue );
400 // set the scene graph property value
401 SetSceneGraphProperty( index, *custom, propertyValue );
403 else if( custom->IsWritable() )
405 // update the cached property value
406 custom->SetPropertyValue( propertyValue );
410 // trying to set value on read only property is no-op
416 DALI_LOG_ERROR( "Property index %d not found\n", index );
421 // Let derived classes know that a property has been set
422 // 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
425 OnPropertySet( index, propertyValue );
426 Dali::Handle handle( this );
427 mPropertySetSignal.Emit( handle, index, propertyValue );
431 Property::Value Object::GetProperty( Property::Index index ) const
433 DALI_ASSERT_ALWAYS( index > Property::INVALID_INDEX && "Property index is out of bounds" );
435 Property::Value value;
437 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
439 value = GetDefaultProperty( index );
441 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
443 const TypeInfo* typeInfo( GetTypeInfo() );
446 value = typeInfo->GetProperty( this, index );
450 DALI_LOG_ERROR( "Property index %d not found\n", index );
453 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
455 // check whether the animatable property is registered already, if not then register one.
456 // this is needed because property value may have been set as full property and get as a property component
457 AnimatablePropertyMetadata* animatableProperty = GetSceneAnimatableProperty( index, nullptr );
458 if( animatableProperty )
460 // get the cached animatable property value
461 value = animatableProperty->GetPropertyValue();
465 DALI_LOG_ERROR( "Property index %d not found\n", index );
468 else if(mCustomProperties.Count() > 0)
470 CustomPropertyMetadata* custom = FindCustomProperty( index );
473 // get the cached custom property value
474 value = custom->GetPropertyValue();
478 DALI_LOG_ERROR( "Property index %d not found\n", index );
485 Property::Value Object::GetCurrentProperty( Property::Index index ) const
487 DALI_ASSERT_ALWAYS( index > Property::INVALID_INDEX && "Property index is out of bounds" );
489 Property::Value value;
491 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
493 value = GetDefaultPropertyCurrentValue( index );
495 else if ( ( index >= PROPERTY_REGISTRATION_START_INDEX ) && ( index <= PROPERTY_REGISTRATION_MAX_INDEX ) )
497 const TypeInfo* typeInfo( GetTypeInfo() );
500 value = typeInfo->GetProperty( this, index );
504 DALI_LOG_ERROR( "Property index %d not found\n", index );
507 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
509 // check whether the animatable property is registered already, if not then register one.
510 // this is needed because property value may have been set as full property and get as a property component
511 AnimatablePropertyMetadata* animatableProperty = GetSceneAnimatableProperty( index, nullptr );
512 if( animatableProperty )
514 // get the animatable property value
515 value = GetCurrentPropertyValue( *animatableProperty );
519 DALI_LOG_ERROR( "Property index %d not found\n", index );
522 else if(mCustomProperties.Count() > 0)
524 CustomPropertyMetadata* custom = FindCustomProperty( index );
527 // get the custom property value
528 value = GetCurrentPropertyValue( *custom );
532 DALI_LOG_ERROR( "Property index %d not found\n", index );
539 void Object::GetPropertyIndices( Property::IndexContainer& indices ) const
544 const TypeInfo* typeInfo( GetTypeInfo() );
547 typeInfo->GetPropertyIndices( indices );
551 if ( mCustomProperties.Count() > 0 )
553 indices.Reserve( indices.Size() + mCustomProperties.Count() );
555 auto iter = mCustomProperties.Begin();
556 const auto endIter = mCustomProperties.End();
558 for ( ; iter != endIter; ++iter, ++i )
560 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>( *iter );
561 if ( custom->childPropertyIndex != Property::INVALID_INDEX )
563 // If it is a child property, add the child property index
564 indices.PushBack( custom->childPropertyIndex );
568 indices.PushBack( PROPERTY_CUSTOM_START_INDEX + i );
574 Property::Index Object::RegisterProperty( const std::string& name, const Property::Value& propertyValue )
576 return RegisterProperty( name, Property::INVALID_KEY, propertyValue, Property::ANIMATABLE );
579 Property::Index Object::RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue )
581 return RegisterProperty( name, key, propertyValue, Property::ANIMATABLE );
584 Property::Index Object::RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode )
586 return RegisterProperty( name, Property::INVALID_KEY, propertyValue, accessMode );
589 Property::Index Object::RegisterProperty( const std::string& name, Property::Index key, const Property::Value& propertyValue, Property::AccessMode accessMode )
591 // If property with the required key already exists, then just set it.
592 Property::Index index = Property::INVALID_INDEX;
593 if( key != Property::INVALID_KEY ) // Try integer key first if it's valid
595 index = GetPropertyIndex( key );
597 if( index == Property::INVALID_INDEX ) // If it wasn't valid, or doesn't exist, try name
599 index = GetPropertyIndex( name );
602 if( index != Property::INVALID_INDEX ) // If there was a valid index found by either key, set it.
604 SetProperty( index, propertyValue );
608 // Otherwise register the property
609 if( Property::ANIMATABLE == accessMode )
611 index = RegisterSceneGraphProperty( name, key, PROPERTY_CUSTOM_START_INDEX + static_cast<Property::Index>( mCustomProperties.Count() ), propertyValue );
612 AddUniformMapping( index, name );
616 // Add entry to the property lookup
617 index = PROPERTY_CUSTOM_START_INDEX + static_cast<Property::Index>( mCustomProperties.Count() );
619 CustomPropertyMetadata* customProperty = new CustomPropertyMetadata( name, propertyValue, accessMode );
621 // Resolve index for the child property
622 Object* parent = GetParentObject();
625 const TypeInfo* parentTypeInfo( parent->GetTypeInfo() );
628 Property::Index childPropertyIndex = parentTypeInfo->GetChildPropertyIndex( name );
629 if( childPropertyIndex != Property::INVALID_INDEX )
631 customProperty->childPropertyIndex = childPropertyIndex;
632 index = childPropertyIndex;
637 mCustomProperties.PushBack( customProperty );
644 bool Object::DoesCustomPropertyExist( Property::Index index )
646 auto metadata = FindCustomProperty( index );
647 return metadata != nullptr;
650 Dali::PropertyNotification Object::AddPropertyNotification( Property::Index index,
651 int32_t componentIndex,
652 const Dali::PropertyCondition& condition)
654 if ( index >= DEFAULT_PROPERTY_MAX_COUNT )
656 if ( index <= PROPERTY_REGISTRATION_MAX_INDEX )
658 DALI_ABORT( "Property notification added to event side only property." );
660 else if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
662 // check whether the animatable property is registered already, if not then register one.
663 AnimatablePropertyMetadata* animatable = GetSceneAnimatableProperty( index, nullptr );
664 DALI_ASSERT_ALWAYS( animatable && "Property index is invalid" );
666 else if ( mCustomProperties.Count() > 0 )
668 CustomPropertyMetadata* custom = FindCustomProperty( index );
669 DALI_ASSERT_ALWAYS( custom && "Invalid property index" );
670 DALI_ASSERT_ALWAYS( custom->IsAnimatable() && "Property notification added to event side only property." );
674 Dali::Handle self(this);
675 Property target( self, index );
677 PropertyNotificationPtr internal = PropertyNotification::New( target, componentIndex, condition );
678 Dali::PropertyNotification propertyNotification(internal.Get());
680 if( !mPropertyNotifications )
682 mPropertyNotifications = new PropertyNotificationContainer;
684 mPropertyNotifications->push_back(propertyNotification);
686 return propertyNotification;
689 void Object::RemovePropertyNotification(Dali::PropertyNotification propertyNotification)
691 if( mPropertyNotifications )
693 auto iter = mPropertyNotifications->begin();
694 while(iter != mPropertyNotifications->end() )
696 if(*iter == propertyNotification)
698 mPropertyNotifications->erase(iter);
699 // As we can't ensure all references are removed, we can just disable
701 GetImplementation(propertyNotification).Disable();
709 void Object::RemovePropertyNotifications()
711 if( mPropertyNotifications )
713 auto iter = mPropertyNotifications->begin();
714 while(iter != mPropertyNotifications->end() )
716 // As we can't ensure all references are removed, we can just disable
718 GetImplementation(*iter).Disable();
722 mPropertyNotifications->clear();
726 void Object::NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType )
728 if ( index < DEFAULT_PROPERTY_MAX_COUNT )
730 OnNotifyDefaultPropertyAnimation( animation, index, value, animationType );
734 PropertyMetadata* propertyMetadata = nullptr;
735 if( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
737 propertyMetadata = FindAnimatableProperty( index );
741 CustomPropertyMetadata* custom = FindCustomProperty( index );
742 if( custom && custom->IsAnimatable() )
744 propertyMetadata = custom;
748 if( propertyMetadata )
750 switch( animationType )
753 case Animation::BETWEEN:
755 // Update the cached property value
756 propertyMetadata->SetPropertyValue( value );
761 // Adjust the cached property value
762 propertyMetadata->AdjustPropertyValueBy( value );
770 void Object::AddUniformMapping( Property::Index propertyIndex, const std::string& uniformName ) const
772 // Get the address of the property if it's a scene property
773 const PropertyInputImpl* propertyPtr = GetSceneObjectInputProperty( propertyIndex );
775 // Check instead for newly registered properties
776 if( propertyPtr == nullptr )
778 PropertyMetadata* animatable = FindAnimatableProperty( propertyIndex );
781 propertyPtr = animatable->GetSceneGraphProperty();
785 if( propertyPtr == nullptr )
787 PropertyMetadata* custom = FindCustomProperty( propertyIndex );
790 propertyPtr = custom->GetSceneGraphProperty();
796 const SceneGraph::PropertyOwner& sceneObject = GetSceneObject();
798 OwnerPointer< SceneGraph::UniformPropertyMapping > map = new SceneGraph::UniformPropertyMapping( uniformName, propertyPtr );
799 // Message takes ownership of Uniform map (and will delete it after copy)
800 AddUniformMapMessage( const_cast<EventThreadServices&>(GetEventThreadServices()), sceneObject, map );
804 void Object::RemoveUniformMapping( const std::string& uniformName ) const
806 const SceneGraph::PropertyOwner& sceneObject = GetSceneObject();
807 RemoveUniformMapMessage( const_cast<EventThreadServices&>(GetEventThreadServices()), sceneObject, uniformName);
810 void Object::ApplyConstraint( ConstraintBase& constraint )
814 mConstraints = new ConstraintContainer;
816 mConstraints->push_back( Dali::Constraint( &constraint ) );
819 void Object::RemoveConstraint( ConstraintBase& constraint )
821 // nullptr if the Constraint sources are destroyed before Constraint::Apply()
824 ConstraintIter it( std::find( mConstraints->begin(), mConstraints->end(), Dali::Constraint( &constraint ) ) );
825 if( it != mConstraints->end() )
827 mConstraints->erase( it );
832 void Object::RemoveConstraints()
834 // guard against constraint sending messages during core destruction
835 if( mConstraints && Stage::IsInstalled() )
837 for ( auto&& item : *mConstraints )
839 GetImplementation( item ).RemoveInternal();
843 mConstraints = nullptr;
847 void Object::RemoveConstraints( uint32_t tag )
849 // guard against constraint sending messages during core destruction
850 if( mConstraints && Stage::IsInstalled() )
852 auto iter( mConstraints->begin() );
853 while(iter != mConstraints->end() )
855 ConstraintBase& constraint = GetImplementation( *iter );
856 if( constraint.GetTag() == tag )
858 GetImplementation( *iter ).RemoveInternal();
859 iter = mConstraints->erase( iter );
867 if ( mConstraints->empty() )
870 mConstraints = nullptr;
875 void Object::SetTypeInfo( const TypeInfo* typeInfo )
877 mTypeInfo = typeInfo;
880 const SceneGraph::PropertyOwner& Object::GetSceneObject() const
884 auto sceneObject = SceneGraph::PropertyOwner::New();
885 OwnerPointer< SceneGraph::PropertyOwner > transferOwnership( sceneObject );
886 mUpdateObject = sceneObject;
887 AddObjectMessage( const_cast<EventThreadServices&>( GetEventThreadServices() ).GetUpdateManager(), transferOwnership );
889 DALI_ASSERT_DEBUG( mUpdateObject && "there must always be a scene object" );
890 return *mUpdateObject;
893 const PropertyBase* Object::GetSceneObjectAnimatableProperty( Property::Index index ) const
895 const SceneGraph::PropertyBase* property = nullptr;
896 if ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX && index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX )
898 AnimatablePropertyMetadata* animatable = GetSceneAnimatableProperty( index, nullptr );
899 DALI_ASSERT_ALWAYS( animatable && "Property index is invalid" );
901 property = animatable->GetSceneGraphProperty();
903 else if ( ( index >= CHILD_PROPERTY_REGISTRATION_START_INDEX ) && // Child properties are also stored as custom properties
904 ( index <= PROPERTY_CUSTOM_MAX_INDEX ) )
906 CustomPropertyMetadata* custom = FindCustomProperty( index );
907 DALI_ASSERT_ALWAYS( custom && "Property index is invalid" );
909 property = custom->GetSceneGraphProperty();
914 const PropertyInputImpl* Object::GetSceneObjectInputProperty( Property::Index index ) const
916 // reuse animatable version as they are inputs as well
917 return GetSceneObjectAnimatableProperty( index );
920 int32_t Object::GetPropertyComponentIndex( Property::Index index ) const
922 int32_t componentIndex = Property::INVALID_COMPONENT_INDEX;
924 if ( ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ) )
926 // check whether the animatable property is registered already, if not then register one.
927 AnimatablePropertyMetadata* animatableProperty = GetSceneAnimatableProperty( index, nullptr );
928 if( animatableProperty )
930 componentIndex = animatableProperty->componentIndex;
933 if( Property::INVALID_COMPONENT_INDEX == componentIndex )
935 const TypeInfo* typeInfo( GetTypeInfo() );
938 componentIndex = typeInfo->GetComponentIndex(index);
942 return componentIndex;
945 DevelHandle::PropertySetSignalType& Object::PropertySetSignal()
947 return mPropertySetSignal;
950 Object::Object( const SceneGraph::PropertyOwner* sceneObject )
951 : mEventThreadServices( EventThreadServices::Get() ),
952 mUpdateObject( sceneObject ),
953 mTypeInfo( nullptr ),
954 mConstraints( nullptr ),
955 mPropertyNotifications( nullptr )
961 // Notification for observers
962 for( auto&& item : mObservers )
964 item->ObjectDestroyed( *this );
967 delete mPropertyNotifications;
969 // Guard to allow handle destruction after Core has been destroyed
970 if( Stage::IsInstalled() )
972 if( nullptr != mUpdateObject )
974 RemoveObjectMessage( GetEventThreadServices().GetUpdateManager(), mUpdateObject );
979 void Object::OnSceneObjectAdd()
981 // Notification for observers
982 for( auto&& item : mObservers )
984 item->SceneObjectAdded(*this);
987 // enable property notifications in scene graph
988 EnablePropertyNotifications();
991 void Object::OnSceneObjectRemove()
993 // Notification for observers
994 for( auto&& item : mObservers )
996 item->SceneObjectRemoved(*this);
999 // disable property notifications in scene graph
1000 DisablePropertyNotifications();
1003 const TypeInfo* Object::GetTypeInfo() const
1007 // This uses a dynamic_cast so can be quite expensive so we only really want to do it once
1008 // especially as the type-info does not change during the life-time of an application
1010 TypeRegistry::TypeInfoPointer typeInfoHandle = TypeRegistry::Get()->GetTypeInfo( this );
1011 if ( typeInfoHandle )
1013 mTypeInfo = typeInfoHandle.Get(); // just a raw pointer to use, ownership is kept
1020 CustomPropertyMetadata* Object::FindCustomProperty( Property::Index index ) const
1022 CustomPropertyMetadata* property = nullptr;
1023 if ( ( index >= CHILD_PROPERTY_REGISTRATION_START_INDEX ) && ( index <= CHILD_PROPERTY_REGISTRATION_MAX_INDEX ) )
1025 for ( std::size_t arrayIndex = 0; arrayIndex < mCustomProperties.Count(); arrayIndex++ )
1027 CustomPropertyMetadata* custom = static_cast<CustomPropertyMetadata*>( mCustomProperties[ arrayIndex ] );
1028 if( custom->childPropertyIndex == index )
1036 int32_t arrayIndex = index - PROPERTY_CUSTOM_START_INDEX;
1037 if( arrayIndex >= 0 )
1039 if( arrayIndex < static_cast<int32_t>( mCustomProperties.Count() ) ) // we can only access the first 2 billion custom properties
1041 property = static_cast<CustomPropertyMetadata*>(mCustomProperties[ arrayIndex ]);
1048 AnimatablePropertyMetadata* Object::FindAnimatableProperty( Property::Index index ) const
1050 for( auto&& entry : mAnimatableProperties )
1052 AnimatablePropertyMetadata* property = static_cast<AnimatablePropertyMetadata*>( entry );
1053 if( property->index == index )
1061 Property::Index Object::RegisterSceneGraphProperty( const std::string& name, Property::Index key, Property::Index index, const Property::Value& propertyValue ) const
1063 // Create a new property
1064 Dali::Internal::OwnerPointer<PropertyBase> newProperty;
1066 switch ( propertyValue.GetType() )
1068 case Property::BOOLEAN:
1070 newProperty = new AnimatableProperty<bool>( propertyValue.Get<bool>() );
1074 case Property::INTEGER:
1076 newProperty = new AnimatableProperty<int32_t>( propertyValue.Get<int32_t>() );
1080 case Property::FLOAT:
1082 newProperty = new AnimatableProperty<float>( propertyValue.Get<float>() );
1086 case Property::VECTOR2:
1088 newProperty = new AnimatableProperty<Vector2>( propertyValue.Get<Vector2>() );
1092 case Property::VECTOR3:
1094 newProperty = new AnimatableProperty<Vector3>( propertyValue.Get<Vector3>() );
1098 case Property::VECTOR4:
1100 newProperty = new AnimatableProperty<Vector4>( propertyValue.Get<Vector4>() );
1104 case Property::MATRIX:
1106 newProperty = new AnimatableProperty<Matrix>( propertyValue.Get<Matrix>() );
1110 case Property::MATRIX3:
1112 newProperty = new AnimatableProperty<Matrix3>( propertyValue.Get<Matrix3>() );
1116 case Property::ROTATION:
1118 newProperty = new AnimatableProperty<Quaternion>( propertyValue.Get<Quaternion>() );
1122 case Property::RECTANGLE:
1123 case Property::STRING:
1124 case Property::ARRAY:
1126 case Property::EXTENTS:
1127 case Property::NONE:
1129 DALI_ASSERT_ALWAYS( !"Property type is not animatable" );
1134 // get the scene property owner
1135 const SceneGraph::PropertyOwner& scenePropertyOwner = GetSceneObject();
1136 // keep a local pointer to the property as the OwnerPointer will pass its copy to the message
1137 const PropertyBase* property = newProperty.Get();
1138 if(index >= PROPERTY_CUSTOM_START_INDEX)
1140 DALI_ASSERT_ALWAYS( index <= PROPERTY_CUSTOM_MAX_INDEX && "Too many custom properties have been registered" );
1142 mCustomProperties.PushBack( new CustomPropertyMetadata( name, key, propertyValue, property ) );
1146 mAnimatableProperties.PushBack( new AnimatablePropertyMetadata( index, propertyValue, property ) );
1149 // queue a message to add the property
1150 InstallCustomPropertyMessage( const_cast<EventThreadServices&>(GetEventThreadServices()), scenePropertyOwner, newProperty ); // Message takes ownership
1155 void Object::RegisterAnimatableProperty( const TypeInfo& typeInfo,
1156 Property::Index index,
1157 const Property::Value* value ) const
1159 // If the property is not a component of a base property, register the whole property itself.
1160 const std::string& propertyName = typeInfo.GetPropertyName( index );
1161 Property::Value initialValue;
1164 initialValue = *value;
1168 initialValue = typeInfo.GetPropertyDefaultValue( index ); // recurses type hierarchy
1169 if( Property::NONE == initialValue.GetType() )
1171 initialValue = Property::Value( typeInfo.GetPropertyType( index ) ); // recurses type hierarchy
1174 RegisterSceneGraphProperty( propertyName, Property::INVALID_KEY, index, initialValue );
1175 AddUniformMapping( index, propertyName );
1178 AnimatablePropertyMetadata* Object::GetSceneAnimatableProperty( Property::Index index, const Property::Value* value ) const
1180 // property range already checked by calling methods
1181 // check whether the animatable property is registered already, if not then register one.
1182 AnimatablePropertyMetadata* animatableProperty = FindAnimatableProperty( index );
1183 if( !animatableProperty )
1185 const TypeInfo* typeInfo( GetTypeInfo() );
1188 Property::Index basePropertyIndex = typeInfo->GetBasePropertyIndex( index );
1189 if( basePropertyIndex == Property::INVALID_INDEX )
1191 // If the property is not a component of a base property, register the whole property itself.
1192 RegisterAnimatableProperty( *typeInfo, index, value );
1196 // Since the property is a component of a base property, check whether the base property is registered.
1197 animatableProperty = FindAnimatableProperty( basePropertyIndex );
1198 if( !animatableProperty )
1200 // If the base property is not registered yet, register the base property first.
1201 RegisterAnimatableProperty( *typeInfo, basePropertyIndex, value );
1202 animatableProperty = static_cast<AnimatablePropertyMetadata*>(mAnimatableProperties[mAnimatableProperties.Size()-1]);
1205 // Create the metadata for the property component.
1206 mAnimatableProperties.PushBack( new AnimatablePropertyMetadata( index, typeInfo->GetComponentIndex(index), animatableProperty->value, animatableProperty->GetSceneGraphProperty() ) );
1209 // The metadata has just been added and therefore should be in the end of the vector.
1210 animatableProperty = static_cast<AnimatablePropertyMetadata*>(mAnimatableProperties[mAnimatableProperties.Size()-1]);
1214 return animatableProperty;
1217 void Object::ResolveChildProperties()
1219 // Resolve index for the child property
1220 Object* parent = GetParentObject();
1223 const TypeInfo* parentTypeInfo( parent->GetTypeInfo() );
1224 if( parentTypeInfo )
1226 // Go through each custom property
1227 for( auto&& entry : mCustomProperties )
1229 CustomPropertyMetadata* customProperty = static_cast<CustomPropertyMetadata*>( entry );
1231 if( customProperty->name.empty() )
1233 if( customProperty->childPropertyIndex != Property::INVALID_INDEX )
1235 // Resolve name for any child property with no name
1236 customProperty->name = parentTypeInfo->GetChildPropertyName( customProperty->childPropertyIndex );
1241 Property::Index childPropertyIndex = parentTypeInfo->GetChildPropertyIndex( customProperty->name );
1242 if( childPropertyIndex != Property::INVALID_INDEX )
1244 // Resolve index for any property with a name that matches the parent's child property name
1245 customProperty->childPropertyIndex = childPropertyIndex;
1253 void Object::SetDefaultProperty( Property::Index index, const Property::Value& property )
1258 Property::Value Object::GetDefaultProperty(Property::Index index) const
1260 return Property::Value();
1263 Property::Value Object::GetDefaultPropertyCurrentValue( Property::Index index ) const
1265 return GetDefaultProperty( index );
1268 void Object::EnablePropertyNotifications()
1270 if( mPropertyNotifications )
1272 for( auto&& element : *mPropertyNotifications )
1274 GetImplementation( element ).Enable();
1279 void Object::DisablePropertyNotifications()
1281 if( mPropertyNotifications )
1283 for( auto&& element : *mPropertyNotifications )
1285 GetImplementation( element ).Disable();
1290 Property::Value Object::GetCurrentPropertyValue( const PropertyMetadata& entry ) const
1292 Property::Value value;
1294 if( !entry.IsAnimatable() )
1296 value = entry.GetPropertyValue();
1300 BufferIndex bufferIndex( GetEventThreadServices().GetEventBufferIndex() );
1302 switch ( entry.GetType() )
1304 case Property::BOOLEAN:
1306 const AnimatableProperty<bool>* property = static_cast< const AnimatableProperty<bool>* >( entry.GetSceneGraphProperty() );
1307 DALI_ASSERT_DEBUG( property );
1309 value = (*property)[ bufferIndex ];
1313 case Property::INTEGER:
1315 const AnimatableProperty<int32_t>* property = static_cast< const AnimatableProperty<int32_t>* >( entry.GetSceneGraphProperty() );
1316 DALI_ASSERT_DEBUG( property );
1318 value = (*property)[ bufferIndex ];
1322 case Property::FLOAT:
1324 const AnimatableProperty<float>* property = static_cast< const AnimatableProperty<float>* >( entry.GetSceneGraphProperty() );
1325 DALI_ASSERT_DEBUG( property );
1327 value = (*property)[ bufferIndex ];
1331 case Property::VECTOR2:
1333 const AnimatableProperty<Vector2>* property = static_cast< const AnimatableProperty<Vector2>* >( entry.GetSceneGraphProperty() );
1334 DALI_ASSERT_DEBUG( property );
1336 if(entry.componentIndex == 0)
1338 value = (*property)[ bufferIndex ].x;
1340 else if(entry.componentIndex == 1)
1342 value = (*property)[ bufferIndex ].y;
1346 value = (*property)[ bufferIndex ];
1351 case Property::VECTOR3:
1353 const AnimatableProperty<Vector3>* property = static_cast< const AnimatableProperty<Vector3>* >( entry.GetSceneGraphProperty() );
1354 DALI_ASSERT_DEBUG( property );
1356 if(entry.componentIndex == 0)
1358 value = (*property)[ bufferIndex ].x;
1360 else if(entry.componentIndex == 1)
1362 value = (*property)[ bufferIndex ].y;
1364 else if(entry.componentIndex == 2)
1366 value = (*property)[ bufferIndex ].z;
1370 value = (*property)[ bufferIndex ];
1375 case Property::VECTOR4:
1377 const AnimatableProperty<Vector4>* property = static_cast< const AnimatableProperty<Vector4>* >( entry.GetSceneGraphProperty() );
1378 DALI_ASSERT_DEBUG( property );
1380 if(entry.componentIndex == 0)
1382 value = (*property)[ bufferIndex ].x;
1384 else if(entry.componentIndex == 1)
1386 value = (*property)[ bufferIndex ].y;
1388 else if(entry.componentIndex == 2)
1390 value = (*property)[ bufferIndex ].z;
1392 else if(entry.componentIndex == 3)
1394 value = (*property)[ bufferIndex ].w;
1398 value = (*property)[ bufferIndex ];
1403 case Property::MATRIX:
1405 const AnimatableProperty<Matrix>* property = static_cast< const AnimatableProperty<Matrix>* >( entry.GetSceneGraphProperty() );
1406 DALI_ASSERT_DEBUG( property );
1408 value = (*property)[ bufferIndex ];
1412 case Property::MATRIX3:
1414 const AnimatableProperty<Matrix3>* property = static_cast< const AnimatableProperty<Matrix3>* >( entry.GetSceneGraphProperty() );
1415 DALI_ASSERT_DEBUG( property );
1417 value = (*property)[ bufferIndex ];
1421 case Property::ROTATION:
1423 const AnimatableProperty<Quaternion>* property = static_cast< const AnimatableProperty<Quaternion>* >( entry.GetSceneGraphProperty() );
1424 DALI_ASSERT_DEBUG( property );
1426 value = (*property)[ bufferIndex ];
1432 // unreachable code due to higher level logic
1440 void Object::SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value )
1442 switch ( entry.GetType() )
1444 case Property::BOOLEAN:
1446 const AnimatableProperty<bool>* property = dynamic_cast< const AnimatableProperty<bool>* >( entry.GetSceneGraphProperty() );
1447 DALI_ASSERT_DEBUG( property );
1449 // property is being used in a separate thread; queue a message to set the property
1450 BakeMessage<bool>( GetEventThreadServices(), *property, value.Get<bool>() );
1454 case Property::INTEGER:
1456 const AnimatableProperty<int32_t>* property = dynamic_cast< const AnimatableProperty<int32_t>* >( entry.GetSceneGraphProperty() );
1457 DALI_ASSERT_DEBUG( property );
1459 // property is being used in a separate thread; queue a message to set the property
1460 BakeMessage<int32_t>( GetEventThreadServices(), *property, value.Get<int32_t>() );
1464 case Property::FLOAT:
1466 const AnimatableProperty<float>* property = dynamic_cast< const AnimatableProperty<float>* >( entry.GetSceneGraphProperty() );
1467 DALI_ASSERT_DEBUG( property );
1469 // property is being used in a separate thread; queue a message to set the property
1470 BakeMessage<float>( GetEventThreadServices(), *property, value.Get<float>() );
1474 case Property::VECTOR2:
1476 const AnimatableProperty<Vector2>* property = dynamic_cast< const AnimatableProperty<Vector2>* >( entry.GetSceneGraphProperty() );
1477 DALI_ASSERT_DEBUG( property );
1479 // property is being used in a separate thread; queue a message to set the property
1480 if(entry.componentIndex == 0)
1482 SetXComponentMessage<Vector2>( GetEventThreadServices(), *property, value.Get<float>() );
1484 else if(entry.componentIndex == 1)
1486 SetYComponentMessage<Vector2>( GetEventThreadServices(), *property, value.Get<float>() );
1490 BakeMessage<Vector2>( GetEventThreadServices(), *property, value.Get<Vector2>() );
1495 case Property::VECTOR3:
1497 const AnimatableProperty<Vector3>* property = dynamic_cast< const AnimatableProperty<Vector3>* >( entry.GetSceneGraphProperty() );
1498 DALI_ASSERT_DEBUG( property );
1500 // property is being used in a separate thread; queue a message to set the property
1501 if(entry.componentIndex == 0)
1503 SetXComponentMessage<Vector3>( GetEventThreadServices(), *property, value.Get<float>() );
1505 else if(entry.componentIndex == 1)
1507 SetYComponentMessage<Vector3>( GetEventThreadServices(), *property, value.Get<float>() );
1509 else if(entry.componentIndex == 2)
1511 SetZComponentMessage<Vector3>( GetEventThreadServices(), *property, value.Get<float>() );
1515 BakeMessage<Vector3>( GetEventThreadServices(), *property, value.Get<Vector3>() );
1521 case Property::VECTOR4:
1523 const AnimatableProperty<Vector4>* property = dynamic_cast< const AnimatableProperty<Vector4>* >( entry.GetSceneGraphProperty() );
1524 DALI_ASSERT_DEBUG( property );
1526 // property is being used in a separate thread; queue a message to set the property
1527 if(entry.componentIndex == 0)
1529 SetXComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1531 else if(entry.componentIndex == 1)
1533 SetYComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1535 else if(entry.componentIndex == 2)
1537 SetZComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1539 else if(entry.componentIndex == 3)
1541 SetWComponentMessage<Vector4>( GetEventThreadServices(), *property, value.Get<float>() );
1545 BakeMessage<Vector4>( GetEventThreadServices(), *property, value.Get<Vector4>() );
1550 case Property::ROTATION:
1552 const AnimatableProperty<Quaternion>* property = dynamic_cast< const AnimatableProperty<Quaternion>* >( entry.GetSceneGraphProperty() );
1553 DALI_ASSERT_DEBUG( property );
1555 // property is being used in a separate thread; queue a message to set the property
1556 BakeMessage<Quaternion>( GetEventThreadServices(), *property, value.Get<Quaternion>() );
1560 case Property::MATRIX:
1562 const AnimatableProperty<Matrix>* property = dynamic_cast< const AnimatableProperty<Matrix>* >( entry.GetSceneGraphProperty() );
1563 DALI_ASSERT_DEBUG( property );
1565 // property is being used in a separate thread; queue a message to set the property
1566 BakeMessage<Matrix>( GetEventThreadServices(), *property, value.Get<Matrix>() );
1570 case Property::MATRIX3:
1572 const AnimatableProperty<Matrix3>* property = dynamic_cast< const AnimatableProperty<Matrix3>* >( entry.GetSceneGraphProperty() );
1573 DALI_ASSERT_DEBUG( property );
1575 // property is being used in a separate thread; queue a message to set the property
1576 BakeMessage<Matrix3>( GetEventThreadServices(), *property, value.Get<Matrix3>() );
1582 // non-animatable scene graph property, do nothing
1587 } // namespace Internal