2002-11-21 05:40:49 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=iso-8859-1" >
< title > ZE::ZTimer class Reference< / title >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
2002-12-05 00:05:06 +00:00
<!-- Generated by Doxygen 1.3 - rc1 -->
2002-11-21 05:40:49 +00:00
< center >
< a class = "qindex" href = "index.html" > Main Page< / a > < a class = "qindex" href = "namespaces.html" > Namespace List< / a > < a class = "qindex" href = "hierarchy.html" > Class Hierarchy< / a > < a class = "qindex" href = "annotated.html" > Compound List< / a > < a class = "qindex" href = "files.html" > File List< / a > < a class = "qindex" href = "namespacemembers.html" > Namespace Members< / a > < a class = "qindex" href = "functions.html" > Compound Members< / a > < a class = "qindex" href = "globals.html" > File Members< / a > < / center >
< hr > < h1 > ZE::ZTimer Class Reference< / h1 > < code > #include < < a class = "el" href = "ZE__ZTimer_8h-source.html" > ZE_ZTimer.h< / a > > < / code >
< p >
Inherits < a class = "el" href = "classZE_1_1ZObject.html" > ZE::ZObject< / a > .
< p >
< a href = "classZE_1_1ZTimer-members.html" > List of all members.< / a > < hr > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< a class = "el" href = "classZE_1_1ZTimer.html" > ZTimer< / a > timing class, class wraps common features of SDL timer. Inherited from < a class = "el" href = "classZE_1_1ZObject.html" > ZObject< / a > and tied to < a class = "el" href = "classZE_1_1ZEngine.html" > ZEngine< / a > main timer.
< p >
< table border = 0 cellpadding = 0 cellspacing = 0 >
< tr > < td > < / td > < / tr >
< tr > < td colspan = 2 > < br > < h2 > Public Methods< / h2 > < / td > < / tr >
< tr > < td nowrap align = right valign = top > < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#a0" > ZTimer< / a > (bool useZEngine=true)< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Constructs a new Timer.< / em > < a href = "#a0" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > void < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#a1" > Reset< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Reset Timer.< / em > < a href = "#a1" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > void < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#a2" > Pause< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Pause Timer.< / em > < a href = "#a2" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > void < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#a3" > Unpause< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Unpause Timer.< / em > < a href = "#a3" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > Uint32 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#a4" > GetTime< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Get Time of Timer.< / em > < a href = "#a4" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > bool < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#a5" > IsPaused< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Get paused state.< / em > < a href = "#a5" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td colspan = 2 > < br > < h2 > Protected Methods< / h2 > < / td > < / tr >
< tr > < td nowrap align = right valign = top > Uint32 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#b0" > GetParentTime< / a > ()< / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Get time from parent timer.< / em > < a href = "#b0" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td colspan = 2 > < br > < h2 > Protected Attributes< / h2 > < / td > < / tr >
< tr > < td nowrap align = right valign = top > < a name = "n0" doxytag = "ZE::ZTimer::rPaused" > < / a >
bool < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#n0" > rPaused< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Paused / Unpaused state of Timer.< / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > < a name = "n1" doxytag = "ZE::ZTimer::rUseZEngine" > < / a >
bool < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#n1" > rUseZEngine< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Using < a class = "el" href = "classZE_1_1ZEngine.html" > ZEngine< / a > timer or SDL global timer.< / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > < a name = "n2" doxytag = "ZE::ZTimer::rPausedTime" > < / a >
Uint32 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#n2" > rPausedTime< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Total time this timer has been paused.< / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > < a name = "n3" doxytag = "ZE::ZTimer::rLastPause" > < / a >
Uint32 < / td > < td valign = bottom > < a class = "el" href = "classZE_1_1ZTimer.html#n3" > rLastPause< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Time this Timer was paused.< / em > < / font > < br > < br > < / td > < / tr >
< / table >
< hr > < h2 > Constructor & Destructor Documentation< / h2 >
< a name = "a0" doxytag = "ZE::ZTimer::ZTimer" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > ZE::ZTimer::ZTimer < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "md" nowrap valign = "top" > bool < / td >
< td class = "mdname1" valign = "top" nowrap > < em > useZEngine< / em > = true < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
2002-12-05 00:05:06 +00:00
Sets TimePaused to current < a class = "el" href = "classZE_1_1ZEngine.html" > ZEngine< / a > time if useZEngine is true, otherwise uses SDL timer. < dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = top > < em > useZEngine< / em > < / td > < td > Tells if timer should use < a class = "el" href = "classZE_1_1ZEngine.html" > ZEngine< / a > or SDL. < / td > < / tr >
< / table >
< / dl >
< / td >
2002-11-21 05:40:49 +00:00
< / tr >
< / table >
< hr > < h2 > Member Function Documentation< / h2 >
< a name = "b0" doxytag = "ZE::ZTimer::GetParentTime" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > Uint32 ZE::ZTimer::GetParentTime < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < code > [protected]< / code > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
2002-12-05 00:05:06 +00:00
Protected method to get time from whichever timer is parent. < dl compact > < dt > < b > Returns:< / b > < / dt > < dd > Time on parent timer. < / dd > < / dl >
< / td >
2002-11-21 05:40:49 +00:00
< / tr >
< / table >
< a name = "a1" doxytag = "ZE::ZTimer::Reset" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > void ZE::ZTimer::Reset < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Set Timer back to Zero, will also unpause timer if it was paused. < / td >
< / tr >
< / table >
< a name = "a2" doxytag = "ZE::ZTimer::Pause" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > void ZE::ZTimer::Pause < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Pause the timer if it is unpaused. < / td >
< / tr >
< / table >
< a name = "a3" doxytag = "ZE::ZTimer::Unpause" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > void ZE::ZTimer::Unpause < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Unpause the timer if it is paused. < / td >
< / tr >
< / table >
< a name = "a4" doxytag = "ZE::ZTimer::GetTime" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > Uint32 ZE::ZTimer::GetTime < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
2002-12-05 00:05:06 +00:00
Get current time accounting for time paused. < dl compact > < dt > < b > Returns:< / b > < / dt > < dd > Current Timer Time. < / dd > < / dl >
< / td >
2002-11-21 05:40:49 +00:00
< / tr >
< / table >
< a name = "a5" doxytag = "ZE::ZTimer::IsPaused" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > bool ZE::ZTimer::IsPaused < / td >
< td class = "md" valign = "top" > ( < / td >
< td class = "mdname1" valign = "top" nowrap > < / td >
< td class = "md" valign = "top" > ) < / td >
< td class = "md" nowrap > < / td >
< / tr >
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
2002-12-05 00:05:06 +00:00
Find out paused state of timer. < dl compact > < dt > < b > Returns:< / b > < / dt > < dd > Paused state for timer. < / dd > < / dl >
< / td >
2002-11-21 05:40:49 +00:00
< / tr >
< / table >
< hr > The documentation for this class was generated from the following files:< ul >
2002-12-05 00:05:06 +00:00
< li > /home/James/ZEngine-dev/include/< a class = "el" href = "ZE__ZTimer_8h-source.html" > ZE_ZTimer.h< / a > < li > /home/James/ZEngine-dev/src/< a class = "el" href = "ZE__ZTimer_8cpp.html" > ZE_ZTimer.cpp< / a > < / ul >
2002-12-05 00:16:49 +00:00
< hr > < address style = "align: right;" > < small > Generated on Wed Dec 4 19:16:09 2002 for ZEngine by
2002-11-21 05:40:49 +00:00
< a href = "http://www.doxygen.org/index.html" >
< img src = "doxygen.png" alt = "doxygen" align = "middle" border = 0
2002-12-05 00:05:06 +00:00
width=110 height=53>< / a > 1.3-rc1 < / small > < / address >
2002-11-21 05:40:49 +00:00
< / body >
< / html >
