note description: "Joystick manager. Not tested. It is most probable that it does not work correctly" author: "Louis Marchand" date: "May 24, 2012" revision: "1.0.0.0" class interface GAME_JOYSTICK create {GAME_LIBRARY_CONTROLLER} make (a_open_index: INTEGER_32) -- Initialization for Current using a_open_index when open. feature -- Access axes_count: INTEGER_32 -- Get the number of axes on the joystick. require get_axes_number_opened: is_open not_removed: not is_removed axis_motion_actions: ACTION_SEQUENCE [NATURAL_32, NATURAL_8, INTEGER_16] -- When an axis of Current has been moved at a certain value. -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_JOYSTICK_EVENTS joy_axis_motion_event_enable: events_controller.is_joy_axis_motion_event_enable axis_value (a_axis_id: INTEGER_32): INTEGER_16 -- Get the value of the axis identified by a_axis_id. -- Note that a_axis_id index start at 0 require get_axis_value_opened: is_open not_removed: not is_removed get_axis_value_axis_id_valid: a_axis_id < axes_count ball_change (a_ball_id: INTEGER_32): TUPLE [x_relative: INTEGER_32; y_relative: INTEGER_32] -- Return the state of the ball identified by a_ball_id (relative to the last read). -- Note that a_ball_id index start at 0 require get_ball_value_opened: is_open get_ball_value_ball_id_valid: a_ball_id < axes_count not_removed: not is_removed ball_motion_actions: ACTION_SEQUENCE [NATURAL_32, NATURAL_8, INTEGER_16, INTEGER_16] -- When a ball of Current has been moved to a certain relative value (x_relative,y_relative) -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_JOYSTICK_EVENTS joy_ball_motion_event_enable: events_controller.is_joy_ball_motion_event_enable balls_count: INTEGER_32 -- Return the number of balls on the joystick. require get_balls_number_opened: is_open not_removed: not is_removed button_pressed_actions: ACTION_SEQUENCE [NATURAL_32, NATURAL_8] -- When a button (identified by button_id) of Current has been pressed. -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_JOYSTICK_EVENTS joy_button_pressed_event_enable: events_controller.is_joy_button_pressed_event_enable button_released_actions: ACTION_SEQUENCE [NATURAL_32, NATURAL_8] -- When a button (identified by button_id) of Current has been released. -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_JOYSTICK_EVENTS joy_button_pressed_event_enable: events_controller.is_joy_button_released_event_enable buttons_count: INTEGER_32 -- Return the number of buttons on the joystick. require get_buttons_number_opened: is_open not_removed: not is_removed clear_events -- <Precuror> -- (from GAME_JOYSTICK_EVENTS) ensure -- from GAME_EVENTS running_unchanged: is_events_running = old is_events_running close -- Close Current (Free internal structure). require close_is_open: is_open events_controller: GAME_EVENTS_CONTROLLER -- Used main event manager Game_library: GAME_LIBRARY_CONTROLLER -- The main controller of the game library -- (from GAME_LIBRARY_SHARED) generating_type: TYPE [detachable GAME_JOYSTICK] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty guid: READABLE_STRING_GENERAL -- A unique hardware identifier of Current require not_removed: not is_removed haptic_controller: GAME_HAPTIC_JOYSTICK -- Used to manage the haptic (force feedback) of Current require is_buttons_pressed_opened: is_open not_removed: not is_removed is_haptic_capable: is_haptic_capable is_haptic_enable: Game_library.is_haptic_enable has_error: BOOLEAN -- Is the library has generate an error -- (from GAME_ERROR_MANAGER) hat_motion_actions: ACTION_SEQUENCE [NATURAL_32, NATURAL_8, GAME_JOYSTICK_HAT_STATE] -- When a hat of Current has been moved at a certain value. -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_JOYSTICK_EVENTS joy_hat_motion_event_enable: events_controller.is_joy_hat_motion_event_enable hat_state (a_hat_id: INTEGER_32): GAME_JOYSTICK_HAT_STATE -- The state of the hat identified by a_hat_id -- Note that a_hat_id index start at 0 require get_hat_state_opened: is_open not_removed: not is_removed get_hat_state_hat_id_valid: a_hat_id < hats_count hats_count: INTEGER_32 -- Return the number of hats on the joystick. require get_hats_number_opened: is_open not_removed: not is_removed index: INTEGER_32 -- Internal unique identifier of Current instance_id: INTEGER_32 -- Identifier of Current used in event handeling require is_buttons_pressed_opened: is_open not_removed: not is_removed is_button_pressed (a_button_id: INTEGER_32): BOOLEAN -- True if the button identified by a_button_id is pressed, False otherwise -- Note that a_button_id index start at 0 require is_buttons_pressed_opened: is_open is_button_pressed_button_id_valid: a_button_id < buttons_count not_removed: not is_removed is_haptic_capable: BOOLEAN -- Is Current has haptic features require is_buttons_pressed_opened: is_open not_removed: not is_removed is_haptic_enable: Game_library.is_haptic_enable is_open: BOOLEAN -- True if the joystick has been opened. is_removed: BOOLEAN -- Current has been removed is_events_running: BOOLEAN assign set_is_running -- Is Current active -- (from GAME_EVENTS) last_error: READABLE_STRING_GENERAL -- The last error generate by the library -- (from GAME_SDL_ANY) name: STRING_8 -- Return the Joystick Name. require not_removed: not is_removed open -- Open Current (Allocate internal structure). require open_joystick_not_open: not is_open ensure is_open_or_error: not has_error implies is_open removed_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current is removed (probably disconected) -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_JOYSTICK_EVENTS joy_button_pressed_event_enable: events_controller.is_joy_device_removed_event_enable run_events -- <Precuror> -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_EVENTS run_not_already_running: not is_events_running ensure -- from GAME_EVENTS is_running: is_events_running set_is_running (a_value: BOOLEAN) -- Assign to is_running the value of a_value -- (from GAME_EVENTS) ensure -- from GAME_EVENTS is_assign: is_events_running ~ a_value stop_events -- <Precuror> -- (from GAME_JOYSTICK_EVENTS) require -- from GAME_EVENTS stop_is_running: is_events_running ensure -- from GAME_EVENTS is_stopped: not is_events_running feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: GAME_JOYSTICK): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: GAME_JOYSTICK): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: GAME_JOYSTICK): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: GAME_JOYSTICK) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: GAME_JOYSTICK) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: GAME_JOYSTICK -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: GAME_JOYSTICK) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: GAME_JOYSTICK -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: GAME_JOYSTICK -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable GAME_JOYSTICK -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Implementation dispose -- <Pecursor> feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class GAME_JOYSTICK
Generated by ISE EiffelStudio