1.4.2 Send methods

area ->center: point

Move the area<-x and area<-y of the area such that the area<-center of the area matches the argument point.

See also

area->set

area ->clear:

Equivalent to area->set: 0, 0, 0, 0. Note that an area with area<-width or area<-height equal contain no pixels and area->union with such an area is a no-op.

See also

area->union

area ->corner: point

Manipulate area<-width and area<-height such that area<-corner matches the argument point. Its graphical->corner counterpart is sometimes used to implement resizing.

See also

area<-corner

area ->decrease: int

Makes the area from all sides smaller by the specified amount. For normalised areas (see area->normalise), this implies:

<-width := <-width - 2*<arg>
<-x     := <-x + <arg>

and similar for area<-y and area<-height. Deals properly with non-normalised areas.

See also

- graphical->resize
- area->increase

area ->equal: area

Succeed if the normalised representation of both areas is the same. See area->normalise.

area ->in: point

@see event->inside

area ->increase: int

Move all sides outward. This is the opposite operation of area->decrease.

See also

area->decrease

area ->initialise: x=[int], y=[int], width=[int], height=[int]

Creates an area with origin at (X,Y) and given width and height.

area ->inside: area

Succeeds if the argument area is inside this area. See also area->in, graphical->in_event_area and area->overlap.

See also

device<-inside

area ->intersection: area

Area becomes the intersection with the argument area. The intersection is the largest (rectangular) area that is area->inside both area's. To get the intersection without modifying either of the areas, use area<-intersection. Fails without modifying the area if the areas do not area->overlap.

See also

- area->overlap
- area<-intersection

area ->normalise:

Places the origin at the top-left corner. Equivalent to area->orientation: north_west.

See also

- area<-normalised
- area->orientation
- class area

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

An area object is described by its area<-x, area<-y, area<-width and area<-height. The point (area<-x, area<-y) is called the origin or area<-position. Either or both area<-width and area<-height (together representing area<-size) may be negative. This method manipulates one or both of the pairs area<-x/area<-width or area<-y/area<-height such that the origin becomes the indicated corner.

The call area->orientation: north_west is equivalent to area->normalise.

area->orientation	area->width	area->height
north_west	>= 0	>= 0
south_west	>= 0	< 0
north_east	< 0	>= 0
south_east	< 0	< 0

See also

class area

area ->overlap: area

Succeeds if both areas describe common pixels. If this message succeeds, area<-distance returns 0 and area->intersection computes the common pixels.

See also

- area->intersection
- area<-distance

area ->position: point

Copy area<-x and area<-y from the corresponding values of the point object.

area ->relative_move: point

Executes area<-x := area<-x + point<-x and area<-y := area<-y + point<-y.

area ->set: x=[int], y=[int], width=[int], height=[int]

Sets area<-x, area<-y, area<-width and area<-height from the 4 integer arguments. Any argument that is @default will not cause the corresponding parameter to be changed.

area ->size: size

Sets area->width and area->height from the corresponding size parameters.

area ->union: area

Enlarge the area such that it represents the smallest area containing both area objects. area<-union computes the same without changing either of the area objects.

See also

- area<-union
- area->clear