diff --git a/doc/html/SDLGL__Util_8h-source.html b/doc/html/SDLGL__Util_8h-source.html
deleted file mode 100755
index 0e6ae40..0000000
--- a/doc/html/SDLGL__Util_8h-source.html
+++ /dev/null
@@ -1,26 +0,0 @@
-
-/include/external/SDLGL_Util.h Source File
-
-Main Page Namespace List 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 Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 /include/ZE_Defines.h Source File
-
-Main Page Namespace List 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
-00020 #ifndef __ze_defines_h__
-00021 #define __ze_defines_h__
-00022 00026 #define USE_SDL_TTF
-00027 00028 #define USE_SDL_IMAGE
-00029 00030 #define USE_SDL_MIXER
-00031 #ifdef USE_SDL_NET
-00037 namespace ZE
-00039 {
-00040
-00042 const int MAX_MSG_LEN = 10240;
-00044 typedef char ZByte;
-00045
-00046 }
-00047
-00048 #endif
-00049 #endif //__ze_defines_h__
- Generated on Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 ZE_Defines.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_Defines.h File Reference Detailed Description
-Definition file, holds #define statements describing optional features of ZEngine. ZE_Defines.h ,v 1.13 2003/05/07 18:38:43 cozman Exp $Author: James Turk
-
-
-Go to the source code of this file.
-Defines 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.
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_Includes.h Source File
-
-Main Page Namespace List 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
-00021 #ifndef __ze_includes_h__
-00022 #define __ze_includes_h__
-00023 #include "ZE_Defines.h "
-00025
-00026 #include "SDL.h"
-00027 #include "SDL_opengl.h"
-00028 #include "external/SDLGL_Util.h"
-00029 #ifdef USE_SDL_IMAGE
-00030 #include "SDL_image.h"
-00031 #endif
-00032 #ifdef USE_SDL_TTF
-00033 #include "SDL_ttf.h"
-00034 #endif
-00035 #ifdef USE_SDL_MIXER
-00036 #include "SDL_mixer.h"
-00037 #endif
-00038 #ifdef USE_SDL_NET
-00039 #include "SDL_net.h"
-00040 #endif
-00041 #ifdef USE_PHYSFS
-00042 #include "physfs.h"
-00043 #include "external/physfsrwops.h"
-00044 #endif
-00045 #include <string>
-00047 #include <queue>
-00048 #include <list>
-00049 #include <fstream>
-00050 #include <cctype>
-00051
-00052 #endif //__ze_includes_h__
- Generated on Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 ZE_Includes.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_Includes.h File Reference Detailed Description
-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. $ id: ZE_Includes.h ,v 1.8 2003/04/27 22:05:25 cozman Exp $Author: James Turk
-#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 <queue>#include <list>#include <fstream>#include <cctype>
-Go to the source code of this file.
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_Utility.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_Utility.cpp File Reference Detailed Description
-Source file containing open utilities for use inside and alongside ZEngine. Id ZE_Utility.cpp ,v 1.9 2003/06/11 05:51:15 cozman Exp Author: James Turk
-#include "ZE_Utility.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_Utility.h Source File
-
-Main Page Namespace List 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
-00022 #ifndef __ze_utility_h__
-00023 #define __ze_utility_h__
-00024 #include "ZE_Includes.h "
-00026
-00027 namespace ZE
-00028 {
-00029
-00039 std::string FormatStr (const char *fmtstr, ...);
-00040
-00042
-00044
-00051 void FreeImage (SDL_Surface *&image);
-00052
-00053 #ifdef USE_SDL_MIXER
-00054 void FreeSound (Mix_Chunk *&chunk);
-00062
-00069 void FreeMusic (Mix_Music *&music);
-00070
-00071 #endif
-00072 #ifdef USE_SDL_TTF
-00074 void FreeFont (TTF_Font *&font);
-00081 #endif
-00082 #endif //__ze_utility_h__
-00086 Generated on Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 ZE_Utility.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_Utility.h File Reference Detailed Description
-Definition file for ZEngine Utilities which are used throughout the engine and can be used in conjunction with ZEngine. Id ZE_Utility.h ,v 1.5 2003/06/11 00:15:25 cozman Exp Author: James Turk
-#include "ZE_Includes.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZClient.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZClient.cpp File Reference Detailed Description
-Implementation file for ZClient, the TCP Client class for ZEngine. Id ZE_ZClient.cpp ,v 1.11 2003/06/16 21:17:22 cozman Exp Author: James Turk
-#include "ZE_ZClient.h "
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZClient.h Source File
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZClient.h Go to the documentation of this file. 00001
-00002
-00003
-00004
-00005
-00006
-00007
-00008
-00009
-00010
-00020 #ifndef __ze_zclient_h__
-00021 #define __ze_zclient_h__
-00022 #include "ZE_ZEngine.h "
-00024
-00025 #ifdef USE_SDL_NET
-00026 namespace ZE
-00028 {
-00029
-00036 class ZClient
-00037 {
-00038 protected :
-00040 ZEngine *rEngine;
-00042 TCPsocket rSocket;
-00044 SDLNet_SocketSet rSocketSet;
-00046 bool rVerbose;
-00048 int rWaitTime;
-00049
-00050 public :
-00057 ZClient(bool verbose=false );
-00058
-00064 virtual ~ZClient();
-00065
-00074 bool Connect(char *server, Uint16 port);
-00075
-00081 void Disconnect();
-00082
-00090 void SetWaitTime(int wait);
-00091
-00100 bool Send(ZByte *data, int size);
-00101
-00109 int Receive(ZByte *data);
-00110
-00117 bool Connected();
-00118
-00125 int WaitTime();
-00126 };
-00127
-00128 }
-00129
-00130 #endif //USE_SDL_NET
-00131 #endif //__ze_zclient_h__
- Generated on Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 ZE_ZClient.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZClient.h File Reference Detailed Description
-Definition file for ZClient, the TCP Client class for ZEngine. Id ZE_ZClient.h ,v 1.6 2003/05/13 01:30:51 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZConfigFile.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZConfigFile.cpp File Reference Detailed Description
-Implementation of ZConfigFile, the ZEngine INI-Style Config File. Id ZE_ZConfigFile.cpp ,v 1.13 2003/06/16 07:45:03 cozman Exp Author: James Turk
-#include "ZE_ZConfigFile.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZConfigFile.h Source File
-
-Main Page Namespace List 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
-00021 #ifndef __ze_zconfigfile_h__
-00022 #define __ze_zconfigfile_h__
-00023 #include "ZE_ZEngine.h "
-00025
-00026 namespace ZE
-00027 {
-00028
-00034 class ZConfigFile
-00035 {
-00036 private :
-00037
-00038
-00039
-00046 class ZCF_Variable
-00047 {
-00048 public :
-00050 std::string var ;
-00052 std::string val ;
-00053 };
-00054
-00060 class ZCF_Section
-00061 {
-00062 public :
-00064 std::string section ;
-00066 std::list<ZCF_Variable> varList ;
-00067 };
-00068
-00069 protected :
-00071 std::list<ZCF_Section> rFileLayout ;
-00073 std::string rFilename ;
-00074
-00082 std::string CleanString (std::string str) const ;
-00083
-00091 bool Exists (std::string sec) const ;
-00092
-00101 bool Exists (std::string sec, std::string var) const ;
-00102
-00111 void SetVariable (std::string sec, std::string var, std::string val);
-00112
-00122 std::string GetVariable (std::string sec, std::string var, std::string defVal) const ;
-00123
-00124 public :
-00125
-00131 ZConfigFile ();
-00132
-00139 ZConfigFile (std::string filename);
-00140
-00146 virtual ~ZConfigFile ();
-00147
-00154 void Process (std::string filename);
-00155
-00166 float GetFloat (std::string section, std::string var, float defVal) const ;
-00167
-00177 int GetInt (std::string section, std::string var, int defVal) const ;
-00178
-00189 bool GetBool (std::string section, std::string var, bool defVal) const ;
-00190
-00200 std::string GetString (std::string section, std::string var, std::string defVal) const ;
-00201
-00212 void SetFloat (std::string section, std::string var, float val);
-00213
-00223 void SetInt (std::string section, std::string var, int val);
-00224
-00234 void SetBool (std::string section, std::string var, bool val);
-00235
-00245 void SetString (std::string section, std::string var, std::string val);
-00246
-00252 void Flush ();
-00253
-00259 void Close ();
-00260 };
-00261
-00262 }
-00263
-00264 #endif //__ze_zconfigfile_h__
- Generated on Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 ZE_ZConfigFile.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZConfigFile.h File Reference Detailed Description
-Definition file for ZConfigFile, an INI-style config file format.ZE_ZConfigFile.h ,v 1.9 2003/02/10 04:40:16 cozman Exp $ Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZEngine.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZEngine.cpp File Reference Detailed Description
-Actual implementation of ZEngine singleton class, the core of ZEngine. Id ZE_ZEngine.cpp ,v 1.47 2003/06/16 07:45:03 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZEngine.h Source File
-
-Main Page Namespace List 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
-00020
-00021
-00022 #ifndef __ze_zengine_h__
-00023 #define __ze_zengine_h__
-00024 #include "ZE_Defines.h "
-00026 #include "ZE_Utility.h "
-00027 #include "ZE_Includes.h "
-00028 #include "ZE_ZError.h "
-00029 #include "ZE_ZRandGen.h "
-00030 #include "VersionInfo.h "
-00031
-00037 namespace ZE
-00038 {
-00039
-00046 class ZEngine
-00047 {
-00048 public :
-00050 static VersionInfo Version ;
-00051
-00052 private :
-00054 static ZEngine *sInstance ;
-00056 int mWidth ;
-00058 int mHeight ;
-00060 int mBPP ;
-00062 bool mFullscreen ;
-00064 bool mInitialized ;
-00066 SDL_Surface *mScreen ;
-00068 bool mPaused ;
-00070 bool mUnpauseOnActive ;
-00072 Uint8 mDesiredFramerate ;
-00074 Uint32 mNextUpdate ;
-00076 Uint32 mLastPause ;
-00078 Uint32 mPausedTime ;
-00080 Uint32 mLastTime ;
-00082 double mSecPerFrame ;
-00084 bool mNeedReload ;
-00086 bool mActive ;
-00088 bool mQuit ;
-00090 Uint8 *mKeyIsPressed ;
-00092 bool mKeyPress [SDLK_LAST];
-00094 int mMouseX ;
-00096 int mMouseY ;
-00098 Uint8 mMouseB ;
-00100 std::queue<ZError> mErrorQueue ;
-00102 ZError mCurError ;
-00104 bool mLogAllErrors ;
-00106 std::FILE *mErrlog ;
-00108 SDL_EventFilter mEventFilter ;
-00110 ZRandGen mRandGen ;
-00111
-00112 #ifdef USE_SDL_MIXER
-00113 00114 int mRate ;
-00116 bool mStereo ;
-00117 #endif
-00118 private :
-00129 ZEngine ();
-00130
-00131 public :
-00132
-00139 static ZEngine * GetInstance ();
-00140
-00146 static void ReleaseInstance ();
-00147
-00149
-00151
-00162 void SetupDisplay (int width, int height, int bpp, bool fullscreen);
-00163
-00164 #ifdef USE_SDL_MIXER
-00165 void SetupSound (int rate, bool stereo);
-00174 #endif
-00175 bool CreateDisplay (std::string title, std::string icon="" );
-00188
-00194 void CloseDisplay ();
-00195
-00203 void ToggleFullscreen ();
-00204
-00212 bool Initialized ();
-00213
-00215
-00217
-00224 SDL_Surface *Display ();
-00225
-00232 void Update ();
-00233
-00243 void Clear (float red=0.0f, float green=0.0f, float blue=0.0f, float alpha=1.0f);
-00244
-00246
-00248
-00255 void SetGL2D ();
-00256
-00258
-00260
-00267 void Delay (Uint32 milliseconds);
-00268
-00275 Uint32 GetTime ();
-00276
-00282 void PauseTimer ();
-00283
-00289 void UnpauseTimer ();
-00290
-00297 double GetFrameTime ();
-00298
-00306 double GetFramerate ();
-00307
-00317 void SetDesiredFramerate (Uint8 rate);
-00318
-00326 Uint8 GetDesiredFramerate ();
-00327
-00334 bool IsPaused ();
-00335
-00337
-00339
-00346 bool IsActive ();
-00347
-00354 void RequestQuit ();
-00355
-00363 bool QuitRequested ();
-00364
-00369 void SetReloadNeed (bool state);
-00370
-00378 bool ImagesNeedReload ();
-00379
-00388 void SetKeyRepeatRate (int rate);
-00389
-00397 bool KeyIsPressed (SDLKey key);
-00398
-00406 bool KeyPress (SDLKey key);
-00407
-00413 void HideCursor ();
-00414
-00420 void ShowCursor ();
-00421
-00428 int MouseX ();
-00429
-00436 int MouseY ();
-00437
-00444 bool LButtonPressed ();
-00445
-00452 bool RButtonPressed ();
-00453
-00461 bool MouseInRect (SDL_Rect *rect);
-00462
-00468 void CheckEvents ();
-00469
-00482 void SetEventFilter (SDL_EventFilter filter);
-00483
-00484 #ifdef USE_PHYSFS
-00485 void InitPhysFS(std::string argv);
-00495
-00502 void AddPhysFSDir(std::string dir);
-00503
-00504 #endif //USE_PHYSFS
-00505 private :
-00517 void LogError (ZError error);
-00518
-00519 public :
-00530 void SetErrorLog (bool logAll, std::string logFile="" );
-00531
-00542 void ReportError (ZErrorCode code, std::string desc="" , std::string file="" , unsigned int line=0);
-00543
-00551 ZErrorCode GetLastError ();
-00552
-00560 void WriteLog (std::string str);
-00561
-00568 void FlushErrors ();
-00569
-00571
-00573
-00579 void SeedRandGen (unsigned long seed);
-00580
-00588 unsigned int Rand (unsigned int max);
-00589
-00597 unsigned long Rand (unsigned long max);
-00598
-00607 int Rand (int min, int max);
-00608
-00617 long Rand (long min, long max);
-00618
-00627 float Rand (float min, float max);
-00628
-00637 double Rand (double min, double max);
-00638
-00645 double RandDouble ();
-00646
-00648
-00650
-00657 SDL_Surface* LoadImage (std::string filename);
-00658
-00659 #ifdef USE_SDL_MIXER
-00660 LoadSound (std::string filename);
-00668
-00676 Mix_Music* LoadMusic (std::string filename);
-00677 #endif
-00678 #ifdef USE_SDL_TTF
-00680 LoadFont (std::string filename, int size);
-00689 #endif
-00690 int Width ();
-00702
-00709 int Height ();
-00710
-00717 int BPP ();
-00718
-00725 bool IsFullscreen ();
-00726 };
-00727
-00728 }
-00729
-00730 #endif //__ze_zengine_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZEngine.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZEngine.h File Reference Detailed Description
-ZEngine Game Engine core Engine definition. Id ZE_ZEngine.h ,v 1.41 2003/06/11 05:51:32 cozman Exp Author: James Turk
-#include "ZE_Defines.h "#include "ZE_Utility.h "#include "ZE_Includes.h "#include "ZE_ZError.h "#include "ZE_ZRandGen.h "#include "VersionInfo.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZError.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZError.cpp File Reference Detailed Description
-Implementation of ZError, the ZEngine internal error information storage class. Id ZE_ZError.cpp ,v 1.10 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZError.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZError.h Source File
-
-Main Page Namespace List 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
-00021 #ifndef __ze_zerror_h__
-00022 #define __ze_zerror_h__
-00023 #include "ZE_Utility.h "
-00025 #include <string>
-00026
-00027 namespace ZE
-00028 {
-00029
-00036 enum ZErrorCode
-00037 {
-00038 ZERR_NONE ,
-00039 ZERR_SDL_INTERNAL ,
-00040 ZERR_SDL_INIT ,
-00041 ZERR_MIX_INIT ,
-00042 ZERR_TTF_INIT ,
-00043 ZERR_NET_INIT ,
-00044 ZERR_VIDMODE ,
-00045 ZERR_LOAD_IMAGE ,
-00046 ZERR_LOAD_SOUND ,
-00047 ZERR_LOAD_MUSIC ,
-00048 ZERR_LOAD_FONT ,
-00049 ZERR_NOIMAGE ,
-00050 ZERR_NOSOUND ,
-00051 ZERR_NOMUSIC ,
-00052 ZERR_NOFONT ,
-00053 ZERR_NOSOCKET ,
-00054 ZERR_NET_CLIENT ,
-00055 ZERR_NET_SERVER ,
-00056 ZERR_LAST
-00057 };
-00058
-00065 class ZError
-00066 {
-00067 protected :
-00069 static std::string sErrorDesc [ZERR_LAST ];
-00071 ZErrorCode rCode ;
-00073 std::string rDescription ;
-00075 std::string rFilename ;
-00077 unsigned int rLine ;
-00078
-00079 public :
-00085 static void CreateStringTable ();
-00086
-00096 ZError (ZErrorCode code=ZERR_NONE, std::string desc="" , std::string file="" , int line=0);
-00097
-00107 void Create (ZErrorCode code, std::string desc="" , std::string file="" , int line=0);
-00108
-00110
-00112
-00119 ZErrorCode Code () const ;
-00120
-00126 std::string LogString () const ;
-00127 };
-00128
-00129 }
-00130
-00131 #endif //__ze_zerror_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZError.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZError.h File Reference Detailed Description
-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. Id ZE_ZError.h ,v 1.12 2003/06/11 05:51:32 cozman Exp Author: James Turk
-#include "ZE_Utility.h "#include <string>
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZFont.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZFont.cpp File Reference Detailed Description
-Implementation of ZFont, the basic Font class for ZEngine. Id ZE_ZFont.cpp ,v 1.12 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZFont.h "
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZFont.h Source File
-
-Main Page Namespace List 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
-00020 #ifndef __ze_zfont_h__
-00021 #define __ze_zfont_h__
-00022 #include "ZE_ZEngine.h "
-00024 #include "ZE_ZImage.h "
-00025
-00026 #ifdef USE_SDL_TTF
-00027 namespace ZE
-00029 {
-00030
-00036 class ZFont
-00037 {
-00038 protected :
-00040 ZEngine * rEngine ;
-00042 TTF_Font *rFont ;
-00044 std::string rFilename ;
-00046 SDL_Color rColor ;
-00048 SDL_Color rBGColor ;
-00049
-00050 public :
-00051
-00053
-00055
-00061 ZFont ();
-00062
-00070 ZFont (std::string filename, int size);
-00071
-00077 virtual ~ZFont ();
-00078
-00086 void Open (std::string filename, int size);
-00087
-00093 void Release ();
-00094
-00096
-00098
-00106 void DrawText (std::string text, ZImage &image) const ;
-00107
-00115 void DrawShadedText (std::string text, ZImage &image) const ;
-00116
-00126 void SetColor (Uint8 r, Uint8 g, Uint8 b, Uint8 a=255);
-00127
-00136 void SetBGColor (Uint8 r, Uint8 g, Uint8 b);
-00137
-00146 void SetStyle (bool bold, bool italic, bool underline);
-00147
-00154 void Resize (int size);
-00155
-00157
-00159
-00166 bool IsLoaded () const ;
-00167
-00174 bool IsBold () const ;
-00175
-00182 bool IsItalic () const ;
-00183
-00190 bool IsUnderlined () const ;
-00191
-00198 int Height () const ;
-00199
-00206 int LineSkip () const ;
-00207
-00215 int StringWidth (std::string text) const ;
-00216
-00224 int StringHeight (std::string text) const ;
-00225 };
-00226
-00227 }
-00228
-00229 #endif //USE_SDL_TTF
-00230 #endif //__ze_zfont_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZFont.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZFont.h File Reference Detailed Description
-Definition file for ZFont, the basic Font class for ZEngine. Author: James Turk
-#include "ZE_ZEngine.h "#include "ZE_ZImage.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZImage.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZImage.cpp File Reference Detailed Description
-Implementation of ZImage, the Image class for ZEngine. Id ZE_ZImage.cpp ,v 1.35 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZImage.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZImage.h Source File
-
-Main Page Namespace List 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
-00020 #ifndef __ze_zimage_h__
-00021 #define __ze_zimage_h__
-00022 #include "ZE_ZEngine.h "
-00024
-00025 namespace ZE
-00026 {
-00027
-00033 class ZImage
-00034 {
-00035 protected :
-00037 ZEngine * rEngine ;
-00039 GLfloat rTexMinX ;
-00041 GLfloat rTexMinY ;
-00043 GLfloat rTexMaxX ;
-00045 GLfloat rTexMaxY ;
-00047 SDL_Surface *rImage ;
-00049 unsigned int rTexID ;
-00051 unsigned int rWidth ;
-00053 unsigned int rHeight ;
-00055 Uint8 rAlpha ;
-00056
-00057 public :
-00058
-00064 ZImage ();
-00065
-00072 ZImage (const ZImage &rhs);
-00073
-00080 ZImage (std::string filename);
-00081
-00088 ZImage (SDL_Surface *surface);
-00089
-00101 ZImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
-00102
-00114 ZImage (const ZImage &img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
-00115
-00121 virtual ~ZImage ();
-00122
-00124
-00126
-00133 void Open (std::string filename);
-00134
-00146 void OpenFromImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
-00147
-00159 void OpenFromImage (const ZImage &img, Sint16 x, Sint16 y, Sint16 w, Sint16 h);
-00160
-00167 void Attach (SDL_Surface *surface);
-00168
-00174 void Reload ();
-00175
-00181 void Release ();
-00182
-00184
-00186
-00194 void SetAlpha (Uint8 alpha);
-00195
-00204 void SetColorKey (Uint8 red, Uint8 green, Uint8 blue);
-00205
-00213 void Flip (bool horizontal, bool vertical);
-00214
-00222 void Stretch (float xFactor, float yFactor);
-00223
-00231 void Resize (unsigned int width, unsigned int height);
-00232
-00239 void Bind () const ;
-00240
-00250 void Draw (int x, int y, Uint8 zIndex=0) const ;
-00251
-00261 void Draw (float x, float y, Uint8 zIndex=0) const ;
-00262
-00272 void DrawRotated (int x, int y, float angle, Uint8 zIndex=0) const ;
-00273
-00284 void DrawRotated (float x, float y, float angle, Uint8 zIndex=0) const ;
-00285
-00287
-00289
-00296 bool IsLoaded () const ;
-00297
-00303 SDL_Surface *Surface () const ;
-00304
-00311 int Width () const ;
-00312
-00319 int Height () const ;
-00320
-00328 Uint8 Alpha () const ;
-00329 };
-00330
-00331 }
-00332
-00333 #endif
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZImage.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZImage.h File Reference Detailed Description
-Definition file for ZImage, the OpenGL version of the ZImage class for ZEngine. Id ZE_ZImage.h ,v 1.19 2003/06/11 00:15:26 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZMusic.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZMusic.cpp File Reference Detailed Description
-Implementation of ZMusic, the basic Music class for ZEngine. Id ZE_ZMusic.cpp ,v 1.10 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZMusic.h "
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZMusic.h Source File
-
-Main Page Namespace List 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
-00020 #ifndef __ze_zmusic_h__
-00021 #define __ze_zmusic_h__
-00022 #include "ZE_ZEngine.h "
-00024
-00025 #ifdef USE_SDL_MIXER
-00026 namespace ZE
-00028 {
-00029
-00035 class ZMusic
-00036 {
-00037 protected :
-00039 ZEngine * rEngine ;
-00041 Mix_Music *rMusic ;
-00042
-00043 public :
-00045 static const int LoopInfinite ;
-00046
-00048
-00050
-00056 ZMusic ();
-00057
-00064 ZMusic (std::string filename);
-00065
-00071 virtual ~ZMusic ();
-00072
-00079 void Open (std::string filename);
-00080
-00086 void Release ();
-00087
-00089
-00091
-00100 void Play (int loopNum=0, int fadeTime=0) const ;
-00101
-00107 void Pause () const ;
-00108
-00114 void Unpause () const ;
-00115
-00121 void Rewind () const ;
-00122
-00129 void Stop (int fadeTime=0) const ;
-00130
-00137 void SetVolume (int volume);
-00138
-00140
-00142
-00149 bool IsLoaded () const ;
-00150
-00157 bool IsPlaying () const ;
-00158
-00165 bool IsPaused () const ;
-00166
-00173 int Volume () const ;
-00174 };
-00175
-00176
-00177 }
-00178
-00179 #endif //USE_SDL_MIXER
-00180 #endif //__ze_zmusic_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZMusic.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZMusic.h File Reference Detailed Description
-Definition file for ZMusic, the Music file wrapper for ZEngine. Id ZE_ZMusic.h ,v 1.9 2003/06/11 00:15:26 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZRect.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZRect.cpp File Reference Detailed Description
-Implementation of ZRect, the Rectangle class for ZEngine. Id ZE_ZRect.cpp ,v 1.12 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZRect.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZRect.h Source File
-
-Main Page Namespace List 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
-00020 #ifndef __ze_zrect_h__
-00021 #define __ze_zrect_h__
-00022 #include "ZE_ZEngine.h "
-00024
-00025 namespace ZE
-00026 {
-00027
-00033 class ZRect
-00034 {
-00035 protected :
-00037 float rX ;
-00039 float rY ;
-00041 float rWidth ;
-00043 float rHeight ;
-00044
-00045 public :
-00046
-00052 ZRect ();
-00053
-00063 ZRect (float x, float y, float width, float height);
-00064
-00071 ZRect (const SDL_Rect &rect);
-00072
-00079 ZRect (const ZRect &rhs);
-00080
-00088 const ZRect & operator= (const ZRect &rhs);
-00089
-00095 virtual ~ZRect ();
-00096
-00105 bool operator< (const ZRect &rhs) const ;
-00106
-00116 void Draw (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) const ;
-00117
-00125 void Move (float x, float y);
-00126
-00134 void MoveRel (float xMove, float yMove);
-00135
-00143 void Resize (float width, float height);
-00144
-00152 void ResizeRel (float widthChange, float heightChange);
-00153
-00161 bool Intersects (const ZRect &rect) const ;
-00162
-00171 bool Contains (float x, float y) const ;
-00172
-00180 bool Contains (const ZRect &rect) const ;
-00181
-00189 ZRect Intersection (const ZRect &rect) const ;
-00190
-00197 SDL_Rect SDLrect () const ;
-00198
-00205 float X () const ;
-00206
-00213 float Y () const ;
-00214
-00221 float Left () const ;
-00222
-00229 float Right () const ;
-00230
-00237 float Top () const ;
-00238
-00245 float Bottom () const ;
-00246
-00253 float Width () const ;
-00254
-00261 float Height () const ;
-00262 };
-00263
-00264 }
-00265
-00266 #endif //__ze_zrect_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZRect.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZRect.h File Reference Detailed Description
-Definition file for ZRect, the Rectangle class for ZEngine. Id ZE_ZRect.h ,v 1.11 2003/05/13 01:30:51 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZServer.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZServer.cpp File Reference Detailed Description
-Implementation file for ZServer, the TCP Server class for ZEngine. Id ZE_ZServer.cpp ,v 1.7 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZServer.h "
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZServer.h Source File
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZServer.h Go to the documentation of this file. 00001
-00002
-00003
-00004
-00005
-00006
-00007
-00008
-00009
-00010
-00020 #ifndef __ze_zserver_h__
-00021 #define __ze_zserver_h__
-00022 #include "ZE_ZEngine.h "
-00024
-00025 #ifdef USE_SDL_NET
-00026 namespace ZE
-00028 {
-00029
-00037 class ZServer
-00038 {
-00039 private :
-00041 ZEngine *rEngine;
-00043 TCPsocket rSocket;
-00045 SDLNet_SocketSet rSocketSet;
-00047 TCPsocket *rClientSockets;
-00049 int rMaxClients;
-00051 bool rVerbose;
-00053 int rWaitTime;
-00054
-00061 void CloseSocket(int num);
-00062
-00063 public :
-00070 ZServer(bool verbose=false );
-00071
-00077 virtual ~ZServer();
-00078
-00087 bool Start(int maxClients, Uint16 port);
-00088
-00094 void Stop();
-00095
-00103 void SetWaitTime(int wait);
-00104
-00111 void CheckSockets();
-00112
-00119 int Clients();
-00120
-00127 int WaitTime();
-00128 };
-00129
-00130 }
-00131
-00132 #endif //USE_SDL_NET
-00133 #endif //__ze_zserver_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZServer.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZServer.h File Reference Detailed Description
-Definition file for ZServer, the TCP Server class for ZEngine. Id ZE_ZServer.h ,v 1.7 2003/05/13 01:30:51 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZSound.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZSound.cpp File Reference Detailed Description
-Implementation of ZSound, the basic Sound class for ZEngine. Id ZE_ZSound.cpp ,v 1.10 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZSound.h "
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZSound.h Source File
-
-Main Page Namespace List 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
-00020 #ifndef __ze_zsound_h__
-00021 #define __ze_zsound_h__
-00022 #include "ZE_ZEngine.h "
-00024
-00025 #ifdef USE_SDL_MIXER
-00026 namespace ZE
-00028 {
-00029
-00035 class ZSound
-00036 {
-00037 protected :
-00039 ZEngine * rEngine ;
-00041 Mix_Chunk* rSound ;
-00043 int rChannelID ;
-00044
-00045 public :
-00047 static const int LoopInfinite ;
-00048
-00050
-00052
-00058 ZSound ();
-00059
-00066 ZSound (std::string filename);
-00067
-00073 virtual ~ZSound ();
-00074
-00081 void Open (std::string filename);
-00082
-00088 void Release ();
-00089
-00091
-00093
-00102 void Play (int loopNum=0, int fadeTime=0);
-00103
-00109 void Pause () const ;
-00110
-00116 void Unpause () const ;
-00117
-00124 void Stop (int fadeTime=0) const ;
-00125
-00132 void SetVolume (int volume);
-00133
-00135
-00137
-00144 bool IsLoaded () const ;
-00145
-00152 bool IsPlaying () const ;
-00153
-00160 bool IsPaused () const ;
-00161
-00168 int Volume () const ;
-00169 };
-00170
-00171
-00172 }
-00173
-00174 #endif //USE_SDL_MIXER
-00175 #endif //__ze_zsound_h__
- Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZSound.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZSound.h File Reference Detailed Description
-Definition file for ZSound, the Sound Effect wrapper for ZEngine. Id ZE_ZSound.h ,v 1.9 2003/06/11 00:15:26 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZTimer.cpp File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/src/ZE_ZTimer.cpp File Reference Detailed Description
-Implementation of ZTimer, the basic Timer class for ZEngine. Id ZE_ZTimer.cpp ,v 1.9 2003/06/11 05:51:16 cozman Exp Author: James Turk
-#include "ZE_ZTimer.h "
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZE_ZTimer.h Source File
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZTimer.h Go to the documentation of this file. Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE_ZTimer.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZE_ZTimer.h File Reference Detailed Description
-Definition file for ZTimer, the Timer class for ZEngine. Id ZE_ZTimer.h ,v 1.8 2003/05/13 01:30:51 cozman Exp Author: James Turk
-#include "ZE_ZEngine.h "
-Go to the source code of this file.
-Namespaces namespace ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/ZEngine.h Source File
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZEngine.h Go to the documentation of this file. Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZEngine.h File Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/ZEngine.h File Reference Detailed Description
-Header file for ZEngine Game Engine from Concept of Zero, this is the file that programs that wish to utilize ZEngine should include. Id ZEngine.h ,v 1.26 2003/05/13 01:30:51 cozman Exp Author: James Turk
-#include "ZE_Defines.h "#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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Annotated Index
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZClient Member List This is the complete list of members for ZE::ZClient , including all inherited members.Generated on Sun Apr 27 22:34:35 2003 for ZEngine by
-
- 1.3-rc2 ZE::ZClient class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZClient Class Reference #include <ZE_ZClient.h >
-
-List of all members.
Detailed Description
-ZClient net client class, used to create a simple TCP game client for use with ZServer . Since: 0.8.3
-
-Public Methods ZClient (bool verbose=false) Default Constructor. virtual ~ZClient () Destructor, disconnects and frees memory. bool Connect (char *server, Uint16 port) Connects to a server on a given port. void Disconnect () Disconnect client. void SetWaitTime (int wait) Sets wait time for recieves. bool Send (ZByte *data, int size) Send data too connected server. int Receive (ZByte *data) Recieve data if available. bool Connected () Return connected state. int WaitTime () Gets current wait time. Protected Attributes ZEngine * rEngine Pointer to ZEngine Object. rSocket SDL_net socket for connection. rSocketSet Socket set for connection. rVerbose Verbose setting for connection logs. rWaitTime Wait timeout setting for recieves on connection. [Defaults to 0.].
-Constructor & Destructor Documentation
-
-
-
-
-
-
- ZE::ZClient::ZClient
- (
- bool
- verbose = false
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Default Constructor, does basic initialization. If verbose is true connection data will be added to log file.
Parameters:
-
- verbose Sets verbose setting of client. [Defaults to false.]
-
-
-
-
-
-
-
-
-
- virtual ZE::ZClient::~ZClient
- (
-
- )
- [virtual]
-
-
-
-
-
-
-Member Function Documentation
-
-
-
-
-
-
- bool ZE::ZClient::Connect
- (
- char *
- server ,
-
-
- Uint16
- port
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Connects to a server (given in dotted ip form) on a given port.
Parameters:
-
- server Dotted IP address to connect to. port Port number to connect to.
- Returns: true if connected, false otherwise.
-
-
-
-
-
-
-
-
- void ZE::ZClient::Disconnect
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Disconnect from server if connected.
-
-
-
-
-
-
-
-
- void ZE::ZClient::SetWaitTime
- (
- int
- wait
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Sets wait time in milliseconds , time which ZClient::Recieve will wait before returning if there is no data. Before this is called for the first time WaitTime is 0.
Parameters:
-
-
-
-
-
-
-
-
-
-
- bool ZE::ZClient::Send
- (
- ZByte * data ,
-
-
- int
- size
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Sends data to server if available.
Parameters:
-
- data Pointer to data buffer to send. size Size of data buffer. (Can't be larger than MAX_MSG_LEN as defined in ZE_Defines.h )
- Returns: True if data could be sent, false upon error.
-
-
-
-
-
-
-
-
- int ZE::ZClient::Receive
- (
- ZByte * data
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Recieves data from server if available, waiting for timeout period if no data is pending.
Parameters:
-
- data Pointer to buffer to store data in. (Must be large enough, needs not be more than MAX_MSG_LEN as defined in ZE_Defines.h )
- Returns: Size of recieved data stored to buffer. (<MAX_MSG_LEN)
-
-
-
-
-
-
-
-
- bool ZE::ZClient::Connected
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns state of connection.
Returns: true if connected, false otherwise
-
-
-
-
-
-
-
-
- int ZE::ZClient::WaitTime
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Gets amount of time in milliseconds that is specified to wait for data on Recieve.
Returns: Wait time.
-
-
-Generated on Sun Apr 27 22:34:35 2003 for ZEngine by
-
- 1.3-rc2 Member List
-
-Main Page Namespace List 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 (std::string str) constZE::ZConfigFile [protected]Close ()ZE::ZConfigFile Exists (std::string sec) constZE::ZConfigFile [protected]Exists (std::string sec, std::string var) constZE::ZConfigFile [protected]Flush ()ZE::ZConfigFile GetBool (std::string section, std::string var, bool defVal) constZE::ZConfigFile GetFloat (std::string section, std::string var, float defVal) constZE::ZConfigFile GetInt (std::string section, std::string var, int defVal) constZE::ZConfigFile GetString (std::string section, std::string var, std::string defVal) constZE::ZConfigFile GetVariable (std::string sec, std::string var, std::string defVal) constZE::ZConfigFile [protected]Process (std::string filename)ZE::ZConfigFile rFileLayout ZE::ZConfigFile [protected]rFilename ZE::ZConfigFile [protected]SetBool (std::string section, std::string var, bool val)ZE::ZConfigFile SetFloat (std::string section, std::string var, float val)ZE::ZConfigFile SetInt (std::string section, std::string var, int val)ZE::ZConfigFile SetString (std::string section, std::string var, std::string val)ZE::ZConfigFile SetVariable (std::string sec, std::string var, std::string val)ZE::ZConfigFile [protected]ZConfigFile ()ZE::ZConfigFile ZConfigFile (std::string filename)ZE::ZConfigFile ~ZConfigFile ()ZE::ZConfigFile [virtual]
Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZConfigFile class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZConfigFile Class Reference #include <ZE_ZConfigFile.h >
-
-List of all members.
Detailed Description
-ZConfigFile class for INI-style configuration files for games or applications. Inherited from ZObject.
-
-
-Public Member Functions ZConfigFile () Default constructor. ZConfigFile (std::string filename) Constructor which takes filename. virtual ~ZConfigFile () Destructor, flushes file. void Process (std::string filename) Parse a file. float GetFloat (std::string section, std::string var, float defVal) const Get value in floating point format from file. int GetInt (std::string section, std::string var, int defVal) const Get value in integer format from file. bool GetBool (std::string section, std::string var, bool defVal) const Get value in boolean format from file. std::string GetString (std::string section, std::string var, std::string defVal) const Get value in std::string format from file. void SetFloat (std::string section, std::string var, float val) Set value in floating point format in file. void SetInt (std::string section, std::string var, int val) Set value in integer format in file. void SetBool (std::string section, std::string var, bool val) Set value in boolean format in file. void SetString (std::string section, std::string var, std::string val) Set value in std::string format in file. void Flush () Write all values to file. void Close () Close the file. Protected Member Functions std::string CleanString (std::string str) const Reformat a std::string in a form more suitable to parsing. bool Exists (std::string sec) const Check if a section exists. bool Exists (std::string sec, std::string var) const Check if a variable exists. void SetVariable (std::string sec, std::string var, std::string val) Internal function to set variables. std::string GetVariable (std::string sec, std::string var, std::string defVal) const Internal function to get value of a variable. Protected Attributes ZCF_Section > rFileLayout List of sections of internal type. rFilename Filename of file currently open.
-Constructor & Destructor Documentation
-
-
-
-
-
-
- ZE::ZConfigFile::ZConfigFile
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-A no-op default constructor.
-
-
-
-
-
-
-
-
- ZE::ZConfigFile::ZConfigFile
- (
- std::string
- filename
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor takes filename, and calls process on it.
Parameters:
-
-
-
-
-
-
-
-
-
-
- ZE::ZConfigFile::~ZConfigFile
- (
-
- )
- [virtual]
-
-
-
-
-
-
-
-
-
-
-
-
-
-Flushes the file, ensures a flush if the file is left open.
-
-
-Member Function Documentation
-
-
-
-
-
-
- std::string ZE::ZConfigFile::CleanString
- (
- std::string
- str
- )
- const [protected]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Removes whitespace from a std::string and makes all characters lowercase.
Parameters:
-
- str The std::string to get a clean version of.
- Returns: Cleaned std::string.
-
-
-
-
-
-
-
-
- bool ZE::ZConfigFile::Exists
- (
- std::string
- sec
- )
- const [protected]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-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
- (
- std::string
- sec ,
-
-
- std::string
- var
-
-
- )
- const [protected]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-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
- (
- std::string
- sec ,
-
-
- std::string
- var ,
-
-
- std::string
- val
-
-
- )
- [protected]
-
-
-
-
-
-
-
-
-
-
-
-
-
-Set variable to value, called internally only.
Parameters:
-
- sec Section for variable. var Variable to set. val Value to set variable to.
-
-
-
-
-
-
-
-
-
- std::string ZE::ZConfigFile::GetVariable
- (
- std::string
- sec ,
-
-
- std::string
- var ,
-
-
- std::string
- defVal
-
-
- )
- const [protected]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-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
- (
- std::string
- filename
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Parses the file, reading the contents into the fileLayout map.
Parameters:
-
- filename File to parse and attach this ZDataFile to.
-
-
-
-
-
-
-
-
-
- float ZE::ZConfigFile::GetFloat
- (
- std::string
- section ,
-
-
- std::string
- var ,
-
-
- float
- defVal
-
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get the current value of a variable in the file, or defVal if not found in file.
Since: 0.8.3 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 floating point format.
-
-
-
-
-
-
-
-
- int ZE::ZConfigFile::GetInt
- (
- std::string
- section ,
-
-
- std::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
- (
- std::string
- section ,
-
-
- std::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.
-
-
-
-
-
-
-
-
- std::string ZE::ZConfigFile::GetString
- (
- std::string
- section ,
-
-
- std::string
- var ,
-
-
- std::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 std::string format.
-
-
-
-
-
-
-
-
- void ZE::ZConfigFile::SetFloat
- (
- std::string
- section ,
-
-
- std::string
- var ,
-
-
- float
- val
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Set the new value of a variable in the file to val, creating the section and variable if not already found in file.
Since: 0.8.3 Parameters:
-
- section Name of section to edit variable under. var Name of variable to set value for. val Floating point value to set variable to in file.
-
-
-
-
-
-
-
-
-
- void ZE::ZConfigFile::SetInt
- (
- std::string
- section ,
-
-
- std::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
- (
- std::string
- section ,
-
-
- std::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
- (
- std::string
- section ,
-
-
- std::string
- var ,
-
-
- std::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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZConfigFile::ZCF_Section class Reference
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZConfigFile::ZCF_Variable class Reference
-
-Main Page Namespace List 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 std::string form (later converted to bool or int if needed).
-
-
-Public Attributes var Variable name. val Value associated with variable.
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 (std::string title, std::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 Height ()ZE::ZEngine HideCursor ()ZE::ZEngine ImagesNeedReload ()ZE::ZEngine Initialized ()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 (std::string filename, int size)ZE::ZEngine LoadImage (std::string filename)ZE::ZEngine LoadMusic (std::string filename)ZE::ZEngine LoadSound (std::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]mEventFilter ZE::ZEngine [private]mFullscreen ZE::ZEngine [private]mHeight ZE::ZEngine [private]mInitialized 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]mRandGen 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 Rand (unsigned int max)ZE::ZEngine Rand (unsigned long max)ZE::ZEngine Rand (int min, int max)ZE::ZEngine Rand (long min, long max)ZE::ZEngine Rand (float min, float max)ZE::ZEngine Rand (double min, double max)ZE::ZEngine RandDouble ()ZE::ZEngine RButtonPressed ()ZE::ZEngine ReleaseInstance ()ZE::ZEngine [static]ReportError (ZErrorCode code, std::string desc="", std::string file="", unsigned int line=0)ZE::ZEngine RequestQuit ()ZE::ZEngine SeedRandGen (unsigned long seed)ZE::ZEngine SetDesiredFramerate (Uint8 rate)ZE::ZEngine SetErrorLog (bool logAll, std::string logFile="")ZE::ZEngine SetEventFilter (SDL_EventFilter filter)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]ToggleFullscreen ()ZE::ZEngine UnpauseTimer ()ZE::ZEngine Update ()ZE::ZEngine Version ZE::ZEngine [static]Width ()ZE::ZEngine WriteLog (std::string str)ZE::ZEngine ZEngine ()ZE::ZEngine [private]
Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZEngine class Reference
-
-Main Page Namespace List 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 and OpenGL wrapping.
-
-
-Public Member Functions 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 (std::string title, std::string icon="") Create Display with predefined settings. void CloseDisplay () Quit SDL and any Subsystems. void ToggleFullscreen () Toggle fullscreen/windowed mode. bool Initialized () Check state of ZEngine . 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 SetEventFilter (SDL_EventFilter filter) Add a SDL Event Filter for user processing of events. void SetErrorLog (bool logAll, std::string logFile="") Modify Error Logging. void ReportError (ZErrorCode code, std::string desc="", std::string file="", unsigned int line=0) Report an error. ZErrorCode GetLastError () Get the last error. void WriteLog (std::string str) Write to the log. void FlushErrors () Flush Stack of Errors to file. void SeedRandGen (unsigned long seed) Seed random number generator. unsigned int Rand (unsigned int max) Obtain random integer [0,max). unsigned long Rand (unsigned long max) Obtain random integer [0,max). int Rand (int min, int max) Obtain random integer [min,max]. long Rand (long min, long max) Obtain random integer [min,max]. float Rand (float min, float max) Obtain random integer [min,max]. double Rand (double min, double max) Obtain random integer [min,max]. double RandDouble () Obtain random double [0,1). SDL_Surface * LoadImage (std::string filename) Load an Image. Mix_Chunk * LoadSound (std::string filename) Load a Sound. Mix_Music * LoadMusic (std::string filename) Load a Music File. TTF_Font * LoadFont (std::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 Member Functions ZEngine * GetInstance () Get Instance. void ReleaseInstance () Release Instance. Static Public Attributes VersionInfo Version Static version information. Private Member Functions 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. mInitialized If ZEngine display has been setup. 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. mEventFilter Event filter, for users who need to process their own events. ZRandGen mRandGen Random Generator for general use. mRate Sound Bitrate. mStereo Stereo setting of Sound Subsystem. 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.
-
-
-
-
-
-
-
-
- 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, generally use 8,16 or 32, pass -1 if you want ZEngine to guess the best choice. fullscreen A bool for fullscreen setting.
-
-
-
-
-
-
-
-
-
- void ZE::ZEngine::SetupSound
- (
- int
- rate ,
-
-
- bool
- stereo
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Set sound settings to specified parameters. (If not called before CreateDisplay rate will default to 22050+mono)
-
Parameters:
-
- rate Desired sound bitrate. stereo A bool for stereo setting.
-
-
-
-
-
-
-
-
-
- bool ZE::ZEngine::CreateDisplay
- (
- std::string
- title ,
-
-
- std::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 for OS. Returns result of setting up ZEngine , and logs error if false is returned (Trys not to fail + returns bool in versions >= 0.8.2).
-
Parameters:
-
- title Window Title. icon Path to Icon File.
- Returns: result of setting up the display, true if everything went ok, false if any setup failed (check GetLastError).
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- void ZE::ZEngine::ToggleFullscreen
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Safely toggles fullscreen/windowed mode, generally toggling modes will bring the need to reload images so it will set the ImagesNeedReload state to true.
Since: 0.8.2
-
-
-
-
-
-
-
-
- bool ZE::ZEngine::Initialized
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Checks if ZEngine display has been properly setup.
Since: 0.8.2 Returns: Boolean status of ZEngine , true if CreateDisplay has been successfully called, false if ZEngine has no display.
-
-
-
-
-
-
-
-
- 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. 0 to disable. If 2 different values are needed 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::SetEventFilter
- (
- SDL_EventFilter
- filter
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-This is only needed when you need tight control with ZEngine . The parameter processed as if it were passed to SDL_SetEventFilter, generally only those with a good amount of SDL experience should use this function or ZEngine's internal message state could be corrupted. For more information on SDL_SetEventFilter see http://sdldoc.csn.ul.ie/sdlseteventfilter.php. (FYI: The parameter is now actually processed in check events, not passed to the SDL function, this is done because of problems with singletons and event threading.)
Since: 0.8.2 Parameters:
-
- filter An SDL_EventFilter (A function that takes a const SDL_Event* and returns 0 if the event should be removed from the event queue and 1 otherwise.)
-
-
-
-
-
-
-
-
-
- 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 ,
-
-
- std::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 ,
-
-
- std::string
- desc = "",
-
-
- std::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 std::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
- (
- std::string
- str
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Write a std::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
-
-
-
-
-
-
-
-
- void ZE::ZEngine::SeedRandGen
- (
- unsigned long
- seed
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Reseed Mersenne Twister random number generator. NOTE: Generator is initialized upon creation of object using time.
Parameters:
-
- seed Seed for random sequence.
-
-
-
-
-
-
-
-
-
- unsigned int ZE::ZEngine::Rand
- (
- unsigned int
- max
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random int l where 0 <= l < max.
Parameters:
-
- max Limit for random number.
- Returns: Random unsigned int.
-
-
-
-
-
-
-
-
- unsigned long ZE::ZEngine::Rand
- (
- unsigned long
- max
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random long l where 0 <= l < max.
Parameters:
-
- max Limit for random number.
- Returns: Random unsigned long.
-
-
-
-
-
-
-
-
- int ZE::ZEngine::Rand
- (
- int
- min ,
-
-
- int
- max
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random int l where min <= l <= max.
Parameters:
-
- min Lower limit for random number. max Upper limit for random number.
- Returns: Random int.
-
-
-
-
-
-
-
-
- long ZE::ZEngine::Rand
- (
- long
- min ,
-
-
- long
- max
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random long l where min <= l <= max.
Parameters:
-
- min Lower limit for random number. max Upper limit for random number.
- Returns: Random long.
-
-
-
-
-
-
-
-
- float ZE::ZEngine::Rand
- (
- float
- min ,
-
-
- float
- max
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random float l where min <= l <= max.
Parameters:
-
- min Lower limit for random number. max Upper limit for random number.
- Returns: Random float.
-
-
-
-
-
-
-
-
- double ZE::ZEngine::Rand
- (
- double
- min ,
-
-
- double
- max
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random double l where min <= l <= max.
Parameters:
-
- min Lower limit for random number. max Upper limit for random number.
- Returns: Random double.
-
-
-
-
-
-
-
-
- double ZE::ZEngine::RandDouble
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Obtain random double d where 0 <= d < 1.
Returns: Random double [0,1).
-
-
-
-
-
-
-
-
- SDL_Surface * ZE::ZEngine::LoadImage
- (
- std::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
- (
- std::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
- (
- std::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
- (
- std::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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZError class Reference
-
-Main Page Namespace List 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 Member Functions ZError (ZErrorCode code=ZERR_NONE, std::string desc="", std::string file="", int line=0) Default constructor for ZError . void Create (ZErrorCode code, std::string desc="", std::string file="", int line=0) Set members of error object. ZErrorCode Code () const Get ZErrorCode of error. std::string LogString () const Get formatted string for log file. Static Public Member Functions void CreateStringTable () Construct string table for error strings. Protected Attributes ZErrorCode rCode Error ID. rDescription Error Description. rFilename File which error occured in. rLine Line which error occured on. Static Protected Attributes sErrorDesc [ZERR_LAST] Static Array of Error Identifiers.
-Constructor & Destructor Documentation
-
-
-
-
-
-
- ZE::ZError::ZError
- (
- ZErrorCode code = ZERR_NONE,
-
-
- std::string
- desc = "",
-
-
- std::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::CreateStringTable
- (
-
- )
- [static]
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructs a string table for errors, enabling ZEngine to properly delete the table on exit.
-
-
-
-
-
-
-
-
- void ZE::ZError::Create
- (
- ZErrorCode code ,
-
-
- std::string
- desc = "",
-
-
- std::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.
-
-
-
-
-
-
-
-
- std::string ZE::ZError::LogString
- (
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Return the string to be written to the logfile. Called by ZEngine in LogError.
-
-
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 (std::string text, ZImage &image) constZE::ZFont DrawText (std::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 (std::string filename, int size)ZE::ZFont rBGColor ZE::ZFont [protected]rColor ZE::ZFont [protected]Release ()ZE::ZFont rEngine ZE::ZFont [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, Uint8 a=255)ZE::ZFont SetStyle (bool bold, bool italic, bool underline)ZE::ZFont StringHeight (std::string text) constZE::ZFont StringWidth (std::string text) constZE::ZFont ZFont ()ZE::ZFont ZFont (std::string filename, int size)ZE::ZFont ~ZFont ()ZE::ZFont [virtual]
Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZFont class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZFont Class Reference #include <ZE_ZFont.h >
-
-List of all members.
Detailed Description
-ZFont font container class, class wraps common features of SDL_TTF.
-
-
-Public Member Functions ZFont () Default Constructor. ZFont (std::string filename, int size) Constructor that opens a font with a certain size. virtual ~ZFont () Destructor, frees memory. void Open (std::string filename, int size) Opens a font with a certain size. void Release () Release font. void DrawText (std::string text, ZImage &image) const Draws a std::string in a color to a ZImage . void DrawShadedText (std::string text, ZImage &image) const Draws a std::string with a colored background to a ZImage . void SetColor (Uint8 r, Uint8 g, Uint8 b, Uint8 a=255) 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 (std::string text) const Get String Width. int StringHeight (std::string text) const Get String Height. Protected Attributes ZEngine * rEngine Pointer to ZEngine Object. 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
- (
- std::string
- filename ,
-
-
- int
- size
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor simply calls ZFont::Open() with same parameters.
Parameters:
-
- filename Font to open. size Size to use for font.
-
-
-
-
-
-
-
-
-
- virtual ZE::ZFont::~ZFont
- (
-
- )
- [virtual]
-
-
-
-
-
-
-Member Function Documentation
-
-
-
-
-
-
- void ZE::ZFont::Open
- (
- std::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
- (
- std::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
- (
- std::string
- text ,
-
-
- ZImage & image
-
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Draw to a surface a std::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 ,
-
-
- Uint8
- a = 255
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-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). a Alpha component of drawn font, including background if present. (0-255) (Optional, defaults to 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
- (
- std::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
- (
- std::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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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.
- Alpha () constZE::ZImage Attach (SDL_Surface *surface)ZE::ZImage Bind () constZE::ZImage Draw (int x, int y, Uint8 zIndex=0) constZE::ZImage Draw (float x, float y, Uint8 zIndex=0) constZE::ZImage DrawRotated (int x, int y, float angle, Uint8 zIndex=0) constZE::ZImage DrawRotated (float x, float y, float angle, Uint8 zIndex=0) constZE::ZImage Flip (bool horizontal, bool vertical)ZE::ZImage Height () constZE::ZImage IsLoaded () constZE::ZImage Open (std::string filename)ZE::ZImage OpenFromImage (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)ZE::ZImage OpenFromImage (const ZImage &img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)ZE::ZImage rAlpha ZE::ZImage [protected]Release ()ZE::ZImage Reload ()ZE::ZImage rEngine ZE::ZImage [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]SetAlpha (Uint8 alpha)ZE::ZImage 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 (const ZImage &rhs)ZE::ZImage ZImage (std::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 (const ZImage &img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)ZE::ZImage ~ZImage ()ZE::ZImage [virtual]
Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZImage class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZImage Class Reference #include <ZE_ZImage.h >
-
-List of all members.
Detailed Description
-ZImage image drawing class, class wraps common features of SDL_Surface. Inherited from ZObject.
-
-
-Public Member Functions ZImage () Default Constructor. ZImage (const ZImage &rhs) Copy constructor for ZImage . ZImage (std::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 (const ZImage &img, Sint16 x, Sint16 y, Sint16 w, Sint16 h) Constructor to Construct from part of another ZImage . virtual ~ZImage () Destructor, frees memory. void Open (std::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 a new image. void OpenFromImage (const ZImage &img, Sint16 x, Sint16 y, Sint16 w, Sint16 h) Cuts part of an existing ZImage to create a 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 SetAlpha (Uint8 alpha) Set alpha value (translucency) of 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 (int x, int y, Uint8 zIndex=0) const Draw Image to Screen. void Draw (float x, float y, Uint8 zIndex=0) const Draw Image to Screen. void DrawRotated (int x, int y, float angle, Uint8 zIndex=0) const Draw Image rotated to screen. void DrawRotated (float x, float y, float angle, Uint8 zIndex=0) 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. Uint8 Alpha () const Get Alpha component. Protected Attributes ZEngine * rEngine Pointer to ZEngine Object. 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. rAlpha Stored alpha value for drawing texture.
-Constructor & Destructor Documentation
-
-
-
-
-
-
- ZE::ZImage::ZImage
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Default Constructor, initializes variables.
-
-
-
-
-
-
-
-
- ZE::ZImage::ZImage
- (
- const ZImage &
- rhs
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Creates one ZImage using another.
Parameters:
-
- rhs A previously created ZImage to copy.
-
-
-
-
-
-
-
-
-
- ZE::ZImage::ZImage
- (
- std::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 with an SDL_Surface*.
-
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
- (
- const ZImage &
- img ,
-
-
- Sint16
- x ,
-
-
- Sint16
- y ,
-
-
- Sint16
- w ,
-
-
- Sint16
- h
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor is same as calling ZImage::OpenFromImage with a ZImage .
-
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
- (
-
- )
- [virtual]
-
-
-
-
-
-
-Member Function Documentation
-
-
-
-
-
-
- void ZE::ZImage::Open
- (
- std::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 SDL_Surface* 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::OpenFromImage
- (
- const ZImage &
- img ,
-
-
- Sint16
- x ,
-
-
- Sint16
- y ,
-
-
- Sint16
- w ,
-
-
- Sint16
- h
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Cut part of another ZImage to create a new Image.
-
Parameters:
-
- img ZImage 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::SetAlpha
- (
- Uint8
- alpha
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Set translucency value 0-255 (0 is transparent, 255 = opaque).
Since: 0.8.2 Parameters:
-
- alpha Number 0-255 setting translucency for 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
- (
- int
- x ,
-
-
- int
- y ,
-
-
- Uint8
- zIndex = 0
-
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Draw Image to screen at specified location.
Parameters:
-
- x X coord to draw Image to. y Y coord to draw Image to. zLayer Special parameter defining draw order of the image, defaults to 0 which means 'draw immediately.' (1-255 define order, lowest first.)
-
-
-
-
-
-
-
-
-
- void ZE::ZImage::Draw
- (
- float
- x ,
-
-
- float
- y ,
-
-
- Uint8
- zIndex = 0
-
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Draw Image to screen at specified location.
Since: 0.8.3 Parameters:
-
- x X coord to draw Image to. y Y coord to draw Image to. zLayer Special parameter defining draw order of the image, defaults to 0 which means 'draw immediately.'
-
-
-
-
-
-
-
-
-
- void ZE::ZImage::DrawRotated
- (
- int
- x ,
-
-
- int
- y ,
-
-
- float
- angle ,
-
-
- Uint8
- zIndex = 0
-
-
- )
- 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. zLayer Special parameter defining draw order of the image, defaults to 0 which means 'draw immediately.'
-
-
-
-
-
-
-
-
-
- void ZE::ZImage::DrawRotated
- (
- float
- x ,
-
-
- float
- y ,
-
-
- float
- angle ,
-
-
- Uint8
- zIndex = 0
-
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Image is rotated about it's own center by specified angle, then drawn to screen.
Since: 0.8.3 Parameters:
-
- x X coord to draw Image to. y Y coord to draw Image to. angle Angle in degrees to rotate image. zLayer Special parameter defining draw order of the image, defaults to 0 which means 'draw immediately.'
-
-
-
-
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
- Uint8 ZE::ZImage::Alpha
- (
-
- )
- const
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get current alpha value of image.
Since: 0.8.2 Returns: Image Alpha.
-
-
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZMusic class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZMusic Class Reference #include <ZE_ZMusic.h >
-
-List of all members.
Detailed Description
-ZMusic music class, class wraps common features for SDL_Mixer's Mix_Music. Inherited from ZObject.
-
-
-Public Member Functions ZMusic () Default Constructor. ZMusic (std::string filename) Constructor that opens a music file. virtual ~ZMusic () Destructor, frees memory. void Open (std::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 ZEngine * rEngine Pointer to ZEngine Object. rMusic Pointer to music data.
-Constructor & Destructor Documentation
-
-
-
-
-
-
- ZE::ZMusic::ZMusic
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Default Constructor, does nothing.
-
-
-
-
-
-
-
-
- ZE::ZMusic::ZMusic
- (
- std::string
- filename
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor simply calls ZMusic::Open() with same filename. (WAV,MOD,MID,OGG)
Parameters:
-
- filename Music to open.
-
-
-
-
-
-
-
-
-
- virtual ZE::ZMusic::~ZMusic
- (
-
- )
- [virtual]
-
-
-
-
-
-
-Member Function Documentation
-
-
-
-
-
-
- void ZE::ZMusic::Open
- (
- std::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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 SDL_Rect &rect)ZE::ZRect ZRect (const ZRect &rhs)ZE::ZRect ~ZRect ()ZE::ZRect [virtual]
Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZRect class Reference
-
-Main Page Namespace List 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 Member Functions ZRect () Default constructor for ZRect . ZRect (float x, float y, float width, float height) Constructor for ZRect that takes inital values. ZRect (const SDL_Rect &rect) Constructor for ZRect that uses an SDL_Rect. ZRect (const ZRect &rhs) Copy constructor for ZRect . const ZRect & operator= (const ZRect &rhs) Overload for = operator with ZRect . virtual ~ZRect () Virtual Destructor. 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 SDL_Rect &
- rect
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor for ZRect that initializes from an SDL_Rect.
Parameters:
-
- rect SDL_Rect to intialize from.
-
-
-
-
-
-
-
-
-
- ZE::ZRect::ZRect
- (
- const ZRect &
- rhs
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Takes a ZRect and constructs a new identical rectangle.
Parameters:
-
- rhs Rectangle to construct from.
-
-
-
-
-
-
-
-
-
- ZE::ZRect::~ZRect
- (
-
- )
- [virtual]
-
-
-
-
-
-
-
-
-
-
-
-
-
-Virtual destructor making future inheritance safe.
-
-
-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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZServer Member List This is the complete list of members for ZE::ZServer , including all inherited members.Generated on Sun Apr 27 22:34:35 2003 for ZEngine by
-
- 1.3-rc2 ZE::ZServer class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZServer Class Reference #include <ZE_ZServer.h >
-
-List of all members.
Detailed Description
-ZServer server class, used to create a simple TCP game server for use with ZClient . A very simple turnaround server, all the server does is accept connections and relay all recieved data to all other clients. Since: 0.8.3
-
-Public Methods ZServer (bool verbose=false) Default Constructor. virtual ~ZServer () Destructor, disconnects server and frees memory. bool Start (int maxClients, Uint16 port) Starts server. void Stop () Stops server. void SetWaitTime (int wait) Sets wait time for recieves. void CheckSockets () Check sockets for connections or data. int Clients () Gets number of clients. int WaitTime () Gets current wait time. Private Methods void CloseSocket (int num) Closes a socket. Private Attributes ZEngine * rEngine Pointer to ZEngine Object. rSocket SDL_net socket for connection. rSocketSet Socket set for client connections. rClientSockets SDL_net TCPSockets for client connections. rMaxClients Maximum number of clients. rVerbose Verbose setting for connection logs. rWaitTime Wait timeout setting for recieves on connection. [Defaults to 0.].
-Constructor & Destructor Documentation
-
-
-
-
-
-
- ZE::ZServer::ZServer
- (
- bool
- verbose = false
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Default Constructor, does basic initialization. If verbose is true connection data will be added to log file.
Parameters:
-
- verbose Sets verbose setting of client. [Defaults to false.]
-
-
-
-
-
-
-
-
-
- virtual ZE::ZServer::~ZServer
- (
-
- )
- [virtual]
-
-
-
-
-
-
-Member Function Documentation
-
-
-
-
-
-
- void ZE::ZServer::CloseSocket
- (
- int
- num
- )
- [private]
-
-
-
-
-
-
-
-
-
-
-
-
-
-Close a socket given by it's number.
Parameters:
-
- num Socket number to close.
-
-
-
-
-
-
-
-
-
- bool ZE::ZServer::Start
- (
- int
- maxClients ,
-
-
- Uint16
- port
-
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Starts server with a number of maximum clients and on a specified port.
Parameters:
-
- maxClients Maximum number of clients possible to connect to server. port Port to listen on for connections.
- Returns: True if server started, false otherwise.
-
-
-
-
-
-
-
-
- void ZE::ZServer::Stop
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Closes port and disconnects all clients.
-
-
-
-
-
-
-
-
- void ZE::ZServer::SetWaitTime
- (
- int
- wait
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Sets wait time in milliseconds , time which ZServer::CheckSockets will wait before returning if there is no activity. Before this is called for the first time the wait time is 0.
Parameters:
-
-
-
-
-
-
-
-
-
-
- void ZE::ZServer::CheckSockets
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Check sockets for connections or data, accepting new connections or relaying data from existing connections. Waits the specified wait period. This should be called very often to keep events flowing.
-
-
-
-
-
-
-
-
- int ZE::ZServer::Clients
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Finds number of connected clients.
Returns: Number of clients.
-
-
-
-
-
-
-
-
- int ZE::ZServer::WaitTime
- (
-
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Gets amount of time in milliseconds that is specified to wait for data on CheckSockets.
Returns: Wait time.
-
-
-Generated on Sun Apr 27 22:34:35 2003 for ZEngine by
-
- 1.3-rc2 Member List
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZSound class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZSound Class Reference #include <ZE_ZSound.h >
-
-List of all members.
Detailed Description
-ZSound music class, class wraps common features for SDL_Mixer's Mix_Chunk. Inherited from ZObject.
-
-
-Public Member Functions ZSound () Default Constructor. ZSound (std::string filename) Constructor that opens a sound effect file. virtual ~ZSound () Destructor, frees memory. void Open (std::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 ZEngine * rEngine Pointer to ZEngine Object. 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
- (
- std::string
- filename
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Constructor simply calls ZSound::Open() with same filename. (WAV,MOD,MID,OGG)
Parameters:
-
- filename Sound effect to open.
-
-
-
-
-
-
-
-
-
- virtual ZE::ZSound::~ZSound
- (
-
- )
- [virtual]
-
-
-
-
-
-
-Member Function Documentation
-
-
-
-
-
-
- void ZE::ZSound::Open
- (
- std::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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Member List
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZE::ZTimer class Reference
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZE::ZTimer Class Reference #include <ZE_ZTimer.h >
-
-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 Member Functions ZTimer (bool useZEngine=true) Constructs a new Timer. virtual ~ZTimer () Virtual Destructor. 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 Member Functions Uint32 GetParentTime () const Get time from parent timer. Protected Attributes ZEngine * rEngine Pointer to ZEngine Object. 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.
-
-
-
-
-
-
-
-
-
- ZE::ZTimer::~ZTimer
- (
-
- )
- [virtual]
-
-
-
-
-
-
-
-
-
-
-
-
-
-Virtual destructor making future inheritance safe.
-
-
-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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 File Index
-
-Main Page Namespace List 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 Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 Compound Member Index
-
-Main Page Namespace List 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 | n | 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:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-rAlpha
-: ZE::ZImage Rand()
-: ZE::ZRandGen , ZE::ZEngine RandDouble()
-: ZE::ZRandGen , ZE::ZEngine rBGColor
-: ZE::ZFont RButtonPressed()
-: ZE::ZEngine rChannelID
-: ZE::ZSound rCode
-: ZE::ZError rColor
-: ZE::ZFont rDescription
-: ZE::ZError Release()
-: ZE::ZSound , ZE::ZMusic , ZE::ZImage , ZE::ZFont release
-: VersionInfo ReleaseInstance()
-: ZE::ZEngine Reload()
-: ZE::ZImage rEngine
-: ZE::ZTimer , ZE::ZSound , ZE::ZMusic , ZE::ZImage , ZE::ZFont ReportError()
-: ZE::ZEngine RequestQuit()
-: ZE::ZEngine Reset()
-: ZE::ZTimer Resize()
-: ZE::ZRect , ZE::ZImage , ZE::ZFont ResizeRel()
-: ZE::ZRect Rewind()
-: ZE::ZMusic rFileLayout
-: ZE::ZConfigFile rFilename
-: ZE::ZFont , ZE::ZError , ZE::ZConfigFile rFont
-: ZE::ZFont rHeight
-: ZE::ZRect , ZE::ZImage Right()
-: ZE::ZRect rImage
-: ZE::ZImage rLastPause
-: ZE::ZTimer rLine
-: ZE::ZError rMusic
-: ZE::ZMusic rPaused
-: ZE::ZTimer rPausedTime
-: ZE::ZTimer rSound
-: ZE::ZSound rStateVector
-: ZE::ZRandGen rStateVectorIndex
-: ZE::ZRandGen rTexID
-: ZE::ZImage rTexMaxX
-: ZE::ZImage rTexMaxY
-: ZE::ZImage rTexMinX
-: ZE::ZImage rTexMinY
-: ZE::ZImage rUseZEngine
-: ZE::ZTimer rWidth
-: ZE::ZRect , ZE::ZImage rX
-: ZE::ZRect rY
-: ZE::ZRect
-
-
-
-
-
-
-
-
-
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 File Member Index
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZEngine File Members
-u
-
-
-Here is a list of all documented file members with links to the documentation:
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 ZEngine Documentation
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-ZEngine Documentation
-
-
0.8.3 Author: James Turk Version: 0.8.3 Date: April 27, 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.
-
james@conceptofzero.net - Core Engine, Design, Docs, and Classestazar@conceptofzero.net - OpenGL assistancesean@conceptofzero.net - MSVC++6 Project Fileskwatters@adelphia.net - Fix to ZImage::SetColorKey<br>Generated on Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 /include/external/mt19937ar.h Source File
-
-Main Page Namespace List Compound List File List Namespace Members Compound Members File Members
-/include/external/mt19937ar.h 00001 #ifndef __mt19937ar__
-00002 #define __mt19937ar__
-00003 #include <cstdio>
-00008
-00009 #define N 624
-00010 #define M 397
-00011 #define MATRIX_A 0x9908b0dfUL
-00012 #define UPPER_MASK 0x80000000UL
-00013 #define LOWER_MASK 0x7fffffffUL
-00014
-00015 void init_genrand(unsigned long s);
-00016 unsigned long genrand_int32(void );
-00017 long genrand_int31(void );
-00018 double genrand_real1(void );
-00019 double genrand_real2(void );
-00020 double genrand_real3(void );
-00021 double genrand_res53(void );
-00022
-00023 #endif //__mt19937ar__
- Generated on Sun Apr 27 22:34:35 2003 for ZEngine by
-
- 1.3-rc2 ZE Namespace Reference
-
-Main Page Namespace List 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 ZConfigFile::ZCF_Variable ZConfigFile Variable class.More... class ZConfigFile::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 ZRandGen ZRandGen class for OO encapsulation of superb random generator "Mersenne Twister.".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_NET_INIT ,
-ZERR_VIDMODE ,
-ZERR_LOAD_IMAGE ,
-ZERR_LOAD_SOUND ,
-ZERR_LOAD_MUSIC ,
-ZERR_LOAD_FONT ,
-ZERR_NOIMAGE ,
-ZERR_NOSOUND ,
-ZERR_NOMUSIC ,
-ZERR_NOFONT ,
-ZERR_NOSOCKET ,
-ZERR_NET_CLIENT ,
-ZERR_NET_SERVER ,
-ZERR_LAST
- Enumeration of ZEngine error codes. More... Functions std::string FormatStr (const char *fmtstr,...) Parses a std::string and interprets variable arguments, similar to sprintf. void FreeImage (SDL_Surface *&image) Properly free SDL_Surface. void FreeSound (Mix_Chunk *&chunk) Properly free Mix_Chunk. void FreeMusic (Mix_Music *&music) Properly free Mix_Music. void FreeFont (TTF_Font *&font) Properly free TTF_Font.
-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_NET_INIT
-Error Initializing SDL_net. 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_NOSOCKET
-Error trying to use a ZClient without having an open socket. ZERR_NET_CLIENT
-Error using SDL_net in ZClient. ZERR_NET_SERVER
-Error using SDL_net in ZClient. ZERR_LAST
-Value used as range index, not a valid error code.
-
-
-
-Function Documentation
-
-
-
-
-
-
- std::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 std::string ... variable number of arguments after fmtstr
- Returns: std::string of parsed and combined std::string
-
-
-
-
-
-
-
-
- void ZE::FreeImage
- (
- SDL_Surface *&
- image
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Safely free an SDL_Surface* and set it to NULL.
Parameters:
-
- image Image to free and set to NULL.
-
-
-
-
-
-
-
-
-
- void FreeSound
- (
- Mix_Chunk *&
- chunk
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Safely free a Mix_Chunk* and set it to NULL.
Parameters:
-
- chunk Chunk to free and set to NULL.
-
-
-
-
-
-
-
-
-
- void FreeMusic
- (
- Mix_Music *&
- music
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Safely free a Mix_Music* and set it to NULL.
Parameters:
-
- music Music to free and set to NULL.
-
-
-
-
-
-
-
-
-
- void FreeFont
- (
- TTF_Font *&
- font
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Safely free a TTF_Font* and set it to NULL.
Parameters:
-
- font Font to free and set to NULL.
-
-
-
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Namespace Member Index
-
-Main Page Namespace List 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:
-FormatStr()
-: ZE FreeFont()
-: ZE FreeImage()
-: ZE FreeMusic()
-: ZE FreeSound()
-: ZE
-
-ZERR_LAST
-: ZE ZERR_LOAD_FONT
-: ZE ZERR_LOAD_IMAGE
-: ZE ZERR_LOAD_MUSIC
-: ZE ZERR_LOAD_SOUND
-: ZE ZERR_MIX_INIT
-: ZE ZERR_NET_CLIENT
-: ZE ZERR_NET_INIT
-: ZE ZERR_NET_SERVER
-: ZE ZERR_NOFONT
-: ZE ZERR_NOIMAGE
-: ZE ZERR_NOMUSIC
-: ZE ZERR_NONE
-: ZE ZERR_NOSOCKET
-: ZE ZERR_NOSOUND
-: ZE ZERR_SDL_INIT
-: ZE ZERR_SDL_INTERNAL
-: ZE ZERR_TTF_INIT
-: ZE ZERR_VIDMODE
-: ZE ZErrorCode
-: ZE
-Generated on Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 Namespace Index
-
-Main Page Namespace List 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 Sun Jun 29 14:13:51 2003 for ZEngine by
-
- 1.3 /include/external/physfsrwops.h Source File
-
-Main Page Namespace List 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 Sun Jun 29 14:13:50 2003 for ZEngine by
-
- 1.3 