slideshow/source/engine/shapes/drawshape.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: drawshape.hxx,v $
  10  * $Revision: 1.4.12.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_DRAWSHAPE_HXX
  32 #define INCLUDED_SLIDESHOW_DRAWSHAPE_HXX
  33
  34 #include <osl/diagnose.hxx>
  35 #include <com/sun/star/drawing/XShape.hpp>
  36
  37 #include "attributableshape.hxx"
  38 #include "doctreenodesupplier.hxx"
  39 #include "gdimtftools.hxx"
  40 #include "viewshape.hxx"
  41 #include "hyperlinkarea.hxx"
  42
  43 #include <boost/optional.hpp>
  44 #include <boost/shared_ptr.hpp>
  45 #include <boost/weak_ptr.hpp>
  46 #include <set>
  47 #include <vector>
  48
  49 class Graphic;
  50
  51 namespace slideshow
  52 {
  53     namespace internal
  54     {
  55         class  Activity;
  56         struct SlideShowContext;
  57         class  DrawShapeSubsetting;
  58         class  DrawShape;
  59         typedef ::boost::shared_ptr< DrawShape > DrawShapeSharedPtr;
  60
  61         /** This class is the representation of a draw document's
  62             XShape, and implements the Shape, AnimatableShape, and
  63             AttributableShape interfaces.
  64
  65             @attention this class is to be treated 'final', i.e. one
  66             should not derive from it.
  67          */
  68         class DrawShape : public AttributableShape,
  69                           public DocTreeNodeSupplier,
  70                           public HyperlinkArea,
  71                           protected ::osl::DebugBase<DrawShape>
  72         {
  73         public:
  74             /** Create a shape for the given XShape
  75
  76                 @param xShape
  77                 The XShape to represent.
  78
  79                 @param xContainingPage
  80                 The page that contains this shape. Needed for proper
  81                 import (currently, the UnoGraphicExporter needs this
  82                 information).
  83
  84                 @param nPrio
  85                 Externally-determined shape priority (used e.g. for
  86                 paint ordering). This number _must be_ unique!
  87
  88                 @param bForeignSource
  89                 When true, the source of the shape metafile might be a
  90                 foreign application. The metafile is checked against
  91                 unsupported content, and, if necessary, returned as a
  92                 pre-rendererd bitmap.
  93              */
  94             static DrawShapeSharedPtr create(
  95                 const ::com::sun::star::uno::Reference<
  96                    ::com::sun::star::drawing::XShape >&    xShape,
  97                 const ::com::sun::star::uno::Reference<
  98                    ::com::sun::star::drawing::XDrawPage >& xContainingPage,
  99                 double                                     nPrio,
 100                 bool                                       bForeignSource,
 101                 const SlideShowContext&                    rContext ); // throw ShapeLoadFailedException;
 102
 103             /** Create a shape for the given XShape and graphic content
 104
 105                 @param xShape
 106                 The XShape to represent.
 107
 108                 @param xContainingPage
 109                 The page that contains this shape. Needed for proper
 110                 import (currently, the UnoGraphicExporter needs this
 111                 information).
 112
 113                 @param nPrio
 114                 Externally-determined shape priority (used e.g. for
 115                 paint ordering). This number _must be_ unique!
 116
 117                 @param rGraphic
 118                 Graphic to display in the shape's bound rect. If this
 119                 Graphic contains animatable content, the created
 120                 DrawShape will register itself for intrinsic animation
 121                 events.
 122              */
 123             static DrawShapeSharedPtr create(
 124                 const ::com::sun::star::uno::Reference<
 125                    ::com::sun::star::drawing::XShape >&    xShape,
 126                 const ::com::sun::star::uno::Reference<
 127                    ::com::sun::star::drawing::XDrawPage >& xContainingPage,
 128                 double                                     nPrio,
 129                 const Graphic&                             rGraphic,
 130                 const SlideShowContext&                    rContext ); // throw ShapeLoadFailedException;
 131
 132             virtual ::com::sun::star::uno::Reference<
 133                 ::com::sun::star::drawing::XShape > getXShape() const;
 134
 135             virtual ~DrawShape();
 136
 137
 138             // View layer methods
 139             //------------------------------------------------------------------
 140
 141             virtual void addViewLayer( const ViewLayerSharedPtr&    rNewLayer,
 142                                        bool                         bRedrawLayer );
 143             virtual bool removeViewLayer( const ViewLayerSharedPtr& rNewLayer );
 144             virtual bool clearAllViewLayers();
 145
 146             // attribute methods
 147             //------------------------------------------------------------------
 148
 149             virtual ShapeAttributeLayerSharedPtr createAttributeLayer();
 150             virtual bool revokeAttributeLayer( const ShapeAttributeLayerSharedPtr& rLayer );
 151             virtual ShapeAttributeLayerSharedPtr getTopmostAttributeLayer() const;
 152             virtual void setVisibility( bool bVisible );
 153             virtual ::basegfx::B2DRectangle getBounds() const;
 154             virtual ::basegfx::B2DRectangle getDomBounds() const;
 155             virtual ::basegfx::B2DRectangle getUpdateArea() const;
 156             virtual bool isVisible() const;
 157             virtual double getPriority() const;
 158
 159
 160             // animation methods
 161             //------------------------------------------------------------------
 162
 163             virtual void enterAnimationMode();
 164             virtual void leaveAnimationMode();
 165             virtual bool isBackgroundDetached() const;
 166
 167             // render methods
 168             //------------------------------------------------------------------
 169
 170             virtual bool update() const;
 171             virtual bool render() const;
 172             virtual bool isContentChanged() const;
 173
 174             // Sub item specialities
 175             //------------------------------------------------------------------
 176
 177             virtual const DocTreeNodeSupplier&  getTreeNodeSupplier() const;
 178             virtual DocTreeNodeSupplier&        getTreeNodeSupplier();
 179
 180             virtual DocTreeNode                 getSubsetNode() const;
 181             virtual AttributableShapeSharedPtr  getSubset( const DocTreeNode& rTreeNode ) const;
 182             virtual bool                        createSubset( AttributableShapeSharedPtr&   o_rSubset,
 183                                                               const DocTreeNode&            rTreeNode );
 184             virtual bool                        revokeSubset( const AttributableShapeSharedPtr& rShape );
 185
 186
 187             // DocTreeNodeSupplier methods
 188             //------------------------------------------------------------------
 189
 190             virtual sal_Int32   getNumberOfTreeNodes        ( DocTreeNode::NodeType eNodeType ) const; // throw ShapeLoadFailedException;
 191             virtual DocTreeNode getTreeNode                 ( sal_Int32             nNodeIndex,
 192                                                               DocTreeNode::NodeType eNodeType ) const; // throw ShapeLoadFailedException;
 193             virtual sal_Int32   getNumberOfSubsetTreeNodes  ( const DocTreeNode&    rParentNode,
 194                                                               DocTreeNode::NodeType eNodeType ) const; // throw ShapeLoadFailedException;
 195             virtual DocTreeNode getSubsetTreeNode           ( const DocTreeNode&    rParentNode,
 196                                                               sal_Int32             nNodeIndex,
 197                                                               DocTreeNode::NodeType eNodeType ) const; // throw ShapeLoadFailedException;
 198
 199             // HyperlinkArea methods
 200             //------------------------------------------------------------------
 201
 202             virtual HyperlinkRegions getHyperlinkRegions() const;
 203             virtual double getHyperlinkPriority() const;
 204
 205
 206             // intrinsic animation methods
 207             //------------------------------------------------------------------
 208
 209             /** Display next frame of an intrinsic animation.
 210
 211                 Used by IntrinsicAnimationActivity, to show the next
 212                 animation frame.
 213              */
 214             bool setIntrinsicAnimationFrame( ::std::size_t nCurrFrame );
 215
 216             /** forces the drawshape to load and return a specially
 217                 crafted metafile, usable to display drawing layer text
 218                 animations.
 219             */
 220             GDIMetaFileSharedPtr forceScrollTextMetaFile();
 221
 222         private:
 223             /** Create a shape for the given XShape
 224
 225                 @param xShape
 226                 The XShape to represent.
 227
 228                 @param xContainingPage
 229                 The page that contains this shape. Needed for proper
 230                 import (currently, the UnoGraphicExporter needs this
 231                 information).
 232
 233                 @param nPrio
 234                 Externally-determined shape priority (used e.g. for
 235                 paint ordering). This number _must be_ unique!
 236
 237                 @param bForeignSource
 238                 When true, the source of the shape metafile might be a
 239                 foreign application. The metafile is checked against
 240                 unsupported content, and, if necessary, returned as a
 241                 pre-rendererd bitmap.
 242              */
 243             DrawShape( const ::com::sun::star::uno::Reference<
 244                             ::com::sun::star::drawing::XShape >&    xShape,
 245                        const ::com::sun::star::uno::Reference<
 246                             ::com::sun::star::drawing::XDrawPage >& xContainingPage,
 247                        double                                       nPrio,
 248                        bool                                         bForeignSource,
 249                        const SlideShowContext&                      rContext ); // throw ShapeLoadFailedException;
 250
 251             /** Create a shape for the given XShape and graphic content
 252
 253                 @param xShape
 254                 The XShape to represent.
 255
 256                 @param xContainingPage
 257                 The page that contains this shape. Needed for proper
 258                 import (currently, the UnoGraphicExporter needs this
 259                 information).
 260
 261                 @param nPrio
 262                 Externally-determined shape priority (used e.g. for
 263                 paint ordering). This number _must be_ unique!
 264
 265                 @param rGraphic
 266                 Graphic to display in the shape's bound rect. If this
 267                 Graphic contains animatable content, the created
 268                 DrawShape will register itself for intrinsic animation
 269                 events.
 270              */
 271             DrawShape( const ::com::sun::star::uno::Reference<
 272                             ::com::sun::star::drawing::XShape >&    xShape,
 273                        const ::com::sun::star::uno::Reference<
 274                             ::com::sun::star::drawing::XDrawPage >& xContainingPage,
 275                        double                                       nPrio,
 276                        const Graphic&                               rGraphic,
 277                        const SlideShowContext&                      rContext ); // throw ShapeLoadFailedException;
 278
 279             /** Private copy constructor
 280
 281                 Used to create subsetted shapes
 282              */
 283             DrawShape( const DrawShape&, const DocTreeNode& rTreeNode, double nPrio );
 284
 285             int  getUpdateFlags() const;
 286             bool implRender( int nUpdateFlags ) const;
 287             void updateStateIds() const;
 288
 289             ViewShape::RenderArgs   getViewRenderArgs() const;
 290             ::basegfx::B2DRectangle getActualUnitShapeBounds() const;
 291
 292             void ensureVerboseMtfComments() const;
 293             bool hasIntrinsicAnimation() const;
 294             bool hasHyperlinks() const;
 295             void prepareHyperlinkIndices() const;
 296
 297             /// The associated XShape
 298             ::com::sun::star::uno::Reference<
 299                     ::com::sun::star::drawing::XShape >                             mxShape;
 300             ::com::sun::star::uno::Reference<
 301                     ::com::sun::star::drawing::XDrawPage >                          mxPage;
 302
 303             /** A vector of metafiles actually representing the Shape.
 304
 305                 If this shape is not animated, only a single entry is
 306                 available.
 307              */
 308             mutable VectorOfMtfAnimationFrames                                      maAnimationFrames;
 309             ::std::size_t                                                           mnCurrFrame;
 310
 311             /// Metafile of currently active frame (static for shapes w/o intrinsic animation)
 312             mutable GDIMetaFileSharedPtr                                            mpCurrMtf;
 313
 314             /// loadflags of current meta file
 315             mutable int                                                             mnCurrMtfLoadFlags;
 316
 317             /// Contains the current shape bounds, in unit rect space
 318             mutable ::boost::optional<basegfx::B2DRectangle>                        maCurrentShapeUnitBounds;
 319
 320             // The attributes of this Shape
 321             const double                                                            mnPriority;
 322             ::basegfx::B2DRectangle                                                 maBounds; // always needed for rendering.
 323                                                                                               // for subset shapes, this member
 324                                                                                               // might change when views are
 325                                                                                               // added, as minimal bounds are
 326                                                                                               // calculated
 327
 328             // Pointer to modifiable shape attributes
 329             ShapeAttributeLayerSharedPtr                                            mpAttributeLayer; // only created lazily
 330
 331             // held here, to signal our destruction
 332             boost::weak_ptr<Activity>                                               mpIntrinsicAnimationActivity;
 333
 334             // The attribute states, to detect attribute changes,
 335             // without buffering and querying each single attribute
 336             mutable State::StateId                                                  mnAttributeTransformationState;
 337             mutable State::StateId                                                  mnAttributeClipState;
 338             mutable State::StateId                                                  mnAttributeAlphaState;
 339             mutable State::StateId                                                  mnAttributePositionState;
 340             mutable State::StateId                                                  mnAttributeContentState;
 341             mutable State::StateId                                                  mnAttributeVisibilityState;
 342
 343             /// the list of active view shapes (one for each registered view layer)
 344             typedef ::std::vector< ViewShapeSharedPtr > ViewShapeVector;
 345             ViewShapeVector                                                         maViewShapes;
 346
 347             ::com::sun::star::uno::Reference<
 348                 ::com::sun::star::uno::XComponentContext>                           mxComponentContext;
 349
 350             /// hyperlink support
 351             typedef ::std::pair<sal_Int32 /* mtf start */,
 352                                 sal_Int32 /* mtf end */> HyperlinkIndexPair;
 353             typedef ::std::vector<HyperlinkIndexPair> HyperlinkIndexPairVector;
 354             mutable HyperlinkIndexPairVector                                        maHyperlinkIndices;
 355             mutable HyperlinkRegions                                                maHyperlinkRegions;
 356
 357             /// Delegated subset handling
 358             mutable DrawShapeSubsetting                                             maSubsetting;
 359
 360             /// Whether this shape is currently in animation mode (value != 0)
 361             int                                                                     mnIsAnimatedCount;
 362
 363             /// Number of times the bitmap animation shall loop
 364             ::std::size_t                                                           mnAnimationLoopCount;
 365
 366             /// Cycle mode for bitmap animation
 367             CycleMode                                                               meCycleMode;
 368
 369             /// Whether shape is visible (without attribute layers)
 370             bool                                                                    mbIsVisible;
 371
 372             /// Whether redraw is necessary, regardless of state ids
 373             mutable bool                                                            mbForceUpdate;
 374
 375             /// Whether attribute layer was revoked (making a redraw necessary)
 376             mutable bool                                                            mbAttributeLayerRevoked;
 377
 378             /// whether a drawing layer animation has to be performed
 379             bool                                                                    mbDrawingLayerAnim;
 380
 381         };
 382     }
 383 }
 384
 385 #endif /* INCLUDED_SLIDESHOW_DRAWSHAPE_HXX */