note description: "GAME_HAPTIC_EFFECT that play at a custom strength." author: "Louis Marchand" date: "Tue, 03 Mar 2015 14:16:22 +0000" revision: "2.0" class interface GAME_HAPTIC_CUSTOM_EFFECT create make -- Initialization of Current require -- from MEMORY_STRUCTURE True ensure -- from MEMORY_STRUCTURE not_shared: not shared ensure then axes_number_valid: axes_count >= 1 type_valid: type.to_natural_32 = {GAME_SDL_EXTERNAL}.sdl_haptic_custom feature -- Initialization make -- Initialization of Current require -- from MEMORY_STRUCTURE True ensure -- from MEMORY_STRUCTURE not_shared: not shared ensure then axes_number_valid: axes_count >= 1 type_valid: type.to_natural_32 = {GAME_SDL_EXTERNAL}.sdl_haptic_custom make_by_pointer (a_ptr: POINTER) -- Initialize current with a_ptr. -- (from MEMORY_STRUCTURE) require -- from MEMORY_STRUCTURE a_ptr_not_null: a_ptr /= default_pointer ensure -- from MEMORY_STRUCTURE shared: shared feature -- Access axes_count: NATURAL_8 assign set_axes_number -- The number of axes to use require exists: exists delay: NATURAL_16 assign set_delay -- delay before starting Current (in millisecond) require -- from GAME_HAPTIC_EFFECT_DELAYED exists: exists direction: GAME_HAPTIC_DIRECTION assign set_direction -- The orientation that the force of Current come from require exists: exists fade_in_length: NATURAL_16 assign set_fade_in_length -- length of the fade in require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists fade_in_level: NATURAL_16 assign set_fade_in_level -- level at the start of the fade in require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists fade_out_length: NATURAL_16 assign set_fade_out_length -- length of the fade out require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists fade_out_level: NATURAL_16 assign set_fade_out_level -- level at the start of the fade out require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists generating_type: TYPE [detachable GAME_HAPTIC_CUSTOM_EFFECT] -- 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 hash_code: INTEGER_32 -- Hash code value -- (from POINTER_REF) ensure -- from HASHABLE good_hash_value: Result >= 0 interval: NATURAL_16 assign set_interval -- how soon before effect can be triggered again (in millisecond) require -- from GAME_HAPTIC_EFFECT_DELAYED exists: exists is_infinite: BOOLEAN -- It True, Current will never stop by itself when started -- (from GAME_HAPTIC_EFFECT_INFINITE_LENGTH) require -- from GAME_HAPTIC_EFFECT_INFINITE_LENGTH exists: exists item: POINTER -- Access to memory area. -- (from MEMORY_STRUCTURE) null: POINTER -- Pointer value -- (from POINTER_REF) length: NATURAL_32 assign set_length -- Duration of Current (in millisecond) require -- from GAME_HAPTIC_EFFECT exists: exists period: NATURAL_16 assign set_period -- Time (in millisecond) between two samples. require exists: exists samples: ARRAYED_LIST [NATURAL_16] assign set_samples -- Value sequence to play Current require exists: exists set_axes_count (a_count: NATURAL_8) -- Assign axes_count with the value of a_count -- Note: Callig this routine will clear the samples (to satisfied invariant) require exists: exists number_valid: a_count >= 1 ensure is_assign: axes_count = a_count samples_valid_for_every_axes: samples.count.divisible (axes_count.to_integer_32) set_delay (a_delay: NATURAL_16) -- Assign delay with the value of a_delay require -- from GAME_HAPTIC_EFFECT_DELAYED exists: exists delay_valid: a_delay <= 32767 ensure -- from GAME_HAPTIC_EFFECT_DELAYED is_assign: delay = a_delay set_direction (a_direction: GAME_HAPTIC_DIRECTION) -- assign direction with the values of a_direction require exists: exists ensure is_assign: direction ~ a_direction set_fade_in_length (a_fade_in_length: NATURAL_16) -- Assign fade_in_length with the value of a_fade_in_length require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists length_valid: a_fade_in_length <= 32767 ensure -- from GAME_HAPTIC_EFFECT_ENVELOPE is_assign: fade_in_length = a_fade_in_length set_fade_in_level (a_fade_in_level: NATURAL_16) -- Assign fade_in_level with the value of a_fade_in_level require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists level_valid: a_fade_in_level <= 32767 ensure -- from GAME_HAPTIC_EFFECT_ENVELOPE is_assign: fade_in_level = a_fade_in_level set_fade_out_length (a_fade_out_length: NATURAL_16) -- Assign fade_out_length with the value of a_fade_out_length require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists length_valid: a_fade_out_length <= 32767 ensure -- from GAME_HAPTIC_EFFECT_ENVELOPE is_assign: fade_out_length = a_fade_out_length set_fade_out_level (a_fade_out_level: NATURAL_16) -- Assign fade_out_level with the value of a_fade_out_level require -- from GAME_HAPTIC_EFFECT_ENVELOPE exists: exists level_valid: a_fade_out_level <= 32767 ensure -- from GAME_HAPTIC_EFFECT_ENVELOPE is_assign: fade_out_level = a_fade_out_level set_infinite -- When played, Current will never stop by itself -- (from GAME_HAPTIC_EFFECT_INFINITE_LENGTH) require -- from GAME_HAPTIC_EFFECT_INFINITE_LENGTH exists: exists ensure -- from GAME_HAPTIC_EFFECT_INFINITE_LENGTH infinite_is_set: is_infinite set_interval (a_interval: NATURAL_16) -- Assign interval with the value of a_interval require -- from GAME_HAPTIC_EFFECT_DELAYED exists: exists interval_valid: a_interval <= 32767 ensure -- from GAME_HAPTIC_EFFECT_DELAYED is_assign: interval = a_interval set_length (a_length: NATURAL_32) -- Assign length with the value of a_length require -- from GAME_HAPTIC_EFFECT exists: exists length_valid: a_length <= 32767 require else -- from GAME_HAPTIC_EFFECT_INFINITE_LENGTH exists: exists length_valid: a_length <= 32767 or a_length = {GAME_SDL_EXTERNAL}.sdl_haptic_infinity ensure -- from GAME_HAPTIC_EFFECT is_assign: length = a_length set_period (a_period: NATURAL_16) -- Assign period with the value of a_period require exists: exists period_valid: a_period <= 32767 ensure is_assign: period = a_period set_samples (a_samples: ARRAYED_LIST [NATURAL_16]) -- Assign samples with the values in a_samples require exists: exists samples_for_all_axes: a_samples.count.divisible (axes_count.to_integer_32) ensure is_assign: samples ~ a_samples samples_valid_for_every_axes: samples.count.divisible (axes_count.to_integer_32) shared: BOOLEAN -- Is current memory area shared with others? -- (from MEMORY_STRUCTURE) 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_HAPTIC_CUSTOM_EFFECT): 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_HAPTIC_CUSTOM_EFFECT): 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 memory_compare (other: POINTER; a_size: INTEGER_32): BOOLEAN -- True if Current and other are identical on a_size bytes. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size > 0 valid_other: other /= default_pointer 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_HAPTIC_CUSTOM_EFFECT): 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 exists: BOOLEAN -- Is allocated memory still allocated? -- (from MEMORY_STRUCTURE) is_default_pointer: BOOLEAN -- Is current default_pointer? -- (from POINTER_REF) ensure -- from POINTER_REF definition: Result = (null = default_pointer) is_hashable: BOOLEAN -- May current object be hashed? -- (True if it is not its type's default.) -- (from POINTER_REF) 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 -- Element change frozen set_item (p: POINTER) -- Make p the item value. -- (from POINTER_REF) feature -- Conversion to_integer_32: INTEGER_32 -- Convert item into an INTEGER_32 value. -- (from POINTER_REF) to_reference: POINTER_REF -- Associated reference of Current -- (from POINTER_REF) ensure -- from POINTER_REF to_reference_not_void: Result /= Void feature -- Duplication copy (other: GAME_HAPTIC_CUSTOM_EFFECT) -- 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_HAPTIC_CUSTOM_EFFECT) -- 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_HAPTIC_CUSTOM_EFFECT -- 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_HAPTIC_CUSTOM_EFFECT) -- 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_HAPTIC_CUSTOM_EFFECT -- 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_HAPTIC_CUSTOM_EFFECT -- 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_HAPTIC_CUSTOM_EFFECT -- 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 -- Action to be executed just before garbage collection -- reclaims an object. -- Effect it in descendants to perform specific dispose -- actions. Those actions should only take care of freeing -- external resources; they should not perform remote calls -- on other objects since these may also be dead and reclaimed. structure_size: INTEGER_32 -- Size to allocate (in bytes). -- (from GAME_HAPTIC_EFFECT) ensure -- from MEMORY_STRUCTURE is_class: class positive_result: Result > 0 feature -- Access bits size boolean_bits: INTEGER_32 -- Number of bits in a value of type BOOLEAN -- (from PLATFORM) ensure -- from PLATFORM instance_free: class Character_32_bits: INTEGER_32 = 32 -- Number of bits in a value of type CHARACTER_32 -- (from PLATFORM) Character_8_bits: INTEGER_32 = 8 -- Number of bits in a value of type CHARACTER_8 -- (from PLATFORM) Integer_16_bits: INTEGER_32 = 16 -- Number of bits in a value of type INTEGER_16 -- (from PLATFORM) Integer_32_bits: INTEGER_32 = 32 -- Number of bits in a value of type INTEGER_32 -- (from PLATFORM) Integer_64_bits: INTEGER_32 = 64 -- Number of bits in a value of type INTEGER_64 -- (from PLATFORM) Integer_8_bits: INTEGER_32 = 8 -- Number of bits in a value of type INTEGER_8 -- (from PLATFORM) Natural_16_bits: INTEGER_32 = 16 -- Number of bits in a value of type NATURAL_16 -- (from PLATFORM) Natural_32_bits: INTEGER_32 = 32 -- Number of bits in a value of type NATURAL_32 -- (from PLATFORM) Natural_64_bits: INTEGER_32 = 64 -- Number of bits in a value of type NATURAL_64 -- (from PLATFORM) Natural_8_bits: INTEGER_32 = 8 -- Number of bits in a value of type NATURAL_8 -- (from PLATFORM) pointer_bits: INTEGER_32 -- Number of bits in a value of type POINTER -- (from PLATFORM) ensure -- from PLATFORM instance_free: class Real_32_bits: INTEGER_32 = 32 -- Number of bits in a value of type REAL_32 -- (from PLATFORM) Real_64_bits: INTEGER_32 = 64 -- Number of bits in a value of type REAL_64 -- (from PLATFORM) feature -- Access bytes size boolean_bytes: INTEGER_32 -- Number of bytes in a value of type BOOLEAN -- (from PLATFORM) ensure -- from PLATFORM instance_free: class Character_32_bytes: INTEGER_32 = 4 -- Number of bytes in a value of type CHARACTER_32 -- (from PLATFORM) Character_8_bytes: INTEGER_32 = 1 -- Number of bytes in a value of type CHARACTER_8 -- (from PLATFORM) Integer_16_bytes: INTEGER_32 = 2 -- Number of bytes in a value of type INTEGER_16 -- (from PLATFORM) Integer_32_bytes: INTEGER_32 = 4 -- Number of bytes in a value of type INTEGER_32 -- (from PLATFORM) Integer_64_bytes: INTEGER_32 = 8 -- Number of bytes in a value of type INTEGER_64 -- (from PLATFORM) Integer_8_bytes: INTEGER_32 = 1 -- Number of bytes in a value of type INTEGER_8 -- (from PLATFORM) Natural_16_bytes: INTEGER_32 = 2 -- Number of bytes in a value of type NATURAL_16 -- (from PLATFORM) Natural_32_bytes: INTEGER_32 = 4 -- Number of bytes in a value of type NATURAL_32 -- (from PLATFORM) Natural_64_bytes: INTEGER_32 = 8 -- Number of bytes in a value of type NATURAL_64 -- (from PLATFORM) Natural_8_bytes: INTEGER_32 = 1 -- Number of bytes in a value of type NATURAL_8 -- (from PLATFORM) pointer_bytes: INTEGER_32 -- Number of bytes in a value of type POINTER -- (from PLATFORM) ensure -- from PLATFORM instance_free: class Real_32_bytes: INTEGER_32 = 4 -- Number of bytes in a value of type REAL_32 -- (from PLATFORM) Real_64_bytes: INTEGER_32 = 8 -- Number of bytes in a value of type REAL_64 -- (from PLATFORM) feature -- Allocation/free memory_alloc (a_size: INTEGER_32): POINTER -- Allocated size bytes using malloc. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size > 0 ensure -- from POINTER_REF instance_free: class memory_calloc (a_count, a_element_size: INTEGER_32): POINTER -- Allocate a_count elements of size a_element_size bytes using `calloc. -- (from POINTER_REF) require -- from POINTER_REF valid_element_count: a_count > 0 valid_element_size: a_element_size > 0 ensure -- from POINTER_REF instance_free: class memory_free -- Free allocated memory with malloc. -- (from POINTER_REF) memory_realloc (a_size: INTEGER_32): POINTER -- Realloc Current. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size >= 0 feature -- Markers fixme (comment: READABLE_STRING_8) -- Mark code that has to be "fixed" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement (comment: READABLE_STRING_8) -- Mark code that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement_assertion (comment: READABLE_STRING_8): BOOLEAN -- Mark assertion that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class feature -- Memory copy memory_copy (a_source: POINTER; a_size: INTEGER_32) -- Copy a_size bytes from a_source to Current. -- a_source and Current should not overlap. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size >= 0 valid_source: a_source /= default_pointer memory_move (a_source: POINTER; a_size: INTEGER_32) -- Copy a_size bytes from a_source to Current. -- a_source and Current can overlap. -- (from POINTER_REF) require -- from POINTER_REF valid_size: a_size >= 0 valid_source: a_source /= default_pointer memory_set (val, n: INTEGER_32) -- Fill first n bytes of the memory pointed by Current -- with constant val. -- (from POINTER_REF) require -- from POINTER_REF valid_val: val >= 0 valid_n: n >= 0 feature -- Operations plus alias "+" (offset: INTEGER_32): POINTER -- Pointer moved by an offset of offset bytes. -- (from POINTER_REF) 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 is_64_bits: BOOLEAN -- Is the current process runing in 64-bit mode -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_dotnet: BOOLEAN -- Are we targetting .NET? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class Is_little_endian: BOOLEAN -- Is current platform a little endian one? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_mac: BOOLEAN -- Are we running on Mac OS? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_scoop_capable: BOOLEAN -- Is current platform capable of SCOOP? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_thread_capable: BOOLEAN -- Is current platform capable of multi-threading? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_unix: BOOLEAN -- Are we running on a Unix like platform? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_vms: BOOLEAN -- Are we running on VMS? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_vxworks: BOOLEAN -- Are we running on VxWorks? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class is_windows: BOOLEAN -- Are we running on Windows platform? -- (from PLATFORM) ensure -- from PLATFORM instance_free: class 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 axes_number_valid: axes_count >= 1 samples_valid_for_every_axes: samples.count.divisible (axes_count.to_integer_32) -- from GAME_HAPTIC_EFFECT type_valid: type > 0 -- from MEMORY_STRUCTURE managed_pointer_valid: not shared implies managed_pointer /= Void internal_item_valid: shared implies internal_item /= default_pointer -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class GAME_HAPTIC_CUSTOM_EFFECT
Generated by ISE EiffelStudio