diff --git a/doc/html/SDLGL__Util_8h-source.html b/doc/html/SDLGL__Util_8h-source.html
new file mode 100755
index 0000000..e41170d
--- /dev/null
+++ b/doc/html/SDLGL__Util_8h-source.html
@@ -0,0 +1,26 @@
+
+/include/external/SDLGL_Util.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/external/SDLGL_Util.h 00001
+00002
+00003
+00004 #ifndef __sdlgl_h__
+00005 #define __sdlgl_h__
+00006 #include "ZE_Includes.h "
+00008
+00009 int power_of_two(int input);
+00010 GLuint SDL_GL_LoadTexture(SDL_Surface *surface, GLfloat *texcoord);
+00011
+00012 #endif //__sdlgl_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_Defines.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_Defines.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_defines_h__
+00025 #define __ze_defines_h__
+00026 00029
+00031
+00033
+00035
+00037
+00039
+00040
+00041 #endif //__ze_defines_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_Defines.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_Defines.h File Reference Detailed Description
+File Header: File: ZE_Defines.h Id ZE_Defines.h ,v 1.6 2003/01/13 05:48:47 cozman Exp
+Definition file, holds #define statements describing optional features of ZEngine.
+
+
+
+Go to the source code of this file.
+Defines USE_OPENGL Define to include OpenGL support (MUST be defined, may become optional in future). USE_SDL_TTF Define to include font support. USE_SDL_IMAGE Define to include non-bmp image file support. USE_SDL_MIXER Define to include sound support. VERSION "0.8.2" Version number.
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_Includes.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_Includes.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00025 #ifndef __ze_includes_h__
+00026 #define __ze_includes_h__
+00027 #include "ZE_Defines.h "
+00029
+00030 #include "SDL.h"
+00031 #include "SDL_opengl.h"
+00032 #include "external/SDLGL_Util.h"
+00033 #ifdef USE_SDL_IMAGE
+00034 #include "SDL_image.h"
+00035 #endif
+00036 #ifdef USE_SDL_TTF
+00037 #include "SDL_ttf.h"
+00038 #endif
+00039 #ifdef USE_SDL_MIXER
+00040 #include "SDL_mixer.h"
+00041 #endif
+00042 #ifdef USE_PHYSFS
+00043 #include "physfs.h"
+00044 #include "external/physfsrwops.h"
+00045 #endif
+00046 #include <string>
+00048 #include <vector>
+00049 #include <queue>
+00050 #include <list>
+00051 #include <fstream>
+00052 #include <cstdio>
+00053 #include <cstdlib>
+00054 #include <cstdarg>
+00055 #include <cctype>
+00056 using namespace std;
+00057
+00058 #endif //__ze_includes_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_Includes.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_Includes.h File Reference Detailed Description
+File Header: File: ZE_Includes.h Id ZE_Includes.h ,v 1.5 2003/01/13 05:53:47 cozman Exp
+ZE_*.h files should only include this file and any other ZE_*.h files that they need, External Library or C/C++ Standard Library files should be included from within this file.
+
+#include "ZE_Defines.h "#include "SDL.h"#include "SDL_opengl.h"#include "external/SDLGL_Util.h"#include "SDL_image.h"#include "SDL_ttf.h"#include "SDL_mixer.h"#include <string>#include <vector>#include <queue>#include <list>#include <fstream>#include <cstdio>#include <cstdlib>#include <cstdarg>#include <cctype>
+Go to the source code of this file.
+Namespaces namespace std
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_Utility.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_Utility.cpp File Reference Detailed Description
+File Header: File: ZE_Utility.cpp Id ZE_Utility.cpp ,v 1.3 2003/01/16 04:47:35 cozman Exp
+Source file containing open utilities for use inside and alongside ZEngine.
+
+#include "ZE_Utility.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_Utility.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_Utility.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00025 #ifndef __ze_utility_h__
+00026 #define __ze_utility_h__
+00027 #include "ZE_Includes.h "
+00029
+00030 namespace ZE
+00031 {
+00032
+00042 string FormatStr (const char *fmtstr, ...);
+00043
+00045
+00047
+00051 #define FreeImage(image) if(image){SDL_FreeSurface(image); image = NULL;}
+00052 #ifdef USE_SDL_MIXER
+00054 00057 #define FreeSound(sound) if(sound){Mix_FreeChunk(sound); sound = NULL;}
+00058 00061 #define FreeMusic(music) if(music){Mix_FreeMusic(music); music = NULL;}
+00062 #endif
+00063 #ifdef USE_SDL_TTF
+00065 00068 #define FreeFont(font) if(font){TTF_CloseFont(font); font = NULL;}
+00069 #endif
+00070 #endif //__ze_utility_h__
+00075 Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_Utility.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_Utility.h File Reference Detailed Description
+File Header: File: ZE_Utility.h Id ZE_Utility.h ,v 1.1 2003/01/15 05:31:51 cozman Exp
+Definition file for ZEngine Utilities which are used throughout the engine and can be used in conjunction with ZEngine.
+
+#include "ZE_Includes.h "
+Go to the source code of this file.
+Namespaces namespace ZE Defines #define FreeImage (image) if(image){SDL_FreeSurface(image); image = NULL;}#define FreeSound (sound) if(sound){Mix_FreeChunk(sound); sound = NULL;}#define FreeMusic (music) if(music){Mix_FreeMusic(music); music = NULL;}#define FreeFont (font) if(font){TTF_CloseFont(font); font = NULL;}
+Define Documentation
+
+
+
+
+
+
+ #define FreeImage
+ (
+ image
+
+ )
+ if(image){SDL_FreeSurface(image); image = NULL;}
+
+
+
+
+
+
+
+
+
+
+
+
+Safely free an SDL_Surface* and set it to NULL.
+
+
+
+
+
+
+
+
+ #define FreeSound
+ (
+ sound
+
+ )
+ if(sound){Mix_FreeChunk(sound); sound = NULL;}
+
+
+
+
+
+
+
+
+
+
+
+
+Safely free a Mix_Chunk* and set it to NULL.
+
+
+
+
+
+
+
+
+ #define FreeMusic
+ (
+ music
+
+ )
+ if(music){Mix_FreeMusic(music); music = NULL;}
+
+
+
+
+
+
+
+
+
+
+
+
+Safely free a Mix_Music* and set it to NULL.
+
+
+
+
+
+
+
+
+ #define FreeFont
+ (
+ font
+
+ )
+ if(font){TTF_CloseFont(font); font = NULL;}
+
+
+
+
+
+
+
+
+
+
+
+
+Safely free a TTF_Font and set it to NULL.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZConfigFile.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZConfigFile.cpp File Reference Detailed Description
+File Header: File: ZE_ZConfigFile.cpp Id ZE_ZConfigFile.cpp ,v 1.4 2003/01/16 05:45:58 cozman Exp
+Implementation of ZConfigFile, the ZEngine INI-Style Config File.
+
+#include "ZE_ZConfigFile.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZConfigFile.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZConfigFile.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00025 #ifndef __ze_zconfigfile_h__
+00026 #define __ze_zconfigfile_h__
+00027 #include "ZE_ZObject.h "
+00029
+00030 namespace ZE
+00031 {
+00032
+00038 class ZConfigFile : public ZObject
+00039 {
+00040 private :
+00041
+00042
+00043
+00044
+00051 class ZCF_Variable
+00052 {
+00053 public :
+00055 string var ;
+00057 string val ;
+00058 };
+00059
+00065 class ZCF_Section
+00066 {
+00067 public :
+00069 string section ;
+00071 list<ZCF_Variable> varList ;
+00072 };
+00073
+00075 list<ZCF_Section> mFileLayout ;
+00076
+00078 string mFilename ;
+00079
+00087 string CleanString (string str) const ;
+00088
+00096 bool Exists (string sec) const ;
+00097
+00106 bool Exists (string sec, string var) const ;
+00107
+00116 void SetVariable (string sec, string var, string val);
+00117
+00127 string GetVariable (string sec, string var, string defVal) const ;
+00128
+00129 public :
+00130
+00136 ZConfigFile ();
+00137
+00144 ZConfigFile (string filename);
+00145
+00151 ~ZConfigFile ();
+00152
+00159 void Process (string filename);
+00160
+00170 int GetInt (string section, string var, int defVal) const ;
+00171
+00182 bool GetBool (string section, string var, bool defVal) const ;
+00183
+00193 string GetString (string section, string var, string defVal) const ;
+00194
+00204 void SetInt (string section, string var, int val);
+00205
+00215 void SetBool (string section, string var, bool val);
+00216
+00226 void SetString (string section, string var, string val);
+00227
+00233 void Flush ();
+00234
+00240 void Close ();
+00241 };
+00242
+00243 }
+00244
+00245 #endif //__ze_zconfigfile_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZConfigFile.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZConfigFile.h File Reference Detailed Description
+File Header: File: Types/ZE_ZConfigFile.h Id ZE_ZConfigFile.h ,v 1.6 2003/01/16 05:46:39 cozman Exp
+Definition file for ZConfigFile, an INI-style Config format.
+
+#include "ZE_ZObject.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZEngine.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZEngine.cpp File Reference Detailed Description
+File Header: File: ZE_ZEngine.cpp Id ZE_ZEngine.cpp ,v 1.16 2003/01/18 21:53:14 cozman Exp
+Actual implementation of ZEngine singleton class, the core of ZEngine.
+
+#include "ZE_ZEngine.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZEngine.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZEngine.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zengine_h__
+00025 #define __ze_zengine_h__
+00026 #include "ZE_Defines.h "
+00028 #include "ZE_Utility.h "
+00029 #include "ZE_Includes.h "
+00030 #include "ZE_ZError.h "
+00031
+00037 namespace ZE
+00038 {
+00039
+00046 class ZEngine
+00047 {
+00049
+00051
+00052 private :
+00054 static ZEngine *sInstance ;
+00055
+00061 ZEngine ();
+00062
+00063 public :
+00064
+00071 static ZEngine * GetInstance ();
+00072
+00078 static void ReleaseInstance ();
+00079
+00086 static string GetVersion ();
+00087
+00089
+00091
+00092 private :
+00094 int mWidth ;
+00096 int mHeight ;
+00098 int mBPP ;
+00100 bool mFullscreen ;
+00101
+00102 #ifdef USE_SDL_MIXER
+00103 00104 int mRate ;
+00106 bool mStereo ;
+00107 #endif
+00108 public :
+00111
+00112
+00123 void SetupDisplay (int width, int height, int bpp, bool fullscreen);
+00124
+00125 #ifdef USE_SDL_MIXER
+00126 void SetupSound (int rate, bool stereo);
+00135 #endif
+00136 bool CreateDisplay (string title, string icon="" );
+00149
+00155 void CloseDisplay ();
+00156
+00158
+00160
+00161 private :
+00163 SDL_Surface *mScreen ;
+00164
+00165 public :
+00172 SDL_Surface *Display ();
+00173
+00180 void Update ();
+00181
+00191 void Clear (float red=0.0f, float green=0.0f, float blue=0.0f, float alpha=1.0f);
+00192
+00194
+00196
+00197
+00204 void SetGL2D ();
+00205
+00207
+00209
+00210 private :
+00212 bool mPaused ;
+00214 bool mUnpauseOnActive ;
+00216 Uint8 mDesiredFramerate ;
+00218 Uint32 mNextUpdate ;
+00220 Uint32 mLastPause ;
+00222 Uint32 mPausedTime ;
+00224 Uint32 mLastTime ;
+00226 double mSecPerFrame ;
+00227
+00228 public :
+00235 void Delay (Uint32 milliseconds);
+00236
+00243 Uint32 GetTime ();
+00244
+00250 void PauseTimer ();
+00251
+00257 void UnpauseTimer ();
+00258
+00265 double GetFrameTime ();
+00266
+00274 double GetFramerate ();
+00275
+00285 void SetDesiredFramerate (Uint8 rate);
+00286
+00294 Uint8 GetDesiredFramerate ();
+00295
+00302 bool IsPaused ();
+00303
+00305
+00307
+00309
+00311
+00313
+00315
+00317
+00319
+00321
+00323
+00324
+00325 public :
+00332 bool IsActive ();
+00333
+00340 void RequestQuit ();
+00341
+00349 bool QuitRequested ();
+00350
+00355 void SetReloadNeed (bool state);
+00356
+00364 bool ImagesNeedReload ();
+00365
+00375 void SetKeyRepeatRate (int rate);
+00376
+00384 bool KeyIsPressed (SDLKey key);
+00385
+00393 bool KeyPress (SDLKey key);
+00394
+00400 void HideCursor ();
+00401
+00407 void ShowCursor ();
+00408
+00415 int MouseX ();
+00416
+00423 int MouseY ();
+00424
+00431 bool LButtonPressed ();
+00432
+00439 bool RButtonPressed ();
+00440
+00448 bool MouseInRect (SDL_Rect *rect);
+00449
+00455 void CheckEvents ();
+00456
+00457 #ifdef USE_PHYSFS
+00458 void InitPhysFS(string argv);
+00469
+00476 void AddPhysFSDir(string dir);
+00477
+00478 #endif //USE_PHYSFS
+00479 00485
+00487
+00489
+00491
+00492
+00500 void LogError (ZError error);
+00501
+00502 public :
+00513 void SetErrorLog (bool logAll, string logFile="" );
+00514
+00525 void ReportError (ZErrorCode code, string desc="" , string file="" , unsigned int line=0);
+00526
+00534 ZErrorCode GetLastError ();
+00535
+00543 void WriteLog (string str);
+00544
+00551 void FlushErrors ();
+00552
+00553
+00555
+00557
+00565 SDL_Surface* LoadImage (string filename);
+00566
+00567 #ifdef USE_SDL_MIXER
+00568 LoadSound (string filename);
+00576
+00584 Mix_Music* LoadMusic (string filename);
+00585 #endif
+00586 #ifdef USE_SDL_TTF
+00588 LoadFont (string filename, int size);
+00597 #endif
+00598 public :
+00610 int Width ();
+00611
+00618 int Height ();
+00619
+00626 int BPP ();
+00627
+00634 bool IsFullscreen ();
+00635 };
+00636
+00637 }
+00638
+00639 #endif //__ze_zengine_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZEngine.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZEngine.h File Reference Detailed Description
+File Header: File: ZE_ZEngine.h Id ZE_ZEngine.h ,v 1.12 2003/01/15 05:51:18 cozman Exp
+ZEngine Game Engine core Engine definition.
+
+#include "ZE_Defines.h "#include "ZE_Utility.h "#include "ZE_Includes.h "#include "ZE_ZError.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZError.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZError.cpp File Reference Detailed Description
+File Header: File: ZE_ZError.cpp Id ZE_ZError.cpp ,v 1.2 2003/01/16 05:45:58 cozman Exp
+Implementation of ZError, the ZEngine internal error information storage class.
+
+#include "ZE_ZError.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZError.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZError.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00025 #ifndef __ze_zerror_h__
+00026 #define __ze_zerror_h__
+00027 #include "ZE_Utility.h "
+00029 #include <string>
+00030 using namespace std;
+00031
+00032 namespace ZE
+00033 {
+00034
+00036
+00040 enum ZErrorCode
+00041 {
+00042 ZERR_NONE ,
+00043 ZERR_SDL_INTERNAL ,
+00044 ZERR_SDL_INIT ,
+00045 ZERR_MIX_INIT ,
+00046 ZERR_TTF_INIT ,
+00047 ZERR_VIDMODE ,
+00048 ZERR_LOAD_IMAGE ,
+00049 ZERR_LOAD_SOUND ,
+00050 ZERR_LOAD_MUSIC ,
+00051 ZERR_LOAD_FONT ,
+00052 ZERR_NOIMAGE ,
+00053 ZERR_NOSOUND ,
+00054 ZERR_NOMUSIC ,
+00055 ZERR_NOFONT ,
+00056 ZERR_LAST
+00057 };
+00058
+00065 class ZError
+00066 {
+00067 protected :
+00069 static string sErrorDesc [ZERR_LAST ];
+00071 ZErrorCode rCode ;
+00073 string rDescription ;
+00075 string rFilename ;
+00077 unsigned int rLine ;
+00078
+00079 public :
+00089 ZError (ZErrorCode code=ZERR_NONE, string desc="" , string file="" , int line=0);
+00090
+00100 void Create (ZErrorCode code, string desc="" , string file="" , int line=0);
+00101
+00103
+00105
+00112 ZErrorCode Code () const ;
+00113
+00119 string LogString () const ;
+00120 };
+00121
+00122 }
+00123
+00124 #endif //__ze_zerror_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZError.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZError.h File Reference Detailed Description
+File Header: File: ZE_ZError.h Id ZE_ZError.h ,v 1.4 2003/01/16 05:46:39 cozman Exp
+Definition file for ZError, the Error logging class for ZEngine. This class should never be used by the average user, it is used by ZEngine to store information on an error.
+
+#include "ZE_Utility.h "#include <string>
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZFont.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZFont.cpp File Reference Detailed Description
+File Header: File: ZE_ZFont.cpp Id ZE_ZFont.cpp ,v 1.5 2003/01/16 05:45:58 cozman Exp
+Implementation of ZFont, the basic Font class for ZEngine.
+
+#include "ZE_ZFont.h "
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZFont.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZFont.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zfont_h__
+00025 #define __ze_zfont_h__
+00026 #include "ZE_ZObject.h "
+00028 #include "ZE_ZImage.h "
+00029
+00030 #ifdef USE_SDL_TTF
+00031 namespace ZE
+00033 {
+00034
+00040 class ZFont : public ZObject
+00041 {
+00042 protected :
+00044 TTF_Font *rFont ;
+00046 string rFilename ;
+00048 SDL_Color rColor ;
+00050 SDL_Color rBGColor ;
+00051
+00052 public :
+00053
+00055
+00057
+00063 ZFont ();
+00064
+00072 ZFont (string filename, int size);
+00073
+00079 ~ZFont ();
+00080
+00088 void Open (string filename, int size);
+00089
+00095 void Release ();
+00096
+00098
+00100
+00108 void DrawText (string text, ZImage &image) const ;
+00109
+00117 void DrawShadedText (string text, ZImage &image) const ;
+00118
+00127 void SetColor (Uint8 r, Uint8 g, Uint8 b);
+00128
+00137 void SetBGColor (Uint8 r, Uint8 g, Uint8 b);
+00138
+00147 void SetStyle (bool bold, bool italic, bool underline);
+00148
+00155 void Resize (int size);
+00156
+00158
+00160
+00167 bool IsLoaded () const ;
+00168
+00175 bool IsBold () const ;
+00176
+00183 bool IsItalic () const ;
+00184
+00191 bool IsUnderlined () const ;
+00192
+00199 int Height () const ;
+00200
+00207 int LineSkip () const ;
+00208
+00216 int StringWidth (string text) const ;
+00217
+00225 int StringHeight (string text) const ;
+00226 };
+00227
+00228 }
+00229
+00230 #endif //USE_SDL_TTF
+00231 #endif //__ze_zfont_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZFont.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZFont.h File Reference Detailed Description
+File Header: File: ZE_ZFont.h Id ZE_ZFont.h ,v 1.4 2003/01/16 05:46:39 cozman Exp
+Definition file for ZFont, the basic Font class for ZEngine.
+
+#include "ZE_ZObject.h "#include "ZE_ZImage.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZImage.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZImage.cpp File Reference Detailed Description
+File Header: File: ZE_ZImage.cpp Id ZE_ZImage.cpp ,v 1.15 2003/01/16 05:45:58 cozman Exp
+Implementation of ZImage, the Image class for ZEngine.
+
+#include "ZE_ZImage.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZImage.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZImage.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zimage_h__
+00025 #define __ze_zimage_h__
+00026 #include "ZE_ZObject.h "
+00028
+00029 namespace ZE
+00030 {
+00031
+00037 class ZImage : public ZObject
+00038 {
+00039 protected :
+00041 GLfloat rTexMinX ;
+00043 GLfloat rTexMinY ;
+00045 GLfloat rTexMaxX ;
+00047 GLfloat rTexMaxY ;
+00049 SDL_Surface *rImage ;
+00051 unsigned int rTexID ;
+00053 unsigned int rWidth ;
+00055 unsigned int rHeight ;
+00056
+00057 public :
+00058
+00064 ZImage ();
+00065
+00072 ZImage::ZImage (const ZImage &rhs);
+00073
+00080 ZImage (string filename);
+00081
+00088 ZImage (SDL_Surface *surface);
+00089
+00101 ZImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
+00102
+00108 ~ZImage ();
+00109
+00111
+00113
+00120 void Open (string filename);
+00121
+00133 void OpenFromImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
+00134
+00141 void Attach (SDL_Surface *surface);
+00142
+00148 void Reload ();
+00149
+00155 void Release ();
+00156
+00158
+00160
+00169 void SetColorKey (Uint8 red, Uint8 green, Uint8 blue);
+00170
+00178 void Flip (bool horizontal, bool vertical);
+00179
+00187 void Stretch (float xFactor, float yFactor);
+00188
+00196 void Resize (unsigned int width, unsigned int height);
+00197
+00204 void Bind () const ;
+00205
+00213 void Draw (float x, float y) const ;
+00214
+00223 void DrawRotated (int x, int y, float angle) const ;
+00224
+00226
+00228
+00235 bool IsLoaded () const ;
+00236
+00242 SDL_Surface *Surface () const ;
+00243
+00250 int Width () const ;
+00251
+00258 int Height () const ;
+00259 };
+00260
+00261 }
+00262
+00263 #endif
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZImage.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZImage.h File Reference Detailed Description
+File Header: File: ZE_ZImage.h Id ZE_ZImage.h ,v 1.9 2003/01/18 22:22:37 cozman Exp
+Definition file for ZImage, the OpenGL version of the ZImage class for ZEngine.
+
+#include "ZE_ZObject.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZMusic.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZMusic.cpp File Reference Detailed Description
+File Header: File: ZE_ZMusic.cpp Id ZE_ZMusic.cpp ,v 1.5 2003/01/16 05:45:58 cozman Exp
+Implementation of ZMusic, the basic Music class for ZEngine.
+
+#include "ZE_ZMusic.h "
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZMusic.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZMusic.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zmusic_h__
+00025 #define __ze_zmusic_h__
+00026 #include "ZE_ZObject.h "
+00028
+00029 #ifdef USE_SDL_MIXER
+00030 namespace ZE
+00032 {
+00033
+00039 class ZMusic : public ZObject
+00040 {
+00041 protected :
+00043 Mix_Music *rMusic ;
+00044
+00045 public :
+00047 static const int LoopInfinite ;
+00048
+00050
+00052
+00058 ZMusic ();
+00059
+00066 ZMusic (string filename);
+00067
+00073 ~ZMusic ();
+00074
+00081 void Open (string filename);
+00082
+00088 void Release ();
+00089
+00091
+00093
+00102 void Play (int loopNum=0, int fadeTime=0) const ;
+00103
+00109 void Pause () const ;
+00110
+00116 void Unpause () const ;
+00117
+00123 void Rewind () const ;
+00124
+00131 void Stop (int fadeTime=0) const ;
+00132
+00139 void SetVolume (int volume);
+00140
+00142
+00144
+00151 bool IsLoaded () const ;
+00152
+00159 bool IsPlaying () const ;
+00160
+00167 bool IsPaused () const ;
+00168
+00175 int Volume () const ;
+00176 };
+00177
+00178
+00179 }
+00180
+00181 #endif //USE_SDL_MIXER
+00182 #endif //__ze_zmusic_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZMusic.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZMusic.h File Reference Detailed Description
+File Header: File: ZE_ZMusic.h Id ZE_ZMusic.h ,v 1.4 2003/01/16 05:46:39 cozman Exp
+Definition file for ZMusic, the Music file wrapper for ZEngine.
+
+#include "ZE_ZObject.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZObject.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZObject.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zobject_h__
+00025 #define __ze_zobject_h__
+00026 #include "ZE_ZEngine.h "
+00028
+00029 namespace ZE
+00030 {
+00036 class ZObject
+00037 {
+00038 protected :
+00040 ZEngine * rEngine ;
+00041 public :
+00047 ZObject () { rEngine = ZEngine::GetInstance(); };
+00048
+00054 virtual ~ZObject () {};
+00055 };
+00056 }
+00057
+00058 #endif //__ze_zobject_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZObject.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZObject.h File Reference Detailed Description
+File Header: File: ZE_ZObject.h Id ZE_ZObject.h ,v 1.3 2002/12/29 06:50:19 cozman Exp
+Definition file for ZObject the Virtual Base Class for majority of the ZEngine Objects.
+
+#include "ZE_ZEngine.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZRect.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZRect.cpp File Reference Detailed Description
+File Header: File: ZE_ZRect.cpp Id ZE_ZRect.cpp ,v 1.7 2003/01/16 05:45:58 cozman Exp
+Implementation of ZRect, the Rectangle class for ZEngine.
+
+#include "ZE_ZRect.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZRect.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZRect.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zrect_h__
+00025 #define __ze_zrect_h__
+00026 #include "ZE_ZObject.h "
+00028
+00029 namespace ZE
+00030 {
+00031
+00037 class ZRect
+00038 {
+00039 protected :
+00041 float rX ;
+00043 float rY ;
+00045 float rWidth ;
+00047 float rHeight ;
+00048
+00049 public :
+00050
+00056 ZRect ();
+00057
+00067 ZRect (float x, float y, float width, float height);
+00068
+00075 ZRect (const ZRect &rhs);
+00076
+00084 const ZRect & operator= (const ZRect &rhs);
+00085
+00094 bool operator< (const ZRect &rhs) const ;
+00095
+00105 void Draw (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) const ;
+00106
+00114 void Move (float x, float y);
+00115
+00123 void MoveRel (float xMove, float yMove);
+00124
+00132 void Resize (float width, float height);
+00133
+00141 void ResizeRel (float widthChange, float heightChange);
+00142
+00150 bool Intersects (const ZRect &rect) const ;
+00151
+00160 bool Contains (float x, float y) const ;
+00161
+00169 bool Contains (const ZRect &rect) const ;
+00170
+00178 ZRect Intersection (const ZRect &rect) const ;
+00179
+00186 SDL_Rect SDLrect () const ;
+00187
+00194 float X () const ;
+00195
+00202 float Y () const ;
+00203
+00210 float Left () const ;
+00211
+00218 float Right () const ;
+00219
+00226 float Top () const ;
+00227
+00234 float Bottom () const ;
+00235
+00242 float Width () const ;
+00243
+00250 float Height () const ;
+00251 };
+00252
+00253 }
+00254
+00255 #endif //__ze_zrect_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZRect.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZRect.h File Reference Detailed Description
+File Header: File: ZE_ZRect.h Id ZE_ZRect.h ,v 1.5 2003/01/16 05:46:39 cozman Exp
+Definition file for ZRect, the Rectangle class for ZEngine.
+
+#include "ZE_ZObject.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZSound.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZSound.cpp File Reference Detailed Description
+File Header: File: ZE_ZSound.cpp Id ZE_ZSound.cpp ,v 1.5 2003/01/16 05:45:58 cozman Exp
+Implementation of ZSound, the basic Sound class for ZEngine.
+
+#include "ZE_ZSound.h "
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZSound.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZSound.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_zsound_h__
+00025 #define __ze_zsound_h__
+00026 #include "ZE_ZObject.h "
+00028
+00029 #ifdef USE_SDL_MIXER
+00030 namespace ZE
+00032 {
+00033
+00039 class ZSound : public ZObject
+00040 {
+00041 protected :
+00043 Mix_Chunk* rSound ;
+00045 int rChannelID ;
+00046
+00047 public :
+00049 static const int LoopInfinite ;
+00050
+00052
+00054
+00060 ZSound ();
+00061
+00068 ZSound (string filename);
+00069
+00075 ~ZSound ();
+00076
+00083 void Open (string filename);
+00084
+00090 void Release ();
+00091
+00093
+00095
+00104 void Play (int loopNum=0, int fadeTime=0);
+00105
+00111 void Pause () const ;
+00112
+00118 void Unpause () const ;
+00119
+00126 void Stop (int fadeTime=0) const ;
+00127
+00134 void SetVolume (int volume);
+00135
+00137
+00139
+00146 bool IsLoaded () const ;
+00147
+00154 bool IsPlaying () const ;
+00155
+00162 bool IsPaused () const ;
+00163
+00170 int Volume () const ;
+00171 };
+00172
+00173
+00174 }
+00175
+00176 #endif //USE_SDL_MIXER
+00177 #endif //__ze_zsound_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZSound.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZSound.h File Reference Detailed Description
+File Header: File: ZE_ZSound.h Id ZE_ZSound.h ,v 1.4 2003/01/16 05:46:39 cozman Exp
+Definition file for ZSound, the Sound Effect wrapper for ZEngine.
+
+#include "ZE_ZObject.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZTimer.cpp File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/src/ZE_ZTimer.cpp File Reference Detailed Description
+File Header: File: ZE_ZTimer.cpp Id ZE_ZTimer.cpp ,v 1.4 2003/01/16 05:45:58 cozman Exp
+Implementation of ZTimer, the basic Timer class for ZEngine.
+
+#include "ZE_ZTimer.h "
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZE_ZTimer.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZTimer.h Go to the documentation of this file. 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00024 #ifndef __ze_ztimer_h__
+00025 #define __ze_ztimer_h__
+00026 #include "ZE_ZObject.h "
+00028
+00029 namespace ZE
+00030 {
+00031
+00037 class ZTimer : public ZObject
+00038 {
+00039 protected :
+00041 bool rPaused ;
+00043 bool rUseZEngine ;
+00045 Uint32 rPausedTime ;
+00047 Uint32 rLastPause ;
+00048
+00055 Uint32 GetParentTime () const ;
+00056
+00057 public :
+00058
+00065 ZTimer (bool useZEngine=true );
+00066
+00072 void Reset ();
+00073
+00079 void Pause ();
+00080
+00086 void Unpause ();
+00087
+00094 Uint32 GetTime () const ;
+00095
+00102 bool IsPaused () const ;
+00103 };
+00104
+00105 }
+00106
+00107 #endif //__ze_ztimer_h__
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE_ZTimer.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZE_ZTimer.h File Reference Detailed Description
+File Header: File: ZE_ZTimer.h Id ZE_ZTimer.h ,v 1.4 2003/01/16 05:46:39 cozman Exp
+Definition file for ZTimer, the Timer class for ZEngine.
+
+#include "ZE_ZObject.h "
+Go to the source code of this file.
+Namespaces namespace ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/ZEngine.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZEngine.h Go to the documentation of this file. Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZEngine.h File Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/ZEngine.h File Reference Detailed Description
+File Header: File: ZEngine.h Id ZEngine.h ,v 1.20 2003/01/18 22:00:52 cozman Exp
+Header file for ZEngine Game Engine from Concept of Zero, this is the file that programs that wish to utilize ZEngine should include.
+
+#include "ZE_ZEngine.h "#include "ZE_Utility.h "#include "ZE_ZImage.h "#include "ZE_ZTimer.h "#include "ZE_ZConfigFile.h "#include "ZE_ZRect.h "#include "ZE_ZFont.h "#include "ZE_ZSound.h "#include "ZE_ZMusic.h "
+Go to the source code of this file.
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Annotated Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine Compound List Here are the classes, structs, unions and interfaces with brief descriptions:
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZConfigFile Member List This is the complete list of members for ZE::ZConfigFile , including all inherited members.
+ CleanString (string str) constZE::ZConfigFile [private]Close ()ZE::ZConfigFile Exists (string sec) constZE::ZConfigFile [private]Exists (string sec, string var) constZE::ZConfigFile [private]Flush ()ZE::ZConfigFile GetBool (string section, string var, bool defVal) constZE::ZConfigFile GetInt (string section, string var, int defVal) constZE::ZConfigFile GetString (string section, string var, string defVal) constZE::ZConfigFile GetVariable (string sec, string var, string defVal) constZE::ZConfigFile [private]mFileLayout ZE::ZConfigFile [private]mFilename ZE::ZConfigFile [private]Process (string filename)ZE::ZConfigFile rEngine ZE::ZObject [protected]SetBool (string section, string var, bool val)ZE::ZConfigFile SetInt (string section, string var, int val)ZE::ZConfigFile SetString (string section, string var, string val)ZE::ZConfigFile SetVariable (string sec, string var, string val)ZE::ZConfigFile [private]ZConfigFile ()ZE::ZConfigFile ZConfigFile (string filename)ZE::ZConfigFile ZObject ()ZE::ZObject [inline]~ZConfigFile ()ZE::ZConfigFile ~ZObject ()ZE::ZObject [inline, virtual]
Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZConfigFile class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZConfigFile Class Reference #include <ZE_ZConfigFile.h >
+
+Inherits ZE::ZObject .
+
+List of all members.
Detailed Description
+ZConfigFile class for INI-style configuration files for games or applications. Inherited from ZObject .
+
+
+Public Methods ZConfigFile () Default constructor. ZConfigFile (string filename) Constructor which takes filename. ~ZConfigFile () Destructor, flushes file. void Process (string filename) Parse a file. int GetInt (string section, string var, int defVal) const Get value in integer format from file. bool GetBool (string section, string var, bool defVal) const Get value in boolean format from file. string GetString (string section, string var, string defVal) const Get value in string format from file. void SetInt (string section, string var, int val) Set value in integer format in file. void SetBool (string section, string var, bool val) Set value in boolean format in file. void SetString (string section, string var, string val) Set value in string format in file. void Flush () Write all values to file. void Close () Close the file. Private Methods string CleanString (string str) const Reformat a string in a form more suitable to parsing. bool Exists (string sec) const Check if a section exists. bool Exists (string sec, string var) const Check if a variable exists. void SetVariable (string sec, string var, string val) Internal function to set variables. string GetVariable (string sec, string var, string defVal) const Internal function to get value of a variable. Private Attributes ZCF_Section > mFileLayout List of sections of internal type. mFilename Filename of file currently open.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZConfigFile::ZConfigFile
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+A no-op default constructor.
+
+
+
+
+
+
+
+
+ ZE::ZConfigFile::ZConfigFile
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor takes filename, and calls process on it.
Parameters:
+
+
+
+
+
+
+
+
+
+
+ ZE::ZConfigFile::~ZConfigFile
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Flushes the file, ensures a flush if the file is left open.
+
+
+Member Function Documentation
+
+
+
+
+
+
+ string ZE::ZConfigFile::CleanString
+ (
+ string
+ str
+ )
+ const [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Removes whitespace from a string and makes all characters lowercase.
Parameters:
+
+ str The string to get a clean version of.
+ Returns: Cleaned string.
+
+
+
+
+
+
+
+
+ bool ZE::ZConfigFile::Exists
+ (
+ string
+ sec
+ )
+ const [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find out if a section currently exists.
Parameters:
+
+ sec Section to check for.
+ Returns: bool, true if section exists in file.
+
+
+
+
+
+
+
+
+ bool ZE::ZConfigFile::Exists
+ (
+ string
+ sec ,
+
+
+ string
+ var
+
+
+ )
+ const [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find out if a variable currently exists.
Parameters:
+
+ sec Section to check in. var Variable to check for.
+ Returns: bool, true if section exists in file.
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::SetVariable
+ (
+ string
+ sec ,
+
+
+ string
+ var ,
+
+
+ string
+ val
+
+
+ )
+ [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set variable to value, called internally only.
Parameters:
+
+ sec Section for variable. var Variable to set. val Value to set variable to.
+
+
+
+
+
+
+
+
+
+ string ZE::ZConfigFile::GetVariable
+ (
+ string
+ sec ,
+
+
+ string
+ var ,
+
+
+ string
+ defVal
+
+
+ )
+ const [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get value of variable, called internally only.
Parameters:
+
+ sec Section for variable. var Variable to get. defVal Value to return if variable doesnt exist.
+ Returns: Value of variable.
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::Process
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Parses the file, reading the contents into the fileLayout map.
Parameters:
+
+ filename File to parse and attach this ZDataFile to.
+
+
+
+
+
+
+
+
+
+ int ZE::ZConfigFile::GetInt
+ (
+ string
+ section ,
+
+
+ string
+ var ,
+
+
+ int
+ defVal
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get the current value of a variable in the file, or defVal if not found in file.
Parameters:
+
+ section Name of section to seek variable under. var Name of variable to seek value for. defVal Value to return if var does not exist within section.
+ Returns: Contents of the variable in integer format.
+
+
+
+
+
+
+
+
+ bool ZE::ZConfigFile::GetBool
+ (
+ string
+ section ,
+
+
+ string
+ var ,
+
+
+ bool
+ defVal
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get the current value of a variable in the file, or defVal if not found in file. (Valid values are "0","1","true" and "false")
Parameters:
+
+ section Name of section to seek variable under. var Name of variable to seek value for. defVal Value to return if var does not exist within section.
+ Returns: Contents of the variable in boolean format.
+
+
+
+
+
+
+
+
+ string ZE::ZConfigFile::GetString
+ (
+ string
+ section ,
+
+
+ string
+ var ,
+
+
+ string
+ defVal
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get the current value of a variable in the file, or defVal if not found in file.
Parameters:
+
+ section Name of section to seek variable under. var Name of variable to seek value for. defVal Value to return if var does not exist within section.
+ Returns: Contents of the variable in string format.
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::SetInt
+ (
+ string
+ section ,
+
+
+ string
+ var ,
+
+
+ int
+ val
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set the new value of a variable in the file to val, creating the section and variable if not already found in file.
Parameters:
+
+ section Name of section to edit variable under. var Name of variable to set value for. val Integer value to set variable to in file.
+
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::SetBool
+ (
+ string
+ section ,
+
+
+ string
+ var ,
+
+
+ bool
+ val
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set the new value of a variable in the file to val, creating the section and variable if not already found in file.
Parameters:
+
+ section Name of section to edit variable under. var Name of variable to set value for. val Boolean value to set variable to in file.
+
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::SetString
+ (
+ string
+ section ,
+
+
+ string
+ var ,
+
+
+ string
+ val
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set the new value of a variable in the file to val, creating the section and variable if not already found in file.
Parameters:
+
+ section Name of section to edit variable under. var Name of variable to set value for. val String value to set variable to in file.
+
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::Flush
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Writes all values and sections to file.
+
+
+
+
+
+
+
+
+ void ZE::ZConfigFile::Close
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Flush the file and clear the filename.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZConfigFile::ZCF_Section Member List This is the complete list of members for ZE::ZConfigFile::ZCF_Section , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZConfigFile::ZCF_Section class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZConfigFile::ZCF_Section Class Reference List of all members. Detailed Description
+ZConfigFile class for mapping a section name to a list of variables in that section.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZConfigFile::ZCF_Variable Member List This is the complete list of members for ZE::ZConfigFile::ZCF_Variable , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZConfigFile::ZCF_Variable class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZConfigFile::ZCF_Variable Class Reference List of all members. Detailed Description
+ZConfigFile class for mapping a variable name to it's value, stored in string form (later converted to bool or int if needed).
+
+
+Public Attributes var Variable name. val Value associated with variable.
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZEngine Member List This is the complete list of members for ZE::ZEngine , including all inherited members.
+ BPP ()ZE::ZEngine CheckEvents ()ZE::ZEngine Clear (float red=0.0f, float green=0.0f, float blue=0.0f, float alpha=1.0f)ZE::ZEngine CloseDisplay ()ZE::ZEngine CreateDisplay (string title, string icon="")ZE::ZEngine Delay (Uint32 milliseconds)ZE::ZEngine Display ()ZE::ZEngine FlushErrors ()ZE::ZEngine GetDesiredFramerate ()ZE::ZEngine GetFramerate ()ZE::ZEngine GetFrameTime ()ZE::ZEngine GetInstance ()ZE::ZEngine [static]GetLastError ()ZE::ZEngine GetTime ()ZE::ZEngine GetVersion ()ZE::ZEngine [static]Height ()ZE::ZEngine HideCursor ()ZE::ZEngine ImagesNeedReload ()ZE::ZEngine IsActive ()ZE::ZEngine IsFullscreen ()ZE::ZEngine IsPaused ()ZE::ZEngine KeyIsPressed (SDLKey key)ZE::ZEngine KeyPress (SDLKey key)ZE::ZEngine LButtonPressed ()ZE::ZEngine LoadFont (string filename, int size)ZE::ZEngine LoadImage (string filename)ZE::ZEngine LoadMusic (string filename)ZE::ZEngine LoadSound (string filename)ZE::ZEngine LogError (ZError error)ZE::ZEngine [private]mActive ZE::ZEngine [private]mBPP ZE::ZEngine [private]mCurError ZE::ZEngine [private]mDesiredFramerate ZE::ZEngine [private]mErrlog ZE::ZEngine [private]mErrorQueue ZE::ZEngine [private]mFullscreen ZE::ZEngine [private]mHeight ZE::ZEngine [private]mKeyIsPressed ZE::ZEngine [private]mKeyPress ZE::ZEngine [private]mLastPause ZE::ZEngine [private]mLastTime ZE::ZEngine [private]mLogAllErrors ZE::ZEngine [private]mMouseB ZE::ZEngine [private]mMouseX ZE::ZEngine [private]mMouseY ZE::ZEngine [private]mNeedReload ZE::ZEngine [private]mNextUpdate ZE::ZEngine [private]MouseInRect (SDL_Rect *rect)ZE::ZEngine MouseX ()ZE::ZEngine MouseY ()ZE::ZEngine mPaused ZE::ZEngine [private]mPausedTime ZE::ZEngine [private]mQuit ZE::ZEngine [private]mRate ZE::ZEngine [private]mScreen ZE::ZEngine [private]mSecPerFrame ZE::ZEngine [private]mStereo ZE::ZEngine [private]mUnpauseOnActive ZE::ZEngine [private]mWidth ZE::ZEngine [private]PauseTimer ()ZE::ZEngine QuitRequested ()ZE::ZEngine RButtonPressed ()ZE::ZEngine ReleaseInstance ()ZE::ZEngine [static]ReportError (ZErrorCode code, string desc="", string file="", unsigned int line=0)ZE::ZEngine RequestQuit ()ZE::ZEngine SetDesiredFramerate (Uint8 rate)ZE::ZEngine SetErrorLog (bool logAll, string logFile="")ZE::ZEngine SetGL2D ()ZE::ZEngine SetKeyRepeatRate (int rate)ZE::ZEngine SetReloadNeed (bool state)ZE::ZEngine SetupDisplay (int width, int height, int bpp, bool fullscreen)ZE::ZEngine SetupSound (int rate, bool stereo)ZE::ZEngine ShowCursor ()ZE::ZEngine sInstance ZE::ZEngine [private, static]UnpauseTimer ()ZE::ZEngine Update ()ZE::ZEngine Width ()ZE::ZEngine WriteLog (string str)ZE::ZEngine ZEngine ()ZE::ZEngine [private]
Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZEngine class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZEngine Class Reference #include <ZE_ZEngine.h >
+
+List of all members.
Detailed Description
+ZEngine Singleton Class, accessible from anywhere in a ZEngine-based program by nature. Controls core elements of program and does majority of SDL wrapping. Also keeps track of loaded data and helps programs avoid memory leaks and dangling pointers.
+
+
+Public Methods void SetupDisplay (int width, int height, int bpp, bool fullscreen) Setup Display for SDL. void SetupSound (int rate, bool stereo) Initialize Sound for SDL. bool CreateDisplay (string title, string icon="") Create Display with predefined settings. void CloseDisplay () Quit SDL and any Subsystems. SDL_Surface * Display () Allow access to Screen Surface. void Update () Update display contents. void Clear (float red=0.0f, float green=0.0f, float blue=0.0f, float alpha=1.0f) Clear screen to a certain color (Black by default). void SetGL2D () Setup OpenGL ortho mode. void Delay (Uint32 milliseconds) Sleep for a certain amount of time. Uint32 GetTime () Get Global ZEngine time. void PauseTimer () Pause ZEngine . void UnpauseTimer () Unpause ZEngine . double GetFrameTime () Get Seconds Per Frame. double GetFramerate () Get Frames Per Second. void SetDesiredFramerate (Uint8 rate) Set Desired Framerate. Uint8 GetDesiredFramerate () Get Desired Framerate. bool IsPaused () Check Engine Paused State. bool IsActive () Find out if application is active. void RequestQuit () Request A Quit. bool QuitRequested () Find out if user has requested to quit. void SetReloadNeed (bool state) Set State of ImagesNeedReload. bool ImagesNeedReload () Find out if images should be reloaded. void SetKeyRepeatRate (int rate) Set Key repeat rate. bool KeyIsPressed (SDLKey key) Find the state of a key. bool KeyPress (SDLKey key) Find if key has been pressed since last check. void HideCursor () Hide mouse cursor. void ShowCursor () Show mouse cursor. int MouseX () Get X Position of Mouse. int MouseY () Get Y Position of Mouse. bool LButtonPressed () Get Status of Left Button. bool RButtonPressed () Get Status of Right Button. bool MouseInRect (SDL_Rect *rect) Check if mouse is in given rectangle. void CheckEvents () Check for Activation, Window Manager, and Quit Events. void SetErrorLog (bool logAll, string logFile="") Modify Error Logging. void ReportError (ZErrorCode code, string desc="", string file="", unsigned int line=0) Report an error. ZErrorCode GetLastError () Get the last error. void WriteLog (string str) Write to the log. void FlushErrors () Flush Stack of Errors to file. SDL_Surface * LoadImage (string filename) Load an Image. Mix_Chunk * LoadSound (string filename) Load a Sound. Mix_Music * LoadMusic (string filename) Load a Music File. TTF_Font * LoadFont (string filename, int size) Load a Font. int Width () Get Current Display Width. int Height () Get Current Display Height. int BPP () Get Current Display BPP. bool IsFullscreen () Get Fullscreen setting. Static Public Methods ZEngine * GetInstance () Get Instance. void ReleaseInstance () Release Instance. string GetVersion () Get Current Version. Private Methods ZEngine () Constructor for ZEngine . void LogError (ZError error) Writes an error to file. Private Attributes mWidth Width of Display. mHeight Height of Display. mBPP BPP Setting of Display. mFullscreen Fullscreen setting of Display. mRate Sound Bitrate. mStereo Stereo setting of Sound Subsystem. mScreen Pointer to Display. mPaused Keep track of paused state of game. mUnpauseOnActive Keep track of if ZEngine should unpause on active event. mDesiredFramerate Value framerate strives to be at, set by SetDesiredFramerate. mNextUpdate Time scheduled for next update (used for framerate locked movement). mLastPause Keep track of time game was last paused. mPausedTime Keep track of total globally paused time. mLastTime Keep track of last screen update time. mSecPerFrame Seconds per frame. mNeedReload bool which is only set to true if the engine thinks the images need to be reloaded (loss of focus in fullscreen). mActive bool describing Active or Inactive State of Game mQuit bool for checking if a Quit event has been detected mKeyIsPressed Pointer to array of Keys. mKeyPress [SDLK_LAST] Array of keys, used by KeyPress. mMouseX X Position of Mouse. mMouseY Y Position of Mouse. mMouseB Mouse Button Information. ZError > mErrorQueue Stack of Errors which have occured. ZError mCurError Current error. mLogAllErrors Option controlling how logfile is used. mErrlog C-style FILE* for error logging. Static Private Attributes sInstance = NULL Static Pointer to Instance of ZEngine for Singleton.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZEngine::ZEngine
+ (
+
+ )
+ [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+Initialize ZEngine values to defaults. (Private so that only one instance may be created.)
+
+
+Member Function Documentation
+
+
+
+
+
+
+ ZEngine * ZE::ZEngine::GetInstance
+ (
+
+ )
+ [static]
+
+
+
+
+
+
+
+
+
+
+
+
+
+Static function, returns pointer to instance of ZEngine , creating an instance if none exist.
Returns: Instance to the ZEngine .
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::ReleaseInstance
+ (
+
+ )
+ [static]
+
+
+
+
+
+
+
+
+
+
+
+
+
+Release memory held by instance of engine and closes window.
+
+
+
+
+
+
+
+
+ string ZE::ZEngine::GetVersion
+ (
+
+ )
+ [static]
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Version Number of ZEngine . (Major.Minor.Extension#)
Returns: string containing version number
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetupDisplay
+ (
+ int
+ width ,
+
+
+ int
+ height ,
+
+
+ int
+ bpp ,
+
+
+ bool
+ fullscreen
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sets display parameters to specified parameters. (called before CreateDisplay)
+
+
Parameters:
+
+ width Desired width of screen or window. height Desired height of screen or window. bpp Desired BPP for screen (only works in fullscreen). fullscreen A bool for fullscreen setting.
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetupSound
+ (
+ int
+ rate ,
+
+
+ bool
+ stereo
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set sound settings to specified parameters. (called before CreateDisplay)
+
+
Parameters:
+
+ rate Desired sound bitrate. stereo A bool for stereo setting.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::CreateDisplay
+ (
+ string
+ title ,
+
+
+ string
+ icon = ""
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+SetupDisplay and SetupSound should be called prior to this to change settings, settings from those do not go into effect until this function is called. Specify no icon file to use default icon. Returns result of setting up ZEngine , and logs error if false is returned (returns bool in versions >= 0.8.2).
+
+
Parameters:
+
+ title Window Title. icon Path to Icon File.
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::CloseDisplay
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Shut down SDL (and SDL_ttf,SDL_mixer if necessary) You shouldn't ever have to call this, ReleaseInstance calls this for you.
+
+
+
+
+
+
+
+
+ SDL_Surface * ZE::ZEngine::Display
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get pointer to screen SDL_Surface, allowing direct screen manipulation using SDL.
Returns: Pointer to Display Surface.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::Update
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Swap OpenGL buffers, and update screen, if a desired framerate is set it will delay to stay under that rate. Must be called every frame.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::Clear
+ (
+ float
+ red = 0.0f,
+
+
+ float
+ green = 0.0f,
+
+
+ float
+ blue = 0.0f,
+
+
+ float
+ alpha = 1.0f
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Clears a rectangle on screen to a color, defaults to solid black.
Parameters:
+
+ red Red component (0.0-1.0) of new color. green Green component (0.0-1.0) of new color. blue Blue component (0.0-1.0) of new color. alpha Alpha component (0.0-1.0) of new color.
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetGL2D
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sets the OpenGL scaled orthographic mode, called once at beginning, no need to call unless you change the OpenGL mode manually.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::Delay
+ (
+ Uint32
+ milliseconds
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Freeze everything for given number of milliseconds.
Parameters:
+
+ milliseconds Number of milliseconds to freeze.
+
+
+
+
+
+
+
+
+
+ Uint32 ZE::ZEngine::GetTime
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get active time since ZEngine initialization in milliseconds, paused time doesn't count.
Returns: Number of active milliseconds since initialization.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::PauseTimer
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::UnpauseTimer
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+ double ZE::ZEngine::GetFrameTime
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get double that describes the time passed between screen updates. (should be used for Framerate Independant Movement)
Returns: Time between screen updates.
+
+
+
+
+
+
+
+
+ double ZE::ZEngine::GetFramerate
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get double representing current (approximate) FPS. This value is always the same as 1/GetFrameTime().
Since: 0.8.2 Returns: Current Framerate.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetDesiredFramerate
+ (
+ Uint8
+ rate
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sets desired framerate, if engine gets ahead of desired rate during a frame it will stall in Update until current framerate is closer to that desired. Acceptable values are 1-255, setting this value to 0 will disable this feature. (Desired framerate is disabled upon initialization of ZEngine .)
Since: 0.8.2 Parameters:
+
+ rate Desired framerate 1-255, or 0 to disable.
+
+
+
+
+
+
+
+
+
+ Uint8 ZE::ZEngine::GetDesiredFramerate
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get desired framerate set by SetDesiredFramerate.
Since: 0.8.2 Returns: Current setting for desired framerate.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::IsPaused
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find out if engine timer is paused.
Returns: Paused State of engine.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::IsActive
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Function to find out if application currently has focus.
Returns: bool telling active/inactive state of application.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::RequestQuit
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Tell the engine that it should behave as if a Quit was requested, does not call any shutdown functions.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::QuitRequested
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Function to find out if user or operating system has requested program cease execution, can be set by Alt-F4, SDL_Quit event or ZEngine::RequestQuit() .
Returns: bool telling if quit has been requested.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetReloadNeed
+ (
+ bool
+ state
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+ state False if images need to be reloaded, True if images have been reloaded.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::ImagesNeedReload
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Function that is good to call every frame to check if images should be reloaded, usually only caused by loss of focus in fullscreen.
Returns: bool, True if images should be reloaded, false otherwise.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetKeyRepeatRate
+ (
+ int
+ rate
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Calls SDL_EnableKeyRepeat(rate,rate) because usually this is the desired movement style for games. The rate is set to 30 upon the creation of the display, pass zero to disable this. SDL_EnableKeyRepeat can be called separately: http://sdldoc.csn.ul.ie/sdlenablekeyrepeat.php.
+
+
Parameters:
+
+ rate Desired key repeat rate.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::KeyIsPressed
+ (
+ SDLKey
+ key
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Function returns true/false based on if key is currently pressed or not.
Parameters:
+
+ key Code of key to find status of.
+ Returns: State of requested key.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::KeyPress
+ (
+ SDLKey
+ key
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Function returns true/false based on if key has been pressed since last check.
Parameters:
+
+ key Code of key to find status of.
+ Returns: State of requested key.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::HideCursor
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Hide the system mouse cursor.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::ShowCursor
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Show the system mouse cursor.
+
+
+
+
+
+
+
+
+ int ZE::ZEngine::MouseX
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find X Position of Mouse on screen.
Returns: X Position of Mouse.
+
+
+
+
+
+
+
+
+ int ZE::ZEngine::MouseY
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find Y Position of Mouse on screen.
Returns: Y Position of Mouse.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::LButtonPressed
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get pressed status of left button of mouse.
Returns: true if left button is pressed, false otherwise.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::RButtonPressed
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get pressed status of right button of mouse.
Returns: true if right button is pressed, false otherwise.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::MouseInRect
+ (
+ SDL_Rect *
+ rect
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Return status of mouse in current rectangle (used for buttons)
Parameters:
+
+ rect Rectangle to check if mouse is in.
+ Returns: true if mouse is in rectangle, false otherwise
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::CheckEvents
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Cycle through event queue, processing events, updating all Event Related variables, should be called once per frame.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::LogError
+ (
+ ZError error
+ )
+ [private]
+
+
+
+
+
+
+
+
+
+
+
+
+
+Writes error to current error file.
Since: 0.8.2 Parameters:
+
+ error ZError to write to file.
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::SetErrorLog
+ (
+ bool
+ logAll ,
+
+
+ string
+ logFile = ""
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Change the way errors are logged and the file they are logged to, before calling this errors are logged to stderr. (SDL may define stderr.txt on some platforms.)
Since: 0.8.2 Parameters:
+
+ logAll If set to true every error will be written to file instead of stored in the logfile. logFile Name of file to use as log, passing in stderr or stdio will set the log to the C streams. Passing in nothing will not change the current error log file, which defaults to stderr.
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::ReportError
+ (
+ ZErrorCode code ,
+
+
+ string
+ desc = "",
+
+
+ string
+ file = "",
+
+
+ unsigned int
+ line = 0
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Adds the error to the the error queue, and sets the current error to this error.
Since: 0.8.2 Parameters:
+
+ code ZErrorCode of error. desc Optional string describing error. file Optional argument specifying the file the error occured in. line Optional argument specifying the line the error occured on.
+
+
+
+
+
+
+
+
+
+ ZErrorCode ZE::ZEngine::GetLastError
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get the last error reported.
Since: 0.8.2 Returns: ZErrorCode of last error reported.
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::WriteLog
+ (
+ string
+ str
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Write a string to the log, allowing special usage of the error log.
Since: 0.8.2 Parameters:
+
+ str String to write to log file.
+
+
+
+
+
+
+
+
+
+ void ZE::ZEngine::FlushErrors
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Write the error stack to the error log.
Since: 0.8.2
+
+
+
+
+
+
+
+
+ SDL_Surface * ZE::ZEngine::LoadImage
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Loads an Image to an ImageData class which keeps vital information on the Image.
Parameters:
+
+ filename path to file to load.
+ Returns: A SDL_Surface pointer to data.
+
+
+
+
+
+
+
+
+ Mix_Chunk* ZE::ZEngine::LoadSound
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Loads a Sound to a SoundData class which keeps vital information on the Sound
Parameters:
+
+ filename path to file to load.
+ Returns: A Mix_Chunk pointer to data.
+
+
+
+
+
+
+
+
+ Mix_Music* ZE::ZEngine::LoadMusic
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Loads a Music Clip to a MusicData class which keeps vital information on the Music Data
Parameters:
+
+ filename path to file to load.
+ Returns: A Mix_Music pointer to data.
+
+
+
+
+
+
+
+
+ TTF_Font* ZE::ZEngine::LoadFont
+ (
+ string
+ filename ,
+
+
+ int
+ size
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Loads a Font to a FontData class which keeps vital information on the Font
Parameters:
+
+ filename path to file to load. size point size of font
+ Returns: A TTF_Font pointer to data.
+
+
+
+
+
+
+
+
+ int ZE::ZEngine::Width
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Width of Window or Fullscreen mode.
Returns: Width of Display.
+
+
+
+
+
+
+
+
+ int ZE::ZEngine::Height
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Height of Window or Fullscreen mode.
Returns: Height of Display.
+
+
+
+
+
+
+
+
+ int ZE::ZEngine::BPP
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get BPP of Window or Fullscreen mode.
Returns: BPP of Display.
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::IsFullscreen
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Fullscreen setting of Display.
Returns: True if Fullscreen, False if Windowed
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZError Member List This is the complete list of members for ZE::ZError , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZError class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZError Class Reference #include <ZE_ZError.h >
+
+List of all members.
Detailed Description
+ZError class for storing and printing information on errors. Inherited from ZObject and tied closely to ZEngine . Since: 0.8.2
+
+Public Methods ZError (ZErrorCode code=ZERR_NONE, string desc="", string file="", int line=0) Default constructor for ZError . void Create (ZErrorCode code, string desc="", string file="", int line=0) Set members of error object. ZErrorCode Code () const Get ZErrorCode of error. string LogString () const Get formatted string for log file. Protected Attributes ZErrorCode rCode Error ID. rDescription Error Description. rFilename File which error occured in. rLine Line which error occured on. Static Protected Attributes string sErrorDesc [ZERR_LAST] Static Array of Error Identifiers.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZError::ZError
+ (
+ ZErrorCode code = ZERR_NONE,
+
+
+ string
+ desc = "",
+
+
+ string
+ file = "",
+
+
+ int
+ line = 0
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Make new ZError object, by default set rCode to ZERR_NONE with no description.
Parameters:
+
+ code ZErrorCode to set object to, defaults to ZERR_NONE. desc Description to use for object, defaults to nothing. file Optional argument specifying the file the error occured in. line Optional argument specifying the line the error occured on.
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ void ZE::ZError::Create
+ (
+ ZErrorCode code ,
+
+
+ string
+ desc = "",
+
+
+ string
+ file = "",
+
+
+ int
+ line = 0
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set new values in ZError object.
Parameters:
+
+ code ZErrorCode to set object to. desc Description to use for object, defaults to nothing. file Optional argument specifying the file the error occured in. line Optional argument specifying the line the error occured on.
+
+
+
+
+
+
+
+
+
+ ZErrorCode ZE::ZError::Code
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Access ZErrorCode of the ZError object.
Returns: The error ZErrorCode.
+
+
+
+
+
+
+
+
+ string ZE::ZError::LogString
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Return the string to be written to the logfile. Called by ZEngine in LogError.
+
+
+Member Data Documentation
+
+
+
+
+
+
+ string ZE::ZError::sErrorDesc [static, protected]
+
+
+
+
+
+
+
+
+
+
+
+
+Initial value:
+{
+ "No Error. [%s]" ,
+ "SDL Error. [%s]" ,
+ "Error Initializing SDL: %s" , "Error Initializing SDL_mixer: %s" , "Error Initializing SDL_ttf: %s" ,
+ "Error Creating Display: %s" ,
+ "Failed to load Image: %s" , "Failed to load Sound: %s" , "Failed to load Music: %s" , "Failed to load Font: %s" ,
+ "Called ZImage::%s with no Image loaded." , "Called ZSound::%s with no Sound loaded." ,
+ "Called ZMusic::%s with no Music loaded." , "Called ZFont::%s with no Font loaded."
+}
+
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZFont Member List This is the complete list of members for ZE::ZFont , including all inherited members.
+ DrawShadedText (string text, ZImage &image) constZE::ZFont DrawText (string text, ZImage &image) constZE::ZFont Height () constZE::ZFont IsBold () constZE::ZFont IsItalic () constZE::ZFont IsLoaded () constZE::ZFont IsUnderlined () constZE::ZFont LineSkip () constZE::ZFont Open (string filename, int size)ZE::ZFont rBGColor ZE::ZFont [protected]rColor ZE::ZFont [protected]Release ()ZE::ZFont rEngine ZE::ZObject [protected]Resize (int size)ZE::ZFont rFilename ZE::ZFont [protected]rFont ZE::ZFont [protected]SetBGColor (Uint8 r, Uint8 g, Uint8 b)ZE::ZFont SetColor (Uint8 r, Uint8 g, Uint8 b)ZE::ZFont SetStyle (bool bold, bool italic, bool underline)ZE::ZFont StringHeight (string text) constZE::ZFont StringWidth (string text) constZE::ZFont ZFont ()ZE::ZFont ZFont (string filename, int size)ZE::ZFont ZObject ()ZE::ZObject [inline]~ZFont ()ZE::ZFont ~ZObject ()ZE::ZObject [inline, virtual]
Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZFont class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZFont Class Reference #include <ZE_ZFont.h >
+
+Inherits ZE::ZObject .
+
+List of all members.
Detailed Description
+ZFont font container class, class wraps common features of SDL_TTF. Inherited from ZObject .
+
+
+Public Methods ZFont () Default Constructor. ZFont (string filename, int size) Constructor that opens a font with a certain size. ~ZFont () Destructor, frees memory. void Open (string filename, int size) Opens a font with a certain size. void Release () Release font. void DrawText (string text, ZImage &image) const Draws a string in a color to a ZImage . void DrawShadedText (string text, ZImage &image) const Draws a string with a colored background to a ZImage . void SetColor (Uint8 r, Uint8 g, Uint8 b) Set Text rColor. void SetBGColor (Uint8 r, Uint8 g, Uint8 b) Set Background rColor. void SetStyle (bool bold, bool italic, bool underline) Set display format. void Resize (int size) Resize Font. bool IsLoaded () const Check if file is loaded. bool IsBold () const Get Bold Setting. bool IsItalic () const Get Italic Setting. bool IsUnderlined () const Get Underlined Setting. int Height () const Get Height of Font. int LineSkip () const Get Line Skip for Font. int StringWidth (string text) const Get String Width. int StringHeight (string text) const Get String Height. Protected Attributes rFont Pointer to font data. rFilename Filename, for resizing. rColor SDL_Color for current text color. rBGColor SDL_Color for background color to be used in shaded draws.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZFont::ZFont
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Default Constructor, does nothing.
+
+
+
+
+
+
+
+
+ ZE::ZFont::ZFont
+ (
+ string
+ filename ,
+
+
+ int
+ size
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor simply calls ZFont::Open() with same parameters.
Parameters:
+
+ filename Font to open. size Size to use for font.
+
+
+
+
+
+
+
+
+
+ ZE::ZFont::~ZFont
+ (
+
+ )
+
+
+
+
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ void ZE::ZFont::Open
+ (
+ string
+ filename ,
+
+
+ int
+ size
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Opens a font given a filename and a point size.
Parameters:
+
+ filename Font to open. size Size to use for font.
+
+
+
+
+
+
+
+
+
+ void ZE::ZFont::Release
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Release memory held by font.
+
+
+
+
+
+
+
+
+ void ZE::ZFont::DrawText
+ (
+ string
+ text ,
+
+
+ ZImage & image
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Draw to a surface in specified color and associate that surface with a ZImage .
Parameters:
+
+ text String to write. image ZImage to draw to.
+
+
+
+
+
+
+
+
+
+ void ZE::ZFont::DrawShadedText
+ (
+ string
+ text ,
+
+
+ ZImage & image
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Draw to a surface a string with a background of rBGColor and lettering in the normal color and associate that surface with a ZImage .
Parameters:
+
+ text String to write. image ZImage to draw to.
+
+
+
+
+
+
+
+
+
+ void ZE::ZFont::SetColor
+ (
+ Uint8
+ r ,
+
+
+ Uint8
+ g ,
+
+
+ Uint8
+ b
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set rColor of Text Output.
Parameters:
+
+ r Red component of color (0-255). g Green component of color (0-255). b Blue component of color (0-255).
+
+
+
+
+
+
+
+
+
+ void ZE::ZFont::SetBGColor
+ (
+ Uint8
+ r ,
+
+
+ Uint8
+ g ,
+
+
+ Uint8
+ b
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set rColor of Background for Shaded Draw.
Parameters:
+
+ r Red component of color (0-255). g Green component of color (0-255). b Blue component of color (0-255).
+
+
+
+
+
+
+
+
+
+ void ZE::ZFont::SetStyle
+ (
+ bool
+ bold ,
+
+
+ bool
+ italic ,
+
+
+ bool
+ underline
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set display format (bold, italic, underline).
Parameters:
+
+ bold Decides bold setting of font. italic Decides italic setting of font. underline Decides underline setting of font.
+
+
+
+
+
+
+
+
+
+ void ZE::ZFont::Resize
+ (
+ int
+ size
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Release and Reopen font in new size.
Parameters:
+
+ size New size for font.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZFont::IsLoaded
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if file is loaded and pointer to data is non-NULL.
Returns: Loaded or Unloaded state of data.
+
+
+
+
+
+
+
+
+ bool ZE::ZFont::IsBold
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if font output is currently bold.
Returns: True or False state of bold.
+
+
+
+
+
+
+
+
+ bool ZE::ZFont::IsItalic
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if font output is currently italic.
Returns: True or False state of italic.
+
+
+
+
+
+
+
+
+ bool ZE::ZFont::IsUnderlined
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if font output is currently underline.
Returns: True or False state of underline.
+
+
+
+
+
+
+
+
+ int ZE::ZFont::Height
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check font height as reported by SDL_ttf.
Returns: Height of font.
+
+
+
+
+
+
+
+
+ int ZE::ZFont::LineSkip
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check font line skip as reported by SDL_ttf.
Returns: Recommended Line Skip of font.
+
+
+
+
+
+
+
+
+ int ZE::ZFont::StringWidth
+ (
+ string
+ text
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Width of String in Current Font in Pixels.
Parameters:
+
+ text String to get width of.
+ Returns: Width of String in Current font.
+
+
+
+
+
+
+
+
+ int ZE::ZFont::StringHeight
+ (
+ string
+ text
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Height of String in Current Font in Pixels.
Parameters:
+
+ text String to get height of.
+ Returns: Height of String in Current font.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZImage Member List This is the complete list of members for ZE::ZImage , including all inherited members.
+ Attach (SDL_Surface *surface)ZE::ZImage Bind () constZE::ZImage Draw (float x, float y) constZE::ZImage DrawRotated (int x, int y, float angle) constZE::ZImage Flip (bool horizontal, bool vertical)ZE::ZImage Height () constZE::ZImage IsLoaded () constZE::ZImage Open (string filename)ZE::ZImage OpenFromImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)ZE::ZImage Release ()ZE::ZImage Reload ()ZE::ZImage rEngine ZE::ZObject [protected]Resize (unsigned int width, unsigned int height)ZE::ZImage rHeight ZE::ZImage [protected]rImage ZE::ZImage [protected]rTexID ZE::ZImage [protected]rTexMaxX ZE::ZImage [protected]rTexMaxY ZE::ZImage [protected]rTexMinX ZE::ZImage [protected]rTexMinY ZE::ZImage [protected]rWidth ZE::ZImage [protected]SetColorKey (Uint8 red, Uint8 green, Uint8 blue)ZE::ZImage Stretch (float xFactor, float yFactor)ZE::ZImage Surface () constZE::ZImage Width () constZE::ZImage ZImage ()ZE::ZImage ZImage (string filename)ZE::ZImage ZImage (SDL_Surface *surface)ZE::ZImage ZImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)ZE::ZImage ZImage::ZImage (const ZImage &rhs)ZE::ZImage ZObject ()ZE::ZObject [inline]~ZImage ()ZE::ZImage ~ZObject ()ZE::ZObject [inline, virtual]
Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZImage class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZImage Class Reference #include <ZE_ZImage.h >
+
+Inherits ZE::ZObject .
+
+List of all members.
Detailed Description
+ZImage image drawing class, class wraps common features of SDL_Surface. Inherited from ZObject .
+
+
+Public Methods ZImage () Default Constructor. ZImage::ZImage (const ZImage &rhs) Copy constructor for ZImage . ZImage (string filename) Constructor to Construct from File. ZImage (SDL_Surface *surface) Constructor to Construct from SDL_Surface*. ZImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h) Constructor to Construct from part of an SDL_Surface*. ~ZImage () Destructor, frees memory. void Open (string filename) Opens a file. void OpenFromImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h) Cuts part of an existing image to create the new image. void Attach (SDL_Surface *surface) Attach an existing surface to class. void Reload () Reattach a preloaded texture that has been lost. void Release () Releases image. void SetColorKey (Uint8 red, Uint8 green, Uint8 blue) Set Color Key (transparent color) of Image. void Flip (bool horizontal, bool vertical) Flip image over one or both axes. void Stretch (float xFactor, float yFactor) Stretch the image by a certain X and Y factor. void Resize (unsigned int width, unsigned int height) Resizes an image, stretching to new size. void Bind () const OpenGL related bind call. void Draw (float x, float y) const Draw Image to Screen. void DrawRotated (int x, int y, float angle) const Draw Image rotated to screen. bool IsLoaded () const Check if file is loaded. SDL_Surface * Surface () const Get SDL_Surface. Get SDL_Surface pointer to actual image data. int Width () const Get Width. int Height () const Get Height. Protected Attributes rTexMinX Texture lower X, used internally for flip. rTexMinY Texture lower Y, used internally for flip. rTexMaxX Texture X width ratio, used internally by OpenGL. rTexMaxY Texture Y width ratio, used internally by OpenGL. rImage Stored texture for future use. rTexID Texture ID for OpenGL. rWidth Current draw width of Texture. rHeight Current draw height of Texture.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZImage::ZImage
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Default Constructor, initializes variables.
+
+
+
+
+
+
+
+
+ ZE::ZImage::ZImage
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor is same as calling ZImage::Open() on passed filename.
Parameters:
+
+ filename File to open as rImage.
+
+
+
+
+
+
+
+
+
+ ZE::ZImage::ZImage
+ (
+ SDL_Surface *
+ surface
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor is same as calling ZImage::Attach() on passed SDL_Surface*.
Parameters:
+
+ surface SDL_Surface* to use as rImage.
+
+
+
+
+
+
+
+
+
+ ZE::ZImage::ZImage
+ (
+ SDL_Surface *
+ img ,
+
+
+ Sint16
+ x ,
+
+
+ Sint16
+ y ,
+
+
+ Sint16
+ w ,
+
+
+ Sint16
+ h
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor is same as calling ZImage::OpenFromImage .
+
+
Parameters:
+
+ img Image to take new image from. x X Coordinate in source of top left corner. y Y Coordinate in source of top left corner. w Width of new image. h Height of new image.
+
+
+
+
+
+
+
+
+
+ ZE::ZImage::~ZImage
+ (
+
+ )
+
+
+
+
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ ZE::ZImage::ZImage::ZImage
+ (
+ const ZImage &
+ rhs
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Creates one ZImage using another.
Parameters:
+
+ rhs A previously created ZImage to copy.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Open
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Open a file using ZEngine . Loads into rImage member of class.
Parameters:
+
+ filename File to open as rImage.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::OpenFromImage
+ (
+ SDL_Surface *
+ img ,
+
+
+ Sint16
+ x ,
+
+
+ Sint16
+ y ,
+
+
+ Sint16
+ w ,
+
+
+ Sint16
+ h
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Cut part of an SDL_Surface to create a new Image.
+
+
Parameters:
+
+ img Image to take new image from. x X Coordinate in source of top left corner. y Y Coordinate in source of top left corner. w Width of new image. h Height of new image.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Attach
+ (
+ SDL_Surface *
+ surface
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Attach a pointer to instance of ZImage . (NOTE: Should not be used on a surface that is owned elsewhere.)
Parameters:
+
+ surface SDL_Surface* to use as rImage.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Reload
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Attach loaded textures which have been lost due to loss of focus, should be called when ZEngine::ImagesNeedReload is true.
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Release
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Frees memory via call to SDL_FreeSurface for the image.
+
+
+
+
+
+
+
+
+ void ZE::ZImage::SetColorKey
+ (
+ Uint8
+ red ,
+
+
+ Uint8
+ green ,
+
+
+ Uint8
+ blue
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set color which will not be drawn in image.
Parameters:
+
+ red Red component of colorkey (0-255). green Green component of colorkey (0-255). blue Blue component of colorkey (0-255).
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Flip
+ (
+ bool
+ horizontal ,
+
+
+ bool
+ vertical
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Flip image vertical and/or horizontal.
Parameters:
+
+ horizontal Boolean, true will flip image horizontally. vertical Boolean, true will flip image vertically.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Stretch
+ (
+ float
+ xFactor ,
+
+
+ float
+ yFactor
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Stretch image using a factor to multiply width and height by.
Parameters:
+
+ xFactor Stretch factor for width. [newWidth = oldWidth * xStretch] yFactor Stretch factor for height. [newHeight = oldHeight * yStretch]
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Resize
+ (
+ unsigned int
+ width ,
+
+
+ unsigned int
+ height
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Stretch image to new width and height.
Parameters:
+
+ width New width to stretch image to. height New height to stretch image to.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Bind
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+OpenGL related bind call, only available in case you want to bind image in 3D. Draw uses this but the average user should never need to call this.
+
+
+
+
+
+
+
+
+ void ZE::ZImage::Draw
+ (
+ float
+ x ,
+
+
+ float
+ y
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Draw Image to screen at specified location.
Parameters:
+
+ x X coord to draw Image to. y Y coord to draw Image to.
+
+
+
+
+
+
+
+
+
+ void ZE::ZImage::DrawRotated
+ (
+ int
+ x ,
+
+
+ int
+ y ,
+
+
+ float
+ angle
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Image is rotated about it's own center by specified angle, then drawn to screen.
Parameters:
+
+ x X coord to draw Image to. y Y coord to draw Image to. angle Angle in degrees to rotate image.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZImage::IsLoaded
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if surface is a valid GL texture. (does not detect surface loss)
Returns: Loaded or Unloaded state of data.
+
+
+
+
+
+
+
+
+ SDL_Surface * ZE::ZImage::Surface
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns: SDL_Surface* of rImage.
+
+
+
+
+
+
+
+
+ int ZE::ZImage::Width
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Current Width of Image.
Returns: Image Width.
+
+
+
+
+
+
+
+
+ int ZE::ZImage::Height
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Current Height of Image.
Returns: Image Height.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZMusic Member List This is the complete list of members for ZE::ZMusic , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZMusic class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZMusic Class Reference #include <ZE_ZMusic.h >
+
+Inherits ZE::ZObject .
+
+List of all members.
Detailed Description
+ZMusic music class, class wraps common features for SDL_Mixer's Mix_Music. Inherited from ZObject .
+
+
+Public Methods ZMusic () Default Constructor. ZMusic (string filename) Constructor that opens a music file. ~ZMusic () Destructor, frees memory. void Open (string filename) Opens a music file. void Release () Release music. void Play (int loopNum=0, int fadeTime=0) const Play currently loaded music. void Pause () const Pause music. void Unpause () const Unpause music. void Rewind () const Rewind music. void Stop (int fadeTime=0) const Stop music. void SetVolume (int volume) Change Volume. bool IsLoaded () const Check if file is loaded. bool IsPlaying () const Check if music is Playing. bool IsPaused () const Check if music is Paused. int Volume () const Find Current Volume of Music. Static Public Attributes LoopInfinite Static Variable For Infinite loop of sound. (Defined as -1). Protected Attributes rMusic Pointer to music data.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZMusic::ZMusic
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Default Constructor, does nothing.
+
+
+
+
+
+
+
+
+ ZE::ZMusic::ZMusic
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor simply calls ZMusic::Open() with same filename. (WAV,MOD,MID,OGG)
Parameters:
+
+ filename Music to open.
+
+
+
+
+
+
+
+
+
+ ZE::ZMusic::~ZMusic
+ (
+
+ )
+
+
+
+
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ void ZE::ZMusic::Open
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Open a music file to be used.
Parameters:
+
+ filename Music to open.
+
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::Release
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Release memory held by music data.
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::Play
+ (
+ int
+ loopNum = 0,
+
+
+ int
+ fadeTime = 0
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Play music currently loaded in ZMusic , looping loopNum times. (use ZMusic::LoopInfinite to loop forever.) If fade is not zero (which it defaults to) music will fade in over specified number of milliseconds.
Parameters:
+
+ loopNum Number of times to loop song, defaults to zero. fadeTime Milliseconds to fade to full volume, defaults to zero for no fade.
+
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::Pause
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Pause currently playing music.
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::Unpause
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Unpause currently paused music.
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::Rewind
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Rewind music to beginning.
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::Stop
+ (
+ int
+ fadeTime = 0
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Stop currently playing music, if fadeTime is not zero, fade out over specified time.
Parameters:
+
+ fadeTime Milliseconds to fade out over, defaults to zero for immediate stop.
+
+
+
+
+
+
+
+
+
+ void ZE::ZMusic::SetVolume
+ (
+ int
+ volume
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Change volume of currently playing music.
Parameters:
+
+ volume Volume to change to, can be in a range from 0 to 128
+
+
+
+
+
+
+
+
+
+ bool ZE::ZMusic::IsLoaded
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if file is loaded and pointer to data is non-NULL.
Returns: Loaded or Unloaded state of data.
+
+
+
+
+
+
+
+
+ bool ZE::ZMusic::IsPlaying
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if music is playing, specifically if it is not stopped. (Paused state should be checked for by IsPaused)
Returns: Playing / Not Playing State of Music.
+
+
+
+
+
+
+
+
+ bool ZE::ZMusic::IsPaused
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if music is "playing" but currently paused.
Returns: Paused / Not Paused State of Music.
+
+
+
+
+
+
+
+
+ int ZE::ZMusic::Volume
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get current volume of music represented as a value from 0-128.
Returns: Volume of music, 0-128.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZObject Member List This is the complete list of members for ZE::ZObject , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZObject class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZObject Class Reference #include <ZE_ZObject.h >
+
+Inherited by ZE::ZConfigFile , ZE::ZFont , ZE::ZImage , ZE::ZMusic , ZE::ZSound , and ZE::ZTimer .
+
+List of all members.
Detailed Description
+This is the base class from which all ZEngine internal objects are derived from.
+
+
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZObject::ZObject
+ (
+
+ )
+ [inline]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ZEngine Constructor, gets Engine pointer for Object.
+
+
+
+
+
+
+
+
+ virtual ZE::ZObject::~ZObject
+ (
+
+ )
+ [inline, virtual]
+
+
+
+
+
+
+
+
+
+
+
+
+
+ZEngine destructor, provided to make class safely inheritable.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZRect Member List This is the complete list of members for ZE::ZRect , including all inherited members.
+ Bottom () constZE::ZRect Contains (float x, float y) constZE::ZRect Contains (const ZRect &rect) constZE::ZRect Draw (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) constZE::ZRect Height () constZE::ZRect Intersection (const ZRect &rect) constZE::ZRect Intersects (const ZRect &rect) constZE::ZRect Left () constZE::ZRect Move (float x, float y)ZE::ZRect MoveRel (float xMove, float yMove)ZE::ZRect operator< (const ZRect &rhs) constZE::ZRect operator= (const ZRect &rhs)ZE::ZRect Resize (float width, float height)ZE::ZRect ResizeRel (float widthChange, float heightChange)ZE::ZRect rHeight ZE::ZRect [protected]Right () constZE::ZRect rWidth ZE::ZRect [protected]rX ZE::ZRect [protected]rY ZE::ZRect [protected]SDLrect () constZE::ZRect Top () constZE::ZRect Width () constZE::ZRect X () constZE::ZRect Y () constZE::ZRect ZRect ()ZE::ZRect ZRect (float x, float y, float width, float height)ZE::ZRect ZRect (const ZRect &rhs)ZE::ZRect
Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZRect class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZRect Class Reference #include <ZE_ZRect.h >
+
+List of all members.
Detailed Description
+ZRect Rectangle class, used to define a rectangular area or perform operations on the defined area.
+
+
+Public Methods ZRect () Default constructor for ZRect . ZRect (float x, float y, float width, float height) Constructor for ZRect that takes inital values. ZRect (const ZRect &rhs) Copy constructor for ZRect . const ZRect & operator= (const ZRect &rhs) Overload for = operator with ZRect . bool operator< (const ZRect &rhs) const Overload for < operator with ZRect , based upon location then size. void Draw (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) const Draw rectangle. (filled). void Move (float x, float y) Changes the location of the rectangle. void MoveRel (float xMove, float yMove) Changes the location of the rectangle based upon the current location. void Resize (float width, float height) Resize rectangle. void ResizeRel (float widthChange, float heightChange) Grows or shrinks current rectangle. bool Intersects (const ZRect &rect) const Check if one ZRect intersects another. bool Contains (float x, float y) const Check if a rectangle contains a given point. bool Contains (const ZRect &rect) const Check if a rectangle contains a given point. ZRect Intersection (const ZRect &rect) const Finds intersection of two rectangles. SDL_Rect SDLrect () const Returns an SDL_Rect representing the rectangle. float X () const Returns X Location. float Y () const Returns Y Location. float Left () const Return position of left side. float Right () const Return position of right side. float Top () const Return position of top side. float Bottom () const Return position of bottom side. float Width () const Returns Width. float Height () const Returns Height. Protected Attributes rX X Position of top left corner of rectangle. rY Y Position of top left corner of rectangle. rWidth Width of Rectangle. rHeight Height of Rectangle.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZRect::ZRect
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Default constructor, initializes all values to zero.
+
+
+
+
+
+
+
+
+ ZE::ZRect::ZRect
+ (
+ float
+ x ,
+
+
+ float
+ y ,
+
+
+ float
+ width ,
+
+
+ float
+ height
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor for ZRect that takes inital values for all four members.
Parameters:
+
+ x Value for x position. y Value for y position. width Value for width. height Value for height.
+
+
+
+
+
+
+
+
+
+ ZE::ZRect::ZRect
+ (
+ const ZRect &
+ rhs
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Takes a ZRect and constructs a new identical rectangle.
Parameters:
+
+ rhs Rectangle to construct from.
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ const ZRect & ZE::ZRect::operator=
+ (
+ const ZRect &
+ rhs
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Copies all values from one ZRect into another.
Parameters:
+
+ rhs Rectangle to copy values from.
+ Returns: New value of the ZRect .
+
+
+
+
+
+
+
+
+ bool ZE::ZRect::operator<
+ (
+ const ZRect &
+ rhs
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Rectangles are sorted by y value, followed by x value, if they start at the same place, the smaller of the two is deemed less than the other.
Parameters:
+
+ rhs Rectangle to compare.
+ Returns: True if this rectangle is smaller than the rhs rectangle, false otherwise.
+
+
+
+
+
+
+
+
+ void ZE::ZRect::Draw
+ (
+ Uint8
+ red ,
+
+
+ Uint8
+ green ,
+
+
+ Uint8
+ blue ,
+
+
+ Uint8
+ alpha = 255
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Draw the ZRect , this function is mainly provided for testing purposes.
Parameters:
+
+ red Red component of color (0-255). green Green component of color (0-255). blue Blue component of color (0-255). alpha Alpha component of color (0-255).
+
+
+
+
+
+
+
+
+
+ void ZE::ZRect::Move
+ (
+ float
+ x ,
+
+
+ float
+ y
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Changes the current x,y position of the rectangle.
Parameters:
+
+ x New x position for rectangle. y New y position for rectangle.
+
+
+
+
+
+
+
+
+
+ void ZE::ZRect::MoveRel
+ (
+ float
+ xMove ,
+
+
+ float
+ yMove
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Changes the current x,y position of the rectangle relative to the current location.
Parameters:
+
+ xMove Offset for new x position from current. yMove Offset for new y position from current.
+
+
+
+
+
+
+
+
+
+ void ZE::ZRect::Resize
+ (
+ float
+ width ,
+
+
+ float
+ height
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Changes the current width and height of the rectangle.
Parameters:
+
+ width New width for rectangle. height New height for rectangle.
+
+
+
+
+
+
+
+
+
+ void ZE::ZRect::ResizeRel
+ (
+ float
+ widthChange ,
+
+
+ float
+ heightChange
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Changes the current width and height of the rectangle based upon current values.
Parameters:
+
+ widthChange Amount to add or subtract from width. heightChange Amount to add or subtract from height.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZRect::Intersects
+ (
+ const ZRect &
+ rect
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Checks for overlap and returns boolean value based on if overlap exists.
Parameters:
+
+ rect Rectangle to check for intersection with.
+ Returns: True if intersection occured, false otherwise.
+
+
+
+
+
+
+
+
+ bool ZE::ZRect::Contains
+ (
+ float
+ x ,
+
+
+ float
+ y
+
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Checks point against boundaries of rectangle and returns result.
Parameters:
+
+ x X value of point to check. y Y value of poitn to check.
+ Returns: Boolean variable, true if point is inside rectangle, false otherwise.
+
+
+
+
+
+
+
+
+ bool ZE::ZRect::Contains
+ (
+ const ZRect &
+ rect
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Checks point against boundaries of rectangle and returns result.
Parameters:
+
+ rect Rectangle to check for point.
+ Returns: Boolean variable, true if point is inside rectangle, false otherwise.
+
+
+
+
+
+
+
+
+ ZRect ZE::ZRect::Intersection
+ (
+ const ZRect &
+ rect
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Checks for intersection, and returns rectangle where the two rectangles intersect.
Parameters:
+
+ rect Rectangle to check intersection with.
+ Returns: ZRect describing intersection area.
+
+
+
+
+
+
+
+
+ SDL_Rect ZE::ZRect::SDLrect
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Makes a SDL_Rect representing the rectangle, for use where functions require an SDL_Rect.
Returns: SDL_Rect representing the ZRect .
+
+
+
+
+
+
+
+
+ float ZE::ZRect::X
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Access private X location member.
Returns: Value of mX.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Y
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Access private Y location member.
Returns: Value of mY.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Left
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find X position of left side of rectangle.
Returns: X position of left side.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Right
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find X position of right side of rectangle.
Returns: X position of right side.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Top
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find Y position of top side of rectangle.
Returns: Y position of top side.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Bottom
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find Y position of left side of rectangle.
Returns: Y position of bottom side.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Width
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Access private width member.
Returns: Value of mWidth.
+
+
+
+
+
+
+
+
+ float ZE::ZRect::Height
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Access private height member.
Returns: Value of mHeight.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZSound Member List This is the complete list of members for ZE::ZSound , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZSound class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZSound Class Reference #include <ZE_ZSound.h >
+
+Inherits ZE::ZObject .
+
+List of all members.
Detailed Description
+ZSound music class, class wraps common features for SDL_Mixer's Mix_Chunk. Inherited from ZObject .
+
+
+Public Methods ZSound () Default Constructor. ZSound (string filename) Constructor that opens a sound effect file. ~ZSound () Destructor, frees memory. void Open (string filename) Opens a sound effect file. void Release () Release sound effect. void Play (int loopNum=0, int fadeTime=0) Play currently loaded sound effect. void Pause () const Pause sound. void Unpause () const Unpause sound. void Stop (int fadeTime=0) const Stop sound. void SetVolume (int volume) Change Volume. bool IsLoaded () const Check if file is loaded. bool IsPlaying () const Check if sound is Playing. bool IsPaused () const Check if sound is Paused. int Volume () const Find Current Volume of Sound Channel. Static Public Attributes LoopInfinite Static Variable For Infinite loop of sound. (Defined as -1). Protected Attributes rSound Pointer to music data. rChannelID Channel ID Number from SDL_Mixer.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZSound::ZSound
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Default Constructor, does nothing.
+
+
+
+
+
+
+
+
+ ZE::ZSound::ZSound
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor simply calls ZSound::Open() with same filename. (WAV,MOD,MID,OGG)
Parameters:
+
+ filename Sound effect to open.
+
+
+
+
+
+
+
+
+
+ ZE::ZSound::~ZSound
+ (
+
+ )
+
+
+
+
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ void ZE::ZSound::Open
+ (
+ string
+ filename
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Open a music file to be used.
Parameters:
+
+ filename Music to open.
+
+
+
+
+
+
+
+
+
+ void ZE::ZSound::Release
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Release memory held by sample data.
+
+
+
+
+
+
+
+
+ void ZE::ZSound::Play
+ (
+ int
+ loopNum = 0,
+
+
+ int
+ fadeTime = 0
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Play sound effect, looping loopNum times. (use ZSound::LoopInfinite to loop forever.) If fade is not zero (which it defaults to) music will fade in over specified number of milliseconds.
Parameters:
+
+ loopNum Number of times to loop song, defaults to zero. fadeTime Milliseconds to fade to full volume, defaults to zero for no fade.
+
+
+
+
+
+
+
+
+
+ void ZE::ZSound::Pause
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Pause currently playing sound.
+
+
+
+
+
+
+
+
+ void ZE::ZSound::Unpause
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Unpause currently playing sound.
+
+
+
+
+
+
+
+
+ void ZE::ZSound::Stop
+ (
+ int
+ fadeTime = 0
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Stop currently playing sound, if fadeTime is not zero, fade out over specified time.
Parameters:
+
+ fadeTime Milliseconds to fade out over, defaults to zero for immediate stop.
+
+
+
+
+
+
+
+
+
+ void ZE::ZSound::SetVolume
+ (
+ int
+ volume
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Change volume of currently playing sample.
Parameters:
+
+ volume Volume to change to, can be in a range from 0 to 128.
+
+
+
+
+
+
+
+
+
+ bool ZE::ZSound::IsLoaded
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if file is loaded and pointer to data is non-NULL.
Returns: Loaded or Unloaded state of data.
+
+
+
+
+
+
+
+
+ bool ZE::ZSound::IsPlaying
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if sound is playing, specifically if it is not stopped. (Paused state should be checked for by IsPaused)
Returns: Playing / Not Playing State of sound.
+
+
+
+
+
+
+
+
+ bool ZE::ZSound::IsPaused
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Check if sound is "playing" but currently paused.
Returns: Paused / Not Paused State of Sound.
+
+
+
+
+
+
+
+
+ int ZE::ZSound::Volume
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get current volume of sound channel represented as a value from 0-128.
Returns: Volume of sound channel, 0-128.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Member List
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZTimer Member List This is the complete list of members for ZE::ZTimer , including all inherited members.Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE::ZTimer class Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE::ZTimer Class Reference #include <ZE_ZTimer.h >
+
+Inherits ZE::ZObject .
+
+List of all members.
Detailed Description
+ZTimer timing class, class wraps common features of SDL timer. Inherited from ZObject and tied to ZEngine main timer.
+
+
+Public Methods ZTimer (bool useZEngine=true) Constructs a new Timer. void Reset () Reset Timer. void Pause () Pause Timer. void Unpause () Unpause Timer. Uint32 GetTime () const Get Time of Timer. bool IsPaused () const Get paused state. Protected Methods Uint32 GetParentTime () const Get time from parent timer. Protected Attributes rPaused Paused / Unpaused state of Timer. rUseZEngine Using ZEngine timer or SDL global timer. rPausedTime Total time this timer has been paused. rLastPause Time this Timer was paused.
+Constructor & Destructor Documentation
+
+
+
+
+
+
+ ZE::ZTimer::ZTimer
+ (
+ bool
+ useZEngine = true
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sets TimePaused to current ZEngine time if useZEngine is true, otherwise uses SDL timer.
Parameters:
+
+ useZEngine Tells if timer should use ZEngine or SDL.
+
+
+
+Member Function Documentation
+
+
+
+
+
+
+ Uint32 ZE::ZTimer::GetParentTime
+ (
+
+ )
+ const [protected]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Protected method to get time from whichever timer is parent.
Returns: Time on parent timer.
+
+
+
+
+
+
+
+
+ void ZE::ZTimer::Reset
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set Timer back to Zero, will also unpause timer if it was paused.
+
+
+
+
+
+
+
+
+ void ZE::ZTimer::Pause
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Pause the timer if it is unpaused.
+
+
+
+
+
+
+
+
+ void ZE::ZTimer::Unpause
+ (
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Unpause the timer if it is paused.
+
+
+
+
+
+
+
+
+ Uint32 ZE::ZTimer::GetTime
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get current time accounting for time paused.
Returns: Current Timer Time.
+
+
+
+
+
+
+
+
+ bool ZE::ZTimer::IsPaused
+ (
+
+ )
+ const
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Find out paused state of timer.
Returns: Paused state for timer.
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 File Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine File List Here is a list of all documented files with brief descriptions:
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Compound Member Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine Compound Members
+a | b | c | d | e | f | g | h | i | k | l | m | o | p | q | r | s | t | u | v | w | x | y | z | ~
+
+
+Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 File Member Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine File Members
+f | u | v
+
+
+Here is a list of all documented file members with links to the documentation:
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Hierarchical Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine Class Hierarchy This inheritance list is sorted roughly, but not completely, alphabetically:
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZEngine Documentation
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine Documentation
+
+
0.8.2 Author: James Turk Version: 0.8.2 Date: January 18, 2003 http://zengine.sourceforge.net/. http://conceptofzero.net/tutorials/zengine/. http://www.conceptofzero.net/forums/index.php?act=SF&f=15 This file is Part of the ZEngine Library for 2D game development.
+ Copyright (C) 2002, 2003 James Turk
+
+ Licensed under a BSD-style license.
+
+ The maintainer of this library is James Turk (james@conceptofzero.net )
+ and the home of this Library is http://www.zengine.sourceforge.net
+
+ james@conceptofzero.net - Core Engine, Design, Docs, and Classestazar@conceptofzero.net - OpenGL assistancesean@conceptofzero.net - MSVC++6 Project FilesGenerated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 ZE Namespace Reference
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZE Namespace Reference Detailed Description
+Namespace for ZEngine classes and utility functions.
+
+
+
+
+
+
+Compounds class ZConfigFile ZConfigFile Class for use in ZEngine .More... class ZCF_Variable ZConfigFile Variable class.More... class ZCF_Section ZConfigFile Section class.More... class ZEngine Main ZEngine Singleton Class. More... class ZError ZError class for describing errors.More... class ZFont ZFont class for basic Font use.More... class ZImage ZImage class for basic Image use.More... class ZMusic ZMusic class for playing full length music (eg. ogg or wav).More... class ZObject ZObject base class for other ZEngine objects.More... class ZRect ZEngine class for simplified rectangle use.More... class ZSound ZSound class for playing sound effects. (WAV).More... class ZTimer ZTimer class for Timer use.More... Enumerations enum ZErrorCode { ZERR_NONE ,
+ZERR_SDL_INTERNAL ,
+ZERR_SDL_INIT ,
+ZERR_MIX_INIT ,
+ZERR_TTF_INIT ,
+ZERR_VIDMODE ,
+ZERR_LOAD_IMAGE ,
+ZERR_LOAD_SOUND ,
+ZERR_LOAD_MUSIC ,
+ZERR_LOAD_FONT ,
+ZERR_NOIMAGE ,
+ZERR_NOSOUND ,
+ZERR_NOMUSIC ,
+ZERR_NOFONT ,
+ZERR_LAST
+ Enumeration of ZEngine error codes. More... Functions string FormatStr (const char *fmtstr,...) Parses a string and interprets variable arguments, similar to sprintf.
+Enumeration Type Documentation
+
+
+
+
+
+
+ enum ZE::ZErrorCode
+
+
+
+
+
+
+
+
+
+
+
+
+All the error codes currently possibly by ZEngine , note that ZERR_LAST is not used as an error code, but instead as a range check on the others.
Enumeration values:
+
+ZERR_NONE
+No error has occured. ZERR_SDL_INTERNAL
+Error internal to SDL has occured, usually more detail is given by SDL. ZERR_SDL_INIT
+Error Initializing SDL. ZERR_MIX_INIT
+Error Initializing SDL_mixer. ZERR_TTF_INIT
+Error Initializing SDL_ttf. ZERR_VIDMODE
+Error setting up the display. ZERR_LOAD_IMAGE
+Error loading an image. ZERR_LOAD_SOUND
+Error loading a sound sample. ZERR_LOAD_MUSIC
+Error loading music. ZERR_LOAD_FONT
+Error loading a font. ZERR_NOIMAGE
+Error trying to use a ZImage without properly loading an image. ZERR_NOSOUND
+Error trying to use a ZSound without properly loading a sound. ZERR_NOMUSIC
+Error trying to use a ZMusic without properly loading music. ZERR_NOFONT
+Error trying to use a ZFont without properly loading a font. ZERR_LAST
+Value used as range index, not a valid error code.
+
+
+
+Function Documentation
+
+
+
+
+
+
+ string ZE::FormatStr
+ (
+ const char *
+ fmtstr ,
+
+
+ ...
+
+
+
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Takes identifiers out of fmtstr and parses them, replacing them with cooresponding values in the variable arguments list. For more detail view stdarg documentation.
Parameters:
+
+ fmtstr defines format of resulting string ... variable number of arguments after fmtstr
+ Returns: string of parsed and combined string
+
+
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Namespace Member Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine Namespace Members
+f | z
+
+
+Here is a list of all documented namespace members with links to the namespaces they belong to:
+
+ZERR_LAST
+: ZE ZERR_LOAD_FONT
+: ZE ZERR_LOAD_IMAGE
+: ZE ZERR_LOAD_MUSIC
+: ZE ZERR_LOAD_SOUND
+: ZE ZERR_MIX_INIT
+: ZE ZERR_NOFONT
+: ZE ZERR_NOIMAGE
+: ZE ZERR_NOMUSIC
+: ZE ZERR_NONE
+: ZE ZERR_NOSOUND
+: ZE ZERR_SDL_INIT
+: ZE ZERR_SDL_INTERNAL
+: ZE ZERR_TTF_INIT
+: ZE ZERR_VIDMODE
+: ZE ZErrorCode
+: ZE
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 Namespace Index
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+ZEngine Namespace List Here is a list of all documented namespaces with brief descriptions:
+Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 /include/external/physfsrwops.h Source File
+
+Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members
+/include/external/physfsrwops.h 00001
+00002
+00003
+00004
+00005
+00006
+00007
+00008
+00009
+00010
+00011
+00012
+00013
+00014
+00015
+00016
+00017
+00018
+00019
+00020
+00021
+00022 #ifndef _INCLUDE_PHYSFSRWOPS_H_
+00023 #define _INCLUDE_PHYSFSRWOPS_H_
+00024 #include <physfs.h>
+00026 #include <SDL.h>
+00027
+00038 SDL_RWops *PHYSFSRWOPS_openRead(const char *fname);
+00039
+00050 SDL_RWops *PHYSFSRWOPS_openWrite(const char *fname);
+00051
+00062 SDL_RWops *PHYSFSRWOPS_openAppend(const char *fname);
+00063
+00074 SDL_RWops *PHYSFSRWOPS_makeRWops(PHYSFS_file *handle);
+00075
+00076
+00077 #endif
+00078
+00079
+00080
+ Generated on Sat Jan 18 17:53:20 2003 for ZEngine by
+
+ 1.3-rc2 