1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef _CPPCANVAS_SPRITE_HXX
21 #define _CPPCANVAS_SPRITE_HXX
23 #include <com/sun/star/uno/Reference.hxx>
25 #include <boost/shared_ptr.hpp>
34 namespace com
{ namespace sun
{ namespace star
{ namespace rendering
40 /* Definition of Sprite class */
50 virtual void setAlpha( const double& rAlpha
) = 0;
52 /** Set the sprite position on screen
54 This method differs from the XSprite::move() insofar, as
55 no viewstate/renderstate transformations are applied to
56 the specified position. The given position is interpreted
57 in device coordinates (i.e. screen pixel)
59 virtual void movePixel( const ::basegfx::B2DPoint
& rNewPos
) = 0;
61 /** Set the sprite position on screen
63 This method sets the sprite position in the view
64 coordinate system of the parent canvas
66 virtual void move( const ::basegfx::B2DPoint
& rNewPos
) = 0;
68 virtual void transform( const ::basegfx::B2DHomMatrix
& rMatrix
) = 0;
70 /** Set output clipping
72 This method differs from the XSprite::clip() insofar, as
73 no viewstate/renderstate transformations are applied to
74 the specified clip polygon. The given polygon is
75 interpreted in device coordinates (i.e. screen pixel)
77 virtual void setClipPixel( const ::basegfx::B2DPolyPolygon
& rClipPoly
) = 0;
79 /** Set output clipping
81 This method applies the clip poly-polygon interpreted in
82 the view coordinate system of the parent canvas.
84 virtual void setClip( const ::basegfx::B2DPolyPolygon
& rClipPoly
) = 0;
86 virtual void setClip() = 0;
88 virtual void show() = 0;
89 virtual void hide() = 0;
91 /** Change the sprite priority
94 New sprite priority. The higher the priority, the further
95 towards the viewer the sprite appears. That is, sprites
96 with higher priority appear before ones with lower
99 virtual void setPriority( double fPriority
) = 0;
101 virtual ::com::sun::star::uno::Reference
<
102 ::com::sun::star::rendering::XSprite
> getUNOSprite() const = 0;
105 typedef ::boost::shared_ptr
< ::cppcanvas::Sprite
> SpriteSharedPtr
;
108 #endif /* _CPPCANVAS_SPRITE_HXX */
110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */