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 _CAIROCANVAS_SPRITE_HXX
25*b1cdbd2cSJim Jagielski #define _CAIROCANVAS_SPRITE_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <canvas/base/sprite.hxx>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #include "cairo_cairo.hxx"
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski namespace cairocanvas
32*b1cdbd2cSJim Jagielski {
33*b1cdbd2cSJim Jagielski     /** Specialization of ::canvas::Sprite interface, to also provide
34*b1cdbd2cSJim Jagielski         redraw methods.
35*b1cdbd2cSJim Jagielski      */
36*b1cdbd2cSJim Jagielski     class Sprite : public ::canvas::Sprite
37*b1cdbd2cSJim Jagielski     {
38*b1cdbd2cSJim Jagielski     public:
39*b1cdbd2cSJim Jagielski 
40*b1cdbd2cSJim Jagielski         /** Redraw sprite at the stored position.
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski             @param bBufferedUpdate
43*b1cdbd2cSJim Jagielski             When true, the redraw does <em>not</em> happen directly on
44*b1cdbd2cSJim Jagielski             the front buffer, but within a VDev. Used to speed up
45*b1cdbd2cSJim Jagielski             drawing.
46*b1cdbd2cSJim Jagielski          */
47*b1cdbd2cSJim Jagielski         virtual void redraw( const ::cairo::CairoSharedPtr& pCairo,
48*b1cdbd2cSJim Jagielski                              bool                           bBufferedUpdate ) const = 0;
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski         /** Redraw sprite at the given position.
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski         	@param rPos
53*b1cdbd2cSJim Jagielski             Output position of the sprite. Overrides the sprite's own
54*b1cdbd2cSJim Jagielski             output position.
55*b1cdbd2cSJim Jagielski 
56*b1cdbd2cSJim Jagielski             @param bBufferedUpdate
57*b1cdbd2cSJim Jagielski             When true, the redraw does <em>not</em> happen directly on
58*b1cdbd2cSJim Jagielski             the front buffer, but within a VDev. Used to speed up
59*b1cdbd2cSJim Jagielski             drawing.
60*b1cdbd2cSJim Jagielski         */
61*b1cdbd2cSJim Jagielski         virtual void redraw( const ::cairo::CairoSharedPtr& pCairo,
62*b1cdbd2cSJim Jagielski                              const ::basegfx::B2DPoint&     rOrigOutputPos,
63*b1cdbd2cSJim Jagielski                              bool                           bBufferedUpdate ) const = 0;
64*b1cdbd2cSJim Jagielski     };
65*b1cdbd2cSJim Jagielski }
66*b1cdbd2cSJim Jagielski 
67*b1cdbd2cSJim Jagielski #endif /* _CAIROCANVAS_SPRITE_HXX */
68