1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _VCLCANVAS_SPRITEHELPER_HXX 25*b1cdbd2cSJim Jagielski #define _VCLCANVAS_SPRITEHELPER_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <com/sun/star/rendering/XCustomSprite.hpp> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include <vcl/virdev.hxx> 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski #include <canvas/base/canvascustomspritehelper.hxx> 32*b1cdbd2cSJim Jagielski #include <canvas/base/spritesurface.hxx> 33*b1cdbd2cSJim Jagielski #include <canvas/vclwrapper.hxx> 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski #include "backbuffer.hxx" 36*b1cdbd2cSJim Jagielski #include "impltools.hxx" 37*b1cdbd2cSJim Jagielski #include "spritecanvas.hxx" 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski namespace vclcanvas 41*b1cdbd2cSJim Jagielski { 42*b1cdbd2cSJim Jagielski /* Definition of SpriteHelper class */ 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski /** Helper class for canvas sprites. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski This class implements all sprite-related functionality, like 47*b1cdbd2cSJim Jagielski that available on the XSprite interface. 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielski class SpriteHelper : public ::canvas::CanvasCustomSpriteHelper 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski public: 52*b1cdbd2cSJim Jagielski SpriteHelper(); 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski // make CanvasCustomSpriteHelper::init visible for name lookup 55*b1cdbd2cSJim Jagielski using ::canvas::CanvasCustomSpriteHelper::init; 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** Late-init the sprite helper 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski @param rSpriteSize 60*b1cdbd2cSJim Jagielski Size of the sprite 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @param rSpriteCanvas 63*b1cdbd2cSJim Jagielski Sprite canvas this sprite is part of. Object stores 64*b1cdbd2cSJim Jagielski ref-counted reference to it, thus, don't forget to pass on 65*b1cdbd2cSJim Jagielski disposing()! 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @param rBackBuffer 68*b1cdbd2cSJim Jagielski Buffer of the sprite content (non-alpha part) 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @param rBackBufferMask 71*b1cdbd2cSJim Jagielski Buffer of the sprite content (alpha part) 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski void init( const ::com::sun::star::geometry::RealSize2D& rSpriteSize, 74*b1cdbd2cSJim Jagielski const ::canvas::SpriteSurface::Reference& rOwningSpriteCanvas, 75*b1cdbd2cSJim Jagielski const BackBufferSharedPtr& rBackBuffer, 76*b1cdbd2cSJim Jagielski const BackBufferSharedPtr& rBackBufferMask, 77*b1cdbd2cSJim Jagielski bool bShowSpriteBounds ); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski void disposing(); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** Repaint sprite content to associated sprite canvas 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @param rPos 84*b1cdbd2cSJim Jagielski Output position (sprite's own position is disregarded) 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @param io_bSurfacesDirty 87*b1cdbd2cSJim Jagielski When true, the referenced sprite surfaces (backBuffer and 88*b1cdbd2cSJim Jagielski backBufferMask) have been modified since last call. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski @param bBufferedUpdate 91*b1cdbd2cSJim Jagielski When true, the redraw does <em>not</em> happen directly on 92*b1cdbd2cSJim Jagielski the front buffer, but within a VDev. Used to speed up 93*b1cdbd2cSJim Jagielski drawing. 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski void redraw( OutputDevice& rOutDev, 96*b1cdbd2cSJim Jagielski const ::basegfx::B2DPoint& rPos, 97*b1cdbd2cSJim Jagielski bool& bSurfacesDirty, 98*b1cdbd2cSJim Jagielski bool bBufferedUpdate ) const; 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski private: 101*b1cdbd2cSJim Jagielski virtual ::basegfx::B2DPolyPolygon polyPolygonFromXPolyPolygon2D( 102*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XPolyPolygon2D >& xPoly ) const; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski // for the redraw 105*b1cdbd2cSJim Jagielski BackBufferSharedPtr mpBackBuffer; 106*b1cdbd2cSJim Jagielski BackBufferSharedPtr mpBackBufferMask; 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski /// Cached bitmap for the current sprite content 109*b1cdbd2cSJim Jagielski mutable ::canvas::vcltools::VCLObject<BitmapEx> maContent; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski /// When true, line sprite corners in red 112*b1cdbd2cSJim Jagielski bool mbShowSpriteBounds; 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski }; 115*b1cdbd2cSJim Jagielski } 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski #endif /* _VCLCANVAS_SPRITEHELPER_HXX */ 118