2 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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.
18 #include <dali/internal/event/animation/active-constraint-base.h>
21 #include <dali/public-api/animation/active-constraint.h>
22 #include <dali/public-api/object/handle.h>
23 #include <dali/public-api/object/type-registry.h>
24 #include <dali/internal/common/event-to-update.h>
25 #include <dali/internal/event/animation/animation-impl.h>
26 #include <dali/internal/update/common/animatable-property.h>
27 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
28 #include <dali/internal/update/common/property-owner-messages.h>
30 using Dali::Internal::SceneGraph::AnimatableProperty;
35 const Property::Index ActiveConstraint::WEIGHT = 0;
40 namespace // unnamed namespace
45 // not directly creatable
49 TypeRegistration mType( typeid(Dali::ActiveConstraint), typeid(Dali::Handle), Create );
51 SignalConnectorType signalConnector1( mType, Dali::ActiveConstraint::SIGNAL_APPLIED, &ActiveConstraintBase::DoConnectSignal );
56 namespace // unnamed namespace
60 * We want to discourage the use of property strings (minimize string comparisons),
61 * particularly for the default properties.
63 const std::string DEFAULT_PROPERTY_NAMES[] =
67 const int DEFAULT_PROPERTY_COUNT = sizeof( DEFAULT_PROPERTY_NAMES ) / sizeof( std::string );
69 const Property::Type DEFAULT_PROPERTY_TYPES[DEFAULT_PROPERTY_COUNT] =
71 Property::FLOAT // WEIGHT
74 } // unnamed namespace
76 ActiveConstraintBase::ActiveConstraintBase( EventToUpdate& eventToUpdate, Property::Index targetPropertyIndex )
77 : mEventToUpdate( eventToUpdate ),
78 mTargetPropertyIndex( targetPropertyIndex ),
80 mSceneGraphConstraint( NULL ),
81 mOffstageWeight( Dali::ActiveConstraint::DEFAULT_WEIGHT ),
83 mAlphaFunction( Dali::Constraint::DEFAULT_ALPHA_FUNCTION ),
84 mRemoveAction( Dali::Constraint::DEFAULT_REMOVE_ACTION ),
90 ActiveConstraintBase::~ActiveConstraintBase()
92 // Disconnect from internal animation signals
94 if ( mApplyAnimation )
96 GetImplementation(mApplyAnimation).SetFinishedCallback( NULL, NULL );
99 if( mRemoveAnimation )
101 GetImplementation(mRemoveAnimation).SetFinishedCallback( NULL, NULL );
105 void ActiveConstraintBase::FirstApply( ProxyObject& parent, TimePeriod applyTime, ActiveConstraintCallbackType* callback )
107 // Notify derived classes
108 OnFirstApply( parent );
110 if ( applyTime.durationSeconds > 0.0f )
112 DALI_ASSERT_DEBUG( !mApplyAnimation );
117 // Automatically animate (increase) the weight, until the constraint is fully applied
118 mApplyAnimation = Dali::Animation::New( applyTime.delaySeconds + applyTime.durationSeconds );
119 Dali::ActiveConstraint self( this );
120 mApplyAnimation.AnimateTo( Property( self, Dali::ActiveConstraint::WEIGHT ), Dali::ActiveConstraint::FINAL_WEIGHT, mAlphaFunction, applyTime );
121 mApplyAnimation.Play();
123 // Chain "Finish" to "Applied" signal
124 GetImplementation(mApplyAnimation).SetFinishedCallback( &ActiveConstraintBase::FirstApplyFinished, this );
128 void ActiveConstraintBase::BeginRemove()
130 // Notify derived classes
133 // Remove gradually by animating weight down to zero
134 if ( mRemoveTime.durationSeconds > 0.0f )
136 // Stop baking behaviour from interfering with remove animation
137 if ( mSceneGraphConstraint )
139 // Immediately remove from scene-graph
140 SetRemoveActionMessage( mEventToUpdate, *mSceneGraphConstraint, Dali::Constraint::Discard );
143 // Interrupt ongoing apply-animations
144 if ( mApplyAnimation )
146 mApplyAnimation.Stop();
149 // Reduce the weight to zero
150 mRemoveAnimation = Dali::Animation::New( mRemoveTime.delaySeconds + mRemoveTime.durationSeconds );
151 Dali::ActiveConstraint self( this );
152 mRemoveAnimation.AnimateTo( Property( self, Dali::ActiveConstraint::WEIGHT ), 0.0f, mAlphaFunction, mRemoveTime );
153 mRemoveAnimation.Play();
155 // Finish removal when animation ends
156 GetImplementation(mRemoveAnimation).SetFinishedCallback( &ActiveConstraintBase::OnRemoveFinished, this );
160 OnRemoveFinished( this );
164 bool ActiveConstraintBase::IsRemoving()
166 return mRemoveAnimation;
169 ProxyObject* ActiveConstraintBase::GetParent()
174 bool ActiveConstraintBase::Supports( Capability capability ) const
176 return false; // switch-off support for dynamic properties
179 Dali::Handle ActiveConstraintBase::GetTargetObject()
181 return Dali::Handle( mTargetProxy );
184 Property::Index ActiveConstraintBase::GetTargetProperty()
186 return mTargetPropertyIndex;
189 void ActiveConstraintBase::SetWeight( float weight )
191 if ( mSceneGraphConstraint )
193 BakeWeightMessage( mEventToUpdate, *mSceneGraphConstraint, weight );
197 mOffstageWeight = weight;
201 float ActiveConstraintBase::GetCurrentWeight() const
203 float currentWeight( mOffstageWeight );
205 if ( mSceneGraphConstraint )
207 currentWeight = mSceneGraphConstraint->GetWeight( mEventToUpdate.GetEventBufferIndex() );
210 return currentWeight;
213 ActiveConstraintSignalV2& ActiveConstraintBase::AppliedSignal()
215 return mAppliedSignal;
218 bool ActiveConstraintBase::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
220 bool connected( true );
221 ActiveConstraintBase* constraint = dynamic_cast<ActiveConstraintBase*>(object);
223 if ( Dali::ActiveConstraint::SIGNAL_APPLIED == signalName )
225 constraint->AppliedSignal().Connect( tracker, functor );
229 // signalName does not match any signal
236 void ActiveConstraintBase::SetRemoveTime( TimePeriod removeTime )
238 mRemoveTime = removeTime;
241 TimePeriod ActiveConstraintBase::GetRemoveTime() const
246 void ActiveConstraintBase::SetAlphaFunction( AlphaFunction alphaFunc )
248 mAlphaFunction = alphaFunc;
251 AlphaFunction ActiveConstraintBase::GetAlphaFunction() const
253 return mAlphaFunction;
256 void ActiveConstraintBase::SetRemoveAction( ActiveConstraintBase::RemoveAction action )
258 mRemoveAction = action;
261 ActiveConstraintBase::RemoveAction ActiveConstraintBase::GetRemoveAction() const
263 return mRemoveAction;
266 bool ActiveConstraintBase::IsSceneObjectRemovable() const
268 return true; // The constraint removed when target SceneGraph::PropertyOwner is destroyed
271 unsigned int ActiveConstraintBase::GetDefaultPropertyCount() const
273 return DEFAULT_PROPERTY_COUNT;
276 const std::string& ActiveConstraintBase::GetDefaultPropertyName( Property::Index index ) const
278 // ProxyObject guarantees that index is within range
279 return DEFAULT_PROPERTY_NAMES[index];
282 Property::Index ActiveConstraintBase::GetDefaultPropertyIndex( const std::string& name ) const
284 Property::Index index = Property::INVALID_INDEX;
286 // Only one name to compare with...
287 if ( name == DEFAULT_PROPERTY_NAMES[0] )
295 bool ActiveConstraintBase::IsDefaultPropertyWritable( Property::Index index ) const
297 return true; // All default properties are currently writable
300 bool ActiveConstraintBase::IsDefaultPropertyAnimatable( Property::Index index ) const
302 return true; // All default properties are currently animatable
305 Property::Type ActiveConstraintBase::GetDefaultPropertyType( Property::Index index ) const
307 // ProxyObject guarantees that index is within range
308 return DEFAULT_PROPERTY_TYPES[index];
311 void ActiveConstraintBase::SetDefaultProperty( Property::Index index, const Property::Value& propertyValue )
313 // ProxyObject guarantees the property is writable and index is in range
316 case Dali::ActiveConstraint::WEIGHT:
318 SetWeight( propertyValue.Get<float>() );
324 DALI_ASSERT_ALWAYS( false && "ActiveConstraint property out of bounds" ); // should not come here
330 void ActiveConstraintBase::SetCustomProperty( Property::Index index, const CustomProperty& entry, const Property::Value& value )
332 DALI_ASSERT_ALWAYS( false && "ActiveConstraintBase does not have custom properties"); // should not come here
335 Property::Value ActiveConstraintBase::GetDefaultProperty( Property::Index index ) const
337 Property::Value value;
339 // ProxyObject guarantees that index is within range
342 case Dali::ActiveConstraint::WEIGHT:
344 value = GetCurrentWeight();
350 DALI_ASSERT_ALWAYS( false && "ActiveConstraint property out of bounds" ); // should not come here
358 void ActiveConstraintBase::InstallSceneObjectProperty( SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index )
360 DALI_ASSERT_ALWAYS( false && "ActiveConstraintBase does not have custom properties" ); // should not come here
363 const SceneGraph::PropertyOwner* ActiveConstraintBase::GetSceneObject() const
365 return mSceneGraphConstraint;
368 const SceneGraph::PropertyBase* ActiveConstraintBase::GetSceneObjectAnimatableProperty( Property::Index index ) const
370 DALI_ASSERT_DEBUG( 0 == index ); // only 1 property supported
372 // This method should only return a property which is part of the scene-graph
373 if ( !mSceneGraphConstraint )
378 return &mSceneGraphConstraint->mWeight;
381 const PropertyInputImpl* ActiveConstraintBase::GetSceneObjectInputProperty( Property::Index index ) const
383 DALI_ASSERT_DEBUG( 0 == index ); // only 1 property supported
385 // This method should only return a property which is part of the scene-graph
386 if ( !mSceneGraphConstraint )
391 return &mSceneGraphConstraint->mWeight;
394 void ActiveConstraintBase::FirstApplyFinished( Object* object )
396 ActiveConstraintBase& self = dynamic_cast<ActiveConstraintBase&>( *object );
398 // This is necessary when the constraint was not added to scene-graph during the animation
399 self.SetWeight( Dali::ActiveConstraint::FINAL_WEIGHT );
401 // The animation is no longer needed
402 GetImplementation(self.mApplyAnimation).SetFinishedCallback( NULL, NULL );
403 self.mApplyAnimation.Reset();
405 // Chain "Finish" to "Applied" signal
407 if ( !self.mAppliedSignal.Empty() )
409 Dali::ActiveConstraint handle( &self );
411 self.mAppliedSignal.Emit( handle );
414 // WARNING - this constraint may now have been deleted; don't do anything else here
417 void ActiveConstraintBase::OnRemoveFinished( Object* object )
419 ActiveConstraintBase& self = dynamic_cast<ActiveConstraintBase&>( *object );
421 const SceneGraph::PropertyOwner* propertyOwner = self.mTargetProxy ? self.mTargetProxy->GetSceneObject() : NULL;
423 if ( propertyOwner &&
424 self.mSceneGraphConstraint )
426 // Notify base class that the scene-graph constraint is being removed
427 self.OnSceneObjectRemove();
429 // Remove from scene-graph
430 RemoveConstraintMessage( self.mEventToUpdate, *propertyOwner, *(self.mSceneGraphConstraint) );
432 // mSceneGraphConstraint will be deleted in update-thread, remove dangling pointer
433 self.mSceneGraphConstraint = NULL;
436 // The animation is no longer needed
437 self.mRemoveAnimation.Reset();
440 } // namespace Internal