mod_base::Module Class Reference

Module base class. More...

#include <mod_base_class.hh>

Inheritance diagram for mod_base::Module:

List of all members.

Public Member Functions
	Module (void)
virtual	~Module ()
virtual void	Init (int argc, char **argv, const string &programName)
virtual void	Start (void)
virtual void	End (void)
virtual ModuleMode &	GetModuleMode (void)=0
virtual SharedPtr < Craft >	GetCurrentCraft (void)
SharedPtr0< EyeCraft >	GetEyeCraft (void)
void	SetEyeCraft (SharedPtr0< EyeCraft > eyeCraft)
bool	IfPause (void)
void	SetPause (const bool pause)
void	AdjustResponse (const Percent response)
void	IncResponse (const int percent)
Public Attributes
Joystick	mJoystick
mod_base::Events	mEvents
GFX::Light	mGlobalLight
GFX::Material	mGlobalMaterial
Protected Member Functions
virtual bool	SaveState (bool saveView)=0
virtual bool	LoadState (void)=0
bool	SaveStateBase (bool saveView, ConfigFile &config)
bool	LoadStateBase (bool loadView, ConfigFile &config)
virtual ConfigFile &	GetConfigFile (void)=0
ConfigFile &	GetConfigFileBase (const string &programName)
virtual void	CloseConfigFile (void)
Protected Attributes
string	mCwd
Private Member Functions
void	InitPreCmdarg (void)
void	InitCmdarg (int argc, char **argv)
void	InitPostCmdarg (void)
void	SelfCheck (void)
void	PulseInputQueue (void)
void	VentOverflowingInputQueue (void)
Private Attributes
uint	mSeed
shptr0< EyeCraft >	mEyeCraft
	assigned by EyeCraft ctor
bool	mPause
Friends
class	TimerTickFunctor
Classes
struct	TimerTickFunctor

---

Detailed Description

Module base class.

Initializing and starting libraries are separate actions.

Pausing: Simulation is paused by the main animation tick handler becoming a NOP if Module::mPause=true which esp. stops animation of the eye/viewpoint.

---

Constructor & Destructor Documentation

mod_base::Module::Module

(

void

)

ctor/dtor. Init() does initialization.

mod_base::Module::~Module

(

)

[virtual]

---

Member Function Documentation

virtual void mod_base::Module::Init	(	int	argc,
		char **	argv,
		const string &	programName
	)			[virtual]

Reimplemented in mod_sim::ModuleSim.

void mod_base::Module::Start

(

void

)

[virtual]

Start module.

Reimplemented in mod_sim::ModuleSim.

void mod_base::Module::End

(

void

)

[virtual]

Reimplemented in mod_sim::ModuleSim.

void mod_base::Module::InitPreCmdarg

(

void

)

[private]

Initialization (before cmd-line args).

Reimplemented in mod_sim::ModuleSim.

void mod_base::Module::InitCmdarg	(	int	argc,
		char **	argv
	)			[private]

Process command-line args.

Reimplemented in mod_sim::ModuleSim.

void mod_base::Module::InitPostCmdarg

(

void

)

[private]

Initialization (after cmd-line args).

void mod_base::Module::SelfCheck

(

void

)

[private]

Self-checks. Causes program exit if any fail.

Reimplemented in mod_sim::ModuleSim.

virtual ModuleMode& mod_base::Module::GetModuleMode

(

void

)

[pure virtual]

Implemented in mod_sim::ModuleSim.

SharedPtr< Craft > mod_base::Module::GetCurrentCraft

(

void

)

[virtual]

Returns:

Current Craft.

SharedPtrNull< EyeCraft > mod_base::Module::GetEyeCraft

(

void

)

Returns:

EyeCraft.

void mod_base::Module::SetEyeCraft

(

SharedPtr0< EyeCraft >

eyeCraft

)

bool mod_base::Module::IfPause

(

void

)

Pause/freeze.

void mod_base::Module::SetPause

(

const bool

pause

)

void mod_base::Module::AdjustResponse

(

const Percent

response

)

void mod_base::Module::IncResponse

(

const int

percent

)

void mod_base::Module::PulseInputQueue

(

void

)

[private]

This is the pulse of the input queue. This doesn't do polling (rather, Keyboard and Joystick objects do so).

void mod_base::Module::VentOverflowingInputQueue

(

void

)

[private]

Begin dropping events if an event queue is growing too quickly. The joystick is more prone to causing this problem than the keyboard.

virtual bool mod_base::Module::SaveState

(

bool

saveView

)

[protected, pure virtual]

Implemented in mod_sim::ModuleSim.

virtual bool mod_base::Module::LoadState

(

void

)

[protected, pure virtual]

Implemented in mod_sim::ModuleSim.

bool mod_base::Module::SaveStateBase	(	bool	saveView,
		ConfigFile &	config
	)			[protected]

bool mod_base::Module::LoadStateBase	(	bool	loadView,
		ConfigFile &	config
	)			[protected]

virtual ConfigFile& mod_base::Module::GetConfigFile

(

void

)

[protected, pure virtual]

Implemented in mod_sim::ModuleSim.

ConfigFile & mod_base::Module::GetConfigFileBase

(

const string &

programName

)

[protected]

void mod_base::Module::CloseConfigFile

(

void

)

[protected, virtual]

---

Friends And Related Function Documentation

friend class TimerTickFunctor [friend]

---

Member Data Documentation

Joystick mod_base::Module::mJoystick

mod_base::Events mod_base::Module::mEvents

uint mod_base::Module::mSeed [private]

shptr0<EyeCraft> mod_base::Module::mEyeCraft [private]

assigned by EyeCraft ctor

bool mod_base::Module::mPause [private]

string mod_base::Module::mCwd [protected]

GFX::Light mod_base::Module::mGlobalLight

GFX::Material mod_base::Module::mGlobalMaterial

---

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

• mod_base_class.hh
• mod_base.cc
• mod_base_config.cc
• mod_base_init.cc

Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:29 2007