1 /*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "core/components/shared_transition/shared_transition_element.h"
17
18 #include "core/components/box/box_element.h"
19 #include "core/components/box/render_box.h"
20 #include "core/components/display/display_component.h"
21 #include "core/components/display/render_display.h"
22 #include "core/components/image/image_element.h"
23 #include "core/components/image/render_image.h"
24 #include "core/components/page/page_element.h"
25 #include "core/pipeline/base/element.h"
26 #include "core/pipeline/base/render_node.h"
27
28 namespace OHOS::Ace {
29 namespace {
30
31 constexpr uint8_t MAX_OPACITY = 255;
32 constexpr uint8_t MIN_OPACITY = 0;
33
34 } // namespace
35
~SharedTransitionElement()36 SharedTransitionElement::~SharedTransitionElement()
37 {
38 auto page = pageElement_.Upgrade();
39 if (!page) {
40 return;
41 }
42
43 // shared transition may be updated by other element
44 auto& sharedTransitionMap = page->GetSharedTransitionMap();
45 auto pos = sharedTransitionMap.find(shareId_);
46 if (pos != sharedTransitionMap.end()) {
47 auto ptr = pos->second.Upgrade();
48 if (ptr == this) {
49 page->RemoveSharedTransition(shareId_);
50 }
51 }
52 }
53
Update()54 void SharedTransitionElement::Update()
55 {
56 ComposedElement::Update();
57 const auto sharedComponent = AceType::DynamicCast<SharedTransitionComponent>(component_);
58 if (!sharedComponent) {
59 LOGE("Get SharedComponent failed. id: %{public}s", GetId().c_str());
60 return;
61 }
62 option_ = sharedComponent->GetOption();
63 oldShareId_ = shareId_;
64 shareId_ = sharedComponent->GetShareId();
65 effect_ = sharedComponent->GetEffect();
66 enablePopEnter_ = sharedComponent->IsEnablePopEnter();
67 enablePopExit_ = sharedComponent->IsEnablePopExit();
68 enablePushEnter_ = sharedComponent->IsEnablePushEnter();
69 enablePushExit_ = sharedComponent->IsEnablePushExit();
70 opacity_ = sharedComponent->GetOpacity();
71 zIndex_ = sharedComponent->GetZIndex();
72 }
73
GetRenderPassengerWithPajamas() const74 RefPtr<RenderBox> SharedTransitionElement::GetRenderPassengerWithPajamas() const
75 {
76 if (children_.empty()) {
77 LOGE("Get render passenger failed. no child. id: %{public}s", GetId().c_str());
78 return nullptr;
79 }
80 const auto& passenger = AceType::DynamicCast<BoxElement>(GetContentElement());
81 if (!passenger) {
82 LOGE("Get render passenger failed. passenger is null. id: %{public}s", GetId().c_str());
83 return nullptr;
84 }
85 return AceType::DynamicCast<RenderBox>(passenger->GetRenderNode());
86 }
87
GetRenderBox()88 RefPtr<RenderBox> SharedTransitionElement::GetRenderBox()
89 {
90 const auto& parent = GetElementParent().Upgrade();
91 if (!parent) {
92 LOGE("GetRenderBox failed, parent is nullptr");
93 return nullptr;
94 }
95
96 auto box = AceType::DynamicCast<BoxElement>(parent);
97 if (!box) {
98 LOGE("GetRenderBox failed, parent is not box");
99 return nullptr;
100 }
101
102 return AceType::DynamicCast<RenderBox>(box->GetRenderNode());
103 }
104
GetSuitSize() const105 Size SharedTransitionElement::GetSuitSize() const
106 {
107 const auto& renderBox = GetRenderPassengerWithPajamas();
108 if (!renderBox) {
109 LOGE("Get layout size failed. render box not found. id: %{public}s", GetId().c_str());
110 return Size();
111 }
112 return renderBox->GetLayoutSize() - renderBox->GetMarginSize();
113 }
114
GetGlobalOffset() const115 Offset SharedTransitionElement::GetGlobalOffset() const
116 {
117 const auto& renderBox = GetRenderPassengerWithPajamas();
118 if (!renderBox) {
119 LOGE("Get Global offset failed. render box not found. id: %{public}s", GetId().c_str());
120 return Offset();
121 }
122 return renderBox->GetGlobalOffset();
123 }
124
GetOpacity() const125 float SharedTransitionElement::GetOpacity() const
126 {
127 return opacity_;
128 }
129
GetZIndex() const130 int32_t SharedTransitionElement::GetZIndex() const
131 {
132 return zIndex_;
133 }
134
AboardShuttle(Offset & ticket)135 bool SharedTransitionElement::AboardShuttle(Offset& ticket)
136 {
137 if (!passengerComponent_ || passengerElement_) {
138 LOGE("Aboard Shuttle Component failed. passenger not init or already aboard. id: %{public}s", GetId().c_str());
139 return false;
140 }
141 auto passenger = GetRenderPassengerWithPajamas();
142 if (!passenger) {
143 LOGE("Aboard Shuttle Component failed. render passenger is null. id: %{public}s", GetId().c_str());
144 return false;
145 }
146 const auto& renderBox = AceType::DynamicCast<RenderBox>(passenger);
147 if (!renderBox) {
148 LOGE("Aboard Shuttle Component failed. render passenger do not have pajamas. id: %{public}s", GetId().c_str());
149 return false;
150 }
151 LOGD("SharedTransitionElement: aboard shuttle. id: %{public}s", GetId().c_str());
152 // save origin width/height and recover it when GetOffShuttle
153 passengerWidth_ = passengerComponent_->GetWidthDimension();
154 passengerHeight_ = passengerComponent_->GetHeightDimension();
155 auto suitSize = GetSuitSize();
156 passengerComponent_->SetWidth(suitSize.Width());
157 passengerComponent_->SetHeight(suitSize.Height());
158
159 auto parent = GetRenderBox();
160 if (parent && parent->GetBackDecoration() != nullptr) {
161 passengerComponent_->SetBackDecoration(parent->GetBackDecoration());
162 }
163 if (parent && parent->GetFrontDecoration() != nullptr) {
164 passengerComponent_->SetFrontDecoration(parent->GetFrontDecoration());
165 }
166
167 passengerElement_ = AceType::DynamicCast<BoxElement>(GetContentElement());
168 if (!passengerElement_) {
169 LOGE("Aboard Shuttle Element failed. passenger element is null.");
170 return false;
171 }
172 // update the ticket(initial offset of the sharedTransition element) earlier
173 ticket = renderBox->GetOffsetToStage();
174 // passenger goes out and comes to the shuttle port
175 // check first child not null when check passenger. no need check again here.
176 GetFirstChild()->UpdateChild(passengerElement_, nullptr);
177 passengerRender_ = passenger;
178 passengerElement_->SetRenderNode(passengerRender_);
179 auto placeHolder = AceType::MakeRefPtr<BoxComponent>();
180 // passenger measures the size
181 auto paintRect = renderBox->GetLayoutSize();
182 placeHolder->SetHeight(paintRect.Height());
183 placeHolder->SetWidth(paintRect.Width());
184 // check first child not null when check passenger. no need check again here.
185 GetFirstChild()->UpdateChild(nullptr, placeHolder);
186 return true;
187 }
188
GetOffShuttle()189 void SharedTransitionElement::GetOffShuttle()
190 {
191 LOGD("SharedTransitionElement: get off shuttle. id: %{public}s", GetId().c_str());
192 auto placeHolder = GetContentElement();
193 if (!passengerElement_ || !passengerRender_ || !placeHolder) {
194 LOGE("GetOff Shuttle failed. Passenger already Get Off or place holder is null.");
195 return;
196 }
197 if (placeHolder == passengerElement_) {
198 LOGI("Passenger already takeoff shuttle. do nothing.");
199 return;
200 }
201 // check first child not null when check placeHolder. no need check again here.
202 auto placeHolderRender = placeHolder->GetRenderNode();
203 bool placeHolderHidden = placeHolderRender ? placeHolderRender->GetHidden() : true;
204 GetFirstChild()->UpdateChild(placeHolder, nullptr);
205 auto parent = passengerElement_->GetElementParent().Upgrade();
206 if (parent) {
207 // Remove passenger from overlay.
208 parent->UpdateChild(passengerElement_, nullptr);
209 }
210
211 // save origin width/height in AboardShuttle and recover it when GetOffShuttle
212 passengerComponent_->SetWidth(passengerWidth_.Value(), passengerWidth_.Unit());
213 passengerComponent_->SetHeight(passengerHeight_.Value(), passengerHeight_.Unit());
214 passengerComponent_->SetBackDecoration(nullptr);
215 passengerComponent_->SetFrontDecoration(nullptr);
216 passengerElement_->SetRenderNode(passengerRender_);
217 passengerElement_->SetNewComponent(passengerComponent_);
218 passengerElement_->Mount(GetFirstChild());
219 // Follow place holder's hidden status.
220 passengerRender_->SetHidden(placeHolderHidden);
221 // Clear RefPtr.
222 passengerRender_.Reset();
223 passengerElement_.Reset();
224 }
225
SetVisible(bool visible)226 void SharedTransitionElement::SetVisible(bool visible)
227 {
228 auto displayElement = DynamicCast<DisplayElement>(GetFirstChild());
229 if (!displayElement) {
230 LOGE("Set visible failed. display element is null. id: %{public}s", GetId().c_str());
231 return;
232 }
233 auto displayRender = DynamicCast<RenderDisplay>(displayElement->GetRenderNode());
234 if (!displayRender) {
235 LOGE("Set visible failed. display render is null. id: %{public}s", GetId().c_str());
236 return;
237 }
238 if (visible) {
239 displayRender->UpdateOpacity(MAX_OPACITY);
240 } else {
241 displayRender->UpdateOpacity(MIN_OPACITY);
242 }
243 }
244
PerformBuild()245 void SharedTransitionElement::PerformBuild()
246 {
247 Register();
248 ComposedElement::PerformBuild();
249 }
250
BuildChild()251 RefPtr<Component> SharedTransitionElement::BuildChild()
252 {
253 auto shared = AceType::DynamicCast<SharedTransitionComponent>(component_);
254 if (shared) {
255 auto passengerComponent = ComposedElement::BuildChild();
256 passengerComponent_ = AceType::DynamicCast<BoxComponent>(passengerComponent);
257 if (!passengerComponent_) {
258 passengerComponent_ = AceType::MakeRefPtr<BoxComponent>();
259 passengerComponent_->SetChild(passengerComponent);
260 }
261 auto displayComponent_ = AceType::MakeRefPtr<DisplayComponent>();
262 if (passengerElement_) {
263 displayComponent_->SetChild(AceType::MakeRefPtr<BoxComponent>());
264 } else {
265 displayComponent_->SetChild(passengerComponent_);
266 }
267 Component::MergeRSNode(displayComponent_->GetChild(), displayComponent_);
268 return displayComponent_;
269 } else {
270 LOGE("Build child failed. no shared transition component found. id: %{public}s", GetId().c_str());
271 return ComposedElement::BuildChild();
272 }
273 }
274
Register()275 void SharedTransitionElement::Register()
276 {
277 auto page = SearchParentPage();
278 if (!page) {
279 LOGE("No parent page found.");
280 return;
281 }
282 LOGD("SharedTransitionElement Register shareId: %{public}s, id: %{public}s", shareId_.c_str(), GetId().c_str());
283 pageElement_ = page;
284 if (!oldShareId_.empty()) {
285 auto& sharedTransitionElementMap = page->GetSharedTransitionMap();
286 auto oldSharedIter = sharedTransitionElementMap.find(oldShareId_);
287 if (oldSharedIter != sharedTransitionElementMap.end()) {
288 auto oldWeak = oldSharedIter->second;
289 auto oldShared = oldWeak.Upgrade();
290 if (oldShared == this) {
291 page->RemoveSharedTransition(oldShareId_);
292 }
293 }
294 }
295 page->AddSharedTransition(AceType::Claim(this));
296 }
297
SearchParentPage() const298 RefPtr<PageElement> SharedTransitionElement::SearchParentPage() const
299 {
300 auto parent = GetElementParent().Upgrade();
301 while (parent) {
302 auto page = AceType::DynamicCast<PageElement>(parent);
303 if (page) {
304 LOGD("Find parent page. page id: %{public}d, id: %{public}s", page->GetPageId(), GetId().c_str());
305 return page;
306 }
307 parent = parent->GetElementParent().Upgrade();
308 }
309 LOGD("No parent page found. shareId: %{public}s, id: %{public}s", shareId_.c_str(), GetId().c_str());
310 return nullptr;
311 }
312
GetShareId() const313 const ShareId& SharedTransitionElement::GetShareId() const
314 {
315 return shareId_;
316 }
317
GetEffect() const318 const RefPtr<SharedTransitionEffect>& SharedTransitionElement::GetEffect() const
319 {
320 return effect_;
321 }
322
IsEnablePopEnter() const323 bool SharedTransitionElement::IsEnablePopEnter() const
324 {
325 return enablePopEnter_;
326 }
327
IsEnablePushEnter() const328 bool SharedTransitionElement::IsEnablePushEnter() const
329 {
330 return enablePushEnter_;
331 }
332
IsEnablePopExit() const333 bool SharedTransitionElement::IsEnablePopExit() const
334 {
335 return enablePopExit_;
336 }
337
IsEnablePushExit() const338 bool SharedTransitionElement::IsEnablePushExit() const
339 {
340 return enablePushExit_;
341 }
342
GetContentElement() const343 RefPtr<Element> SharedTransitionElement::GetContentElement() const
344 {
345 auto display = GetFirstChild();
346 if (!display) {
347 LOGE("Get Content Element failed. display is null.");
348 return nullptr;
349 }
350 return display->GetFirstChild();
351 }
352
SetSizeModified(SizeModifiedCallback && sizeModifiedCallback)353 void SharedTransitionElement::SetSizeModified(SizeModifiedCallback&& sizeModifiedCallback)
354 {
355 auto boxBaseElement = DynamicCast<BoxBaseElement>(GetContentElement());
356 if (!boxBaseElement) {
357 LOGE("Set Size Modified failed. image element not found.");
358 return;
359 }
360 auto boxBaseRender = DynamicCast<RenderBoxBase>(boxBaseElement->GetRenderNode());
361 if (!boxBaseRender) {
362 LOGE("Set Size Modified failed. image render not found.");
363 return;
364 }
365 sizeModifiedCallback_ = sizeModifiedCallback;
366 if (!sizeModifiedCallback_) {
367 boxBaseRender->SetLayoutCallback(nullptr);
368 return;
369 }
370 boxBaseRender->SetLayoutCallback([sharedWeak = AceType::WeakClaim(this)]() {
371 auto shared = sharedWeak.Upgrade();
372 if (!shared) {
373 LOGE("Layout callback is failed. shared is null");
374 return;
375 }
376 auto context = shared->context_.Upgrade();
377 if (!context) {
378 LOGE("Layout callback is failed. context is null");
379 return;
380 }
381 // Re-create shared transition after paint.
382 context->AddPostFlushListener(shared);
383 });
384 }
385
OnPostFlush()386 void SharedTransitionElement::OnPostFlush()
387 {
388 if (sizeModifiedCallback_) {
389 sizeModifiedCallback_();
390 }
391 }
392
393 } // namespace OHOS::Ace
394