Main Page   Class Hierarchy   Compound List   File List   Compound Members  

canvas.h

00001 /*--License:
00002         Kyra Sprite Engine
00003         Copyright Lee Thomason (Grinning Lizard Software) 2001-2002
00004         www.grinninglizard.com/kyra
00005         www.sourceforge.net/projects/kyra
00006 
00007         Kyra is provided under 2 licenses:
00008 
00009         - The GPL, with no additional restrictions.
00010         - The LGPL, provided you display the Kyra splash screen, described below.
00011 
00012 
00013 --- GPL License --
00014         This program is free software; you can redistribute it and/or
00015         modify it under the terms of the GNU General Public License
00016         as published by the Free Software Foundation; either version 2
00017         of the License, or (at your option) any later version.
00018 
00019         This program is distributed in the hope that it will be useful,
00020         but WITHOUT ANY WARRANTY; without even the implied warranty of
00021         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00022         GNU General Public License for more details.
00023 
00024         You should have received a copy of the GNU General Public License
00025         along with this program; if not, write to the Free Software
00026         Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00027 
00028         The full text of the license can be found in license.txt
00029 
00030 
00031 --- LGPL License --
00032   **Provided you kindly display the Kyra splash screen (details below), 
00033         you     may use the LGPL license:**
00034 
00035     This library is free software; you can redistribute it and/or
00036     modify it under the terms of the GNU Lesser General Public
00037     License as published by the Free Software Foundation; either
00038     version 2.1 of the License, or (at your option) any later version.
00039 
00040     This library is distributed in the hope that it will be useful,
00041     but WITHOUT ANY WARRANTY; without even the implied warranty of
00042     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00043     Lesser General Public License for more details.
00044 
00045     You should have received a copy of the GNU Lesser General Public
00046     License along with this library; if not, write to the Free Software
00047     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00048 
00049         The full text of the license can be found in lgpl.txt
00050 
00051 
00052 --- Kyra Splash Screen.
00053 
00054         It would be appreciate if you display the Kyra splash screen when using
00055         either license, however it is only required for the LGPL. All the
00056         resources for the splash are compiled into the library, and it can be
00057         accessed through the following API:
00058 
00059                 KrEngine::StartSplash
00060                 KrEngine::UpdateSplash
00061                 KrEngine::EndSplash
00062 
00063         Full documentation is provided with the KrEngine class. The splash screen
00064         should be displayed for 2 seconds.
00065 
00066         Thank you.
00067 */
00068 
00069 #ifndef KYRA_CANVAS_INCLUDED
00070 #define KYRA_CANVAS_INCLUDED
00071 
00072 #include "image.h"
00073 #include "canvasresource.h"
00074 
00075 
00076 struct KrPaintInfo;
00077 class  KrCanvasResource;
00078 union  KrRGBA;
00079 
00080 
00091 class KrCanvas : public KrImage
00092 {
00093   public:
00094 
00096         KrCanvas( KrCanvasResource* resource );
00097         virtual ~KrCanvas();
00098 
00099         virtual void Draw(      KrPaintInfo* paintInfo, 
00100                                                 const KrRect& clip,
00101                                                 int window );
00102 
00103         int Width()                     { return resource->Width(); }   
00104         int Height()            { return resource->Height(); }  
00105 
00111         KrRGBA* Pixels()        { return resource->Pixels(); }
00112 
00118         void Refresh()          { resource->Refresh(); }
00119 
00120         virtual KrImNode* Clone();
00121 
00122         virtual void QueryBoundingBox( KrRect* boundingBox, int window = 0 );
00123         virtual bool HitTest( int x, int y, int flags, GlDynArray<KrImage*>* results, int window );
00124         virtual KrCanvas* ToCanvas()    { return this; }
00125         virtual void CalcTransform( int window );
00126         virtual KrResource* Resource()                  { return resource; }
00127         
00128   protected:
00129 
00130   private:
00131         KrCanvasResource* resource;
00132 };
00133 
00134 
00135 #endif

Generated on Mon Sep 15 12:01:10 2003 for Kyra by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001