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 // save origin width/height and recover it when GetOffShuttle
152 passengerWidth_ = passengerComponent_->GetWidthDimension();
153 passengerHeight_ = passengerComponent_->GetHeightDimension();
154 auto suitSize = GetSuitSize();
155 passengerComponent_->SetWidth(suitSize.Width());
156 passengerComponent_->SetHeight(suitSize.Height());
157
158 auto parent = GetRenderBox();
159 if (parent && parent->GetBackDecoration() != nullptr) {
160 passengerComponent_->SetBackDecoration(parent->GetBackDecoration());
161 }
162 if (parent && parent->GetFrontDecoration() != nullptr) {
163 passengerComponent_->SetFrontDecoration(parent->GetFrontDecoration());
164 }
165
166 passengerElement_ = AceType::DynamicCast<BoxElement>(GetContentElement());
167 if (!passengerElement_) {
168 LOGE("Aboard Shuttle Element failed. passenger element is null.");
169 return false;
170 }
171 // update the ticket(initial offset of the sharedTransition element) earlier
172 ticket = renderBox->GetOffsetToStage();
173 // passenger goes out and comes to the shuttle port
174 // check first child not null when check passenger. no need check again here.
175 GetFirstChild()->UpdateChild(passengerElement_, nullptr);
176 passengerRender_ = passenger;
177 passengerElement_->SetRenderNode(passengerRender_);
178 auto placeHolder = AceType::MakeRefPtr<BoxComponent>();
179 // passenger measures the size
180 auto paintRect = renderBox->GetLayoutSize();
181 placeHolder->SetHeight(paintRect.Height());
182 placeHolder->SetWidth(paintRect.Width());
183 // check first child not null when check passenger. no need check again here.
184 GetFirstChild()->UpdateChild(nullptr, placeHolder);
185 return true;
186 }
187
GetOffShuttle()188 void SharedTransitionElement::GetOffShuttle()
189 {
190 auto placeHolder = GetContentElement();
191 if (!passengerElement_ || !passengerRender_ || !placeHolder) {
192 LOGE("GetOff Shuttle failed. Passenger already Get Off or place holder is null.");
193 return;
194 }
195 if (placeHolder == passengerElement_) {
196 LOGI("Passenger already takeoff shuttle. do nothing.");
197 return;
198 }
199 // check first child not null when check placeHolder. no need check again here.
200 auto placeHolderRender = placeHolder->GetRenderNode();
201 bool placeHolderHidden = placeHolderRender ? placeHolderRender->GetHidden() : true;
202 GetFirstChild()->UpdateChild(placeHolder, nullptr);
203 auto parent = passengerElement_->GetElementParent().Upgrade();
204 if (parent) {
205 // Remove passenger from overlay.
206 parent->UpdateChild(passengerElement_, nullptr);
207 }
208
209 // save origin width/height in AboardShuttle and recover it when GetOffShuttle
210 passengerComponent_->SetWidth(passengerWidth_.Value(), passengerWidth_.Unit());
211 passengerComponent_->SetHeight(passengerHeight_.Value(), passengerHeight_.Unit());
212 passengerComponent_->SetBackDecoration(nullptr);
213 passengerComponent_->SetFrontDecoration(nullptr);
214 passengerElement_->SetRenderNode(passengerRender_);
215 passengerElement_->SetNewComponent(passengerComponent_);
216 passengerElement_->Mount(GetFirstChild());
217 // Follow place holder's hidden status.
218 passengerRender_->SetHidden(placeHolderHidden);
219 // Clear RefPtr.
220 passengerRender_.Reset();
221 passengerElement_.Reset();
222 }
223
SetVisible(bool visible)224 void SharedTransitionElement::SetVisible(bool visible)
225 {
226 auto displayElement = DynamicCast<DisplayElement>(GetFirstChild());
227 if (!displayElement) {
228 LOGE("Set visible failed. display element is null. id: %{public}s", GetId().c_str());
229 return;
230 }
231 auto displayRender = DynamicCast<RenderDisplay>(displayElement->GetRenderNode());
232 if (!displayRender) {
233 LOGE("Set visible failed. display render is null. id: %{public}s", GetId().c_str());
234 return;
235 }
236 if (visible) {
237 displayRender->UpdateOpacity(MAX_OPACITY);
238 } else {
239 displayRender->UpdateOpacity(MIN_OPACITY);
240 }
241 }
242
PerformBuild()243 void SharedTransitionElement::PerformBuild()
244 {
245 Register();
246 ComposedElement::PerformBuild();
247 }
248
BuildChild()249 RefPtr<Component> SharedTransitionElement::BuildChild()
250 {
251 auto shared = AceType::DynamicCast<SharedTransitionComponent>(component_);
252 if (shared) {
253 auto passengerComponent = ComposedElement::BuildChild();
254 passengerComponent_ = AceType::DynamicCast<BoxComponent>(passengerComponent);
255 if (!passengerComponent_) {
256 passengerComponent_ = AceType::MakeRefPtr<BoxComponent>();
257 passengerComponent_->SetChild(passengerComponent);
258 }
259 auto displayComponent_ = AceType::MakeRefPtr<DisplayComponent>();
260 if (passengerElement_) {
261 displayComponent_->SetChild(AceType::MakeRefPtr<BoxComponent>());
262 } else {
263 displayComponent_->SetChild(passengerComponent_);
264 }
265 Component::MergeRSNode(displayComponent_->GetChild(), displayComponent_);
266 return displayComponent_;
267 } else {
268 LOGE("Build child failed. no shared transition component found. id: %{public}s", GetId().c_str());
269 return ComposedElement::BuildChild();
270 }
271 }
272
Register()273 void SharedTransitionElement::Register()
274 {
275 auto page = SearchParentPage();
276 if (!page) {
277 LOGE("No parent page found.");
278 return;
279 }
280 pageElement_ = page;
281 if (!oldShareId_.empty()) {
282 auto& sharedTransitionElementMap = page->GetSharedTransitionMap();
283 auto oldSharedIter = sharedTransitionElementMap.find(oldShareId_);
284 if (oldSharedIter != sharedTransitionElementMap.end()) {
285 auto oldWeak = oldSharedIter->second;
286 auto oldShared = oldWeak.Upgrade();
287 if (oldShared == this) {
288 page->RemoveSharedTransition(oldShareId_);
289 }
290 }
291 }
292 page->AddSharedTransition(AceType::Claim(this));
293 }
294
SearchParentPage() const295 RefPtr<PageElement> SharedTransitionElement::SearchParentPage() const
296 {
297 auto parent = GetElementParent().Upgrade();
298 while (parent) {
299 auto page = AceType::DynamicCast<PageElement>(parent);
300 if (page) {
301 return page;
302 }
303 parent = parent->GetElementParent().Upgrade();
304 }
305 return nullptr;
306 }
307
GetShareId() const308 const ShareId& SharedTransitionElement::GetShareId() const
309 {
310 return shareId_;
311 }
312
GetEffect() const313 const RefPtr<SharedTransitionEffect>& SharedTransitionElement::GetEffect() const
314 {
315 return effect_;
316 }
317
IsEnablePopEnter() const318 bool SharedTransitionElement::IsEnablePopEnter() const
319 {
320 return enablePopEnter_;
321 }
322
IsEnablePushEnter() const323 bool SharedTransitionElement::IsEnablePushEnter() const
324 {
325 return enablePushEnter_;
326 }
327
IsEnablePopExit() const328 bool SharedTransitionElement::IsEnablePopExit() const
329 {
330 return enablePopExit_;
331 }
332
IsEnablePushExit() const333 bool SharedTransitionElement::IsEnablePushExit() const
334 {
335 return enablePushExit_;
336 }
337
GetContentElement() const338 RefPtr<Element> SharedTransitionElement::GetContentElement() const
339 {
340 auto display = GetFirstChild();
341 if (!display) {
342 LOGE("Get Content Element failed. display is null.");
343 return nullptr;
344 }
345 return display->GetFirstChild();
346 }
347
SetSizeModified(SizeModifiedCallback && sizeModifiedCallback)348 void SharedTransitionElement::SetSizeModified(SizeModifiedCallback&& sizeModifiedCallback)
349 {
350 auto boxBaseElement = DynamicCast<BoxBaseElement>(GetContentElement());
351 if (!boxBaseElement) {
352 LOGE("Set Size Modified failed. image element not found.");
353 return;
354 }
355 auto boxBaseRender = DynamicCast<RenderBoxBase>(boxBaseElement->GetRenderNode());
356 if (!boxBaseRender) {
357 LOGE("Set Size Modified failed. image render not found.");
358 return;
359 }
360 sizeModifiedCallback_ = sizeModifiedCallback;
361 if (!sizeModifiedCallback_) {
362 boxBaseRender->SetLayoutCallback(nullptr);
363 return;
364 }
365 boxBaseRender->SetLayoutCallback([sharedWeak = AceType::WeakClaim(this)]() {
366 auto shared = sharedWeak.Upgrade();
367 if (!shared) {
368 LOGE("Layout callback is failed. shared is null");
369 return;
370 }
371 auto context = shared->context_.Upgrade();
372 if (!context) {
373 LOGE("Layout callback is failed. context is null");
374 return;
375 }
376 // Re-create shared transition after paint.
377 context->AddPostFlushListener(shared);
378 });
379 }
380
OnPostFlush()381 void SharedTransitionElement::OnPostFlush()
382 {
383 if (sizeModifiedCallback_) {
384 sizeModifiedCallback_();
385 }
386 }
387
388 } // namespace OHOS::Ace
389