# error This library requires C++
#endif
+#include <plib/js.h>
+#include <plib/ul.h>
+
#include <simgear/compiler.h>
-#include <simgear/misc/props.hxx>
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
+#include <simgear/structure/commands.hxx>
+#include <simgear/props/condition.hxx>
+#include <simgear/props/props.hxx>
-#include <Main/fgfs.hxx>
+#include <Main/fg_os.hxx>
+#include <Main/fg_props.hxx>
#include <Main/globals.hxx>
#include <map>
SG_USING_STD(map);
SG_USING_STD(vector);
+
+\f
+
+#if defined( UL_WIN32 )
+#define TGT_PLATFORM "windows"
+#elif defined ( UL_MAC_OSX )
+#define TGT_PLATFORM "mac"
+#else
+#define TGT_PLATFORM "unix"
+#endif
+
+
+\f
+////////////////////////////////////////////////////////////////////////
+// General binding support.
+////////////////////////////////////////////////////////////////////////
+
+
/**
* An input binding of some sort.
*
* keyboard key, a joystick button or axis, or even a panel
* instrument.</p>
*/
-class FGBinding
+class FGBinding : public SGConditional
{
public:
- enum Action {
- ACTION_NONE,
- ACTION_SWITCH,
- ACTION_ADJUST,
- ACTION_ASSIGN
- };
-
+ /**
+ * Default constructor.
+ */
FGBinding ();
+
+
+ /**
+ * Convenience constructor.
+ *
+ * @param node The binding will be built from this node.
+ */
FGBinding (const SGPropertyNode * node);
- virtual ~FGBinding ();
- virtual Action getAction () const { return _action; }
- virtual SGPropertyNode * getProperty () { return _node; }
- virtual const SGPropertyNode * getProperty () const { return _node; }
- virtual const SGValue * getAdjustStep () const { return _adjust_step; }
- virtual const SGValue * getAssignValue () const { return _assign_value; }
+
+ /**
+ * Destructor.
+ */
+ virtual ~FGBinding () {}
+
+
+ /**
+ * Get the command name.
+ *
+ * @return The string name of the command for this binding.
+ */
+ virtual const string &getCommandName () const { return _command_name; }
+
+
+ /**
+ * Get the command itself.
+ *
+ * @return The command associated with this binding, or 0 if none
+ * is present.
+ */
+ virtual SGCommandMgr::command_t getCommand () const { return _command; }
+
+
+ /**
+ * Get the argument that will be passed to the command.
+ *
+ * @return A property node that will be passed to the command as its
+ * argument, or 0 if none was supplied.
+ */
+ virtual const SGPropertyNode * getArg () { return _arg; }
- virtual void setAction (Action action);
- virtual void setProperty (SGPropertyNode * node);
- virtual void setAdjustStep (const SGValue * step);
- virtual void setAssignValue (const SGValue * value);
+ /**
+ * Read a binding from a property node.
+ *
+ * @param node The property node containing the binding.
+ */
virtual void read (const SGPropertyNode * node);
+
+ /**
+ * Fire a binding.
+ */
virtual void fire () const;
-// virtual void fire (double value);
-// virtual void fire (int xdelta, int ydelta);
+
+
+ /**
+ * Fire a binding with a scaled movement (rather than absolute position).
+ */
+ virtual void fire (double offset, double max) const;
+
+
+ /**
+ * Fire a binding with a setting (i.e. joystick axis).
+ *
+ * A double 'setting' property will be added to the arguments.
+ *
+ * @param setting The input setting, usually between -1.0 and 1.0.
+ */
+ virtual void fire (double setting) const;
+
private:
- Action _action;
- SGPropertyNode * _node;
- const SGValue * _adjust_step;
- const SGValue * _assign_value;
+ // just to be safe.
+ FGBinding (const FGBinding &binding);
+
+ string _command_name;
+ mutable SGCommandMgr::command_t _command;
+ mutable SGPropertyNode_ptr _arg;
+ mutable SGPropertyNode_ptr _setting;
};
+\f
+////////////////////////////////////////////////////////////////////////
+// General input mapping support.
+////////////////////////////////////////////////////////////////////////
+
+
/**
* Generic input module.
*
* keyboard, joystick, mouse, or even panel switches -- in a consistent
* way, and to allow users to rebind any of the actions at runtime.</p>
*/
-class FGInput : public FGSubsystem
+class FGInput : public SGSubsystem
{
public:
+ /**
+ * Default constructor.
+ */
+ FGInput ();
- enum {
- FG_MOD_NONE = 0,
- FG_MOD_SHIFT = 1,
- FG_MOD_CTRL = 2,
- FG_MOD_ALT = 4,
- FG_MOD_MAX = 8 // one past all modifiers
- };
-
- FGInput();
+ /**
+ * Destructor.
+ */
virtual ~FGInput();
//
- // Implementation of FGSubsystem.
+ // Implementation of SGSubsystem.
//
virtual void init ();
- virtual void bind ();
- virtual void unbind ();
- virtual void update ();
+ virtual void reinit ();
+ virtual void postinit ();
+ virtual void update (double dt);
+ virtual void suspend ();
+ virtual void resume ();
+ virtual bool is_suspended () const;
/**
- * Handle a single keystroke.
+ * Control whether this is the default module to receive events.
*
- * <p>Note: for special keys, the integer key code will be the Glut
- * code + 256.</p>
+ * The first input module created will set itself as the default
+ * automatically.
*
- * @param k The integer key code, as returned by glut.
+ * @param status true if this should be the default module for
+ * events, false otherwise.
+ */
+ virtual void makeDefault (bool status = true);
+
+
+ /**
+ * Handle a single keystroke.
+ *
+ * @param k The integer key code, see Main/fg_os.hxx
* @param modifiers Modifier keys pressed (bitfield).
* @param x The mouse x position at the time of keypress.
* @param y The mouse y position at the time of keypress.
- * @see #FG_MOD_SHIFT
- * @see #FG_MOD_CTRL
- * @see #FG_MOD_ALT
*/
virtual void doKey (int k, int modifiers, int x, int y);
/**
- * Fire off a single-trigger action.
+ * Handle a mouse click event.
*
- * <p>This method fires an action triggered by a key or button
- * press, with no additional quantity information.</p>
- *
- * @param binding The property node with the binding.
+ * @param button The mouse button selected.
+ * @param updown Button status.
+ * @param x The X position of the mouse event, in screen coordinates.
+ * @param y The Y position of the mouse event, in screen coordinates.
*/
- virtual void action (const SGPropertyNode * binding);
+ virtual void doMouseClick (int button, int updown, int x, int y);
/**
- * Fire off a quantity action.
- *
- * <p>This method fires an action triggered by a change in value,
- * such as a slider or axis.</p>
+ * Handle mouse motion.
*
- * @param action The property node with the binding.
- * @param value The new value.
+ * @param x The new mouse x position, in screen coordinates.
+ * @param y The new mouse y position, in screen coordinates.
*/
-// virtual void action (const SGPropertyNode * binding, double value);
+ virtual void doMouseMotion (int x, int y);
+private:
+ // Constants
+ enum
+ {
+ MAX_KEYS = 1024,
+
+ #ifdef WIN32
+ MAX_JOYSTICKS = 2,
+ #else
+ MAX_JOYSTICKS = 10,
+ #endif
+ MAX_JOYSTICK_AXES = _JS_MAX_AXES,
+ MAX_JOYSTICK_BUTTONS = 32,
+
+ MAX_MICE = 1,
+ MAX_MOUSE_BUTTONS = 8
+ };
+ struct mouse;
+ friend struct mouse;
+
+ typedef vector<FGBinding *> binding_list_t;
+
/**
- * Fire off a movement action.
- *
- * <p>This method fires an action triggered by relative movement
- * rather than an absolute value; it is especially applicable to
- * mouse-movement bindings.</p>
- *
- * @param binding The property node containing the binding.
- * @param xdelta The amount of X movement.
- * @param ydelta The amount of Y movement.
+ * Settings for a key or button.
*/
-// virtual void action (const SGPropertyNode * binding, int xdelta, int ydelta);
+ struct button {
+ button ();
+ virtual ~button ();
+ bool is_repeatable;
+ float interval_sec;
+ float last_dt;
+ int last_state;
+ binding_list_t bindings[KEYMOD_MAX];
+ };
-private:
+
+ /**
+ * Settings for a single joystick axis.
+ */
+ struct axis {
+ axis ();
+ virtual ~axis ();
+ float last_value;
+ float tolerance;
+ binding_list_t bindings[KEYMOD_MAX];
+ float low_threshold;
+ float high_threshold;
+ struct button low;
+ struct button high;
+ float interval_sec;
+ double last_dt;
+ };
+
+
+ /**
+ * Settings for a joystick.
+ */
+ struct joystick {
+ joystick ();
+ virtual ~joystick ();
+ int jsnum;
+ jsJoystick * js;
+ int naxes;
+ int nbuttons;
+ axis * axes;
+ button * buttons;
+ };
+
+
+ /**
+ * Settings for a mouse mode.
+ */
+ struct mouse_mode {
+ mouse_mode ();
+ virtual ~mouse_mode ();
+ int cursor;
+ bool constrained;
+ bool pass_through;
+ button * buttons;
+ binding_list_t x_bindings[KEYMOD_MAX];
+ binding_list_t y_bindings[KEYMOD_MAX];
+ };
+
+
+ /**
+ * Settings for a mouse.
+ */
+ struct mouse {
+ mouse ();
+ virtual ~mouse ();
+ int x;
+ int y;
+ SGPropertyNode * mode_node;
+ SGPropertyNode * mouse_button_nodes[MAX_MOUSE_BUTTONS];
+ int nModes;
+ int current_mode;
+ double timeout;
+ int save_x;
+ int save_y;
+ mouse_mode * modes;
+ };
+
+
+ /**
+ * Initialize key bindings.
+ */
+ void _init_keyboard ();
+
+
+ /**
+ * Initialize joystick bindings.
+ */
+ void _init_joystick ();
+
+
+ /**
+ * Scan directory recursively for "named joystick" configuration files,
+ * and read them into /input/joysticks/js-named[index]++.
+ */
+ void _scan_joystick_dir (SGPath *path, SGPropertyNode* node, int *index);
+
+
+ /**
+ * Initialize mouse bindings.
+ */
+ void _init_mouse ();
+
+
+ /**
+ * Initialize a single button.
+ */
+ inline void _init_button (const SGPropertyNode * node,
+ button &b,
+ const string name);
+
+ /**
+ * Initialize nasal parts that had to wait for the nasal to get
+ * functional.
+ */
+ void _postinit_joystick ();
+
+ /**
+ * Update the keyboard.
+ */
+ void _update_keyboard ();
+
+
+ /**
+ * Update the joystick.
+ */
+ void _update_joystick (double dt);
+
+
+ /**
+ * Update the mouse.
+ */
+ void _update_mouse (double dt);
+
+
+ /**
+ * Update a single button.
+ */
+ inline void _update_button (button &b, int modifiers, bool pressed,
+ int x, int y);
+
+
+ /**
+ * Read bindings and modifiers.
+ */
+ void _read_bindings (const SGPropertyNode * node,
+ binding_list_t * binding_list,
+ int modifiers);
/**
* Look up the bindings for a key code.
*/
- const vector<FGBinding> * _find_bindings (int k, int modifiers);
+ const vector<FGBinding *> &_find_key_bindings (unsigned int k,
+ int modifiers);
- typedef map<int,vector<FGBinding> > keyboard_map;
- keyboard_map _key_bindings[FG_MOD_MAX];
+ button _key_bindings[MAX_KEYS];
+ joystick _joystick_bindings[MAX_JOYSTICKS];
+ mouse _mouse_bindings[MAX_MICE];
};
-extern FGInput current_input;
-
-#endif // _CONTROLS_HXX
+#endif // _INPUT_HXX
projects / flightgear.git / blobdiff