xref: /trunk/main/canvas/source/null/null_spritehelper.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _NULLCANVAS_SPRITEHELPER_HXX
29*cdf0e10cSrcweir #define _NULLCANVAS_SPRITEHELPER_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <com/sun/star/rendering/XCustomSprite.hpp>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <canvas/base/canvascustomspritehelper.hxx>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <basegfx/point/b2dpoint.hxx>
36*cdf0e10cSrcweir #include <basegfx/vector/b2isize.hxx>
37*cdf0e10cSrcweir #include <basegfx/matrix/b2dhommatrix.hxx>
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir #include "null_spritecanvas.hxx"
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir namespace nullcanvas
43*cdf0e10cSrcweir {
44*cdf0e10cSrcweir     /* Definition of SpriteHelper class */
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir     /** Helper class for canvas sprites.
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir         This class implements all sprite-related functionality, like
49*cdf0e10cSrcweir         that available on the XSprite interface.
50*cdf0e10cSrcweir      */
51*cdf0e10cSrcweir     class SpriteHelper : public ::canvas::CanvasCustomSpriteHelper
52*cdf0e10cSrcweir     {
53*cdf0e10cSrcweir     public:
54*cdf0e10cSrcweir         /** Create sprite helper
55*cdf0e10cSrcweir          */
56*cdf0e10cSrcweir         SpriteHelper();
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir         // make CanvasCustomSpriteHelper::init visible for name lookup
59*cdf0e10cSrcweir         using ::canvas::CanvasCustomSpriteHelper::init;
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir         /** Late-init the sprite helper
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir             @param rSpriteSize
64*cdf0e10cSrcweir             Size of the sprite
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir             @param rSpriteCanvas
67*cdf0e10cSrcweir             Sprite canvas this sprite is part of. Object stores
68*cdf0e10cSrcweir             ref-counted reference to it, thus, don't forget to pass on
69*cdf0e10cSrcweir             disposing()!
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir             @param rDevice
72*cdf0e10cSrcweir             DX device to use
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir             @param rSpriteSurface
75*cdf0e10cSrcweir             The surface of the sprite (not the DX texture, but the
76*cdf0e10cSrcweir             persistent target of content rendering)
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir             @param bShowSpriteBounds
79*cdf0e10cSrcweir             When true, little debug bound rects for sprites are shown
80*cdf0e10cSrcweir          */
81*cdf0e10cSrcweir         void init( const ::com::sun::star::geometry::RealSize2D&    rSpriteSize,
82*cdf0e10cSrcweir                    const SpriteCanvasRef&                           rSpriteCanvas );
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir         void disposing();
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir         /** Repaint sprite content via hardware to associated sprite
87*cdf0e10cSrcweir             canvas
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir             @param io_bSurfaceDirty
90*cdf0e10cSrcweir             Input/output parameter, whether the sprite content is
91*cdf0e10cSrcweir             dirty or not. If texture was updated, set to false
92*cdf0e10cSrcweir          */
93*cdf0e10cSrcweir         void redraw( bool& io_bSurfaceDirty ) const;
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir     private:
96*cdf0e10cSrcweir         virtual ::basegfx::B2DPolyPolygon polyPolygonFromXPolyPolygon2D(
97*cdf0e10cSrcweir             ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >& xPoly ) const;
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir         SpriteCanvasRef             mpSpriteCanvas;
101*cdf0e10cSrcweir         mutable bool                mbTextureDirty;  // when true, texture needs update
102*cdf0e10cSrcweir     };
103*cdf0e10cSrcweir }
104*cdf0e10cSrcweir 
105*cdf0e10cSrcweir #endif /* _NULLCANVAS_SPRITEHELPER_HXX */
106