2 * Copyright (c) 2022 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.
18 #include "flex-node.h"
21 #include <dali/integration-api/debug.h>
22 #include <dali/public-api/actors/actor.h>
23 #include <dali/public-api/object/weak-handle.h>
26 #include <dali-toolkit/third-party/yoga/Yoga.h>
28 #if defined(DEBUG_ENABLED)
29 static Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_FLEX");
40 // Common callback function that is registered when AddChild is called.
41 // Calls MeasureNode which in turns calls the actual callback passed in AddChild not the common callback.
42 YGSize MeasureChild(YGNodeRef child, float width, YGMeasureMode measureModeWidth, float height, YGMeasureMode measureModeHeight)
44 DALI_LOG_INFO(gLogFilter, Debug::General, "MeasureChild\n");
45 // Get the Node from the YGNodeRef
46 Toolkit::Flex::Node* childNode = static_cast<Toolkit::Flex::Node*>(YGNodeGetContext(child));
48 YGSize childSize{1, 1}; // Initialise variable.
50 DALI_ASSERT_DEBUG(childNode);
52 // Call measure function assigned to this Node
53 Toolkit::Flex::SizeTuple nodeSize = childNode->MeasureNode(width, measureModeWidth, height, measureModeHeight);
54 childSize.width = nodeSize.width;
55 childSize.height = nodeSize.height;
56 DALI_LOG_INFO(gLogFilter, Debug::General, "MeasureChild, childNode valid %f,%f\n", childSize.width, childSize.height);
65 using NodePtr = std::unique_ptr<Node>;
67 using FlexNodeVector = std::vector<NodePtr>;
72 MeasureCallback mMeasureCallback;
73 WeakHandle<Dali::Actor> mActor;
74 FlexNodeVector mChildNodes;
80 mImpl->mYogaNode = YGNodeNew();
81 YGNodeSetContext(mImpl->mYogaNode, this);
82 mImpl->mMeasureCallback = NULL;
83 DALI_LOG_INFO(gLogFilter, Debug::General, "Node() Context [%p] set to mYogaNode[%p]\n", this, mImpl->mYogaNode);
86 YGNodeStyleSetFlexDirection(mImpl->mYogaNode, YGFlexDirectionColumn);
87 YGNodeStyleSetFlexWrap(mImpl->mYogaNode, YGWrapNoWrap);
88 YGNodeStyleSetJustifyContent(mImpl->mYogaNode, YGJustifyFlexStart);
89 YGNodeStyleSetAlignContent(mImpl->mYogaNode, YGAlignFlexStart);
90 YGNodeStyleSetAlignItems(mImpl->mYogaNode, YGAlignFlexStart);
95 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Destructor() >> \n");
96 // Destruct child Flex::Node first
97 mImpl->mChildNodes.clear();
101 YGNodeFree(mImpl->mYogaNode);
102 mImpl->mYogaNode = nullptr;
104 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Destructor() <<\n");
107 Node* Node::AddChild(Actor child, Extents margin, MeasureCallback measureFunction, int index)
111 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "AddChild[%s] to node[%p] at index:%d\n", child.GetProperty<std::string>(Dali::Actor::Property::NAME).c_str(), mImpl->mYogaNode, index);
113 NodePtr childNode(new Node());
115 // Store measure function passed in so can call it when the MeasureChild function is called.
116 childNode->mImpl->mMeasureCallback = measureFunction;
118 childNode->mImpl->mActor = child;
119 Vector2 minumumSize = child.GetProperty<Vector2>(Actor::Property::MINIMUM_SIZE);
120 Vector2 maximumSize = child.GetProperty<Vector2>(Actor::Property::MAXIMUM_SIZE);
122 YGNodeStyleSetMaxWidth(childNode->mImpl->mYogaNode, maximumSize.width);
123 YGNodeStyleSetMaxHeight(childNode->mImpl->mYogaNode, maximumSize.height);
124 YGNodeStyleSetMinWidth(childNode->mImpl->mYogaNode, minumumSize.width);
125 YGNodeStyleSetMinHeight(childNode->mImpl->mYogaNode, minumumSize.height);
127 YGNodeStyleSetMargin(childNode->mImpl->mYogaNode, YGEdgeLeft, margin.start);
128 YGNodeStyleSetMargin(childNode->mImpl->mYogaNode, YGEdgeTop, margin.top);
129 YGNodeStyleSetMargin(childNode->mImpl->mYogaNode, YGEdgeRight, margin.end);
130 YGNodeStyleSetMargin(childNode->mImpl->mYogaNode, YGEdgeBottom, margin.bottom);
132 YGNodeSetMeasureFunc(childNode->mImpl->mYogaNode, &MeasureChild);
134 YGNodeInsertChild(mImpl->mYogaNode, childNode->mImpl->mYogaNode, index);
136 Node* result = childNode.get();
137 mImpl->mChildNodes.emplace_back(std::move(childNode));
145 void Node::RemoveChild(Actor child)
147 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "RemoveChild child:[%s] from internal nodeCount[%d] childCount[%d]\n", child.GetProperty<std::string>(Dali::Actor::Property::NAME).c_str(), YGNodeGetChildCount(mImpl->mYogaNode), mImpl->mChildNodes.size());
149 auto iterator = std::find_if(mImpl->mChildNodes.begin(), mImpl->mChildNodes.end(), [&child](NodePtr& childNode) { return childNode->mImpl->mActor.GetHandle() == child; });
151 if(iterator != mImpl->mChildNodes.end())
153 YGNodeRemoveChild(mImpl->mYogaNode, (*iterator)->mImpl->mYogaNode);
154 mImpl->mChildNodes.erase(iterator);
157 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "RemoveChild internal nodeCount[%d] childCount[%d]\n", YGNodeGetChildCount(mImpl->mYogaNode), mImpl->mChildNodes.size());
160 SizeTuple Node::MeasureNode(float width, int widthMode, float height, int heightMode)
162 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "MeasureNode\n");
164 // Execute callback registered with AddChild
165 Toolkit::Flex::SizeTuple nodeSize{8, 8}; // Default size set to 8,8 to aid bug detection.
166 if(mImpl->mMeasureCallback && mImpl->mActor.GetHandle())
168 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "MeasureNode MeasureCallback executing on %s\n", mImpl->mActor.GetHandle().GetProperty<std::string>(Dali::Actor::Property::NAME).c_str());
169 mImpl->mMeasureCallback(mImpl->mActor.GetHandle(), width, widthMode, height, heightMode, &nodeSize);
171 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "MeasureNode nodeSize width:%f height:%f\n", nodeSize.width, nodeSize.height);
175 void Node::CalculateLayout(float availableWidth, float availableHeight, bool isRTL)
177 DALI_LOG_INFO(gLogFilter, Debug::General, "CalculateLayout availableSize(%f,%f)\n", availableWidth, availableHeight);
178 YGNodeCalculateLayout(mImpl->mYogaNode, availableWidth, availableHeight, isRTL ? YGDirectionRTL : YGDirectionLTR);
181 Dali::Vector4 Node::GetNodeFrame(int index) const
183 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "GetNodeFrame[%d]\n", index);
184 YGNodeRef childNode = YGNodeGetChild(mImpl->mYogaNode, index);
185 Dali::Vector4 frame = Vector4::ZERO;
188 frame.x = YGNodeLayoutGetLeft(childNode);
189 frame.y = YGNodeLayoutGetTop(childNode);
190 frame.z = frame.x + YGNodeLayoutGetWidth(childNode);
191 frame.w = frame.y + YGNodeLayoutGetHeight(childNode);
192 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "GetNodeFrame Node index[%d] child ptr[%p] GetYogaNodeFrame left:%f top:%f right:%f bottom:%f\n", index, childNode, frame.x, frame.y, frame.z, frame.w);
196 frame.x = YGNodeLayoutGetLeft(mImpl->mYogaNode);
197 frame.y = YGNodeLayoutGetTop(mImpl->mYogaNode);
198 frame.z = frame.x + YGNodeLayoutGetWidth(mImpl->mYogaNode);
199 frame.w = frame.y + YGNodeLayoutGetHeight(mImpl->mYogaNode);
200 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "GetNodeFrame Root index[%d] root ptr[%p] GetYogaNodeFrame left:%f top:%f right:%f bottom:%f\n", index, mImpl->mYogaNode, frame.x, frame.y, frame.z, frame.w);
205 void Node::SetFlexDirection(Dali::Toolkit::Flex::FlexDirection flexDirection)
207 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex direction[%d]\n", flexDirection);
209 YGNodeStyleSetFlexDirection(mImpl->mYogaNode, static_cast<YGFlexDirection>(flexDirection));
212 Dali::Toolkit::Flex::FlexDirection Node::GetFlexDirection() const
214 return static_cast<Dali::Toolkit::Flex::FlexDirection>(YGNodeStyleGetFlexDirection(mImpl->mYogaNode));
217 void Node::SetFlexJustification(Dali::Toolkit::Flex::Justification flexJustification)
219 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex justification[%d]\n", flexJustification)
221 YGNodeStyleSetJustifyContent(mImpl->mYogaNode, static_cast<YGJustify>(flexJustification));
224 Dali::Toolkit::Flex::Justification Node::GetFlexJustification() const
226 return static_cast<Dali::Toolkit::Flex::Justification>(YGNodeStyleGetJustifyContent(mImpl->mYogaNode));
229 Dali::Toolkit::Flex::WrapType Node::GetFlexWrap() const
231 return static_cast<Dali::Toolkit::Flex::WrapType>(YGNodeStyleGetFlexWrap(mImpl->mYogaNode));
234 void Node::SetFlexAlignment(Dali::Toolkit::Flex::Alignment flexAlignment)
236 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex alignment[%d]\n", flexAlignment)
238 YGNodeStyleSetAlignContent(mImpl->mYogaNode, static_cast<YGAlign>(flexAlignment));
241 Dali::Toolkit::Flex::Alignment Node::GetFlexAlignment() const
243 return static_cast<Dali::Toolkit::Flex::Alignment>(YGNodeStyleGetAlignContent(mImpl->mYogaNode));
246 void Node::SetFlexItemsAlignment(Dali::Toolkit::Flex::Alignment flexAlignment)
248 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex items alignment[%d] on mYogaNode[%p]\n", flexAlignment, mImpl->mYogaNode)
250 YGNodeStyleSetAlignItems(mImpl->mYogaNode, static_cast<YGAlign>(flexAlignment));
253 Dali::Toolkit::Flex::Alignment Node::GetFlexItemsAlignment() const
255 return static_cast<Dali::Toolkit::Flex::Alignment>(YGNodeStyleGetAlignItems(mImpl->mYogaNode));
258 void Node::SetFlexAlignmentSelf(Dali::Toolkit::Flex::Alignment flexAlignmentSelf)
260 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex alignment self [%d] on mYogaNode[%p]\n", flexAlignmentSelf, mImpl->mYogaNode)
262 YGNodeStyleSetAlignSelf(mImpl->mYogaNode, static_cast<YGAlign>(flexAlignmentSelf));
265 Dali::Toolkit::Flex::Alignment Node::GetFlexAlignmentSelf() const
267 return static_cast<Dali::Toolkit::Flex::Alignment>(YGNodeStyleGetAlignSelf(mImpl->mYogaNode));
270 void Node::SetFlexPositionType(Dali::Toolkit::Flex::PositionType flexPositionType)
272 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex position type [%d] on mYogaNode[%p]\n", flexPositionType, mImpl->mYogaNode)
274 YGNodeStyleSetPositionType(mImpl->mYogaNode, static_cast<YGPositionType>(flexPositionType));
277 Dali::Toolkit::Flex::PositionType Node::GetFlexPositionType() const
279 return static_cast<Dali::Toolkit::Flex::PositionType>(YGNodeStyleGetPositionType(mImpl->mYogaNode));
282 void Node::SetFlexAspectRatio(float flexAspectRatio)
284 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex aspect ratio [%d] on mYogaNode[%p]\n", flexAspectRatio, mImpl->mYogaNode)
286 YGNodeStyleSetAspectRatio(mImpl->mYogaNode, static_cast<float>(flexAspectRatio));
289 float Node::GetFlexAspectRatio() const
291 return static_cast<float>(YGNodeStyleGetAspectRatio(mImpl->mYogaNode));
294 void Node::SetFlexBasis(float flexBasis)
296 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex basis [%d] on mYogaNode[%p]\n", flexBasis, mImpl->mYogaNode)
298 YGNodeStyleSetFlexBasis(mImpl->mYogaNode, static_cast<float>(flexBasis));
301 float Node::GetFlexBasis() const
303 return static_cast<float>(YGNodeStyleGetFlexBasis(mImpl->mYogaNode).value);
306 void Node::SetFlexShrink(float flexShrink)
308 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex shrink [%d] on mYogaNode[%p]\n", flexShrink, mImpl->mYogaNode)
310 YGNodeStyleSetFlexShrink(mImpl->mYogaNode, static_cast<float>(flexShrink));
313 float Node::GetFlexShrink() const
315 return static_cast<float>(YGNodeStyleGetFlexShrink(mImpl->mYogaNode));
318 void Node::SetFlexGrow(float flexGrow)
320 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex grow [%d] on mYogaNode[%p]\n", flexGrow, mImpl->mYogaNode)
322 YGNodeStyleSetFlexGrow(mImpl->mYogaNode, static_cast<float>(flexGrow));
325 float Node::GetFlexGrow() const
327 return static_cast<float>(YGNodeStyleGetFlexGrow(mImpl->mYogaNode));
330 float Node::GetFlexWidth() const
332 float flexWidth = YGNodeLayoutGetWidth(mImpl->mYogaNode);
333 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Get flex mYogaNode[%p] width[%f]\n", mImpl->mYogaNode, flexWidth)
338 float Node::GetFlexHeight() const
340 float flexHeight = YGNodeLayoutGetHeight(mImpl->mYogaNode);
341 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Get flex mYogaNode[%p] height[%f]\n", mImpl->mYogaNode, flexHeight)
346 void Node::SetMargin(Extents margin)
348 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex margin\n")
350 YGNodeStyleSetMargin(mImpl->mYogaNode, YGEdgeLeft, margin.start);
351 YGNodeStyleSetMargin(mImpl->mYogaNode, YGEdgeTop, margin.top);
352 YGNodeStyleSetMargin(mImpl->mYogaNode, YGEdgeRight, margin.end);
353 YGNodeStyleSetMargin(mImpl->mYogaNode, YGEdgeBottom, margin.bottom);
356 void Node::SetPadding(Extents padding)
358 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set padding\n")
360 YGNodeStyleSetPadding(mImpl->mYogaNode, YGEdgeLeft, padding.start);
361 YGNodeStyleSetPadding(mImpl->mYogaNode, YGEdgeTop, padding.top);
362 YGNodeStyleSetPadding(mImpl->mYogaNode, YGEdgeRight, padding.end);
363 YGNodeStyleSetPadding(mImpl->mYogaNode, YGEdgeBottom, padding.bottom);
366 void Node::SetFlexWrap(Dali::Toolkit::Flex::WrapType wrapType)
368 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Set flex wrap[%d] on mYogaNode[%p]\n", wrapType, mImpl->mYogaNode)
370 YGNodeStyleSetFlexWrap(mImpl->mYogaNode, static_cast<YGWrap>(wrapType));
374 } // namespace Toolkit