dali/internal/update/manager/update-algorithms.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/update-algorithms.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/render/renderers/render-renderer.h>
  26 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
  27 #include <dali/internal/update/nodes/node.h>
  28 #include <dali/internal/update/nodes/scene-graph-layer.h>
  29 #include <dali/public-api/actors/draw-mode.h>
  30 #include <dali/public-api/math/matrix.h>
  31 #include <dali/public-api/math/vector3.h>
  32
  33 #include <dali/integration-api/debug.h>
  34
  35 namespace Dali
  36 {
  37 namespace Internal
  38 {
  39 namespace SceneGraph
  40 {
  41 #if defined(DEBUG_ENABLED)
  42 Debug::Filter* gUpdateFilter = Debug::Filter::New(Debug::Concise, false, "LOG_UPDATE_ALGORITHMS");
  43 #endif
  44
  45 /******************************************************************************
  46  *********************** Apply Constraints ************************************
  47  ******************************************************************************/
  48
  49 /**
  50  * Constrain the local properties of the PropertyOwner.
  51  * @param propertyOwner to constrain
  52  * @param updateBufferIndex buffer index to use
  53  */
  54 void ConstrainPropertyOwner(PropertyOwner& propertyOwner, BufferIndex updateBufferIndex)
  55 {
  56   ConstraintOwnerContainer& constraints = propertyOwner.GetConstraints();
  57
  58   const ConstraintIter endIter = constraints.End();
  59   for(ConstraintIter iter = constraints.Begin(); iter != endIter; ++iter)
  60   {
  61     ConstraintBase& constraint = **iter;
  62     constraint.Apply(updateBufferIndex);
  63   }
  64 }
  65
  66 /******************************************************************************
  67  ************************** Update node hierarchy *****************************
  68  ******************************************************************************/
  69
  70 inline void UpdateRootNodeOpacity(Layer& rootNode, NodePropertyFlags nodeDirtyFlags, BufferIndex updateBufferIndex)
  71 {
  72   if(nodeDirtyFlags & NodePropertyFlags::COLOR)
  73   {
  74     rootNode.SetWorldColor(rootNode.GetColor(updateBufferIndex), updateBufferIndex);
  75   }
  76   else
  77   {
  78     // Copy previous value, in case it changed in the previous frame
  79     rootNode.CopyPreviousWorldColor(updateBufferIndex);
  80   }
  81 }
  82
  83 inline void UpdateNodeOpacity(Node& node, NodePropertyFlags nodeDirtyFlags, BufferIndex updateBufferIndex)
  84 {
  85   // If opacity needs to be recalculated
  86   if(nodeDirtyFlags & NodePropertyFlags::COLOR)
  87   {
  88     node.InheritWorldColor(updateBufferIndex);
  89   }
  90   else
  91   {
  92     // Copy inherited value, if changed in the previous frame
  93     node.CopyPreviousWorldColor(updateBufferIndex);
  94   }
  95 }
  96
  97 /**
  98  * This is called recursively for all children of the root Node
  99  */
 100 inline NodePropertyFlags UpdateNodes(Node&             node,
 101                                      NodePropertyFlags parentFlags,
 102                                      BufferIndex       updateBufferIndex,
 103                                      RenderQueue&      renderQueue,
 104                                      bool              updated)
 105 {
 106   // Apply constraints to the node
 107   ConstrainPropertyOwner(node, updateBufferIndex);
 108
 109   // Some dirty flags are inherited from parent
 110   NodePropertyFlags nodeDirtyFlags = node.GetDirtyFlags() | node.GetInheritedDirtyFlags(parentFlags);
 111
 112   NodePropertyFlags cumulativeDirtyFlags = nodeDirtyFlags;
 113
 114   UpdateNodeOpacity(node, nodeDirtyFlags, updateBufferIndex);
 115
 116   // Collect uniform maps
 117   node.PrepareRender(updateBufferIndex);
 118
 119   // For partial update, mark all children of an animating node as updated.
 120   if(updated) // Only set to updated if parent was updated.
 121   {
 122     node.SetUpdated(true);
 123   }
 124   else if(node.Updated()) // Only propagate updated==true downwards.
 125   {
 126     updated = true;
 127   }
 128
 129   // recurse children
 130   NodeContainer& children = node.GetChildren();
 131   const NodeIter endIter  = children.End();
 132   for(NodeIter iter = children.Begin(); iter != endIter; ++iter)
 133   {
 134     Node& child = **iter;
 135     cumulativeDirtyFlags |= UpdateNodes(child,
 136                                         nodeDirtyFlags,
 137                                         updateBufferIndex,
 138                                         renderQueue,
 139                                         updated);
 140   }
 141
 142   return cumulativeDirtyFlags;
 143 }
 144
 145 /**
 146  * The root node is treated separately; it cannot inherit values since it has no parent
 147  */
 148 NodePropertyFlags UpdateNodeTree(Layer&       rootNode,
 149                                  BufferIndex  updateBufferIndex,
 150                                  RenderQueue& renderQueue)
 151 {
 152   DALI_ASSERT_DEBUG(rootNode.IsRoot());
 153
 154   // Short-circuit for invisible nodes
 155   if(DALI_UNLIKELY(!rootNode.IsVisible(updateBufferIndex))) // almost never ever true
 156   {
 157     return NodePropertyFlags::NOTHING;
 158   }
 159
 160   // If the root node was not previously visible
 161   BufferIndex previousBuffer = updateBufferIndex ? 0u : 1u;
 162   if(DALI_UNLIKELY(!rootNode.IsVisible(previousBuffer))) // almost never ever true
 163   {
 164     // The node was skipped in the previous update; it must recalculate everything
 165     rootNode.SetAllDirtyFlags();
 166   }
 167
 168   NodePropertyFlags nodeDirtyFlags(rootNode.GetDirtyFlags());
 169
 170   NodePropertyFlags cumulativeDirtyFlags = nodeDirtyFlags;
 171
 172   UpdateRootNodeOpacity(rootNode, nodeDirtyFlags, updateBufferIndex);
 173
 174   bool updated = rootNode.Updated();
 175
 176   // recurse children
 177   NodeContainer& children = rootNode.GetChildren();
 178   const NodeIter endIter  = children.End();
 179   for(NodeIter iter = children.Begin(); iter != endIter; ++iter)
 180   {
 181     Node& child = **iter;
 182     cumulativeDirtyFlags |= UpdateNodes(child,
 183                                         nodeDirtyFlags,
 184                                         updateBufferIndex,
 185                                         renderQueue,
 186                                         updated);
 187   }
 188
 189   return cumulativeDirtyFlags;
 190 }
 191
 192 inline void UpdateLayers(Node&             node,
 193                          NodePropertyFlags parentFlags,
 194                          BufferIndex       updateBufferIndex,
 195                          Layer&            currentLayer)
 196 {
 197   // Some dirty flags are inherited from parent
 198   NodePropertyFlags nodeDirtyFlags = node.GetDirtyFlags() | node.GetInheritedDirtyFlags(parentFlags);
 199   nodeDirtyFlags |= (node.IsLocalMatrixDirty() ? NodePropertyFlags::TRANSFORM : NodePropertyFlags::NOTHING);
 200
 201   Layer* nodeIsLayer(node.GetLayer());
 202   Layer* layer = nodeIsLayer ? nodeIsLayer : &currentLayer;
 203   if(nodeIsLayer)
 204   {
 205     layer->SetReuseRenderers(updateBufferIndex, true);
 206   }
 207   DALI_ASSERT_DEBUG(nullptr != layer);
 208
 209   // if any child node has moved or had its sort modifier changed, layer is not clean and old frame cannot be reused
 210   // also if node has been deleted, dont reuse old render items
 211   if(nodeDirtyFlags != NodePropertyFlags::NOTHING)
 212   {
 213     layer->SetReuseRenderers(updateBufferIndex, false);
 214   }
 215
 216   // recurse children
 217   NodeContainer& children = node.GetChildren();
 218   const NodeIter endIter  = children.End();
 219   for(NodeIter iter = children.Begin(); iter != endIter; ++iter)
 220   {
 221     Node& child = **iter;
 222     UpdateLayers(child, nodeDirtyFlags, updateBufferIndex, *layer);
 223   }
 224 }
 225
 226 void UpdateLayerTree(Layer&      layer,
 227                      BufferIndex updateBufferIndex)
 228 {
 229   NodePropertyFlags nodeDirtyFlags = layer.GetDirtyFlags();
 230   nodeDirtyFlags |= (layer.IsLocalMatrixDirty() ? NodePropertyFlags::TRANSFORM : NodePropertyFlags::NOTHING);
 231
 232   // recurse children
 233   NodeContainer& children = layer.GetChildren();
 234   const NodeIter endIter  = children.End();
 235   for(NodeIter iter = children.Begin(); iter != endIter; ++iter)
 236   {
 237     Node& child = **iter;
 238     UpdateLayers(child, nodeDirtyFlags, updateBufferIndex, layer);
 239   }
 240 }
 241
 242 } // namespace SceneGraph
 243
 244 } // namespace Internal
 245
 246 } // namespace Dali