diff --git a/Bounds.txt b/Bounds.txt new file mode 100644 index 0000000000..3cac821f62 --- /dev/null +++ b/Bounds.txt @@ -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". diff --git a/LonLat.txt b/LonLat.txt new file mode 100644 index 0000000000..f70aa073f4 --- /dev/null +++ b/LonLat.txt @@ -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. diff --git a/Pixel.txt b/Pixel.txt new file mode 100644 index 0000000000..72ec9cd4d3 --- /dev/null +++ b/Pixel.txt @@ -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. diff --git a/Size.txt b/Size.txt new file mode 100644 index 0000000000..76bafea391 --- /dev/null +++ b/Size.txt @@ -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.