Changeset 994

Show
Ignore:
Timestamp:
01/02/08 15:25:30
Author:
seang
Message:

Made improvements suggested by Kristian

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • Shapely/trunk/manual/manual.txt

    r993 r994  
    107107 
    108108  >>> polygon = Polygon((a1, ..., aM), [(b1, ..., bN), ...]) 
     109 
     110Rings *must* be non-crossing, ordered coordinate sequences. The order may be 
     111clockwise or counter-clockwise. The resulting topology is independent of the 
     112order. 
    109113 
    110114Multipart Geometry Factories 
     
    182186++++++ 
    183187 
    184 .buffer(distance, quadsegs=16) : geometry 
    185   Buffers the geometry by a unitless *distance*. The *quadsegs* parameter is 
    186   the number of segments per quadrant in resulting geometries. The default 
    187   result of buffering a point is a 66-gon approximation of a circle: 
     188.buffer(width, quadsegs=16) : geometry 
     189  Returns a buffer region having the given width and with a specified number of 
     190  segments used to approximate curves. 
     191   
     192The default result of buffering a point is an N-gon approximation of a circle: 
    188193 
    189194.. code-block:: python 
     
    250255 
    251256.difference(other) : geometry 
    252   Returns the difference of one geometry from the *other* geometry. Note that 
    253   A.difference(B) is not equal to B.difference(A). 
     257  Returns a geometry representing the points making up this geometry that do 
     258  not make up *other*. Note that A.difference(B) is not necessarily equal to 
     259  B.difference(A). 
    254260 
    255261.. code-block:: python 
     
    274280 
    275281.symmetric_difference(other) : geometry 
    276   Returns the symmetric difference of one geometry from the *other* geometry. 
     282  Returns a geometry combining the points in this geometry not in *other*, and 
     283  the points in *other* not in this geometry. 
    277284 
    278285.. code-block:: python 
     
    431438  The inverse of *contains*. 
    432439 
     440General Methods 
     441--------------- 
     442 
     443Distance 
     444++++++++ 
     445 
     446.distance(other) : geometry 
     447  The minimum distance from one geometry to the other. 
     448 
     449.. code-block:: python 
     450 
     451  >>> Point(0,0).distance(Point(1,1)) 
     452  1.4142135623730951 
     453 
     454 
    433455Scalar Properties 
    434456----------------- 
     
    437459++++ 
    438460 
    439 area : float 
     461.area : float 
    440462  Area of the geometry, unitless. Non-zero only for surfaces (polygons, 
    441463  multi-polygons). 
     
    444466++++++ 
    445467 
    446 length : float 
     468.length : float 
    447469  Length of the geometry, unitless. Non-zero only for linear geometries 
    448470  (line strings, rings, polygon boundaries)