cppcanvas/source/mtfrenderer/cachedprimitivebase.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _CPPCANVAS_CACHEDPRIMITIVEBASE_HXX
  30 #define _CPPCANVAS_CACHEDPRIMITIVEBASE_HXX
  31
  32 #include <com/sun/star/uno/Reference.hxx>
  33 #include <com/sun/star/rendering/XCanvas.hpp>
  34
  35 #include <cppcanvas/canvas.hxx>
  36 #include <boost/utility.hpp>
  37
  38 #include "action.hxx"
  39
  40 namespace basegfx { class B2DHomMatrix; }
  41
  42
  43 /* Definition of internal::CachedPrimitiveBase class */
  44
  45 namespace cppcanvas
  46 {
  47     namespace internal
  48     {
  49         /** Base class providing cached re-rendering, if XCanvas
  50             returns XCachedPrimitive
  51
  52             Derive from this class and implement private render()
  53             method to perform the actual primitive rendering. Return
  54             cached primitive into given reference. Next time this
  55             class' public render() method gets called, the cached
  56             representation is taken.
  57          */
  58         class CachedPrimitiveBase : public Action,
  59                                     private ::boost::noncopyable
  60         {
  61         public:
  62             /** Constructor
  63
  64                 @param rCanvas
  65                 Canvas on which this primitive is to appear
  66
  67                 @param bOnlyRedrawWithSameTransform
  68                 When true, this class only reuses the cached
  69                 primitive, if the overall transformation stays the
  70                 same. Otherwise, repaints are always performed via the
  71                 cached primitive.
  72              */
  73             CachedPrimitiveBase( const CanvasSharedPtr& rCanvas,
  74                                  bool                   bOnlyRedrawWithSameTransform );
  75             virtual ~CachedPrimitiveBase() {}
  76
  77             virtual bool render( const ::basegfx::B2DHomMatrix& rTransformation ) const;
  78
  79         protected:
  80             using Action::render;
  81
  82         private:
  83             virtual bool renderPrimitive( ::com::sun::star::uno::Reference<
  84                                      ::com::sun::star::rendering::XCachedPrimitive >& rCachedPrimitive,
  85                                  const ::basegfx::B2DHomMatrix&                       rTransformation ) const = 0;
  86
  87             CanvasSharedPtr                                             mpCanvas;
  88             mutable ::com::sun::star::uno::Reference<
  89                     ::com::sun::star::rendering::XCachedPrimitive >     mxCachedPrimitive;
  90             mutable ::basegfx::B2DHomMatrix                             maLastTransformation;
  91             const bool                                                  mbOnlyRedrawWithSameTransform;
  92         };
  93     }
  94 }
  95
  96 #endif /*_CPPCANVAS_CACHEDPRIMITIVEBASE_HXX */
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */