cc/layers/layer.h

   1 // Copyright 2010 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 #ifndef CC_LAYERS_LAYER_H_
   6 #define CC_LAYERS_LAYER_H_
   7
   8 #include <set>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/callback.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/observer_list.h"
  15 #include "cc/animation/layer_animation_controller.h"
  16 #include "cc/animation/layer_animation_value_observer.h"
  17 #include "cc/animation/layer_animation_value_provider.h"
  18 #include "cc/base/cc_export.h"
  19 #include "cc/base/region.h"
  20 #include "cc/base/scoped_ptr_vector.h"
  21 #include "cc/debug/frame_timing_request.h"
  22 #include "cc/debug/micro_benchmark.h"
  23 #include "cc/layers/draw_properties.h"
  24 #include "cc/layers/layer_lists.h"
  25 #include "cc/layers/layer_position_constraint.h"
  26 #include "cc/layers/paint_properties.h"
  27 #include "cc/layers/render_surface.h"
  28 #include "cc/layers/scroll_blocks_on.h"
  29 #include "cc/output/filter_operations.h"
  30 #include "cc/trees/property_tree.h"
  31 #include "skia/ext/refptr.h"
  32 #include "third_party/skia/include/core/SkColor.h"
  33 #include "third_party/skia/include/core/SkImageFilter.h"
  34 #include "third_party/skia/include/core/SkPicture.h"
  35 #include "third_party/skia/include/core/SkXfermode.h"
  36 #include "ui/gfx/geometry/point3_f.h"
  37 #include "ui/gfx/geometry/rect.h"
  38 #include "ui/gfx/geometry/rect_f.h"
  39 #include "ui/gfx/geometry/scroll_offset.h"
  40 #include "ui/gfx/transform.h"
  41
  42 namespace gfx {
  43 class BoxF;
  44 }
  45
  46 namespace base {
  47 namespace trace_event {
  48 class ConvertableToTraceFormat;
  49 }
  50 }
  51
  52 namespace cc {
  53
  54 class Animation;
  55 class AnimationDelegate;
  56 struct AnimationEvent;
  57 class CopyOutputRequest;
  58 class LayerAnimationEventObserver;
  59 class LayerClient;
  60 class LayerImpl;
  61 class LayerSettings;
  62 class LayerTreeHost;
  63 class LayerTreeHostCommon;
  64 class LayerTreeImpl;
  65 class LayerTreeSettings;
  66 class RenderingStatsInstrumentation;
  67 class ResourceUpdateQueue;
  68 class ScrollbarLayerInterface;
  69 class SimpleEnclosedRegion;
  70 struct AnimationEvent;
  71
  72 // Base class for composited layers. Special layer types are derived from
  73 // this class.
  74 class CC_EXPORT Layer : public base::RefCounted<Layer>,
  75                         public LayerAnimationValueObserver,
  76                         public LayerAnimationValueProvider {
  77  public:
  78   typedef RenderSurfaceLayerList RenderSurfaceListType;
  79   typedef LayerList LayerListType;
  80   typedef RenderSurface RenderSurfaceType;
  81
  82   enum LayerIdLabels {
  83     INVALID_ID = -1,
  84   };
  85
  86   static scoped_refptr<Layer> Create(const LayerSettings& settings);
  87
  88   int id() const { return layer_id_; }
  89
  90   Layer* RootLayer();
  91   Layer* parent() { return parent_; }
  92   const Layer* parent() const { return parent_; }
  93   void AddChild(scoped_refptr<Layer> child);
  94   void InsertChild(scoped_refptr<Layer> child, size_t index);
  95   void ReplaceChild(Layer* reference, scoped_refptr<Layer> new_layer);
  96   void RemoveFromParent();
  97   void RemoveAllChildren();
  98   void SetChildren(const LayerList& children);
  99   bool HasAncestor(const Layer* ancestor) const;
 100
 101   const LayerList& children() const { return children_; }
 102   Layer* child_at(size_t index) { return children_[index].get(); }
 103
 104   // This requests the layer and its subtree be rendered and given to the
 105   // callback. If the copy is unable to be produced (the layer is destroyed
 106   // first), then the callback is called with a nullptr/empty result. If the
 107   // request's source property is set, any prior uncommitted requests having the
 108   // same source will be aborted.
 109   void RequestCopyOfOutput(scoped_ptr<CopyOutputRequest> request);
 110   bool HasCopyRequest() const {
 111     return !copy_requests_.empty();
 112   }
 113
 114   virtual void SetBackgroundColor(SkColor background_color);
 115   SkColor background_color() const { return background_color_; }
 116   // If contents_opaque(), return an opaque color else return a
 117   // non-opaque color.  Tries to return background_color(), if possible.
 118   SkColor SafeOpaqueBackgroundColor() const;
 119
 120   // A layer's bounds are in logical, non-page-scaled pixels (however, the
 121   // root layer's bounds are in physical pixels).
 122   void SetBounds(const gfx::Size& bounds);
 123   gfx::Size bounds() const { return bounds_; }
 124
 125   void SetMasksToBounds(bool masks_to_bounds);
 126   bool masks_to_bounds() const { return masks_to_bounds_; }
 127
 128   void SetMaskLayer(Layer* mask_layer);
 129   Layer* mask_layer() { return mask_layer_.get(); }
 130   const Layer* mask_layer() const { return mask_layer_.get(); }
 131
 132   virtual void SetNeedsDisplayRect(const gfx::Rect& dirty_rect);
 133   void SetNeedsDisplay() { SetNeedsDisplayRect(gfx::Rect(bounds())); }
 134
 135   void SetOpacity(float opacity);
 136   float opacity() const { return opacity_; }
 137   bool OpacityIsAnimating() const;
 138   bool HasPotentiallyRunningOpacityAnimation() const;
 139   virtual bool OpacityCanAnimateOnImplThread() const;
 140
 141   void SetBlendMode(SkXfermode::Mode blend_mode);
 142   SkXfermode::Mode blend_mode() const { return blend_mode_; }
 143
 144   void set_draw_blend_mode(SkXfermode::Mode blend_mode) {
 145     if (draw_blend_mode_ == blend_mode)
 146       return;
 147     draw_blend_mode_ = blend_mode;
 148     SetNeedsPushProperties();
 149   }
 150   SkXfermode::Mode draw_blend_mode() const { return draw_blend_mode_; }
 151
 152   bool uses_default_blend_mode() const {
 153     return blend_mode_ == SkXfermode::kSrcOver_Mode;
 154   }
 155
 156   // A layer is root for an isolated group when it and all its descendants are
 157   // drawn over a black and fully transparent background, creating an isolated
 158   // group. It should be used along with SetBlendMode(), in order to restrict
 159   // layers within the group to blend with layers outside this group.
 160   void SetIsRootForIsolatedGroup(bool root);
 161   bool is_root_for_isolated_group() const {
 162     return is_root_for_isolated_group_;
 163   }
 164
 165   void SetFilters(const FilterOperations& filters);
 166   const FilterOperations& filters() const { return filters_; }
 167   bool FilterIsAnimating() const;
 168   bool HasPotentiallyRunningFilterAnimation() const;
 169
 170   // Background filters are filters applied to what is behind this layer, when
 171   // they are viewed through non-opaque regions in this layer. They are used
 172   // through the WebLayer interface, and are not exposed to HTML.
 173   void SetBackgroundFilters(const FilterOperations& filters);
 174   const FilterOperations& background_filters() const {
 175     return background_filters_;
 176   }
 177
 178   virtual void SetContentsOpaque(bool opaque);
 179   bool contents_opaque() const { return contents_opaque_; }
 180
 181   void SetPosition(const gfx::PointF& position);
 182   gfx::PointF position() const { return position_; }
 183
 184   // A layer that is a container for fixed position layers cannot be both
 185   // scrollable and have a non-identity transform.
 186   void SetIsContainerForFixedPositionLayers(bool container);
 187   bool IsContainerForFixedPositionLayers() const;
 188
 189   gfx::Vector2dF FixedContainerSizeDelta() const {
 190     return gfx::Vector2dF();
 191   }
 192
 193   void SetPositionConstraint(const LayerPositionConstraint& constraint);
 194   const LayerPositionConstraint& position_constraint() const {
 195     return position_constraint_;
 196   }
 197
 198   void SetTransform(const gfx::Transform& transform);
 199   const gfx::Transform& transform() const { return transform_; }
 200   bool TransformIsAnimating() const;
 201   bool HasPotentiallyRunningTransformAnimation() const;
 202   bool AnimationsPreserveAxisAlignment() const;
 203   bool transform_is_invertible() const { return transform_is_invertible_; }
 204
 205   void SetTransformOrigin(const gfx::Point3F&);
 206   gfx::Point3F transform_origin() const { return transform_origin_; }
 207
 208   bool HasAnyAnimationTargetingProperty(
 209       Animation::TargetProperty property) const;
 210
 211   bool ScrollOffsetAnimationWasInterrupted() const;
 212
 213   void SetScrollParent(Layer* parent);
 214
 215   Layer* scroll_parent() { return scroll_parent_; }
 216   const Layer* scroll_parent() const { return scroll_parent_; }
 217
 218   void AddScrollChild(Layer* child);
 219   void RemoveScrollChild(Layer* child);
 220
 221   std::set<Layer*>* scroll_children() { return scroll_children_.get(); }
 222   const std::set<Layer*>* scroll_children() const {
 223     return scroll_children_.get();
 224   }
 225
 226   void SetClipParent(Layer* ancestor);
 227
 228   Layer* clip_parent() { return clip_parent_; }
 229   const Layer* clip_parent() const {
 230     return clip_parent_;
 231   }
 232
 233   void AddClipChild(Layer* child);
 234   void RemoveClipChild(Layer* child);
 235
 236   std::set<Layer*>* clip_children() { return clip_children_.get(); }
 237   const std::set<Layer*>* clip_children() const {
 238     return clip_children_.get();
 239   }
 240
 241   DrawProperties<Layer>& draw_properties() { return draw_properties_; }
 242   const DrawProperties<Layer>& draw_properties() const {
 243     return draw_properties_;
 244   }
 245
 246   // The following are shortcut accessors to get various information from
 247   // draw_properties_
 248   const gfx::Transform& draw_transform() const {
 249     return draw_properties_.target_space_transform;
 250   }
 251   const gfx::Transform& screen_space_transform() const {
 252     return draw_properties_.screen_space_transform;
 253   }
 254   float draw_opacity() const { return draw_properties_.opacity; }
 255   bool screen_space_transform_is_animating() const {
 256     return draw_properties_.screen_space_transform_is_animating;
 257   }
 258   gfx::Rect clip_rect() const { return draw_properties_.clip_rect; }
 259   gfx::Rect drawable_content_rect() const {
 260     return draw_properties_.drawable_content_rect;
 261   }
 262   gfx::Rect visible_layer_rect() const {
 263     return draw_properties_.visible_layer_rect;
 264   }
 265   Layer* render_target() {
 266     DCHECK(!draw_properties_.render_target ||
 267            draw_properties_.render_target->render_surface());
 268     return draw_properties_.render_target;
 269   }
 270   const Layer* render_target() const {
 271     DCHECK(!draw_properties_.render_target ||
 272            draw_properties_.render_target->render_surface());
 273     return draw_properties_.render_target;
 274   }
 275   size_t num_unclipped_descendants() const {
 276     return draw_properties_.num_unclipped_descendants;
 277   }
 278
 279   RenderSurface* render_surface() const { return render_surface_.get(); }
 280   void SetScrollOffset(const gfx::ScrollOffset& scroll_offset);
 281   void SetScrollCompensationAdjustment(
 282       const gfx::Vector2dF& scroll_compensation_adjustment);
 283   gfx::Vector2dF ScrollCompensationAdjustment() const;
 284
 285   gfx::ScrollOffset scroll_offset() const { return scroll_offset_; }
 286   void SetScrollOffsetFromImplSide(const gfx::ScrollOffset& scroll_offset);
 287
 288   void SetScrollClipLayerId(int clip_layer_id);
 289   bool scrollable() const { return scroll_clip_layer_id_ != INVALID_ID; }
 290
 291   void SetUserScrollable(bool horizontal, bool vertical);
 292   bool user_scrollable_horizontal() const {
 293     return user_scrollable_horizontal_;
 294   }
 295   bool user_scrollable_vertical() const { return user_scrollable_vertical_; }
 296
 297   void SetShouldScrollOnMainThread(bool should_scroll_on_main_thread);
 298   bool should_scroll_on_main_thread() const {
 299     return should_scroll_on_main_thread_;
 300   }
 301
 302   void SetHaveWheelEventHandlers(bool have_wheel_event_handlers);
 303   bool have_wheel_event_handlers() const { return have_wheel_event_handlers_; }
 304
 305   void SetHaveScrollEventHandlers(bool have_scroll_event_handlers);
 306   bool have_scroll_event_handlers() const {
 307     return have_scroll_event_handlers_;
 308   }
 309
 310   void SetNonFastScrollableRegion(const Region& non_fast_scrollable_region);
 311   const Region& non_fast_scrollable_region() const {
 312     return non_fast_scrollable_region_;
 313   }
 314
 315   void SetTouchEventHandlerRegion(const Region& touch_event_handler_region);
 316   const Region& touch_event_handler_region() const {
 317     return touch_event_handler_region_;
 318   }
 319
 320   void SetScrollBlocksOn(ScrollBlocksOn scroll_blocks_on);
 321   ScrollBlocksOn scroll_blocks_on() const { return scroll_blocks_on_; }
 322
 323   void set_did_scroll_callback(const base::Closure& callback) {
 324     did_scroll_callback_ = callback;
 325   }
 326
 327   void SetForceRenderSurface(bool force_render_surface);
 328   bool force_render_surface() const { return force_render_surface_; }
 329
 330   gfx::Vector2dF ScrollDelta() const { return gfx::Vector2dF(); }
 331   gfx::ScrollOffset CurrentScrollOffset() const { return scroll_offset_; }
 332
 333   void SetDoubleSided(bool double_sided);
 334   bool double_sided() const { return double_sided_; }
 335
 336   void SetShouldFlattenTransform(bool flatten);
 337   bool should_flatten_transform() const { return should_flatten_transform_; }
 338
 339   bool Is3dSorted() const { return sorting_context_id_ != 0; }
 340
 341   void set_use_parent_backface_visibility(bool use) {
 342     use_parent_backface_visibility_ = use;
 343   }
 344   bool use_parent_backface_visibility() const {
 345     return use_parent_backface_visibility_;
 346   }
 347
 348   virtual void SetLayerTreeHost(LayerTreeHost* host);
 349
 350   virtual bool HasDelegatedContent() const;
 351   bool HasContributingDelegatedRenderPasses() const { return false; }
 352
 353   void SetIsDrawable(bool is_drawable);
 354
 355   void SetHideLayerAndSubtree(bool hide);
 356   bool hide_layer_and_subtree() const { return hide_layer_and_subtree_; }
 357
 358   void SetReplicaLayer(Layer* layer);
 359   Layer* replica_layer() { return replica_layer_.get(); }
 360   const Layer* replica_layer() const { return replica_layer_.get(); }
 361
 362   bool has_mask() const { return !!mask_layer_.get(); }
 363   bool has_replica() const { return !!replica_layer_.get(); }
 364   bool replica_has_mask() const {
 365     return replica_layer_.get() &&
 366            (mask_layer_.get() || replica_layer_->mask_layer_.get());
 367   }
 368
 369   int NumDescendantsThatDrawContent() const;
 370
 371   // This is only virtual for tests.
 372   // TODO(awoloszyn): Remove this once we no longer need it for tests
 373   virtual bool DrawsContent() const;
 374
 375   // This methods typically need to be overwritten by derived classes.
 376   virtual void SavePaintProperties();
 377   // Returns true iff anything was updated that needs to be committed.
 378   virtual bool Update();
 379   virtual bool NeedMoreUpdates();
 380   virtual void SetIsMask(bool is_mask) {}
 381   virtual void ReduceMemoryUsage() {}
 382   virtual void OnOutputSurfaceCreated() {}
 383   virtual bool IsSuitableForGpuRasterization() const;
 384
 385   virtual scoped_refptr<base::trace_event::ConvertableToTraceFormat>
 386   TakeDebugInfo();
 387
 388   void SetLayerClient(LayerClient* client) { client_ = client; }
 389
 390   virtual void PushPropertiesTo(LayerImpl* layer);
 391
 392   void CreateRenderSurface();
 393   void ClearRenderSurface();
 394
 395   void ClearRenderSurfaceLayerList();
 396
 397   LayerTreeHost* layer_tree_host() { return layer_tree_host_; }
 398   const LayerTreeHost* layer_tree_host() const { return layer_tree_host_; }
 399
 400   bool AddAnimation(scoped_ptr<Animation> animation);
 401   void PauseAnimation(int animation_id, double time_offset);
 402   void RemoveAnimation(int animation_id);
 403   void RemoveAnimation(int animation_id, Animation::TargetProperty property);
 404   LayerAnimationController* layer_animation_controller() const {
 405     return layer_animation_controller_.get();
 406   }
 407   void SetLayerAnimationControllerForTest(
 408       scoped_refptr<LayerAnimationController> controller);
 409
 410   void set_layer_animation_delegate(AnimationDelegate* delegate) {
 411     DCHECK(layer_animation_controller_);
 412     layer_animation_controller_->set_layer_animation_delegate(delegate);
 413   }
 414
 415   bool HasActiveAnimation() const;
 416   void RegisterForAnimations(AnimationRegistrar* registrar);
 417
 418   void AddLayerAnimationEventObserver(
 419       LayerAnimationEventObserver* animation_observer);
 420   void RemoveLayerAnimationEventObserver(
 421       LayerAnimationEventObserver* animation_observer);
 422
 423   virtual ScrollbarLayerInterface* ToScrollbarLayer();
 424
 425   virtual skia::RefPtr<SkPicture> GetPicture() const;
 426
 427   // Constructs a LayerImpl of the correct runtime type for this Layer type.
 428   virtual scoped_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl);
 429
 430   bool NeedsDisplayForTesting() const { return !update_rect_.IsEmpty(); }
 431   void ResetNeedsDisplayForTesting() { update_rect_ = gfx::Rect(); }
 432
 433   RenderingStatsInstrumentation* rendering_stats_instrumentation() const;
 434
 435   const PaintProperties& paint_properties() const {
 436     return paint_properties_;
 437   }
 438
 439   void SetNeedsPushProperties();
 440   bool needs_push_properties() const { return needs_push_properties_; }
 441   bool descendant_needs_push_properties() const {
 442     return num_dependents_need_push_properties_ > 0;
 443   }
 444   void reset_needs_push_properties_for_testing() {
 445     needs_push_properties_ = false;
 446   }
 447
 448   virtual void RunMicroBenchmark(MicroBenchmark* benchmark);
 449
 450   void Set3dSortingContextId(int id);
 451   int sorting_context_id() const { return sorting_context_id_; }
 452
 453   void set_property_tree_sequence_number(int sequence_number) {
 454     property_tree_sequence_number_ = sequence_number;
 455   }
 456
 457   void SetTransformTreeIndex(int index);
 458   int transform_tree_index() const;
 459
 460   void SetClipTreeIndex(int index);
 461   int clip_tree_index() const;
 462
 463   void SetEffectTreeIndex(int index);
 464   int effect_tree_index() const;
 465
 466   void set_offset_to_transform_parent(gfx::Vector2dF offset) {
 467     if (offset_to_transform_parent_ == offset)
 468       return;
 469     offset_to_transform_parent_ = offset;
 470     SetNeedsPushProperties();
 471   }
 472   gfx::Vector2dF offset_to_transform_parent() const {
 473     return offset_to_transform_parent_;
 474   }
 475
 476   // TODO(vollick): Once we transition to transform and clip trees, rename these
 477   // functions and related values.  The "from property trees" functions below
 478   // use the transform and clip trees.  Eventually, we will use these functions
 479   // to compute the official values, but these functions are retained for
 480   // testing purposes until we've migrated.
 481
 482   const gfx::Rect& visible_rect_from_property_trees() const {
 483     return visible_rect_from_property_trees_;
 484   }
 485   void set_visible_rect_from_property_trees(const gfx::Rect& rect) {
 486     // No push properties here, as this acts like a draw property.
 487     visible_rect_from_property_trees_ = rect;
 488   }
 489
 490   const gfx::Rect& clip_rect_in_target_space_from_property_trees() const {
 491     return clip_rect_in_target_space_from_property_trees_;
 492   }
 493   void set_clip_rect_in_target_space_from_property_trees(
 494       const gfx::Rect& rect) {
 495     clip_rect_in_target_space_from_property_trees_ = rect;
 496   }
 497
 498   void set_should_flatten_transform_from_property_tree(bool should_flatten) {
 499     if (should_flatten_transform_from_property_tree_ == should_flatten)
 500       return;
 501     should_flatten_transform_from_property_tree_ = should_flatten;
 502     SetNeedsPushProperties();
 503   }
 504   bool should_flatten_transform_from_property_tree() const {
 505     return should_flatten_transform_from_property_tree_;
 506   }
 507
 508   void set_is_clipped(bool is_clipped) {
 509     if (is_clipped_ == is_clipped)
 510       return;
 511     is_clipped_ = is_clipped;
 512     SetNeedsPushProperties();
 513   }
 514   bool is_clipped() const { return is_clipped_; }
 515
 516   // TODO(vollick): These values are temporary and will be removed as soon as
 517   // render surface determinations are moved out of CDP. They only exist because
 518   // certain logic depends on whether or not a layer would render to a separate
 519   // surface, but CDP destroys surfaces and targets it doesn't need, so without
 520   // this boolean, this is impossible to determine after the fact without
 521   // wastefully recomputing it. This is public for the time being so that it can
 522   // be accessed from CDP.
 523   bool has_render_surface() const {
 524     return has_render_surface_;
 525   }
 526
 527   // Sets new frame timing requests for this layer.
 528   void SetFrameTimingRequests(const std::vector<FrameTimingRequest>& requests);
 529
 530   // Accessor for unit tests
 531   const std::vector<FrameTimingRequest>& FrameTimingRequests() const {
 532     return frame_timing_requests_;
 533   }
 534
 535   void DidBeginTracing();
 536   void set_num_layer_or_descandant_with_copy_request(
 537       int num_layer_or_descendants_with_copy_request) {
 538     num_layer_or_descendants_with_copy_request_ =
 539         num_layer_or_descendants_with_copy_request;
 540   }
 541
 542   void set_num_children_with_scroll_parent(
 543       int num_children_with_scroll_parent) {
 544     num_children_with_scroll_parent_ = num_children_with_scroll_parent;
 545   }
 546
 547   int num_children_with_scroll_parent() {
 548     return num_children_with_scroll_parent_;
 549   }
 550
 551   void set_visited(bool visited);
 552   bool visited();
 553   void set_layer_or_descendant_is_drawn(bool layer_or_descendant_is_drawn);
 554   bool layer_or_descendant_is_drawn();
 555   void set_sorted_for_recursion(bool sorted_for_recursion);
 556   bool sorted_for_recursion();
 557
 558  protected:
 559   friend class LayerImpl;
 560   friend class TreeSynchronizer;
 561   ~Layer() override;
 562
 563   explicit Layer(const LayerSettings& settings);
 564
 565   // These SetNeeds functions are in order of severity of update:
 566   //
 567   // Called when this layer has been modified in some way, but isn't sure
 568   // that it needs a commit yet.  It needs CalcDrawProperties and UpdateLayers
 569   // before it knows whether or not a commit is required.
 570   void SetNeedsUpdate();
 571   // Called when a property has been modified in a way that the layer
 572   // knows immediately that a commit is required.  This implies SetNeedsUpdate
 573   // as well as SetNeedsPushProperties to push that property.
 574   void SetNeedsCommit();
 575   // This is identical to SetNeedsCommit, but the former requests a rebuild of
 576   // the property trees.
 577   void SetNeedsCommitNoRebuild();
 578   // Called when there's been a change in layer structure.  Implies both
 579   // SetNeedsUpdate and SetNeedsCommit, but not SetNeedsPushProperties.
 580   void SetNeedsFullTreeSync();
 581
 582   // Called when the next commit should wait until the pending tree is activated
 583   // before finishing the commit and unblocking the main thread. Used to ensure
 584   // unused resources on the impl thread are returned before commit completes.
 585   void SetNextCommitWaitsForActivation();
 586
 587   // Will recalculate whether the layer draws content and set draws_content_
 588   // appropriately.
 589   void UpdateDrawsContent(bool has_drawable_content);
 590   virtual bool HasDrawableContent() const;
 591
 592   // Called when the layer's number of drawable descendants changes.
 593   void AddDrawableDescendants(int num);
 594
 595   void AddDependentNeedsPushProperties();
 596   void RemoveDependentNeedsPushProperties();
 597   bool parent_should_know_need_push_properties() const {
 598     return needs_push_properties() || descendant_needs_push_properties();
 599   }
 600
 601   bool IsPropertyChangeAllowed() const;
 602
 603   // This flag is set when the layer needs to push properties to the impl
 604   // side.
 605   bool needs_push_properties_;
 606
 607   // The number of direct children or dependent layers that need to be recursed
 608   // to in order for them or a descendent of them to push properties to the impl
 609   // side.
 610   int num_dependents_need_push_properties_;
 611
 612   // Tracks whether this layer may have changed stacking order with its
 613   // siblings.
 614   bool stacking_order_changed_;
 615
 616   // The update rect is the region of the compositor resource that was
 617   // actually updated by the compositor. For layers that may do updating
 618   // outside the compositor's control (i.e. plugin layers), this information
 619   // is not available and the update rect will remain empty.
 620   // Note this rect is in layer space (not content space).
 621   gfx::Rect update_rect_;
 622
 623   scoped_refptr<Layer> mask_layer_;
 624
 625   int layer_id_;
 626
 627   // When true, the layer is about to perform an update. Any commit requests
 628   // will be handled implicitly after the update completes.
 629   bool ignore_set_needs_commit_;
 630
 631   // Layers that share a sorting context id will be sorted together in 3d
 632   // space.  0 is a special value that means this layer will not be sorted and
 633   // will be drawn in paint order.
 634   int sorting_context_id_;
 635
 636  private:
 637   friend class base::RefCounted<Layer>;
 638   friend class LayerTreeHostCommon;
 639   void SetParent(Layer* layer);
 640   bool DescendantIsFixedToContainerLayer() const;
 641
 642   // This should only be called during BeginMainFrame since it does not
 643   // trigger a Commit.
 644   void SetHasRenderSurface(bool has_render_surface);
 645
 646   // This should only be called from RemoveFromParent().
 647   void RemoveChildOrDependent(Layer* child);
 648
 649   // LayerAnimationValueProvider implementation.
 650   gfx::ScrollOffset ScrollOffsetForAnimation() const override;
 651
 652   // LayerAnimationValueObserver implementation.
 653   void OnFilterAnimated(const FilterOperations& filters) override;
 654   void OnOpacityAnimated(float opacity) override;
 655   void OnTransformAnimated(const gfx::Transform& transform) override;
 656   void OnScrollOffsetAnimated(const gfx::ScrollOffset& scroll_offset) override;
 657   void OnAnimationWaitingForDeletion() override;
 658   void OnTransformIsPotentiallyAnimatingChanged(bool is_animating) override;
 659   bool IsActive() const override;
 660
 661   // If this layer has a scroll parent, it removes |this| from its list of
 662   // scroll children.
 663   void RemoveFromScrollTree();
 664
 665   // If this layer has a clip parent, it removes |this| from its list of clip
 666   // children.
 667   void RemoveFromClipTree();
 668
 669   // When we detach or attach layer to new LayerTreeHost, all property trees'
 670   // indices becomes invalid.
 671   void InvalidatePropertyTreesIndices();
 672
 673   void UpdateNumCopyRequestsForSubtree(bool add);
 674
 675   LayerList children_;
 676   Layer* parent_;
 677
 678   // Layer instances have a weak pointer to their LayerTreeHost.
 679   // This pointer value is nil when a Layer is not in a tree and is
 680   // updated via SetLayerTreeHost() if a layer moves between trees.
 681   LayerTreeHost* layer_tree_host_;
 682
 683   scoped_refptr<LayerAnimationController> layer_animation_controller_;
 684
 685   // Layer properties.
 686   gfx::Size bounds_;
 687
 688   gfx::ScrollOffset scroll_offset_;
 689   gfx::Vector2dF scroll_compensation_adjustment_;
 690   // This variable indicates which ancestor layer (if any) whose size,
 691   // transformed relative to this layer, defines the maximum scroll offset for
 692   // this layer.
 693   int scroll_clip_layer_id_;
 694   int num_descendants_that_draw_content_;
 695   int transform_tree_index_;
 696   int effect_tree_index_;
 697   int clip_tree_index_;
 698   int property_tree_sequence_number_;
 699   int num_layer_or_descendants_with_copy_request_;
 700   int num_children_with_scroll_parent_;
 701   gfx::Vector2dF offset_to_transform_parent_;
 702   bool should_flatten_transform_from_property_tree_ : 1;
 703   bool is_clipped_ : 1;
 704   bool should_scroll_on_main_thread_ : 1;
 705   bool have_wheel_event_handlers_ : 1;
 706   bool have_scroll_event_handlers_ : 1;
 707   bool user_scrollable_horizontal_ : 1;
 708   bool user_scrollable_vertical_ : 1;
 709   bool is_root_for_isolated_group_ : 1;
 710   bool is_container_for_fixed_position_layers_ : 1;
 711   bool is_drawable_ : 1;
 712   bool draws_content_ : 1;
 713   bool hide_layer_and_subtree_ : 1;
 714   bool masks_to_bounds_ : 1;
 715   bool contents_opaque_ : 1;
 716   bool double_sided_ : 1;
 717   bool should_flatten_transform_ : 1;
 718   bool use_parent_backface_visibility_ : 1;
 719   bool force_render_surface_ : 1;
 720   bool transform_is_invertible_ : 1;
 721   bool has_render_surface_ : 1;
 722   ScrollBlocksOn scroll_blocks_on_ : 3;
 723   Region non_fast_scrollable_region_;
 724   Region touch_event_handler_region_;
 725   gfx::PointF position_;
 726   SkColor background_color_;
 727   float opacity_;
 728   SkXfermode::Mode blend_mode_;
 729   // draw_blend_mode may be different than blend_mode_,
 730   // when a RenderSurface re-parents the layer's blend_mode.
 731   SkXfermode::Mode draw_blend_mode_;
 732   FilterOperations filters_;
 733   FilterOperations background_filters_;
 734   LayerPositionConstraint position_constraint_;
 735   Layer* scroll_parent_;
 736   scoped_ptr<std::set<Layer*>> scroll_children_;
 737
 738   // The following three variables are tracker variables. They are bools
 739   // wrapped inside an integer variable. If true, their value equals the
 740   // LayerTreeHost's meta_information_sequence_number. This wrapping of bools
 741   // inside ints is done to avoid a layer tree treewalk to reset their values.
 742   int layer_or_descendant_is_drawn_tracker_;
 743   int sorted_for_recursion_tracker_;
 744   int visited_tracker_;
 745
 746   Layer* clip_parent_;
 747   scoped_ptr<std::set<Layer*>> clip_children_;
 748
 749   gfx::Transform transform_;
 750   gfx::Point3F transform_origin_;
 751
 752   // Replica layer used for reflections.
 753   scoped_refptr<Layer> replica_layer_;
 754
 755   LayerClient* client_;
 756
 757   ScopedPtrVector<CopyOutputRequest> copy_requests_;
 758
 759   base::Closure did_scroll_callback_;
 760
 761   DrawProperties<Layer> draw_properties_;
 762
 763   PaintProperties paint_properties_;
 764   // TODO(awoloszyn): This is redundant with has_render_surface_,
 765   // and should get removed once it is no longer needed on main thread.
 766   scoped_ptr<RenderSurface> render_surface_;
 767
 768   gfx::Rect visible_rect_from_property_trees_;
 769   gfx::Rect clip_rect_in_target_space_from_property_trees_;
 770
 771   std::vector<FrameTimingRequest> frame_timing_requests_;
 772   bool frame_timing_requests_dirty_;
 773
 774   DISALLOW_COPY_AND_ASSIGN(Layer);
 775 };
 776
 777 }  // namespace cc
 778
 779 #endif  // CC_LAYERS_LAYER_H_