template7: CUserInput Class Reference

List of all members.

Get methods

void GetForce (CVector3D &force)

Parameters:

force

Set to the current user force input.

void GetAForce (CAngle3D &aForce)

Parameters:

aForce

Set to the current user ang force input.

void GetFlags (unsigned long &flags)

Parameters:

flags

Set to the user flags currently active.

static CInputMap * getMapPtr (const std::string &strMap)

Public Member Functions

int load ()

Load the input values.

Set methods

CInputMap * set (const std::string &strMap, const std::string &strCode1, const std::string &strCode2="")

Set a keymapping.

Static Public Member Functions

static CUserInput * instance ()

Get a pointer to singleton.

Load methods

static bool load (const std::string &filename, const std::string &path)

Load in the input description from a file.

static bool load (const std::string &filename)

Load in the input description from a file.

static bool load (CXMLNode &node, const std::string &groupname="")

Load input descriptions from an XML node.

Detailed Description

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Member Function Documentation

CInputMap * CUserInput::getMapPtr ( const std::string & strMap ) [static]

Parameters:

strMap

String used to lookup keymapping.

Returns:: Pointer to the keymapping (NULL on error).

CInputMap * CUserInput::set	(	const std::string &	strMap,
		const std::string &	strCode1,
		const std::string &	strCode2 = `""`
	)

Set a keymapping.

Parameters:

	strMap	String used to lookup keymapping.
	strCode1	String used for scancode.
	strCode2	String used for scancode2 (optional).

Returns:: Pointer to the keymapping set (NULL on error).

bool CUserInput::load	(	const std::string &	filename,
		const std::string &	path
	)			`[static]`

Load in the input description from a file.

Parameters:

	filename	Name of the XML file containing the UserInput node.
	path	Path containing the XML file.

Returns:: true if the load succeeds

bool CUserInput::load ( const std::string & filename ) [static]

Load in the input description from a file.

Parameters:

filename

Name of the file containing the UserInput node.

Returns:: true if the load succeeds

bool CUserInput::load	(	CXMLNode &	node,
		const std::string &	groupname = `""`
	)			`[static]`

Load input descriptions from an XML node.

Parameters:

	node	XML node
	groupname	Name of the group to load (blank, use default group).

Returns:: true if the load succeeds