/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_LAYERMANAGER_HXX #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_LAYERMANAGER_HXX #include #include #include "layer.hxx" #include #include #include #include #include namespace basegfx { class B2DRange; } namespace slideshow { namespace internal { /* Definition of Layermanager class */ /** This class manages all of a slide's layers (and shapes) Since layer content changes when animations start or end, the layer manager keeps track of this and also handles starting/stopping of Shape animations. Note that none of the methods actually perform a screen update, this is always delayed until the ActivitiesQueue explicitly performs it. @see Layer @see Shape */ class LayerManager { public: /** Create a new layer manager for the given page bounds @param rViews Views currently registered @param bDisableAnimationZOrder When true, all sprite animations run in the foreground. That is, no extra layers are created, and the slideshow runs potentially faster. */ LayerManager( const UnoViewContainer& rViews, bool bDisableAnimationZOrder ); /// Forbid copy construction LayerManager(const LayerManager&) = delete; /// Forbid copy assignment LayerManager& operator=(const LayerManager&) = delete; /** Activate the LayerManager This method activates the LayerManager. Prior to activation, this instance will be passive, i.e. won't render anything to any view. */ void activate(); /** Deactivate the LayerManager This method deactivates the LayerManager. After deactivation, this instance will be passive, i.e. don't render anything to any view. Furthermore, if there's currently more than one Layer active, this method also removes all but one. */ void deactivate(); // From ViewEventHandler, forwarded by SlideImpl /// Notify new view added to UnoViewContainer void viewAdded( const UnoViewSharedPtr& rView ); /// Notify view removed from UnoViewContainer void viewRemoved( const UnoViewSharedPtr& rView ); void viewChanged( const UnoViewSharedPtr& rView ); void viewsChanged(); /** Add the shape to this object This method adds a shape to the page. */ void addShape( const ShapeSharedPtr& rShape ); /** Remove shape from this object This method removes a shape from the shape. */ bool removeShape( const ShapeSharedPtr& rShape ); /** Lookup a Shape from an XShape model object This method looks up the internal shape map for one representing the given XShape. @param xShape The XShape object, for which the representing Shape should be looked up. */ ShapeSharedPtr lookupShape( const css::uno::Reference< css::drawing::XShape >& xShape ) const; /** Query a subset of the given original shape This method queries a new (but not necessarily unique) shape, which displays only the given subset of the original one. */ AttributableShapeSharedPtr getSubsetShape( const AttributableShapeSharedPtr& rOrigShape, const DocTreeNode& rTreeNode ); /** Revoke a previously queried subset shape. With this method, a previously requested subset shape is revoked again. If the last client revokes a given subset, it will cease to be displayed, and the original shape will again show the subset data. @param rOrigShape The shape the subset was created from @param rSubsetShape The subset created from rOrigShape */ void revokeSubset( const AttributableShapeSharedPtr& rOrigShape, const AttributableShapeSharedPtr& rSubsetShape ); /** Notify the LayerManager that the given Shape starts an animation now. This method enters animation mode for the Shape on all registered views. */ void enterAnimationMode( const AnimatableShapeSharedPtr& rShape ); /** Notify the LayerManager that the given Shape is no longer animated. This methods ends animation mode for the given Shape on all registered views. */ void leaveAnimationMode( const AnimatableShapeSharedPtr& rShape ); /** Notify that a shape needs an update This method notifies the layer manager that a shape update is necessary. This is useful if, during animation playback, changes occur to shapes which make an update necessary on an update() call. Otherwise, update() will not render anything, which is not triggered by calling one of the other LayerManager methods. @param rShape Shape which needs an update */ void notifyShapeUpdate( const ShapeSharedPtr& rShape); /** Check whether any update operations are pending. @return true, if this LayerManager has any updates pending, i.e. needs to repaint something for the next frame. */ bool isUpdatePending() const; /** Update the content This method updates the content on all layers on all registered views. It does not issues a View::updateScreen() call on registered views. Please note that this method only takes into account changes to shapes induced directly by calling methods of the LayerManager. If a shape needs an update, because of some external event unknown to the LayerManager (most notably running animations), you have to notify the LayerManager via notifyShapeUpdate(). @see LayerManager::updateScreen() @return whether the update finished successfully. */ bool update(); /** Render the content to given canvas This is a one-shot operation, which simply draws all shapes onto the given canvas, without any caching or other fuzz. Don't use that for repeated output onto the same canvas, the View concept is more optimal then. @param rTargetCanvas Target canvas to output onto. */ bool renderTo( const ::cppcanvas::CanvasSharedPtr& rTargetCanvas ) const; private: /** A hash map which maps the XShape to the corresponding Shape object. Provides quicker lookup than ShapeSet for simple mappings */ typedef std::unordered_map< css::uno::Reference< css::drawing::XShape >, ShapeSharedPtr, hash< css::uno::Reference< css::drawing::XShape > > > XShapeHash; class ShapeComparator { public: bool operator() (const ShapeSharedPtr& rpS1, const ShapeSharedPtr& rpS2 ) const { return Shape::lessThanShape::compare(rpS1.get(), rpS2.get()); } }; /** Set of all shapes */ private: typedef ::std::map< ShapeSharedPtr, LayerWeakPtr, ShapeComparator > LayerShapeMap; /// Adds shape area to containing layer's damage area void addUpdateArea( ShapeSharedPtr const& rShape ); LayerSharedPtr createForegroundLayer() const; /** Push changes from updateShapeLayerAssociations() to current layer Factored-out method that resizes layer, if necessary, assigns correct layer priority, and repaints contained shapes. @param nCurrLayerIndex Index of current layer in maLayers @param aFirstLayerShape Valid iterator out of maAllShapes, denoting the first shape from nCurrLayerIndex @param aEndLayerShapes Valid iterator or end iterator out of maAllShapes, denoting one-behind-the-last shape of nCurrLayerIndex */ void commitLayerChanges( std::size_t nCurrLayerIndex, LayerShapeMap::const_iterator aFirstLayerShape, const LayerShapeMap::const_iterator& aEndLayerShapes ); /** Init Shape layers with background layer. */ void putShape2BackgroundLayer( LayerShapeMap::value_type& rShapeEntry ); /** Commits any pending layer reorg, due to shapes either entering or leaving animation mode @param bBackgroundLayerPainted When true, LayerManager does not render anything on the background layer. Use this, if background has been updated by other means (e.g. slide transition) */ void updateShapeLayers( bool bBackgroundLayerPainted ); /** Common stuff when adding a shape */ void implAddShape( const ShapeSharedPtr& rShape ); /** Common stuff when removing a shape */ void implRemoveShape( const ShapeSharedPtr& rShape ); /** Add or remove views Sharing duplicate code from viewAdded and viewRemoved method. The only point of variation at those places are removal vs. adding. */ template void manageViews( LayerFunc layerFunc, ShapeFunc shapeFunc ); bool updateSprites(); /// Registered views const UnoViewContainer& mrViews; /// All layers of this object. Vector owns the layers ::std::vector< LayerSharedPtr > maLayers; /** Contains all shapes with their XShape reference as the key */ XShapeHash maXShapeHash; /** Set of shapes this LayerManager own Contains the same set of shapes as XShapeHash, but is sorted in z order, for painting and layer association. Set entries are enriched with two flags for buffering animation enable/disable changes, and shape update requests. */ LayerShapeMap maAllShapes; /** Set of shapes that have requested an update When a shape is member of this set, its maShapes entry has bNeedsUpdate set to true. We maintain this redundant information for faster update processing. */ ::std::set< ShapeSharedPtr > maUpdateShapes; /// Number of shape sprites currently active on this LayerManager sal_Int32 mnActiveSprites; /// sal_True, if shapes might need to move to different layer bool mbLayerAssociationDirty; /// sal_False when deactivated bool mbActive; /** When true, all sprite animations run in the foreground. That is, no extra layers are created, and the slideshow runs potentially faster. */ bool mbDisableAnimationZOrder; }; typedef ::std::shared_ptr< LayerManager > LayerManagerSharedPtr; } } #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SLIDE_LAYERMANAGER_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */