These pages are auto-generated from self-documenting comments embedded in class files.

For more information on breve and steve, refer to the breve homepage.

Abstract : Patch

Class methods:



get-moore-neighborhood

Returns a list of the 2D Moore neighborhood, using the X/Y plane. If you intend to use the neighborhood frequently, you should call this method once and keep a copy of the list.


get-patch-above

Returns the patch towards (0, 1, 0).


get-patch-below

Returns the patch towards (0, -1, 0).


get-patch-to-east

Assumes that the patches are being observed from an XZ-plane. Returns the patch towards (1, 0, 0).


get-patch-to-left

Returns the patch towards (-1, 0, 0).


get-patch-to-lower-left

Returns the patch towards (-1, -1, 0).


get-patch-to-lower-right

Returns the patch towards (1, -1, 0).


get-patch-to-north

Assumes that the patches are being observed from an XZ-plane. Returns the patch towards (0, 0, -1).


get-patch-to-right

Returns the patch towards (1, 0, 0).


get-patch-to-south

Assumes that the patches are being observed from an XZ-plane. Returns the patch towards (0, 0, 1).


get-patch-to-upper-left

Returns the patch towards (-1, 1, 0).


get-patch-to-upper-right

Returns the patch towards (1, 1, 0).


get-patch-to-west

Assumes that the patches are being observed from an XZ-plane. Returns the patch towards (-1, 0, 0).


get-patch-towards-minus-x

Returns the patch towards (-1, 0, 0).


get-patch-towards-minus-x-minus-y

returns the patch towards (-1, -1, 0)


get-patch-towards-minus-x-plus-y

returns the patch towards (-1, 1, 0)


get-patch-towards-minus-y

Returns the patch towards (0, -1, 0).


get-patch-towards-minus-z

Returns the patch towards (0, 0, -1).


get-patch-towards-plus-x

Returns the patch towards (1, 0, 0).


get-patch-towards-plus-x-minus-y

returns the patch towards (1, -1, 0)


get-patch-towards-plus-x-plus-y

returns the patch towards (1, 1, 0)


get-patch-towards-plus-y

Returns the patch towards (0, 1, 0).


get-patch-towards-plus-z

Returns the patch towards (0, 0, 1).


get-von-neumann-neighborhood

Returns a list of the 2D Von Neumann neighborhood, using the X/Y plane. If you intend to use the neighborhood frequently, you should call this method once and keep a copy of the list.


get-x-index

Returns the x index of the patch.


get-y-index

Returns the y index of the patch.


get-z-index

Returns the z index of the patch.


init-patch

This method does nothing in its default implementation. You can implement your own init-patch method in your patch class in order to perform initialization on the patch. This method is called after all the neighbor objects have been created--if you do initialization in the init method, the neighbors will not be initialized.


set-color to newColor (vector)

Sets the color of the patch to newColor. Bear in mind that you'll also need to set the transparency of the patch if you want the patch to be displayed. See the method set-transparency for more information.


set-transparency to theTransparency (float)

Sets the transparency of the patch to theTransparency. The default value is 1.0, which is fully transparent. No matter how much you set the color of the patch, it won't be visible until you've set the transparency to a value other than 1.0.


update-colors

Used internally. Synchronizes the patch's color with recently dearchived values.


Documentation created Tue May 11 10:28:37 2004