vcl/source/gdi/impanmvw.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 <memory>
  21 #include <impanmvw.hxx>
  22
  23 #include <vcl/virdev.hxx>
  24 #include <vcl/window.hxx>
  25 #include <tools/helpers.hxx>
  26
  27 #include <window.h>
  28
  29 ImplAnimView::ImplAnimView( Animation* pParent, OutputDevice* pOut,
  30                             const Point& rPt, const Size& rSz,
  31                             sal_uLong nExtraData,
  32                             OutputDevice* pFirstFrameOutDev ) :
  33         mpParent        ( pParent ),
  34         mpRenderContext ( pFirstFrameOutDev ? pFirstFrameOutDev : pOut ),
  35         mnExtraData     ( nExtraData ),
  36         maPt            ( rPt ),
  37         maSz            ( rSz ),
  38         maSzPix         ( mpRenderContext->LogicToPixel( maSz ) ),
  39         maClip          ( mpRenderContext->GetClipRegion() ),
  40         mpBackground    ( VclPtr<VirtualDevice>::Create() ),
  41         mpRestore       ( VclPtr<VirtualDevice>::Create() ),
  42         meLastDisposal  ( Disposal::Back ),
  43         mbIsPaused      ( false ),
  44         mbIsMarked      ( false ),
  45         mbIsMirroredHorizontally         ( maSz.Width() < 0 ),
  46         mbIsMirroredVertically         ( maSz.Height() < 0 )
  47 {
  48     Animation::ImplIncAnimCount();
  49
  50     // Mirrored horizontally?
  51     if( mbIsMirroredHorizontally )
  52     {
  53         maDispPt.setX( maPt.X() + maSz.Width() + 1 );
  54         maDispSz.setWidth( -maSz.Width() );
  55         maSzPix.setWidth( -maSzPix.Width() );
  56     }
  57     else
  58     {
  59         maDispPt.setX( maPt.X() );
  60         maDispSz.setWidth( maSz.Width() );
  61     }
  62
  63     // Mirrored vertically?
  64     if( mbIsMirroredVertically )
  65     {
  66         maDispPt.setY( maPt.Y() + maSz.Height() + 1 );
  67         maDispSz.setHeight( -maSz.Height() );
  68         maSzPix.setHeight( -maSzPix.Height() );
  69     }
  70     else
  71     {
  72         maDispPt.setY( maPt.Y() );
  73         maDispSz.setHeight( maSz.Height() );
  74     }
  75
  76     // save background
  77     mpBackground->SetOutputSizePixel( maSzPix );
  78     mpRenderContext->SaveBackground(*mpBackground, maDispPt, maDispSz, maSzPix);
  79
  80     // Initialize drawing to actual position
  81     drawToPos( mpParent->ImplGetCurPos() );
  82
  83     // If first frame OutputDevice is set, update variables now for real OutputDevice
  84     if( pFirstFrameOutDev )
  85     {
  86         mpRenderContext = pOut;
  87         maClip = mpRenderContext->GetClipRegion();
  88     }
  89 }
  90
  91 ImplAnimView::~ImplAnimView()
  92 {
  93     mpBackground.disposeAndClear();
  94     mpRestore.disposeAndClear();
  95
  96     Animation::ImplDecAnimCount();
  97 }
  98
  99 bool ImplAnimView::matches(const OutputDevice* pOut, tools::Long nExtraData) const
 100 {
 101     return (!pOut || pOut == mpRenderContext) && (nExtraData == 0 || nExtraData == mnExtraData);
 102 }
 103
 104 void ImplAnimView::getPosSize( const AnimationBitmap& rAnimationBitmap, Point& rPosPix, Size& rSizePix )
 105 {
 106     const Size& rAnmSize = mpParent->GetDisplaySizePixel();
 107     Point       aPt2( rAnimationBitmap.maPositionPixel.X() + rAnimationBitmap.maSizePixel.Width() - 1,
 108                       rAnimationBitmap.maPositionPixel.Y() + rAnimationBitmap.maSizePixel.Height() - 1 );
 109     double      fFactX, fFactY;
 110
 111     // calculate x scaling
 112     if( rAnmSize.Width() > 1 )
 113         fFactX = static_cast<double>( maSzPix.Width() - 1 ) / ( rAnmSize.Width() - 1 );
 114     else
 115         fFactX = 1.0;
 116
 117     // calculate y scaling
 118     if( rAnmSize.Height() > 1 )
 119         fFactY = static_cast<double>( maSzPix.Height() - 1 ) / ( rAnmSize.Height() - 1 );
 120     else
 121         fFactY = 1.0;
 122
 123     rPosPix.setX( FRound( rAnimationBitmap.maPositionPixel.X() * fFactX ) );
 124     rPosPix.setY( FRound( rAnimationBitmap.maPositionPixel.Y() * fFactY ) );
 125
 126     aPt2.setX( FRound( aPt2.X() * fFactX ) );
 127     aPt2.setY( FRound( aPt2.Y() * fFactY ) );
 128
 129     rSizePix.setWidth( aPt2.X() - rPosPix.X() + 1 );
 130     rSizePix.setHeight( aPt2.Y() - rPosPix.Y() + 1 );
 131
 132     // Mirrored horizontally?
 133     if( mbIsMirroredHorizontally )
 134         rPosPix.setX( maSzPix.Width() - 1 - aPt2.X() );
 135
 136     // Mirrored vertically?
 137     if( mbIsMirroredVertically )
 138         rPosPix.setY( maSzPix.Height() - 1 - aPt2.Y() );
 139 }
 140
 141 void ImplAnimView::drawToPos( sal_uLong nPos )
 142 {
 143     VclPtr<vcl::RenderContext> pRenderContext = mpRenderContext;
 144
 145     vcl::PaintBufferGuardPtr pGuard;
 146     if (mpRenderContext->GetOutDevType() == OUTDEV_WINDOW)
 147     {
 148         vcl::Window* pWindow = static_cast<vcl::WindowOutputDevice*>(mpRenderContext.get())->GetOwnerWindow();
 149         pGuard.reset(new vcl::PaintBufferGuard(pWindow->ImplGetWindowImpl()->mpFrameData, pWindow));
 150         pRenderContext = pGuard->GetRenderContext();
 151     }
 152
 153     ScopedVclPtrInstance<VirtualDevice> aVDev;
 154     std::optional<vcl::Region> xOldClip;
 155     if (!maClip.IsNull())
 156         xOldClip = pRenderContext->GetClipRegion();
 157
 158     aVDev->SetOutputSizePixel( maSzPix, false );
 159     nPos = std::min( nPos, static_cast<sal_uLong>(mpParent->Count()) - 1 );
 160
 161     for( sal_uLong i = 0; i <= nPos; i++ )
 162         draw( i, aVDev.get() );
 163
 164     if (xOldClip)
 165         pRenderContext->SetClipRegion( maClip );
 166
 167     pRenderContext->DrawOutDev( maDispPt, maDispSz, Point(), maSzPix, *aVDev );
 168     if (pGuard)
 169         pGuard->SetPaintRect(tools::Rectangle(maDispPt, maDispSz));
 170
 171     if (xOldClip)
 172         pRenderContext->SetClipRegion(*xOldClip);
 173 }
 174
 175 void ImplAnimView::draw( sal_uLong nPos, VirtualDevice* pVDev )
 176 {
 177     VclPtr<vcl::RenderContext> pRenderContext = mpRenderContext;
 178
 179     vcl::PaintBufferGuardPtr pGuard;
 180     if (!pVDev && mpRenderContext->GetOutDevType() == OUTDEV_WINDOW)
 181     {
 182         vcl::Window* pWindow = static_cast<vcl::WindowOutputDevice*>(mpRenderContext.get())->GetOwnerWindow();
 183         pGuard.reset(new vcl::PaintBufferGuard(pWindow->ImplGetWindowImpl()->mpFrameData, pWindow));
 184         pRenderContext = pGuard->GetRenderContext();
 185     }
 186
 187     tools::Rectangle aOutRect( pRenderContext->PixelToLogic( Point() ), pRenderContext->GetOutputSize() );
 188
 189     // check, if output lies out of display
 190     if( aOutRect.Intersection( tools::Rectangle( maDispPt, maDispSz ) ).IsEmpty() )
 191         setMarked( true );
 192     else if( !mbIsPaused )
 193     {
 194         VclPtr<VirtualDevice>   pDev;
 195         Point                   aPosPix;
 196         Point                   aBmpPosPix;
 197         Size                    aSizePix;
 198         Size                    aBmpSizePix;
 199         const sal_uLong             nLastPos = mpParent->Count() - 1;
 200         mnActPos = std::min( nPos, nLastPos );
 201         const AnimationBitmap&  rAnimationBitmap = mpParent->Get( static_cast<sal_uInt16>( mnActPos ) );
 202
 203         getPosSize( rAnimationBitmap, aPosPix, aSizePix );
 204
 205         // Mirrored horizontally?
 206         if( mbIsMirroredHorizontally )
 207         {
 208             aBmpPosPix.setX( aPosPix.X() + aSizePix.Width() - 1 );
 209             aBmpSizePix.setWidth( -aSizePix.Width() );
 210         }
 211         else
 212         {
 213             aBmpPosPix.setX( aPosPix.X() );
 214             aBmpSizePix.setWidth( aSizePix.Width() );
 215         }
 216
 217         // Mirrored vertically?
 218         if( mbIsMirroredVertically )
 219         {
 220             aBmpPosPix.setY( aPosPix.Y() + aSizePix.Height() - 1 );
 221             aBmpSizePix.setHeight( -aSizePix.Height() );
 222         }
 223         else
 224         {
 225             aBmpPosPix.setY( aPosPix.Y() );
 226             aBmpSizePix.setHeight( aSizePix.Height() );
 227         }
 228
 229         // get output device
 230         if( !pVDev )
 231         {
 232             pDev = VclPtr<VirtualDevice>::Create();
 233             pDev->SetOutputSizePixel( maSzPix, false );
 234             pDev->DrawOutDev( Point(), maSzPix, maDispPt, maDispSz, *pRenderContext );
 235         }
 236         else
 237             pDev = pVDev;
 238
 239         // restore background after each run
 240         if( !nPos )
 241         {
 242             meLastDisposal = Disposal::Back;
 243             maRestPt = Point();
 244             maRestSz = maSzPix;
 245         }
 246
 247         // restore
 248         if( ( Disposal::Not != meLastDisposal ) && maRestSz.Width() && maRestSz.Height() )
 249         {
 250             if( Disposal::Back == meLastDisposal )
 251                 pDev->DrawOutDev( maRestPt, maRestSz, maRestPt, maRestSz, *mpBackground );
 252             else
 253                 pDev->DrawOutDev( maRestPt, maRestSz, Point(), maRestSz, *mpRestore );
 254         }
 255
 256         meLastDisposal = rAnimationBitmap.meDisposal;
 257         maRestPt = aPosPix;
 258         maRestSz = aSizePix;
 259
 260         // What do we need to restore the next time?
 261         // Put it into a bitmap if needed, else delete
 262         // SaveBitmap to conserve memory
 263         if( ( meLastDisposal == Disposal::Back ) || ( meLastDisposal == Disposal::Not ) )
 264             mpRestore->SetOutputSizePixel( Size( 1, 1 ), false );
 265         else
 266         {
 267             mpRestore->SetOutputSizePixel( maRestSz, false );
 268             mpRestore->DrawOutDev( Point(), maRestSz, aPosPix, aSizePix, *pDev );
 269         }
 270
 271         pDev->DrawBitmapEx( aBmpPosPix, aBmpSizePix, rAnimationBitmap.maBitmapEx );
 272
 273         if( !pVDev )
 274         {
 275             std::optional<vcl::Region> xOldClip;
 276             if (!maClip.IsNull())
 277                 xOldClip = pRenderContext->GetClipRegion();
 278
 279             if (xOldClip)
 280                 pRenderContext->SetClipRegion( maClip );
 281
 282             pRenderContext->DrawOutDev( maDispPt, maDispSz, Point(), maSzPix, *pDev );
 283             if (pGuard)
 284                 pGuard->SetPaintRect(tools::Rectangle(maDispPt, maDispSz));
 285
 286             if( xOldClip)
 287             {
 288                 pRenderContext->SetClipRegion(*xOldClip);
 289                 xOldClip.reset();
 290             }
 291
 292             pDev.disposeAndClear();
 293             pRenderContext->Flush();
 294         }
 295     }
 296 }
 297
 298 void ImplAnimView::repaint()
 299 {
 300     const bool bOldPause = mbIsPaused;
 301
 302     mpRenderContext->SaveBackground(*mpBackground, maDispPt, maDispSz, maSzPix);
 303
 304     mbIsPaused = false;
 305     drawToPos( mnActPos );
 306     mbIsPaused = bOldPause;
 307 }
 308
 309 AInfo* ImplAnimView::createAInfo() const
 310 {
 311     AInfo* pAInfo = new AInfo;
 312
 313     pAInfo->aStartOrg = maPt;
 314     pAInfo->aStartSize = maSz;
 315     pAInfo->pOutDev = mpRenderContext;
 316     pAInfo->pViewData = const_cast<ImplAnimView *>(this);
 317     pAInfo->nExtraData = mnExtraData;
 318     pAInfo->bPause = mbIsPaused;
 319
 320     return pAInfo;
 321 }
 322
 323 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */