/tclspline/doc/spline.n

http://flightaware-tcltools.googlecode.com/ · Unknown · 47 lines · 46 code · 1 blank · 0 comment · 0 complexity · 4325b17e776ba10c5c31285af0f88d69 MD5 · raw file

  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '\" Copyright (c) 2005 Karl Lehenbauer
  5. '\"
  6. '\" See the file "license.terms" for information on usage and redistribution
  7. '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  8. '\"
  9. '\" RCS: @(#) $Id: spline.n,v 1.1 2005-11-24 03:55:22 karl Exp $
  10. '\"
  11. '\".so man.macros
  12. .TH read n 0.0 TclSpline "Spline Extension for Tcl"
  13. .BS
  14. '\" Note: do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. spline \- Generate a set of quadratic splines based on an input list
  17. .SH SYNOPSIS
  18. \fBspline \fR \fInSteps pointList\fR
  19. .sp
  20. \fBspline_raw \fInSteps pointList\fR
  21. .BE
  22. .SH DESCRIPTION
  23. .PP
  24. Input is an integer number of steps, \fInSteps\fR, and a list containing
  25. three or more pairs of x and y coordinates. \fBspline\fR reads that
  26. list and generates a new list of x and y coordinate pairs representing
  27. a curve based on the passed points, rendered as a set of quadratic
  28. splines: one spline is drawn for the first and second line segments, one
  29. for the second and third, and so on.
  30. .PP
  31. Straight-line segments can be generated within
  32. a curve by duplicating the end-points of the desired line segment.
  33. .PP
  34. \fBspline_raw\fR indicates that the list should also be returned as a
  35. curve, but the list of coordinates is such that the first coordinate pair
  36. (and every third coordinate pair thereafter) is a knot point on a cubic
  37. Bezier curve, and the other coordinates are control points on the cubic
  38. Bezier curve.
  39. .PP
  40. Straight line segments can be generated within a curve by making control
  41. points equal to their neighboring knot points. If the last point is a
  42. control point and not a knot point, the point is repeated (one or two
  43. times) so that it also becomes a knot point.
  44. .PP
  45. \fInSteps\fR specifies the degree of smoothness desired for curves: each
  46. spline will be approximated with \fInSteps\fR line segments.