canvas/source/vcl/spritehelper.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21 #include <sal/log.hxx>
  22
  23 #include <basegfx/matrix/b2dhommatrix.hxx>
  24 #include <basegfx/numeric/ftools.hxx>
  25 #include <basegfx/point/b2dpoint.hxx>
  26 #include <basegfx/range/b2drectangle.hxx>
  27 #include <basegfx/utils/canvastools.hxx>
  28 #include <rtl/math.hxx>
  29 #include <comphelper/diagnose_ex.hxx>
  30 #include <vcl/alpha.hxx>
  31 #include <vcl/bitmapex.hxx>
  32 #include <vcl/canvastools.hxx>
  33 #include <vcl/outdev.hxx>
  34
  35 #include <canvas/canvastools.hxx>
  36
  37 #include "spritehelper.hxx"
  38
  39 using namespace ::com::sun::star;
  40
  41
  42 namespace vclcanvas
  43 {
  44     SpriteHelper::SpriteHelper() :
  45         mbShowSpriteBounds(false)
  46     {
  47     }
  48
  49     void SpriteHelper::init( const geometry::RealSize2D&               rSpriteSize,
  50                              const ::canvas::SpriteSurface::Reference& rOwningSpriteCanvas,
  51                              const BackBufferSharedPtr&                rBackBuffer,
  52                              const BackBufferSharedPtr&                rBackBufferMask,
  53                              bool                                      bShowSpriteBounds )
  54     {
  55         ENSURE_OR_THROW( rOwningSpriteCanvas && rBackBuffer && rBackBufferMask,
  56                          "SpriteHelper::init(): Invalid sprite canvas or back buffer" );
  57
  58         mpBackBuffer        = rBackBuffer;
  59         mpBackBufferMask    = rBackBufferMask;
  60         mbShowSpriteBounds  = bShowSpriteBounds;
  61
  62         init( rSpriteSize, rOwningSpriteCanvas );
  63     }
  64
  65     void SpriteHelper::disposing()
  66     {
  67         mpBackBuffer.reset();
  68         mpBackBufferMask.reset();
  69
  70         // forward to parent
  71         CanvasCustomSpriteHelper::disposing();
  72     }
  73
  74     void SpriteHelper::redraw( OutputDevice&                rTargetSurface,
  75                                const ::basegfx::B2DPoint&   rPos,
  76                                bool&                        io_bSurfacesDirty,
  77                                bool                         /*bBufferedUpdate*/ ) const
  78     {
  79         if( !mpBackBuffer ||
  80             !mpBackBufferMask )
  81         {
  82             return; // we're disposed
  83         }
  84
  85         // log output pos in device pixel
  86         SAL_INFO("canvas.vcl", "SpriteHelper::redraw(): output pos is (" <<
  87                  rPos.getX() << "," << rPos.getY() << ")");
  88
  89         const double fAlpha( getAlpha() );
  90
  91         if( !isActive() || ::basegfx::fTools::equalZero( fAlpha ) )
  92             return;
  93
  94         const ::basegfx::B2DVector& rOrigOutputSize( getSizePixel() );
  95
  96         // might get changed below (e.g. adapted for
  97         // transformations). IMPORTANT: both position and size are
  98         // rounded to integer values. From now on, only those
  99         // rounded values are used, to keep clip and content in
 100         // sync.
 101         ::Size  aOutputSize( vcl::unotools::sizeFromB2DSize( rOrigOutputSize ) );
 102         ::Point aOutPos( vcl::unotools::pointFromB2DPoint( rPos ) );
 103
 104
 105         // TODO(F3): Support for alpha-VDev
 106
 107         // Do we have to update our bitmaps (necessary if virdev
 108         // was painted to, or transformation changed)?
 109         const bool bNeedBitmapUpdate( io_bSurfacesDirty ||
 110                                       hasTransformChanged() ||
 111                                       maContent->IsEmpty() );
 112
 113         // updating content of sprite cache - surface is no
 114         // longer dirty in relation to our cache
 115         io_bSurfacesDirty = false;
 116         transformUpdated();
 117
 118         if( bNeedBitmapUpdate )
 119         {
 120             const Point aEmptyPoint;
 121             BitmapEx aBmp( mpBackBuffer->getOutDev().GetBitmapEx( aEmptyPoint,
 122                                                               aOutputSize ) );
 123
 124             if( isContentFullyOpaque() )
 125             {
 126                 // optimized case: content canvas is fully
 127                 // opaque. Note: since we retrieved aBmp directly
 128                 // from an OutDev, it's already a 'display bitmap'
 129                 // on windows.
 130                 maContent = aBmp;
 131             }
 132             else
 133             {
 134                 // sprite content might contain alpha, create
 135                 // BmpEx, then.
 136                 BitmapEx aMask( mpBackBufferMask->getOutDev().GetBitmapEx( aEmptyPoint,
 137                                                                            aOutputSize ) );
 138                 AlphaMask aAlpha( aMask.GetBitmap() );
 139                 aAlpha.Invert();
 140
 141                 // Note: since we retrieved aBmp and aMask
 142                 // directly from an OutDev, it's already a
 143                 // 'display bitmap' on windows.
 144                 maContent = BitmapEx( aBmp.GetBitmap(), aAlpha );
 145             }
 146         }
 147
 148         ::basegfx::B2DHomMatrix aTransform( getTransformation() );
 149
 150         rTargetSurface.Push( vcl::PushFlags::CLIPREGION );
 151
 152         // apply clip (if any)
 153         if( getClip().is() )
 154         {
 155             ::basegfx::B2DPolyPolygon aClipPoly(
 156                 ::basegfx::unotools::b2DPolyPolygonFromXPolyPolygon2D(
 157                     getClip() ));
 158
 159             if( aClipPoly.count() )
 160             {
 161                 // Move the clip to the final sprite output position.
 162                 ::basegfx::B2DHomMatrix aClipTransform( aTransform );
 163                 aClipTransform.translate( aOutPos.X(), aOutPos.Y() );
 164                 aClipPoly.transform( aClipTransform );
 165
 166                 if( mbShowSpriteBounds )
 167                 {
 168                     // Paint green sprite clip area
 169                     rTargetSurface.SetLineColor( COL_LIGHTGREEN );
 170                     rTargetSurface.SetFillColor();
 171
 172                     rTargetSurface.DrawPolyPolygon(::tools::PolyPolygon(aClipPoly)); // #i76339#
 173                 }
 174
 175                 vcl::Region aClipRegion( aClipPoly );
 176                 rTargetSurface.SetClipRegion( aClipRegion );
 177             }
 178         }
 179
 180         ::basegfx::B2DHomMatrix aSizeTransform, aMoveTransform;
 181         aSizeTransform.scale( aOutputSize.Width(), aOutputSize.Height() );
 182         aMoveTransform.translate( aOutPos.X(), aOutPos.Y() );
 183         aTransform = aMoveTransform * aTransform * aSizeTransform;
 184
 185         rTargetSurface.DrawTransformedBitmapEx( aTransform, *maContent, fAlpha );
 186
 187         rTargetSurface.Pop();
 188
 189         if( !mbShowSpriteBounds )
 190             return;
 191
 192         ::tools::PolyPolygon aMarkerPoly(
 193             ::canvas::tools::getBoundMarksPolyPolygon(
 194                 ::basegfx::B2DRectangle(aOutPos.X(),
 195                                         aOutPos.Y(),
 196                                         aOutPos.X() + aOutputSize.Width()-1,
 197                                         aOutPos.Y() + aOutputSize.Height()-1) ) );
 198
 199         // Paint little red sprite area markers
 200         rTargetSurface.SetLineColor( COL_RED );
 201         rTargetSurface.SetFillColor();
 202
 203         for( int i=0; i<aMarkerPoly.Count(); ++i )
 204         {
 205             rTargetSurface.DrawPolyLine( aMarkerPoly.GetObject(static_cast<sal_uInt16>(i)) );
 206         }
 207
 208         // paint sprite prio
 209         vcl::Font aVCLFont;
 210         aVCLFont.SetFontHeight( std::min(::tools::Long(20),aOutputSize.Height()) );
 211         aVCLFont.SetColor( COL_RED );
 212
 213         rTargetSurface.SetTextAlign(ALIGN_TOP);
 214         rTargetSurface.SetTextColor( COL_RED );
 215         rTargetSurface.SetFont( aVCLFont );
 216
 217         OUString text( ::rtl::math::doubleToUString( getPriority(),
 218                                                             rtl_math_StringFormat_F,
 219                                                             2,'.',nullptr,' ') );
 220
 221         rTargetSurface.DrawText( aOutPos+Point(2,2), text );
 222         SAL_INFO( "canvas.vcl",
 223                   "sprite " << this << " has prio " << getPriority());
 224     }
 225
 226     ::basegfx::B2DPolyPolygon SpriteHelper::polyPolygonFromXPolyPolygon2D( uno::Reference< rendering::XPolyPolygon2D >& xPoly ) const
 227     {
 228         return ::basegfx::unotools::b2DPolyPolygonFromXPolyPolygon2D( xPoly );
 229     }
 230
 231 }
 232
 233 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */