1.4.3 Get methods

area <-left_side: -> int

area <-right_side: -> int

area <-top_side: -> int

area <-bottom_side: -> int

Return the pixel position of the specified edge. Deals properly with areas in any area<-orientation.

See also

- area<-top_side
- area<-right_side
- area<-left_side

area <-corner: -> point

New point at area<-x + area<-width, area<-y + area<-height

See also

- graphical->corner
- area->corner

area <-distance: area -> int

Yields the length of the shortest line that can connect a point on the outline of the first area with a point on the outline of the second area. Yields 0 if the graphicals overlap.

See also

- area<-distance_y
- area<-distance_x
- area->overlap
- graphical<-distance

area <-distance_x: area -> int

Yields an integer representing the distance between the areas in X-direction. Yields 0 if both areas overlap in X-direction.

See also

- area<-distance
- area<-distance_y
- graphical<-distance_x

area <-distance_y: area -> int

Yields an integer representing the distance between the areas in Y-direction. Yields 0 if both areas overlap in Y-direction.

See also

- area<-distance
- area<-distance_x

area <-intersection: area -> area

New area object that represents the common part of the receiver and argument area. The area<-orientation of the new area is the same as that of the receiver.

See also area->intersection and area<-union.

Diagnostics: Fails if the areas do not area->overlap.

See also

area->intersection

area <-less_sides: area -> int

Like area->same_sides, but returns those sides for which the value in the receiver is closer to the origin (i.e. less) then for the argument area.

See also

- area<-same_sides
- area<-near_sides

area <-near_sides: area, int -> int

Same as area<-same_sides, but accepts sides to be the same when they are within the specified distance. With distance 0, exactly the same as area<-same_sides.

See also

- area<-same_sides
- area<-less_sides

area <-normalised: -> area

Return a new area object that describes the same collection of pixels and has area<-orientation = north_west.

See also

area->normalise

area <-orientation: -> {north_west,south_west,north_east,south_east}

Current orientation. See area->orientation for details.

Inherits description from: area->orientation

area <-position: -> point

New point object from area<-x and area<-y.

area <-same_sides: area -> int

Returns a bitmask for sides that have the same value on both arguments. Implemented in the darkness of time for handling automatic layout. The values of the mask are:

Receiver	Argument	Value (octal)
top	top	01
top	center	02
top	bottom	04
center	top	010
bottom	top	020
bottom	center	040
bottom	bottom	0100
left	left	0200
left	middle	0400
left	right	01000
middle	left	02000
middle	middle	04000
middle	right	010000
right	left	020000
right	middle	040000
right	right	0100000

The PCE/Prolog library file area.pl defines these bitmasks.

area <-size: -> size

New size object from the area<-width and area<-height of the area. Note that either or both may be negative. See area->orientation.

area <-union: area -> area