Nirtcpp 2.0.0
Nirtcpp is a high-performance c++ graphics engine.
nirt::ITimer Class Referenceabstract

Interface for getting and manipulating the virtual time. More...

#include <nirtcpp/ITimer.hpp>

Inheritance diagram for nirt::ITimer:
Inheritance graph
Collaboration diagram for nirt::ITimer:
Collaboration graph

Classes

struct  RealTimeDate
 

Public Types

enum  EWeekday {
  EWD_SUNDAY =0 , EWD_MONDAY , EWD_TUESDAY , EWD_WEDNESDAY ,
  EWD_THURSDAY , EWD_FRIDAY , EWD_SATURDAY
}
 

Public Member Functions

virtual u32 getRealTime () const =0
 Returns current real time in milliseconds of the system. More...
 
virtual RealTimeDate getRealTimeAndDate () const =0
 
virtual u32 getTime () const =0
 Returns current virtual time in milliseconds. More...
 
virtual void setTime (u32 time)=0
 sets current virtual time
 
virtual void stop ()=0
 Stops the virtual timer. More...
 
virtual void start ()=0
 Starts the virtual timer. More...
 
virtual void setSpeed (f32 speed=1.0f)=0
 Sets the speed of the timer. More...
 
virtual f32 getSpeed () const =0
 Returns current speed of the timer. More...
 
virtual bool isStopped () const =0
 Returns if the virtual timer is currently stopped.
 
virtual void tick ()=0
 Advances the virtual time. More...
 
- Public Member Functions inherited from nirt::IReferenceCounted
 IReferenceCounted ()
 Constructor.
 
virtual ~IReferenceCounted ()
 Destructor.
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from nirt::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

Interface for getting and manipulating the virtual time.

Member Function Documentation

◆ getRealTime()

virtual u32 nirt::ITimer::getRealTime ( ) const
pure virtual

Returns current real time in milliseconds of the system.

This value does not start with 0 when the application starts. For example in one implementation the value returned could be the amount of milliseconds which have elapsed since the system was started.

◆ getSpeed()

virtual f32 nirt::ITimer::getSpeed ( ) const
pure virtual

Returns current speed of the timer.

The speed is the factor with which the time is running faster or slower then the real system time.

◆ getTime()

virtual u32 nirt::ITimer::getTime ( ) const
pure virtual

Returns current virtual time in milliseconds.

This value starts with 0 and can be manipulated using setTime(), stopTimer(), startTimer(), etc. This value depends on the set speed of the timer if the timer is stopped, etc. If you need the system time, use getRealTime()

◆ setSpeed()

virtual void nirt::ITimer::setSpeed ( f32  speed = 1.0f)
pure virtual

Sets the speed of the timer.

The speed is the factor with which the time is running faster or slower then the real system time.

◆ start()

virtual void nirt::ITimer::start ( )
pure virtual

Starts the virtual timer.

The timer is reference counted, which means everything which calls stop() will also have to call start(), otherwise the timer may not start/stop correctly again.

◆ stop()

virtual void nirt::ITimer::stop ( )
pure virtual

Stops the virtual timer.

The timer is reference counted, which means everything which calls stop() will also have to call start(), otherwise the timer may not start/stop correctly again.

◆ tick()

virtual void nirt::ITimer::tick ( )
pure virtual

Advances the virtual time.

Makes the virtual timer update the time value based on the real time. This is called automatically when calling NirtcppDevice::run(), but you can call it manually if you don't use this method.


The documentation for this class was generated from the following file: