Crazy Eddie's GUI System  ${CEGUI_VERSION}
Sample.h
1 /***********************************************************************
2 created: 29/5/2012
3 author: Lukas E Meindl
4 *************************************************************************/
5 /***************************************************************************
6 * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27 #ifndef _Sample_h_
28 #define _Sample_h_
29 
30 #include "CEGUI/String.h"
31 
32 // This header serves as a base for all samples and is needed inside the
33 // SamplesFramework as interface for Samples that will be loaded.
34 #include "CEGUI/ForwardRefs.h"
35 
36 class Sample
37 {
38 public:
39  virtual bool initialise(CEGUI::GUIContext* guiContext) = 0;
40  virtual void deinitialise() = 0;
41 
42  virtual void onEnteringSample() {}
43  virtual void update(float timeSinceLastUpdate) {}
44 
45  const CEGUI::String& getUsedFilesString() {return d_usedFiles;}
46 
47 protected:
48  CEGUI::String d_usedFiles;
49 };
50 
51 #endif
Definition: cegui/include/CEGUI/GUIContext.h:68
String class used within the GUI system.
Definition: cegui/include/CEGUI/String.h:62
Definition: Sample.h:36