canvas/source/directx/dx_spritehelper.hxx

   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 #ifndef INCLUDED_CANVAS_SOURCE_DIRECTX_DX_SPRITEHELPER_HXX
  21 #define INCLUDED_CANVAS_SOURCE_DIRECTX_DX_SPRITEHELPER_HXX
  22
  23 #include <com/sun/star/rendering/XCustomSprite.hpp>
  24
  25 #include <canvas/base/canvascustomspritehelper.hxx>
  26
  27 #include <basegfx/point/b2dpoint.hxx>
  28 #include <basegfx/vector/b2isize.hxx>
  29 #include <basegfx/matrix/b2dhommatrix.hxx>
  30
  31 #include "dx_spritecanvas.hxx"
  32 #include "dx_surfacebitmap.hxx"
  33
  34 namespace dxcanvas
  35 {
  36     /* Definition of SpriteHelper class */
  37
  38     /** Helper class for canvas sprites.
  39
  40         This class implements all sprite-related functionality, like
  41         that available on the XSprite interface.
  42      */
  43     class SpriteHelper : public ::canvas::CanvasCustomSpriteHelper
  44     {
  45     public:
  46         /** Create sprite helper
  47          */
  48         SpriteHelper();
  49
  50         /** Late-init the sprite helper
  51
  52             @param rSpriteSize
  53             Size of the sprite
  54
  55             @param rSpriteCanvas
  56             Sprite canvas this sprite is part of. Object stores
  57             ref-counted reference to it, thus, don't forget to pass on
  58             disposing()!
  59
  60             @param rRenderModule
  61             rendermodule to use
  62
  63             @param rSpriteSurface
  64             The surface of the sprite (not the DX texture, but the
  65             persistent target of content rendering)
  66
  67             @param bShowSpriteBounds
  68             When true, little debug bound rects for sprites are shown
  69          */
  70         void init( const ::com::sun::star::geometry::RealSize2D&    rSpriteSize,
  71                    const SpriteCanvasRef&                           rSpriteCanvas,
  72                    const IDXRenderModuleSharedPtr&                  rRenderModule,
  73                    const DXSurfaceBitmapSharedPtr&                  rBitmap,
  74                    bool                                             bShowSpriteBounds );
  75
  76         void disposing();
  77
  78         /** Repaint sprite content via hardware to associated sprite
  79             canvas
  80
  81             @param io_bSurfaceDirty
  82             Input/output parameter, whether the sprite content is
  83             dirty or not. If texture was updated, set to false
  84
  85          */
  86         void redraw( bool& io_bSurfaceDirty ) const;
  87
  88     private:
  89         virtual ::basegfx::B2DPolyPolygon polyPolygonFromXPolyPolygon2D(
  90             ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >& xPoly ) const;
  91
  92         /// Returns true, if the sprite _really_ needs redraw
  93         bool needRedraw() const;
  94
  95         SpriteCanvasRef             mpSpriteCanvas;
  96
  97         DXSurfaceBitmapSharedPtr    mpBitmap;
  98         mutable bool                mbTextureDirty;  // when true, texture needs update
  99         bool                        mbShowSpriteBounds; // when true, debug bound rect for sprites is shown
 100     };
 101 }
 102
 103 #endif // INCLUDED_CANVAS_SOURCE_DIRECTX_DX_SPRITEHELPER_HXX
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */