source: trunk/docs/api/zoo-bounds.txt @ 161

Last change on this file since 161 was 161, checked in by jmckenna, 13 years ago

add ZOO.Bounds doc

File size: 2.9 KB
Line 
1.. _api-zoo-bounds:
2
3ZOO.Bounds
4==========
5
6Instances of this class represent bounding boxes.
7
8Properties     
9----------
10
11.. list-table::
12   :widths: 30 50
13   :header-rows: 1
14
15   * - NAME
16     - DESCRIPTION
17   * - :ref:`left <left>`
18     - {Number} Minimum horizontal coordinate.
19   * - :ref:`bottom <bottom>`
20     - {Number} Minimum vertical coordinate.
21   * - :ref:`right <right>`
22     - {Number} Maximum horizontal coordinate.
23   * - :ref:`top <top>`
24     - {Number} Maximum vertical coordinate.   
25     
26Functions
27--------- 
28
29.. list-table::
30   :widths: 20 50
31   :header-rows: 1
32
33   * - NAME
34     - DESCRIPTION
35   * - :ref:`ZOO.Bounds <ZOO.Bounds>`
36     - Construct a new bounds object.
37   * - :ref:`clone <clone>`
38     - Create a cloned instance of this bounds.
39   * - :ref:`equals <equals>`
40     - Test a two bounds for equivalence.
41   * - :ref:`toString <toString>`
42     - {String} String representation of bounds object.
43   * - :ref:`toBBOX <toBBOX>`
44     -
45   * - :ref:`toGeometry <toGeometry>`
46     - Create a new polygon geometry based on this bounds.
47   * - :ref:`getWidth <getWidth>`
48     - {Float} The width of the bounds
49   * - :ref:`getHeight <getHeight>`
50     - {Float} The height of the bounds (top minus bottom) 
51   * - :ref:`add <add>`
52     -
53   * - :ref:`extend <extend>`
54     - Extend the bounds to include the point, lonlat, or bounds specified.
55   * - :ref:`intersectsBounds <intersectsBounds>`
56     - Determine whether the target bounds intersects this bounds.
57   * - :ref:`containsBounds <containsBounds>`
58     - Determine whether the target bounds is contained within this bounds.     
59
60**Properties**
61   
62.. _left:   
63   
64left   
65  {Number} Minimum horizontal coordinate.
66 
67.. _bottom:     
68 
69bottom 
70  {Number} Minimum vertical coordinate.
71
72.. _right:     
73
74right   
75  {Number} Maximum horizontal coordinate.
76
77.. _top:     
78
79top     
80  {Number} Maximum vertical coordinate.
81
82**Functions**
83
84.. _ZOO.Bounds:     
85
86ZOO.Bounds     
87  Construct a new bounds object.
88 
89.. _clone:       
90
91clone   
92  Create a cloned instance of this bounds.
93
94.. _equals:       
95
96equals 
97  Test a two bounds for equivalence.
98
99.. _toString:
100
101toString       
102  {String} String representation of bounds object.
103 
104.. _toBBOX:   
105 
106toBBOX 
107
108.. _toGeometry:   
109
110toGeometry     
111  Create a new polygon geometry based on this bounds.
112 
113.. _getWidth:     
114
115getWidth       
116  {Float} The width of the bounds
117 
118.. _getHeight:       
119 
120getHeight       
121  {Float} The height of the bounds (top minus bottom)
122
123.. _add:       
124
125add
126
127.. _extend:       
128
129extend 
130  Extend the bounds to include the point, lonlat, or bounds specified.
131 
132.. _intersectsBounds:         
133 
134intersectsBounds       
135  Determine whether the target bounds intersects this bounds.
136 
137.. _containsBounds:         
138 
139containsBounds 
140  Determine whether the target bounds is contained within this bounds.
Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png