CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

iInputBinder Struct Reference

SCF interface for csInputBinder. More...

#include <iutil/binder.h>

Inheritance diagram for iInputBinder:

iBase csInputBinder List of all members.

Public Member Functions

virtual iEventHandlerQueryHandler ()=0
 Get a pointer to the embedded iEventHander.
virtual bool Button (unsigned cmd)=0
 Returns the status of the given button command.
virtual int Axis (unsigned cmd)=0
 Returns the position of the given axis command.
virtual void BindButton (csInputDefinition const &def, unsigned int cmd, bool toggle=false)=0
 Bind a button event to a button command.
virtual void BindAxis (csInputDefinition const &def, unsigned int cmd, int sensitivity=1)=0
 Bind an axis motion event to an axis command.
virtual bool UnbindButton (unsigned cmd)=0
 Remove a binding.
virtual bool UnbindAxis (unsigned cmd)=0
 Remove a binding.
virtual void UnbindAll ()=0
 Remove all bindings.
virtual void LoadConfig (iConfigFile *, const char *subsection=0)=0
 Load bindings from a configuration file.
virtual void SaveConfig (iConfigFile *, const char *subsection=0)=0
 Save bindings to a configuration file.

Detailed Description

SCF interface for csInputBinder.

Definition at line 32 of file binder.h.


Member Function Documentation

virtual int iInputBinder::Axis unsigned  cmd  )  [pure virtual]
 

Returns the position of the given axis command.

Implemented in csInputBinder.

virtual void iInputBinder::BindAxis csInputDefinition const &  def,
unsigned int  cmd,
int  sensitivity = 1
[pure virtual]
 

Bind an axis motion event to an axis command.

Parameters:
def Describes the physical axis to bind to.
cmd The ID of the command to bind.
sensitivity A multiplier for the axis command.
Remarks:
Note that cmd is used as an array index so the numbers you use should be consecutive, starting with 0.

virtual void iInputBinder::BindButton csInputDefinition const &  def,
unsigned int  cmd,
bool  toggle = false
[pure virtual]
 

Bind a button event to a button command.

Parameters:
def Describes the physical button to bind to.
cmd The ID of the command to bind.
toggle If true, button status is only toggled on keydown events.
Remarks:
Note that cmd is used as an array index so the numbers you use should be consecutive, starting with 0.

virtual bool iInputBinder::Button unsigned  cmd  )  [pure virtual]
 

Returns the status of the given button command.

Implemented in csInputBinder.

virtual void iInputBinder::LoadConfig iConfigFile ,
const char *  subsection = 0
[pure virtual]
 

Load bindings from a configuration file.

Implemented in csInputBinder.

virtual iEventHandler* iInputBinder::QueryHandler  )  [pure virtual]
 

Get a pointer to the embedded iEventHander.

Remarks:
This class can be registered with the event queue: EventQueue->RegisterListener(InputBinder->QueryHandler (), CSMASK_Input);

Implemented in csInputBinder.

virtual void iInputBinder::SaveConfig iConfigFile ,
const char *  subsection = 0
[pure virtual]
 

Save bindings to a configuration file.

Implemented in csInputBinder.

virtual void iInputBinder::UnbindAll  )  [pure virtual]
 

Remove all bindings.

Implemented in csInputBinder.

virtual bool iInputBinder::UnbindAxis unsigned  cmd  )  [pure virtual]
 

Remove a binding.

Implemented in csInputBinder.

virtual bool iInputBinder::UnbindButton unsigned  cmd  )  [pure virtual]
 

Remove a binding.

Implemented in csInputBinder.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1