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