octave_packages/geometry-1.5.0/shape2d/doc-cache

   1 # Created by Octave 3.6.2, Sun Jun 10 09:53:43 2012 UTC <root@brouzouf>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 7
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 14
  10 curve2polyline
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 828
  17  -- Function File: POLYLINE =  curve2polyline (CURVE)
  18  -- Function File: POLYLINE =  curve2polyline (...,PROPERTY,VALUE,...)
  19      Adaptive sampling of a parametric curve.
  20
  21      The CURVE is described as a 2-by-N matrix. Rows correspond to the
  22      polynomial (compatible with `polyval') describing the respective
  23      component of the curve. The curve must be parametrized in the
  24      interval [0,1].  The vertices of the polyline are accumulated in
  25      regions of the curve where the curvature is higher.
  26
  27      *Parameters*
  28     `'Nmax''
  29           Maximum number of vertices. Not used.
  30
  31     `'Tol''
  32           Tolerance for the error criteria. Default value `1e-4'.
  33
  34     `'MaxIter''
  35           Maximum number of iterations. Default value `10'.
  36
  37     `'Method''
  38           Not implemented.
  39
  40      See also: shape2polygon, curveval
  41
  42
  43
  44
  45
  46 # name: <cell-element>
  47 # type: sq_string
  48 # elements: 1
  49 # length: 40
  50 Adaptive sampling of a parametric curve.
  51
  52
  53
  54 # name: <cell-element>
  55 # type: sq_string
  56 # elements: 1
  57 # length: 8
  58 curveval
  59
  60
  61 # name: <cell-element>
  62 # type: sq_string
  63 # elements: 1
  64 # length: 84
  65  -- Function File: P =  curveval (CURVE, T)
  66      Evaluates parametric CURVE at T.
  67
  68
  69
  70
  71
  72 # name: <cell-element>
  73 # type: sq_string
  74 # elements: 1
  75 # length: 32
  76 Evaluates parametric CURVE at T.
  77
  78
  79
  80 # name: <cell-element>
  81 # type: sq_string
  82 # elements: 1
  83 # length: 13
  84 shape2polygon
  85
  86
  87 # name: <cell-element>
  88 # type: sq_string
  89 # elements: 1
  90 # length: 494
  91  -- Function File: POLYGON =  shape2polygon (SHAPE)
  92  -- Function File: POLYGON =  shape2polygon (...,PROPERTY,VALUE,...)
  93      Transforms a 2D shape described by piecewise smooth polynomials
  94      into a polygon.
  95
  96      SHAPE is a n-by-1 cell where each element is a pair of polynomials
  97      compatible with polyval.  POLYGON is a k-by-2 matrix, where each
  98      row represents a vertex.  The property-value pairs are passed to
  99      `curve2polyline'.
 100
 101      See also: polygon2shape, curve2poyline
 102
 103
 104
 105
 106
 107 # name: <cell-element>
 108 # type: sq_string
 109 # elements: 1
 110 # length: 79
 111 Transforms a 2D shape described by piecewise smooth polynomials into a
 112 polygon.
 113
 114
 115
 116 # name: <cell-element>
 117 # type: sq_string
 118 # elements: 1
 119 # length: 9
 120 shapearea
 121
 122
 123 # name: <cell-element>
 124 # type: sq_string
 125 # elements: 1
 126 # length: 407
 127  -- Function File:  A = shapearea (PP)
 128      Calculate the area of a 2D shape defined with piecewise smooth
 129      polynomials.
 130
 131      Shape is defined with piecewise smooth polynomials. PP is a cell
 132      where each elements is a 2-by-(poly_degree+1) array containing a
 133      pair of polynomials.
 134
 135      `px(i,:) = pp{i}(1,:)' and `py(i,:) = pp{i}(2,:)'.
 136
 137      See also: shapecentroid, shape2polygon, shapeplot
 138
 139
 140
 141
 142
 143 # name: <cell-element>
 144 # type: sq_string
 145 # elements: 1
 146 # length: 75
 147 Calculate the area of a 2D shape defined with piecewise smooth
 148 polynomials.
 149
 150
 151
 152 # name: <cell-element>
 153 # type: sq_string
 154 # elements: 1
 155 # length: 13
 156 shapecentroid
 157
 158
 159 # name: <cell-element>
 160 # type: sq_string
 161 # elements: 1
 162 # length: 521
 163  -- Function File:  CM = shapecentroid (PP)
 164      Centroid of a simple plane shape defined with piecewise smooth
 165      polynomials.
 166
 167      The shape is defined with piecewise smooth polynomials. PP is a
 168      cell where each elements is a 2-by-(poly_degree+1) matrix
 169      containing a pair of polynomials.  `px(i,:) = pp{i}(1,:)' and
 170      `py(i,:) = pp{i}(2,:)'.
 171
 172      The edges of the shape should not self-intersect. This function
 173      does not check for the sanity of the shape.
 174
 175      See also: shapearea, shape2polygon
 176
 177
 178
 179
 180
 181 # name: <cell-element>
 182 # type: sq_string
 183 # elements: 1
 184 # length: 75
 185 Centroid of a simple plane shape defined with piecewise smooth
 186 polynomials.
 187
 188
 189
 190 # name: <cell-element>
 191 # type: sq_string
 192 # elements: 1
 193 # length: 9
 194 shapeplot
 195
 196
 197 # name: <cell-element>
 198 # type: sq_string
 199 # elements: 1
 200 # length: 518
 201  -- Function File: H =  shapeplot (SHAPE)
 202  -- Function File: H =  shapeplot (SHAPE, N)
 203  -- Function File: H =  shapeplot (..., PARAM, VALUE)
 204      Pots a 2D shape defined by piecewise smooth polynomials in the
 205      current axis.
 206
 207      PP is a cell where each elements is a 2-by-(poly_degree+1) matrix
 208      containing a pair of polynomials.  N is the number of points to be
 209      used in non-straight edges.  Additional parameter value pairs are
 210      passed to `drawPolygon'.
 211
 212      See also: drawPolygon, shape2polygon
 213
 214
 215
 216
 217
 218 # name: <cell-element>
 219 # type: sq_string
 220 # elements: 1
 221 # length: 76
 222 Pots a 2D shape defined by piecewise smooth polynomials in the current
 223 axis.
 224
 225
 226
 227 # name: <cell-element>
 228 # type: sq_string
 229 # elements: 1
 230 # length: 14
 231 shapetransform
 232
 233
 234 # name: <cell-element>
 235 # type: sq_string
 236 # elements: 1
 237 # length: 463
 238  -- Function File: NSHAPE =  shapetransform (SHAPE, T)
 239      Applies transformation to a shape defined by piecewise smooth
 240      polynomials.
 241
 242      SHAPE is a cell where each elements is a 2-by-(poly_degree+1)
 243      matrix containing a pair of polynomials.
 244
 245      Format of T can be one of :
 246            [c] , [a b] , [a b c] or [a b c]
 247            [f]   [d e]   [d e f]    [d e f]
 248                                     [0 0 1]
 249
 250      See also: shape2polygon, shapeplot
 251
 252
 253
 254
 255
 256 # name: <cell-element>
 257 # type: sq_string
 258 # elements: 1
 259 # length: 74
 260 Applies transformation to a shape defined by piecewise smooth
 261 polynomials.
 262
 263
 264
 265
 266