note description: "[ Represent the direction that an effect come from (an not where it goes, be carefull). Direction is encoded by three position (X axis, Y axix and Z axis). Cardinal directions of the haptic device are relative to the positioning of the device. North is considered to be away from the user, south is toward the user, east is right, and west is left of the user: .--. |__| .-------. |=.| |.-----.| |--| || || | | |'-----'| |__|~')_____(' [ COMPUTER ] North (0,-1,0) ^ | | (-1,0,0) West <----[ HAPTIC ]----> East (1,0,0) | | v South (0,1,0) [ USER ] \|||/ (o o) ---ooO-(_)-Ooo--- ]" author: "Louis Marchand" date: "Tue, 03 Mar 2015 15:22:37 +0000" revision: "2.0" class interface GAME_HAPTIC_CARTESIAN_DIRECTION create {GAME_HAPTIC_EFFECT} make_from_other (a_other: GAME_HAPTIC_DIRECTION) -- Initalization of Current using a_other as source require other_exists: a_other.exists other_cartesian: a_other.is_cartesian ensure exists: exists type_is_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian is_equal_other: is_values_equal (a_other) create make -- Initialization of Current require -- from MEMORY_STRUCTURE True ensure -- from MEMORY_STRUCTURE not_shared: not shared ensure then exists: exists type_is_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian x_axis_valid: x = 0 y_axis_valid: y = 0 z_axis_valid: z = 0 make_with_2_axis (a_x, a_y: INTEGER_32) -- Initialization of Current using a_x as x axis and a_y as y axis ensure exists: exists type_is_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian x_axis_valid: x = a_x y_axis_valid: y = a_y z_axis_valid: z = 0 make_with_axis (a_x, a_y, a_z: INTEGER_32) -- Initialization of Current using a_ as x axis, a_y as -- y axis and a_z as z axis. ensure exists: exists type_is_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian x_axis_valid: x = a_x y_axis_valid: y = a_y z_axis_valid: z = a_z feature -- Initialization make -- Initialization of Current require -- from MEMORY_STRUCTURE True ensure -- from MEMORY_STRUCTURE not_shared: not shared ensure then exists: exists type_is_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian x_axis_valid: x = 0 y_axis_valid: y = 0 z_axis_valid: z = 0 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 generating_type: TYPE [detachable GAME_HAPTIC_CARTESIAN_DIRECTION] -- 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 is_cartesian: BOOLEAN -- Is Current is represented with cartesian coordinate -- (from GAME_HAPTIC_DIRECTION) require -- from GAME_HAPTIC_DIRECTION exists: exists is_equal (a_other: GAME_HAPTIC_CARTESIAN_DIRECTION): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from GAME_HAPTIC_DIRECTION) require -- from ANY other_not_void: a_other /= Void ensure -- from ANY symmetric: Result implies a_other ~ Current consistent: standard_is_equal (a_other) implies Result is_polar: BOOLEAN -- Is Current is represented with polar coordinate -- (from GAME_HAPTIC_DIRECTION) require -- from GAME_HAPTIC_DIRECTION exists: exists is_spherical: BOOLEAN -- Is Current is represented with spherical coordinate -- (from GAME_HAPTIC_DIRECTION) require -- from GAME_HAPTIC_DIRECTION exists: exists is_values_equal (a_other: GAME_HAPTIC_DIRECTION): BOOLEAN -- Are the important values inside Current are equvalent item: POINTER -- Access to memory area. -- (from MEMORY_STRUCTURE) position: TUPLE [x: INTEGER_32; y: INTEGER_32; z: INTEGER_32] -- The coordinate of the origin of Current require exists: exists set_position (a_x, a_y, a_z: INTEGER_32) -- Assign position with the value of a_x, a_y and a_z require exists: exists ensure x_axis_valid: x = a_x y_axis_valid: y = a_y z_axis_valid: z = a_z set_x (a_x: INTEGER_32) -- Assign x with the value of a_x require exists: exists ensure is_assign: x = a_x set_y (a_y: INTEGER_32) -- Assign y with the value of a_y require exists: exists ensure is_assign: y = a_y set_z (a_z: INTEGER_32) -- Assign z with the value of a_z require exists: exists ensure is_assign: z = a_z shared: BOOLEAN -- Is current memory area shared with others? -- (from MEMORY_STRUCTURE) x: INTEGER_32 assign set_x -- The horizontal coordinate of the origin of Current require exists: exists y: INTEGER_32 assign set_y -- The vertical coordinate of the origin of Current require exists: exists z: INTEGER_32 assign set_z -- The depth coordinate of the origin of Current. -- To use this coordinate, you need a 3 axis haptic -- (See: GAME_HAPTIC.axes_count) require exists: exists 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_CARTESIAN_DIRECTION): 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) 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_CARTESIAN_DIRECTION): 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) 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_object (other: GAME_HAPTIC_CARTESIAN_DIRECTION) -- 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_CARTESIAN_DIRECTION) -- 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_CARTESIAN_DIRECTION -- 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_CARTESIAN_DIRECTION) -- 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_CARTESIAN_DIRECTION -- 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_CARTESIAN_DIRECTION -- 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_CARTESIAN_DIRECTION -- 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 -- 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 feature -- implementation structure_size: INTEGER_32 -- Size to allocate (in bytes). -- (from GAME_HAPTIC_DIRECTION) ensure -- from MEMORY_STRUCTURE is_class: class positive_result: Result > 0 invariant type_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian position_valid: attached position as la_position and then (la_position.x = x and la_position.y = y and la_position.z = z) -- from GAME_HAPTIC_DIRECTION type_valid: type = {GAME_SDL_EXTERNAL}.sdl_haptic_cartesian or type = {GAME_SDL_EXTERNAL}.sdl_haptic_polar or type = {GAME_SDL_EXTERNAL}.sdl_haptic_spherical -- 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_CARTESIAN_DIRECTION
Generated by ISE EiffelStudio