cc/trees/property_tree_builder.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "cc/trees/property_tree_builder.h"
   6
   7 #include <map>
   8 #include <set>
   9
  10 #include "cc/base/math_util.h"
  11 #include "cc/layers/layer.h"
  12 #include "cc/layers/layer_impl.h"
  13 #include "cc/trees/layer_tree_host.h"
  14 #include "ui/gfx/geometry/point_f.h"
  15 #include "ui/gfx/geometry/vector2d_conversions.h"
  16
  17 namespace cc {
  18
  19 class LayerTreeHost;
  20
  21 namespace {
  22
  23 template <typename LayerType>
  24 struct DataForRecursion {
  25   TransformTree* transform_tree;
  26   ClipTree* clip_tree;
  27   OpacityTree* opacity_tree;
  28   LayerType* transform_tree_parent;
  29   LayerType* transform_fixed_parent;
  30   LayerType* render_target;
  31   int clip_tree_parent;
  32   int opacity_tree_parent;
  33   const LayerType* page_scale_layer;
  34   float page_scale_factor;
  35   float device_scale_factor;
  36   bool in_subtree_of_page_scale_layer;
  37   bool should_flatten;
  38   bool ancestor_clips_subtree;
  39   const gfx::Transform* device_transform;
  40   gfx::Vector2dF scroll_compensation_adjustment;
  41   int sequence_number;
  42 };
  43
  44 template <typename LayerType>
  45 static LayerType* GetTransformParent(const DataForRecursion<LayerType>& data,
  46                                      LayerType* layer) {
  47   return layer->position_constraint().is_fixed_position()
  48              ? data.transform_fixed_parent
  49              : data.transform_tree_parent;
  50 }
  51
  52 template <typename LayerType>
  53 static ClipNode* GetClipParent(const DataForRecursion<LayerType>& data,
  54                                LayerType* layer) {
  55   const bool inherits_clip = !layer->parent() || !layer->clip_parent();
  56   const int id = inherits_clip ? data.clip_tree_parent
  57                                : layer->clip_parent()->clip_tree_index();
  58   return data.clip_tree->Node(id);
  59 }
  60
  61 template <typename LayerType>
  62 static bool HasPotentiallyRunningAnimation(LayerType* layer,
  63                                            Animation::TargetProperty property) {
  64   if (Animation* animation =
  65           layer->layer_animation_controller()->GetAnimation(property)) {
  66     return !animation->is_finished();
  67   }
  68   return false;
  69 }
  70
  71 template <typename LayerType>
  72 static bool RequiresClipNode(LayerType* layer,
  73                              const DataForRecursion<LayerType>& data,
  74                              int parent_transform_id,
  75                              bool is_clipped) {
  76   const bool render_surface_applies_clip =
  77       layer->render_surface() && is_clipped;
  78   const bool render_surface_may_grow_due_to_clip_children =
  79       layer->render_surface() && layer->num_unclipped_descendants() > 0;
  80
  81   if (!layer->parent() || layer->masks_to_bounds() || layer->mask_layer() ||
  82       render_surface_may_grow_due_to_clip_children)
  83     return true;
  84
  85   if (!render_surface_applies_clip)
  86     return false;
  87
  88   bool axis_aligned_with_respect_to_parent =
  89       data.transform_tree->Are2DAxisAligned(layer->transform_tree_index(),
  90                                             parent_transform_id);
  91
  92   return !axis_aligned_with_respect_to_parent;
  93 }
  94
  95 template <typename LayerType>
  96 static bool LayerClipsSubtree(LayerType* layer) {
  97   return layer->masks_to_bounds() || layer->mask_layer();
  98 }
  99
 100 template <typename LayerType>
 101 void AddClipNodeIfNeeded(const DataForRecursion<LayerType>& data_from_ancestor,
 102                          LayerType* layer,
 103                          bool created_transform_node,
 104                          DataForRecursion<LayerType>* data_for_children) {
 105   ClipNode* parent = GetClipParent(data_from_ancestor, layer);
 106   int parent_id = parent->id;
 107
 108   bool ancestor_clips_subtree =
 109       data_from_ancestor.ancestor_clips_subtree || layer->clip_parent();
 110
 111   data_for_children->ancestor_clips_subtree = false;
 112   bool has_unclipped_surface = false;
 113
 114   if (layer->has_render_surface()) {
 115     if (ancestor_clips_subtree && layer->num_unclipped_descendants() > 0)
 116       data_for_children->ancestor_clips_subtree = true;
 117     else if (!ancestor_clips_subtree && !layer->num_unclipped_descendants())
 118       has_unclipped_surface = true;
 119   } else {
 120     data_for_children->ancestor_clips_subtree = ancestor_clips_subtree;
 121   }
 122
 123   if (LayerClipsSubtree(layer))
 124     data_for_children->ancestor_clips_subtree = true;
 125
 126   if (has_unclipped_surface)
 127     parent_id = 0;
 128
 129   if (!RequiresClipNode(layer, data_from_ancestor, parent->data.transform_id,
 130                         data_for_children->ancestor_clips_subtree)) {
 131     // Unclipped surfaces reset the clip rect.
 132     data_for_children->clip_tree_parent = parent_id;
 133   } else if (layer->parent()) {
 134     // Note the root clip gets handled elsewhere.
 135     LayerType* transform_parent = data_for_children->transform_tree_parent;
 136     if (layer->position_constraint().is_fixed_position() &&
 137         !created_transform_node) {
 138       transform_parent = data_for_children->transform_fixed_parent;
 139     }
 140     ClipNode node;
 141     node.data.clip = gfx::RectF(
 142         gfx::PointF() + layer->offset_to_transform_parent(), layer->bounds());
 143     node.data.transform_id = transform_parent->transform_tree_index();
 144     node.data.target_id =
 145         data_for_children->render_target->transform_tree_index();
 146     node.owner_id = layer->id();
 147
 148     data_for_children->clip_tree_parent =
 149         data_for_children->clip_tree->Insert(node, parent_id);
 150   }
 151
 152   layer->SetClipTreeIndex(
 153       has_unclipped_surface ? 0 : data_for_children->clip_tree_parent);
 154
 155   // TODO(awoloszyn): Right now when we hit a node with a replica, we reset the
 156   // clip for all children since we may need to draw. We need to figure out a
 157   // better way, since we will need both the clipped and unclipped versions.
 158 }
 159
 160 template <typename LayerType>
 161 bool AddTransformNodeIfNeeded(
 162     const DataForRecursion<LayerType>& data_from_ancestor,
 163     LayerType* layer,
 164     DataForRecursion<LayerType>* data_for_children) {
 165   const bool is_root = !layer->parent();
 166   const bool is_page_scale_layer = layer == data_from_ancestor.page_scale_layer;
 167   const bool is_scrollable = layer->scrollable();
 168   const bool is_fixed = layer->position_constraint().is_fixed_position();
 169
 170   const bool has_significant_transform =
 171       !layer->transform().IsIdentityOr2DTranslation();
 172
 173   const bool has_potentially_animated_transform =
 174       HasPotentiallyRunningAnimation(layer, Animation::TRANSFORM);
 175
 176   const bool has_animated_transform =
 177       layer->layer_animation_controller()->IsAnimatingProperty(
 178           Animation::TRANSFORM);
 179
 180   const bool has_surface = !!layer->render_surface();
 181
 182   bool requires_node = is_root || is_scrollable || has_significant_transform ||
 183                        has_potentially_animated_transform || has_surface ||
 184                        is_fixed || is_page_scale_layer;
 185
 186   LayerType* transform_parent = GetTransformParent(data_from_ancestor, layer);
 187
 188   int parent_index = 0;
 189   if (transform_parent)
 190     parent_index = transform_parent->transform_tree_index();
 191
 192   int source_index = parent_index;
 193
 194   gfx::Vector2dF source_offset;
 195   if (transform_parent) {
 196     if (layer->scroll_parent()) {
 197       LayerType* source = layer->parent();
 198       source_offset += source->offset_to_transform_parent();
 199       source_index = source->transform_tree_index();
 200     } else if (!is_fixed) {
 201       source_offset = transform_parent->offset_to_transform_parent();
 202     } else {
 203       if (data_from_ancestor.transform_tree_parent !=
 204           data_from_ancestor.transform_fixed_parent) {
 205         source_offset = data_from_ancestor.transform_tree_parent
 206                             ->offset_to_transform_parent();
 207         source_index =
 208             data_from_ancestor.transform_tree_parent->transform_tree_index();
 209       }
 210       source_offset += data_from_ancestor.scroll_compensation_adjustment;
 211     }
 212   }
 213
 214   if (layer->IsContainerForFixedPositionLayers() || is_root) {
 215     if (is_scrollable) {
 216       DCHECK(!is_root);
 217       DCHECK(layer->transform().IsIdentity());
 218       data_for_children->transform_fixed_parent = layer->parent();
 219     } else {
 220       data_for_children->transform_fixed_parent = layer;
 221     }
 222   }
 223   data_for_children->transform_tree_parent = layer;
 224
 225   if (layer->IsContainerForFixedPositionLayers() || is_fixed)
 226     data_for_children->scroll_compensation_adjustment = gfx::Vector2dF();
 227
 228   if (!requires_node) {
 229     data_for_children->should_flatten |= layer->should_flatten_transform();
 230     gfx::Vector2dF local_offset = layer->position().OffsetFromOrigin() +
 231                                   layer->transform().To2dTranslation();
 232     gfx::Vector2dF source_to_parent;
 233     if (source_index != parent_index) {
 234       gfx::Transform to_parent;
 235       data_from_ancestor.transform_tree->ComputeTransform(
 236           source_index, parent_index, &to_parent);
 237       source_to_parent = to_parent.To2dTranslation();
 238     }
 239     layer->set_offset_to_transform_parent(source_offset + source_to_parent +
 240                                           local_offset);
 241     layer->set_should_flatten_transform_from_property_tree(
 242         data_from_ancestor.should_flatten);
 243     layer->SetTransformTreeIndex(parent_index);
 244     return false;
 245   }
 246
 247   data_for_children->transform_tree->Insert(TransformNode(), parent_index);
 248
 249   TransformNode* node = data_for_children->transform_tree->back();
 250   layer->SetTransformTreeIndex(node->id);
 251
 252   node->data.scrolls = is_scrollable;
 253   node->data.flattens_inherited_transform = data_for_children->should_flatten;
 254
 255   // Surfaces inherently flatten transforms.
 256   data_for_children->should_flatten =
 257       layer->should_flatten_transform() || has_surface;
 258   node->data.target_id =
 259       data_from_ancestor.render_target->transform_tree_index();
 260   node->data.content_target_id =
 261       data_for_children->render_target->transform_tree_index();
 262   DCHECK_NE(node->data.target_id, -1);
 263   node->data.is_animated = has_animated_transform;
 264
 265   float post_local_scale_factor = 1.0f;
 266   if (is_root) {
 267     node->data.post_local = *data_from_ancestor.device_transform;
 268     post_local_scale_factor = data_from_ancestor.device_scale_factor;
 269   }
 270
 271   if (is_page_scale_layer)
 272     post_local_scale_factor *= data_from_ancestor.page_scale_factor;
 273
 274   if (has_surface && !is_root) {
 275     node->data.needs_sublayer_scale = true;
 276     node->data.layer_scale_factor = data_from_ancestor.device_scale_factor;
 277     if (data_from_ancestor.in_subtree_of_page_scale_layer)
 278       node->data.layer_scale_factor *= data_from_ancestor.page_scale_factor;
 279   }
 280
 281   node->data.source_node_id = source_index;
 282   if (is_root) {
 283     node->data.post_local.Scale(post_local_scale_factor,
 284                                 post_local_scale_factor);
 285   } else {
 286     node->data.post_local_scale_factor = post_local_scale_factor;
 287     node->data.source_offset = source_offset;
 288     node->data.update_post_local_transform(layer->position(),
 289                                            layer->transform_origin());
 290   }
 291
 292   if (!layer->scroll_parent())
 293     node->data.scroll_offset = layer->CurrentScrollOffset();
 294
 295   node->data.local = layer->transform();
 296   node->data.update_pre_local_transform(layer->transform_origin());
 297
 298   node->data.needs_local_transform_update = true;
 299   data_from_ancestor.transform_tree->UpdateTransforms(node->id);
 300
 301   layer->set_offset_to_transform_parent(gfx::Vector2dF());
 302
 303   // Flattening (if needed) will be handled by |node|.
 304   layer->set_should_flatten_transform_from_property_tree(false);
 305
 306   data_for_children->scroll_compensation_adjustment +=
 307       layer->ScrollCompensationAdjustment() - node->data.scroll_snap;
 308
 309   node->owner_id = layer->id();
 310
 311   return true;
 312 }
 313
 314 bool IsAnimatingOpacity(Layer* layer) {
 315   return HasPotentiallyRunningAnimation(layer, Animation::OPACITY) ||
 316          layer->OpacityCanAnimateOnImplThread();
 317 }
 318
 319 bool IsAnimatingOpacity(LayerImpl* layer) {
 320   return HasPotentiallyRunningAnimation(layer, Animation::OPACITY);
 321 }
 322
 323 template <typename LayerType>
 324 void AddOpacityNodeIfNeeded(
 325     const DataForRecursion<LayerType>& data_from_ancestor,
 326     LayerType* layer,
 327     DataForRecursion<LayerType>* data_for_children) {
 328   const bool is_root = !layer->parent();
 329   const bool has_transparency = layer->opacity() != 1.f;
 330   const bool has_animated_opacity = IsAnimatingOpacity(layer);
 331   bool requires_node = is_root || has_transparency || has_animated_opacity;
 332
 333   int parent_id = data_from_ancestor.opacity_tree_parent;
 334
 335   if (!requires_node) {
 336     layer->SetOpacityTreeIndex(parent_id);
 337     data_for_children->opacity_tree_parent = parent_id;
 338     return;
 339   }
 340
 341   OpacityNode node;
 342   node.owner_id = layer->id();
 343   node.data = layer->opacity();
 344   data_for_children->opacity_tree_parent =
 345       data_for_children->opacity_tree->Insert(node, parent_id);
 346   layer->SetOpacityTreeIndex(data_for_children->opacity_tree_parent);
 347 }
 348
 349 template <typename LayerType>
 350 void BuildPropertyTreesInternal(
 351     LayerType* layer,
 352     const DataForRecursion<LayerType>& data_from_parent) {
 353   layer->set_property_tree_sequence_number(data_from_parent.sequence_number);
 354   DataForRecursion<LayerType> data_for_children(data_from_parent);
 355   if (layer->render_surface())
 356     data_for_children.render_target = layer;
 357
 358   bool created_transform_node =
 359       AddTransformNodeIfNeeded(data_from_parent, layer, &data_for_children);
 360   AddClipNodeIfNeeded(data_from_parent, layer, created_transform_node,
 361                       &data_for_children);
 362
 363   if (data_from_parent.opacity_tree)
 364     AddOpacityNodeIfNeeded(data_from_parent, layer, &data_for_children);
 365
 366   if (layer == data_from_parent.page_scale_layer)
 367     data_for_children.in_subtree_of_page_scale_layer = true;
 368
 369   for (size_t i = 0; i < layer->children().size(); ++i) {
 370     if (!layer->child_at(i)->scroll_parent())
 371       BuildPropertyTreesInternal(layer->child_at(i), data_for_children);
 372   }
 373
 374   if (layer->scroll_children()) {
 375     for (LayerType* scroll_child : *layer->scroll_children()) {
 376       BuildPropertyTreesInternal(scroll_child, data_for_children);
 377     }
 378   }
 379
 380   if (layer->has_replica())
 381     BuildPropertyTreesInternal(layer->replica_layer(), data_for_children);
 382 }
 383
 384 }  // namespace
 385
 386 template <typename LayerType>
 387 void BuildPropertyTreesTopLevelInternal(LayerType* root_layer,
 388                                         const LayerType* page_scale_layer,
 389                                         float page_scale_factor,
 390                                         float device_scale_factor,
 391                                         const gfx::Rect& viewport,
 392                                         const gfx::Transform& device_transform,
 393                                         PropertyTrees* property_trees) {
 394   if (!property_trees->needs_rebuild)
 395     return;
 396
 397   property_trees->sequence_number++;
 398
 399   DataForRecursion<LayerType> data_for_recursion;
 400   data_for_recursion.transform_tree = &property_trees->transform_tree;
 401   data_for_recursion.clip_tree = &property_trees->clip_tree;
 402   data_for_recursion.opacity_tree = &property_trees->opacity_tree;
 403   data_for_recursion.transform_tree_parent = nullptr;
 404   data_for_recursion.transform_fixed_parent = nullptr;
 405   data_for_recursion.render_target = root_layer;
 406   data_for_recursion.clip_tree_parent = 0;
 407   data_for_recursion.opacity_tree_parent = -1;
 408   data_for_recursion.page_scale_layer = page_scale_layer;
 409   data_for_recursion.page_scale_factor = page_scale_factor;
 410   data_for_recursion.device_scale_factor = device_scale_factor;
 411   data_for_recursion.in_subtree_of_page_scale_layer = false;
 412   data_for_recursion.should_flatten = false;
 413   data_for_recursion.ancestor_clips_subtree = true;
 414   data_for_recursion.device_transform = &device_transform;
 415
 416   data_for_recursion.transform_tree->clear();
 417   data_for_recursion.clip_tree->clear();
 418   data_for_recursion.opacity_tree->clear();
 419   data_for_recursion.sequence_number = property_trees->sequence_number;
 420
 421   ClipNode root_clip;
 422   root_clip.data.clip = viewport;
 423   root_clip.data.transform_id = 0;
 424   data_for_recursion.clip_tree_parent =
 425       data_for_recursion.clip_tree->Insert(root_clip, 0);
 426   BuildPropertyTreesInternal(root_layer, data_for_recursion);
 427   property_trees->needs_rebuild = false;
 428
 429   // The transform tree is kept up-to-date as it is built, but the
 430   // combined_clips stored in the clip tree aren't computed during tree
 431   // building.
 432   property_trees->transform_tree.set_needs_update(false);
 433   property_trees->clip_tree.set_needs_update(true);
 434 }
 435
 436 void PropertyTreeBuilder::BuildPropertyTrees(
 437     Layer* root_layer,
 438     const Layer* page_scale_layer,
 439     float page_scale_factor,
 440     float device_scale_factor,
 441     const gfx::Rect& viewport,
 442     const gfx::Transform& device_transform,
 443     PropertyTrees* property_trees) {
 444   BuildPropertyTreesTopLevelInternal(
 445       root_layer, page_scale_layer, page_scale_factor, device_scale_factor,
 446       viewport, device_transform, property_trees);
 447 }
 448
 449 void PropertyTreeBuilder::BuildPropertyTrees(
 450     LayerImpl* root_layer,
 451     const LayerImpl* page_scale_layer,
 452     float page_scale_factor,
 453     float device_scale_factor,
 454     const gfx::Rect& viewport,
 455     const gfx::Transform& device_transform,
 456     PropertyTrees* property_trees) {
 457   BuildPropertyTreesTopLevelInternal(
 458       root_layer, page_scale_layer, page_scale_factor, device_scale_factor,
 459       viewport, device_transform, property_trees);
 460 }
 461
 462 }  // namespace cc