IEnvironment Class Reference

Interface class to the global environment of the currently running application. More...

#include <Common/Globals.h>

Inherited by Environment.

List of all members.

Public Member Functions
virtual uint	ScreenWidth () const =0
	Gets the width of the drawable area of the currently active Screen.
virtual uint	ScreenHeight () const =0
	Gets the height of the drawable area of the currently active Screen.
virtual void	ScreenDim (uint &w, uint &h) const =0
	Gets the width and height of the drawable area of the currently active Screen.
virtual uint	CurrentTimeMS () const =0
	Gets the number of milliseconds that have passed since the application started.
virtual float	FrameTime () const =0
	Gets the number of seconds between this and the last frame.
virtual float	FPS () const =0
	Gets the frames per second of the application.
virtual IScreen *	GetScreen () const =0
	Gets the interface to the currently active Screen,.
virtual IMouse *	GetMouse () const =0
	Gets the interface for the active mouse.
virtual IKeyboard *	GetKeyboard () const =0
	Gets the interface for the active keyboard.
virtual ImageMgr *	ImageManager () const =0
	Gets the applications ImageMgr.
virtual FontMgr *	FontManager () const =0
	Gets the applications FontMgr.
virtual SoundSampleMgr *	SoundSampleManager () const =0
	Gets the applications SoundSampleMgr.
virtual SoundStreamMgr *	SoundStreamManager () const =0
	Gets the applications SoundStreamMgr.
virtual Console *	GetConsole () const =0
	Gets the applications Console.
virtual SDLApplication *	GetApp () const =0
	Gets the application itself.
virtual std::string	AppName () const =0
	Gets the name of the active application.

---

Detailed Description

Interface class to the global environment of the currently running application.

---

Member Function Documentation

virtual std::string IEnvironment::AppName

(

)

const [pure virtual]

Gets the name of the active application.

Returns:

the name of the active application.

virtual uint IEnvironment::CurrentTimeMS

(

)

const [pure virtual]

Gets the number of milliseconds that have passed since the application started.

Returns:

The time since the application started in milliseconds.

virtual FontMgr* IEnvironment::FontManager

(

)

const [pure virtual]

Gets the applications FontMgr.

Returns:

A pointer to the applications FontMgr.

virtual float IEnvironment::FPS

(

)

const [pure virtual]

Gets the frames per second of the application.

Returns:

The frames per second of the application.

virtual float IEnvironment::FrameTime

(

)

const [pure virtual]

Gets the number of seconds between this and the last frame.

Returns:

The number of seconds between this and the last frame

virtual SDLApplication* IEnvironment::GetApp

(

)

const [pure virtual]

Gets the application itself.

Returns:

A pointer to the application.

virtual Console* IEnvironment::GetConsole

(

)

const [pure virtual]

Gets the applications Console.

Returns:

A pointer to the applications Console.

virtual IKeyboard* IEnvironment::GetKeyboard

(

)

const [pure virtual]

Gets the interface for the active keyboard.

Returns:

The keyboard interface.

virtual IMouse* IEnvironment::GetMouse

(

)

const [pure virtual]

Gets the interface for the active mouse.

Returns:

The mouse interface.

virtual IScreen* IEnvironment::GetScreen

(

)

const [pure virtual]

Gets the interface to the currently active Screen,.

Returns:

The interface to the active Screen.

virtual ImageMgr* IEnvironment::ImageManager

(

)

const [pure virtual]

Gets the applications ImageMgr.

Returns:

A pointer to the applications ImageMgr.

virtual void IEnvironment::ScreenDim	(	uint &	w,
		uint &	h
	)			const [pure virtual]

Gets the width and height of the drawable area of the currently active Screen.

Parameters:

[out]	w	the width of the drawable area of the currently active Screen.
[out]	h	the height of the drawable area of the currently active Screen.

virtual uint IEnvironment::ScreenHeight

(

)

const [pure virtual]

Gets the height of the drawable area of the currently active Screen.

Returns:

The height of the drawable area of the currently active Screen.

virtual uint IEnvironment::ScreenWidth

(

)

const [pure virtual]

Gets the width of the drawable area of the currently active Screen.

Returns:

The width of the drawable area of the currently active Screen.

virtual SoundSampleMgr* IEnvironment::SoundSampleManager

(

)

const [pure virtual]

Gets the applications SoundSampleMgr.

Returns:

A pointer to the applications SoundSampleMgr.

virtual SoundStreamMgr* IEnvironment::SoundStreamManager

(

)

const [pure virtual]

Gets the applications SoundStreamMgr.

Returns:

A pointer to the applications SoundStreamMgr.

---

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

• Globals.h