Automatic generation produced by ISE Eiffel
note description: "Closed figures filled with `background_color`." legal: "See notice at end of class." status: "See notice at end of class." keywords: "figure, atomic, filled, closed" date: "$Date: 2017-05-03 07:56:14 -0800 (Wed, 03 May 2017) $" revision: "$Revision: 100317 $" deferred class interface EV_CLOSED_FIGURE feature -- Access 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 background_color: detachable EV_COLOR -- Color used to fill Current. 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 dashed_line_style: BOOLEAN -- Are lines drawn dashed? -- (from EV_ATOMIC_FIGURE) 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 foreground_color: EV_COLOR -- Color of text, lines, etc. -- (from EV_ATOMIC_FIGURE) generating_type: TYPE [detachable EV_CLOSED_FIGURE] -- 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 group: detachable EV_FIGURE_GROUP -- Parent of Current. -- (from EV_FIGURE) 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 line_width: INTEGER_32 -- Thickness of lines. -- (from EV_ATOMIC_FIGURE) 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 orientation: REAL_64 -- Angle of first point of Current. -- (from EV_FIGURE) pebble: detachable ANY -- Data to be transported by pick and drop mechanism. -- (from EV_FIGURE) pebble_function: detachable FUNCTION [detachable ANY] -- Returns data to be transported by pick and drop mechanism. -- When not Void, `pebble` is ignored. -- (from EV_FIGURE) 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) point_array: ARRAY [EV_COORDINATE] -- `points` as absolute coordinates. -- (from EV_FIGURE) ensure -- from EV_FIGURE same_length: Result.count = points.count point_count: INTEGER_32 -- Number of points needed to describe Current. -- (from EV_FIGURE) pointer_style: detachable EV_POINTER_STYLE -- Cursor displayed when pointer is over this figure. -- (from EV_FIGURE) 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 target_data_function: detachable FUNCTION [like pebble, EV_PND_TARGET_DATA] -- Function for computing target meta data based on source pebble. -- Primarily used for Pick and Drop target menu. -- (from EV_ABSTRACT_PICK_AND_DROPABLE) note option: stable target_name: detachable READABLE_STRING_GENERAL -- Optional textual name describing Current pick and drop hole. -- (from EV_ABSTRACT_PICK_AND_DROPABLE) note option: stable world: detachable EV_FIGURE_WORLD -- Top-level parent of Current. -- (from EV_FIGURE) 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_CLOSED_FIGURE): 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_CLOSED_FIGURE): 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_CLOSED_FIGURE): 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 accept_cursor: EV_POINTER_STYLE -- Accept cursor set by user. -- To be displayed when the screen pointer is over a target that accepts -- `pebble` during pick and drop. -- (from EV_FIGURE) 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 deny_cursor: EV_POINTER_STYLE -- Deny cursor set by user. -- To be displayed when the screen pointer is not over a valid target. -- (from EV_FIGURE) has_capture: BOOLEAN -- Are all events sent to Current? -- (from EV_FIGURE) frozen id_freed: BOOLEAN -- Has Current been removed from the table? -- (from IDENTIFIED) is_filled: BOOLEAN -- Is this figure filled? is_sensitive: BOOLEAN -- Is object sensitive to user input? -- (from EV_FIGURE) is_show_requested: BOOLEAN -- Will Current be displayed when its parent is? -- (from EV_FIGURE) 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 -- Status setting disable_capture -- Disable grab of all events on `world`. -- (from EV_FIGURE) require -- from EV_FIGURE in_world: world /= Void ensure -- from EV_FIGURE capture_released: not has_capture disable_dashed_line_style -- Draw lines solid. -- (from EV_ATOMIC_FIGURE) ensure -- from EV_ATOMIC_FIGURE dashed_line_style_disabled: not dashed_line_style disable_sensitive -- Make object non-sensitive to user input. -- (from EV_FIGURE) ensure -- from EV_FIGURE insensitive_requested: not internal_is_sensitive enable_capture -- Grab all mouse events for `world`. -- (from EV_FIGURE) require -- from EV_FIGURE in_world: world /= Void ensure -- from EV_FIGURE capture_set: has_capture enable_dashed_line_style -- Draw lines dashed. -- (from EV_ATOMIC_FIGURE) ensure -- from EV_ATOMIC_FIGURE dashed_line_style_enabled: dashed_line_style enable_sensitive -- Make object sensitive to user input. -- (from EV_FIGURE) ensure -- from EV_FIGURE sensitive_requested: internal_is_sensitive hide -- Request that Current not be displayed even when its `group` is. -- (from EV_FIGURE) ensure -- from EV_FIGURE not_is_show_requested: not is_show_requested intersects (r: EV_RECTANGLE): BOOLEAN -- Does r intersect Currents `bounding_box`? -- (from EV_FIGURE) remove_background_color -- Do not fill this figure. ensure background_color_removed: background_color = Void set_background_color (a_color: EV_COLOR) -- Set `background_color` to a_color. require a_color_exists: a_color /= Void ensure background_color_assigned: background_color = a_color set_foreground_color (a_color: EV_COLOR) -- Assign a_color to `foreground_color`. -- (from EV_ATOMIC_FIGURE) require -- from EV_ATOMIC_FIGURE a_color_not_void: a_color /= Void ensure -- from EV_ATOMIC_FIGURE foreground_color_assigned: foreground_color = a_color set_line_width (a_width: INTEGER_32) -- Assign a_width to `line_width`. -- (from EV_ATOMIC_FIGURE) require -- from EV_ATOMIC_FIGURE a_width_non_negative: a_width >= 0 ensure -- from EV_ATOMIC_FIGURE line_width_assigned: line_width = a_width set_target_data_function (a_function: FUNCTION [like pebble, EV_PND_TARGET_DATA]) -- Set a_function to compute target meta data based on transport source. -- Overrides any `target_name` set with `set_target_name`. -- (from EV_ABSTRACT_PICK_AND_DROPABLE) require -- from EV_ABSTRACT_PICK_AND_DROPABLE a_function_not_void: a_function /= Void ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE target_data_function_assigned: target_data_function /= Void and then target_data_function.is_equal (a_function) set_target_name (a_name: READABLE_STRING_GENERAL) -- Assign a_name to `target_name`. -- (from EV_ABSTRACT_PICK_AND_DROPABLE) require -- from EV_ABSTRACT_PICK_AND_DROPABLE a_name_not_void: a_name /= Void ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE target_name_assigned: attached target_name as l_target_name and then a_name /= l_target_name and then a_name.same_string (l_target_name) show -- Request that Current be displayed when its `group` is. -- True by default. -- (from EV_FIGURE) ensure -- from EV_FIGURE is_show_requested: is_show_requested feature -- Element change remove_pebble -- Make `pebble` Void and `pebble_function` `Void, -- Removing transport. -- (from EV_FIGURE) ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE pebble_removed: pebble = Void and pebble_function = Void set_accept_cursor (a_cursor: detachable like accept_cursor) -- Set a_cursor to be displayed when the screen pointer is over a -- target that accepts `pebble` during pick and drop. -- (from EV_FIGURE) ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE accept_cursor_assigned: attached a_cursor as l_accept_cursor implies l_accept_cursor ~ accept_cursor set_deny_cursor (a_cursor: detachable like deny_cursor) -- Set a_cursor to be displayed when the screen pointer is not -- over a valid target. -- (from EV_FIGURE) ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE deny_cursor_assigned: attached a_cursor as l_deny_cursor implies l_deny_cursor ~ deny_cursor set_origin (an_origin: EV_RELATIVE_POINT) -- Change origin of all points to o without moving. -- (from EV_FIGURE) set_pebble (a_pebble: like pebble) -- Assign a_pebble to `pebble`. -- (from EV_FIGURE) require -- from EV_ABSTRACT_PICK_AND_DROPABLE a_pebble_not_void: a_pebble /= Void ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE pebble_assigned: pebble = a_pebble set_pebble_function (a_function: FUNCTION [ANY]) -- Set a_function to compute `pebble`. -- (from EV_FIGURE) require -- from EV_ABSTRACT_PICK_AND_DROPABLE a_function_not_void: a_function /= Void a_function_takes_two_integer_open_operands: a_function.valid_operands ([1, 1]) ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE pebble_function_assigned: pebble_function = a_function set_pointer_style (a_cursor: like pointer_style) -- Assign a_cursor to `pointer_style`. -- (from EV_FIGURE) require -- from EV_FIGURE a_cursor_not_void: a_cursor /= Void ensure -- from EV_FIGURE pointer_style_assigned: pointer_style = a_cursor 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_CLOSED_FIGURE) -- 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_CLOSED_FIGURE) -- 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_CLOSED_FIGURE -- 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_CLOSED_FIGURE) -- 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_CLOSED_FIGURE -- 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_CLOSED_FIGURE -- 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_CLOSED_FIGURE -- 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 -- Action sequences conforming_pick_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when a pebble that fits this hole is -- picked up from another source. -- (when drop_actions.accepts_pebble (pebble)) -- (from EV_FIGURE) drop_actions: EV_PND_ACTION_SEQUENCE -- Actions to take when pick and drop transport drops on Current. -- (from EV_FIGURE) pick_actions: EV_PND_START_ACTION_SEQUENCE -- Actions to be performed when `pebble` is picked up. -- (from EV_FIGURE) pointer_button_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is pressed. -- (from EV_FIGURE) pointer_button_release_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is released. -- (from EV_FIGURE) pointer_double_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer is double clicked. -- (from EV_FIGURE) pointer_enter_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen pointer enters widget. -- (from EV_FIGURE) pointer_leave_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen pointer leaves widget. -- (from EV_FIGURE) pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE -- Actions to be performed when screen pointer moves. -- (from EV_FIGURE) feature -- Events bounding_box: EV_RECTANGLE -- Smallest orthogonal rectangular area Current fits in. -- (from EV_FIGURE) ensure -- from EV_FIGURE not_void: Result /= Void position_on_figure (x, y: INTEGER_32): BOOLEAN -- Is the point on (x, y) on this figure? -- (from EV_FIGURE) 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 EV_ATOMIC_FIGURE foreground_color_exists: foreground_color /= Void line_width_non_negative: line_width >= 0 -- from EV_FIGURE points_not_void: points /= Void points_correct_size: points.count = point_count points_items_not_void: all_points_exist (points) -- 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_CLOSED_FIGURE -- Generated by Eiffel Studio --
For more details: eiffel.org