Ensure a FrameCallback is removed properly from a FrameCallbackInterface
[platform/core/uifw/dali-core.git] / dali / internal / update / manager / scene-graph-frame-callback.cpp
1 /*
2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali/internal/update/manager/scene-graph-frame-callback.h>
20
21 // INTERNAL INCLUDES
22 #include <dali/devel-api/threading/mutex.h>
23 #include <dali/devel-api/update/frame-callback-interface.h>
24 #include <dali/devel-api/update/update-proxy.h>
25 #include <dali/internal/event/update/frame-callback-interface-impl.h>
26
27 namespace Dali
28 {
29 namespace Internal
30 {
31 namespace SceneGraph
32 {
33 FrameCallback* FrameCallback::New(FrameCallbackInterface& frameCallbackInterface)
34 {
35   return new FrameCallback(&frameCallbackInterface);
36 }
37
38 FrameCallback::~FrameCallback()
39 {
40   if(mUpdateProxy)
41   {
42     mUpdateProxy->GetRootNode().RemoveObserver(*this);
43   }
44
45   Invalidate();
46 }
47
48 void FrameCallback::ConnectToSceneGraph(UpdateManager& updateManager, TransformManager& transformManager, Node& rootNode)
49 {
50   mUpdateProxy = std::unique_ptr<UpdateProxy>(new UpdateProxy(updateManager, transformManager, rootNode));
51   rootNode.AddObserver(*this);
52 }
53
54 bool FrameCallback::Update(BufferIndex bufferIndex, float elapsedSeconds, bool nodeHierarchyChanged)
55 {
56   bool continueCalling = false;
57   if(mUpdateProxy)
58   {
59     mUpdateProxy->SetCurrentBufferIndex(bufferIndex);
60
61     if(nodeHierarchyChanged)
62     {
63       mUpdateProxy->NodeHierarchyChanged();
64     }
65
66     Mutex::ScopedLock lock(mMutex);
67     if(mFrameCallbackInterface && mValid)
68     {
69       Dali::UpdateProxy updateProxy(*mUpdateProxy);
70       mFrameCallbackInterface->Update(updateProxy, elapsedSeconds);
71       continueCalling = true;
72     }
73   }
74   return continueCalling;
75 }
76
77 void FrameCallback::Invalidate()
78 {
79   Mutex::ScopedLock lock(mMutex);
80   if(mFrameCallbackInterface && mValid)
81   {
82     FrameCallbackInterface::Impl::Get(*mFrameCallbackInterface).DisconnectFromSceneGraphObject();
83     mValid = false;
84     // Do not set mFrameCallbackInterface to nullptr as it is used for comparison checks by the comparison operator
85   }
86 }
87
88 void FrameCallback::PropertyOwnerDestroyed(PropertyOwner& owner)
89 {
90   mUpdateProxy.reset(); // Root node is being destroyed so no point keeping the update-proxy either
91
92   Invalidate();
93 }
94
95 FrameCallback::FrameCallback(FrameCallbackInterface* frameCallbackInterface)
96 : mMutex(),
97   mFrameCallbackInterface(frameCallbackInterface)
98 {
99   if(frameCallbackInterface)
100   {
101     FrameCallbackInterface::Impl::Get(*mFrameCallbackInterface).ConnectToSceneGraphObject(*this);
102   }
103 }
104
105 } // namespace SceneGraph
106
107 } // namespace Internal
108
109 } // namespace Dali