Add BaseTypes docs.

git-svn-id: http://svn.openlayers.org/trunk/openlayers/doc@1268 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
crschmidt
2006-08-17 02:21:59 +00:00
parent b278b8db1f
commit 4ad0609e07
4 changed files with 58 additions and 0 deletions

21
Bounds.txt Normal file
View File

@@ -0,0 +1,21 @@
OpenLayers.Bounds
This class represents a bounding box. Data stores as left, bottom, right, top floats.
* Constructor
OpenLayers.Bounds(left, bottom, right, top) -- Create new Bounds.
* Methods
clone() -- {OpenLayers.Bounds} -- Return copy of the current bounds.
toString() -- {String} -- Return bounds as string.
toBBOX() -- {String} -- Return bounds as simple string, usable for WMS.
getWidth() -- {float} -- Return width of bounds.
getHeight() -- {float} -- Return height of bounds.
getSize() -- {OpenLayers.Size} -- Return size of bounds.
getCenterPixel() -- {OpenLayers.Pixel} -- Return center of bounds as pixel.
getCenterLonLat() -- {OpenLayers.LonLat} -- Return center of bounds as LonLat.
equals({OpenLayers.Bounds|bounds}) -- {Boolean} -- whether or not the bounds are equivilant.
add({float|x}, {float|y}) -- {OpenLayers.Bounds} -- Shift bounds by x and y.
contains({float|x}, {float|y}, {Boolean|inclusive}) -- {Boolean} -- Return Whether or not the passed-in coordinates are within this bounds
containsBounds({OpenLayers.Bounds|bounds}, {Boolean|partial}, {Boolean|inclusive}) -- {Boolean} -- Returns whether or not the passed-in OpenLayers.Bounds object is contained within this bounds. partial indicates whether bounds must be contained or only overlap. Inclusive determines whether border is included.
determineQuadrant({OpenLayers.LonLat|lonlat}) -- {String} -- Determine which quadrant the LonLat is in. Returns combination of "b" or "t" and "l" or "r".

13
LonLat.txt Normal file
View File

@@ -0,0 +1,13 @@
OpenLayers.LonLat
This class represents a geographic coordinate pair, either projected or unprojected.
* Constructor
OpenLayers.LonLat({float|lon}, {float|lat}) -- Create LonLat.
* Methods
toString() -- {String} -- Converts to human readable string.
toShortString() -- {String} -- Converts to short human readable string.
clone() -- {OpenLayers.Size} -- Returns a copy of the pixel.
equals({OpenLayers.LonLat|ll}) -- {Boolean} -- Compares two LonLats.
add({int|lon}, {int|lat}) -- {OpenLayers.LonLat} -- add x and y to the current coordinates.

13
Pixel.txt Normal file
View File

@@ -0,0 +1,13 @@
OpenLayers.Pixel
This class represents a screen coordinate in x and y coordinates.
* Constructor
OpenLayers.Pixel({float|x}, {float|y}) -- Create Pixel.
* Methods
toString() -- {String} -- Converts to human readable string.
clone() -- {OpenLayers.Pixel} -- Returns a copy of the pixel.
equals({OpenLayers.Pixel|px}) -- {Boolean} -- Tests for equivilance.
add({int|x}, {int|y}) -- {OpenLayers.Pixel} -- add x and y to the current coordinates.
offset({OpenLayers.Pixel|pixel}) -- {OpenLayers.Pixel} -- Add pixels together.

11
Size.txt Normal file
View File

@@ -0,0 +1,11 @@
OpenLayers.Size
This class represents a width/height pair.
* Constructor
OpenLayers.Size({float|h}, {float|w}) -- Create Size.
* Methods
toString() -- {String} -- Converts to human readable string.
clone() -- {OpenLayers.Size} -- Returns a copy of the pixel.
add({int|x}, {int|y}) -- {OpenLayers.Size} -- add x and y to the current coordinates.