include/cppcanvas/sprite.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #ifndef INCLUDED_CPPCANVAS_SPRITE_HXX
  21 #define INCLUDED_CPPCANVAS_SPRITE_HXX
  22
  23 namespace basegfx
  24 {
  25     class B2DHomMatrix;
  26     class B2DPolyPolygon;
  27     class B2DPoint;
  28 }
  29
  30
  31 /* Definition of Sprite class */
  32
  33 namespace cppcanvas
  34 {
  35
  36     class Sprite
  37     {
  38     public:
  39         virtual ~Sprite() {}
  40
  41         virtual void setAlpha( const double& rAlpha ) = 0;
  42
  43         /** Set the sprite position on screen
  44
  45             This method differs from the XSprite::move() insofar, as
  46             no viewstate/renderstate transformations are applied to
  47             the specified position. The given position is interpreted
  48             in device coordinates (i.e. screen pixel)
  49          */
  50         virtual void movePixel( const ::basegfx::B2DPoint& rNewPos ) = 0;
  51
  52         /** Set the sprite position on screen
  53
  54             This method sets the sprite position in the view
  55             coordinate system of the parent canvas
  56          */
  57         virtual void move( const ::basegfx::B2DPoint& rNewPos ) = 0;
  58
  59         virtual void transform( const ::basegfx::B2DHomMatrix& rMatrix ) = 0;
  60
  61         /** Set output clipping
  62
  63             This method differs from the XSprite::clip() insofar, as
  64             no viewstate/renderstate transformations are applied to
  65             the specified clip polygon. The given polygon is
  66             interpreted in device coordinates (i.e. screen pixel)
  67          */
  68         virtual void setClipPixel( const ::basegfx::B2DPolyPolygon& rClipPoly ) = 0;
  69
  70         /** Set output clipping
  71
  72             This method applies the clip poly-polygon interpreted in
  73             the view coordinate system of the parent canvas.
  74          */
  75         virtual void setClip( const ::basegfx::B2DPolyPolygon& rClipPoly ) = 0;
  76
  77         virtual void setClip() = 0;
  78
  79         virtual void show() = 0;
  80         virtual void hide() = 0;
  81
  82         /** Change the sprite priority
  83
  84             @param fPriority
  85             New sprite priority. The higher the priority, the further
  86             towards the viewer the sprite appears. That is, sprites
  87             with higher priority appear before ones with lower
  88             priority.
  89          */
  90         virtual void setPriority( double fPriority ) = 0;
  91     };
  92 }
  93
  94 #endif // INCLUDED_CPPCANVAS_SPRITE_HXX
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */