Automatic generation produced by ISE Eiffel
note description: "Positions relative to other positions.%NTakes another relative point as origin and then defines a%Nhor. & vert. scaling factor, x, y and angle.%NYou can then access absolute scale_x, scale_y, x, y and angle%Nwhich are recomputed only if invalidate_absolute_position has%Nbeen called.%NYou may also choose to specify a positioner. This is an agent%Nthat gets called everytime a recomputation is requested.%NWhen a positioner is installed, the other attributes are ignored.%NThe x and y are transformed by the angle and scaling of the origin.%NThis implies that the scale_x, scale_y and angle features of this%Nobject are only for propagation to referring points." legal: "See notice at end of class." status: "See notice at end of class." keywords: "point, position, location, origin" date: "$Date: 2017-05-03 07:56:14 -0800 (Wed, 03 May 2017) $" revision: "$Revision: 100317 $" class interface EV_RELATIVE_POINT create default_create -- Base origin. make_with_origin (an_origin: EV_RELATIVE_POINT) -- Create with an_origin on position (0, 0). make_with_origin_and_position (an_origin: EV_RELATIVE_POINT; new_x, new_y: INTEGER_32) -- Create with an_origin on position (new_x, new_y). make_with_position (new_x, new_y: INTEGER_32) -- Create on position (new_x, new_y). make_with_positioner (pos_agent: like positioner) -- Create with pos_agent. feature -- Access absolute_coordinates: EV_COORDINATE -- Coordinates relative to (0, 0). Updates if necessary. angle: REAL_64 -- Angle in radians relative to origin. angle_abs: REAL_64 -- Angle relative to 0. Updates if necessary. ensure result_assigned: Result = last_angle_abs arc_cosine (v: REAL_64): REAL_64 -- Trigonometric arccosine of radian v -- in the range [0, pi]. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class arc_sine (v: REAL_64): REAL_64 -- Trigonometric arcsine of radian v -- in the range [-pi/2, +pi/2]. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class arc_tangent (v: REAL_64): REAL_64 -- Trigonometric arctangent of radian v -- in the range [-pi/2, +pi/2]. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class ceiling (v: REAL_64): REAL_64 -- Least integral greater than or equal to v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class cosine (v: REAL_64): REAL_64 -- Trigonometric cosine of radian v approximated -- in the range [-pi/4, +pi/4]. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class dabs (v: REAL_64): REAL_64 -- Absolute of v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class Euler: REAL_64 = 2.7182818284590452353602874713526625 -- Logarithm base -- (from MATH_CONST) exp (x: REAL_64): REAL_64 -- Exponential of v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class floor (v: REAL_64): REAL_64 -- Greatest integral less than or equal to v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class generating_type: TYPE [detachable EV_RELATIVE_POINT] -- 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 frozen id_object (an_id: INTEGER_32): detachable IDENTIFIED -- Object associated with an_id (void if no such object) -- (from IDENTIFIED) ensure -- from IDENTIFIED consistent: Result = Void or else Result.object_id = an_id log (v: REAL_64): REAL_64 -- Natural logarithm of v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class log10 (v: REAL_64): REAL_64 -- Base 10 logarithm of v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class log_2 (v: REAL_64): REAL_64 -- Base 2 logarithm of v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class frozen object_id: INTEGER_32 -- Unique for current object in any given session -- (from IDENTIFIED) ensure -- from IDENTIFIED valid_id: Result > 0 implies id_object (Result) = Current origin: detachable EV_RELATIVE_POINT -- Origin the position is relative to. -- If this is Void, x and y are relative to (0, 0). Pi: REAL_64 = 3.1415926535897932384626433832795029 -- (from MATH_CONST) Pi_2: REAL_64 = 1.5707963267948966192313216916397514 -- (from MATH_CONST) Pi_4: REAL_64 = 0.7853981633974483096156608458198757 -- (from MATH_CONST) positioner: detachable PROCEDURE [like Current] -- Take special absolute positioning action. -- A positioner is expected to use the routines: -- set_x_abs, set_y_abs. -- set_angle_abs, set_scale_x_abs, set_scale_y_abs can be used too -- to propagate angle and scaling factor to referring points. scale_x: REAL_64 -- Relative horizontal scaling factor. scale_x_abs: REAL_64 -- Final horizontal scaling factor. Updates if necessary. ensure result_assigned: Result = last_scale_x_abs scale_y: REAL_64 -- Relative vertical scaling factor. scale_y_abs: REAL_64 -- Final vertical scaling factor. Updates if necessary. ensure result_assigned: Result = last_scale_y_abs sine (v: REAL_64): REAL_64 -- Trigonometric sine of radian v approximated -- in range [-pi/4, +pi/4]. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class sqrt (v: REAL_64): REAL_64 -- Square root of v. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class Sqrt2: REAL_64 = 1.4142135623730950488016887242096981 -- Square root of 2 -- (from MATH_CONST) tangent (v: REAL_64): REAL_64 -- Trigonometric tangent of radian v approximated -- in range [-pi/4, +pi/4]. -- (from DOUBLE_MATH) ensure -- from DOUBLE_MATH instance_free: class x: INTEGER_32 -- X-coordinate relative to origin. x_abs: INTEGER_32 -- X relative to (0, 0). Updates if necessary. ensure result_assigned: Result = last_x_abs y: INTEGER_32 -- Y-coordinate relative to origin. y_abs: INTEGER_32 -- Y relative to (0, 0). Updates if necessary. ensure result_assigned: Result = last_y_abs 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: EV_RELATIVE_POINT): 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: EV_RELATIVE_POINT): 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: EV_RELATIVE_POINT): 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 being_positioned: BOOLEAN -- Used for cycle detection of positioning agents. 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 has_positioner: BOOLEAN -- Is this point controlled by an agent? ensure result_assigned: Result = (positioner /= Void) frozen id_freed: BOOLEAN -- Has Current been removed from the table? -- (from IDENTIFIED) relative_to (org: EV_RELATIVE_POINT): BOOLEAN -- Does this point have org as origin somehow? -- This is not the case when it is being positioned. 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 change_origin (new_origin: EV_RELATIVE_POINT) -- Set point this point is relative to. -- Do not change absolute coordinates if -- scaling factors and angle do not change. require new_origin_not_void: new_origin /= Void no_dependence_circle: not new_origin.relative_to (Current) set_angle (new_angle: REAL_64) -- Set angle of this point (in radians). set_angle_abs (new_angle_abs: REAL_64) -- Change absolute angle. ensure last_angle_abs_assigned: last_angle_abs = new_angle_abs set_origin (new_origin: EV_RELATIVE_POINT) -- Set point this point is relative to. require new_origin_not_void: new_origin /= Void no_dependence_circle: not new_origin.relative_to (Current) and new_origin /= Current set_position (new_x, new_y: INTEGER_32) -- Set both `x` and `y`. set_positioner (pos_agent: like positioner) -- Set a customized positioning routine. ensure positioner_assigned: positioner = pos_agent set_scale (new_scale: REAL_64) -- Set relative scaling factor. set_scale_x (new_scale_x: REAL_64) -- Set relative horizontal scaling factor. set_scale_x_abs (new_scale_x_abs: REAL_64) -- Change absolute horizontal scaling factor. ensure last_scale_x_abs_assigned: last_scale_x_abs = new_scale_x_abs set_scale_y (new_scale_y: REAL_64) -- Set relative vertical scaling factor. set_scale_y_abs (new_scale_y_abs: REAL_64) -- Change absolute vertical scaling factor. ensure last_scale_y_abs_assigned: last_scale_y_abs = new_scale_y_abs set_x (new_x: INTEGER_32) -- Change relative horizontal position. set_x_abs (new_x_abs: INTEGER_32) -- Change absolute position. ensure last_x_abs_assigned: last_x_abs = new_x_abs set_y (new_y: INTEGER_32) -- Change relative vertical position. set_y_abs (new_y_abs: INTEGER_32) -- Change absolute position. ensure last_y_abs_assigned: last_y_abs = new_y_abs feature -- Removal dispose -- Free the entry associated with `object_id` if any -- (from IDENTIFIED) require -- from DISPOSABLE True ensure then -- from IDENTIFIED object_freed: id_freed frozen free_id -- Free the entry associated with `object_id` if any. -- (from IDENTIFIED) ensure -- from IDENTIFIED object_freed: id_freed feature -- Duplication copy (other: EV_RELATIVE_POINT) -- 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: EV_RELATIVE_POINT) -- 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: EV_RELATIVE_POINT -- 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: EV_RELATIVE_POINT) -- 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: EV_RELATIVE_POINT -- 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: EV_RELATIVE_POINT -- 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 EV_RELATIVE_POINT -- 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 between (n, a, b: INTEGER_32): BOOLEAN -- Is n a value between a and b? -- (from EV_FIGURE_MATH) delta_x (angle: REAL_64; length: INTEGER_32): INTEGER_32 -- Get dx component of line segment with length and `angle`. -- (from EV_FIGURE_MATH) delta_y (angle: REAL_64; length: INTEGER_32): INTEGER_32 -- Get dy component of line segment with length and `angle`. -- (from EV_FIGURE_MATH) distance (x1, y1, x2, y2: INTEGER_32): INTEGER_32 -- Calculate distance between (x1, y1) and (x2, y2). -- (from EV_FIGURE_MATH) distance_from_line (x, y, x1, y1, x2, y2: INTEGER_32): INTEGER_32 -- Calculate distance between (`x`, `y`) and (x1, y1)-(x2, y2). -- The line is considered to be infinite. -- (from EV_FIGURE_MATH) line_angle (x1, y1, x2, y2: INTEGER_32): REAL_64 -- Return angle of line from (x1, y1) to (x2, y2) relative to world. -- (from EV_FIGURE_MATH) modulo (a, b: REAL_64): REAL_64 -- a modulo b. -- (from EV_FIGURE_MATH) require -- from EV_FIGURE_MATH divisible: b > 0.0 ensure -- from EV_FIGURE_MATH in_interval: Result >= 0.0 and Result < b Pi_half: REAL_64 = 1.57079633 -- (from EV_FIGURE_MATH) Pi_half_times_three: REAL_64 = 4.71238898 -- (from EV_FIGURE_MATH) Pi_quater: REAL_64 = 0.785398163 -- (from EV_FIGURE_MATH) Pi_times_three: REAL_64 = 9.42477796 -- (from EV_FIGURE_MATH) Pi_times_two: REAL_64 = 6.28318531 -- (from EV_FIGURE_MATH) point_on_ellipse (x, y, xc, yc, r1, r2: INTEGER_32): BOOLEAN -- Is (`x`, `y`) inside specified ellipse? -- (from EV_FIGURE_MATH) point_on_ellipse_boundary (x, y, xc, yc, r1, r2, width: INTEGER_32): BOOLEAN -- Is (`x`, `y`) on specified ellipse border? -- (from EV_FIGURE_MATH) point_on_line (x, y, x1, y1, x2, y2, width: INTEGER_32): BOOLEAN -- Is (`x`, `y`) on line from (x2, y2) to (x1, y1) with width? -- (from EV_FIGURE_MATH) point_on_polygon (x, y: INTEGER_32; points: ARRAY [EV_COORDINATE]): BOOLEAN -- Is (`x`, `y`) contained in polygon with points? -- Based on code by Hanpeter van Vliet. -- (from EV_FIGURE_MATH) point_on_rectangle (x, y, x1, y1, x2, y2: INTEGER_32): BOOLEAN -- Is (`x`, `y`) inside specified box? -- (from EV_FIGURE_MATH) point_on_segment (x, y, x1, y1, x2, y2, width: INTEGER_32): BOOLEAN -- Is (`x`, `y`) on segment [(x2, y2), (x1, y1)] with width? -- (from EV_FIGURE_MATH) 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 -- Representation out_abs: STRING_8 -- A string with absolute coordinates. out_rel: STRING_8 -- A string with all relative coordinates of origins. invariant notify_list_exists: notify_list_ids /= Void has_origin_implies_origin_notifies: attached origin as l_origin implies l_origin.notify_list_ids.has (object_id) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2006, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 356 Storke Road, Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class EV_RELATIVE_POINT -- Generated by Eiffel Studio --
For more details: eiffel.org