octave_packages/geometry-1.5.0/geom2d/readme.txt

   1 %% Copyright (c) 2011, INRA
   2 %% 2007-2011, David Legland <david.legland@grignon.inra.fr>
   3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
   4 %%
   5 %% All rights reserved.
   6 %% (simplified BSD License)
   7 %%
   8 %% Redistribution and use in source and binary forms, with or without
   9 %% modification, are permitted provided that the following conditions are met:
  10 %%
  11 %% 1. Redistributions of source code must retain the above copyright notice, this
  12 %%    list of conditions and the following disclaimer.
  13 %%
  14 %% 2. Redistributions in binary form must reproduce the above copyright notice,
  15 %%    this list of conditions and the following disclaimer in the documentation
  16 %%    and/or other materials provided with the distribution.
  17 %%
  18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 %% POSSIBILITY OF SUCH DAMAGE.
  29 %%
  30 %% The views and conclusions contained in the software and documentation are
  31 %% those of the authors and should not be interpreted as representing official
  32 %% policies, either expressed or implied, of copyright holder.
  33
  34
  35 Description of the geom2d library.
  36
  37 The aim of geom2d library is to handle and visualize geometric primitives such
  38 as points, lines, circles and ellipses, polylines and polygons...  It provides
  39 low-level functions for manipulating geometrical primitives, making easier the
  40 development of more complex geometric algorithms.
  41
  42 Some features of the library are:
  43
  44 - creation of various shapes (points, circles, lines, ellipses, polylines,
  45     polygons...) through an intuitive syntax.
  46     Ex: createCircle(p1, p2, p3) to create a circle through 3 points.
  47
  48 - derivation of new shapes: intersection between 2 lines, between line and
  49     circle, between polylines... or point on a curve from its parametrisation
  50
  51 - functions for polylines and polygons: compute centroid and area, expand,
  52     self-intersections, clipping with half-plane...
  53
  54 - manipulation of planar transformation. Ex.:
  55     ROT = createRotation(CENTER, THETA);
  56     P2 = transformPoint(P1, ROT);
  57
  58 - direct drawing of shapes with specialized functions. Clipping is performed
  59     automatically for infinite shapes such as lines or rays. Ex:
  60     drawCircle([50 50 25]);     % draw circle with radius 25 and center [50 50]
  61     drawLine([X0 Y0 DX DY]);    % clip and draw straight line
  62
  63 - measure distances (between points, a point and a line, a point and a group
  64     of points), angle (of a line, between 3 points), or test geometry (point
  65     on a line, on a circle).
  66
  67 Additional help is provided in geom/Contents.m file, as well as summary files
  68     like 'points2d.m' or 'lines2d.m'.