Last change
on this file since 817 was
348,
checked in by neteler, 13 years ago
|
set correctly svn propset
|
-
Property svn:eol-style set to
native
-
Property svn:keywords set to
HeadURL Date Author Id Rev
-
Property svn:mime-type set to
text/plain
|
File size:
1.4 KB
|
Rev | Line | |
---|
[348] | 1 | .. _api-zoo-geometry-curve: |
---|
| 2 | |
---|
| 3 | ZOO.Geometry.Curve |
---|
| 4 | ================== |
---|
| 5 | |
---|
| 6 | A Curve is a MultiPoint, whose points are assumed to be connected. To this end, |
---|
| 7 | we provide a "getLength()" function, which iterates through the points, summing the |
---|
| 8 | distances between them. |
---|
| 9 | |
---|
| 10 | Inherits from |
---|
| 11 | |
---|
| 12 | - :ref:`ZOO.Geometry.MultiPoint <api-zoo-geometry-multipoint>` |
---|
| 13 | |
---|
| 14 | Properties |
---|
| 15 | ---------- |
---|
| 16 | |
---|
| 17 | .. list-table:: |
---|
| 18 | :widths: 12 50 |
---|
| 19 | :header-rows: 1 |
---|
| 20 | |
---|
| 21 | * - NAME |
---|
| 22 | - DESCRIPTION |
---|
| 23 | * - :ref:`componentTypes <componentTypes>` |
---|
| 24 | - {Array(String)} An array of class names representing the types of components that the collection can include. |
---|
| 25 | |
---|
| 26 | Functions |
---|
| 27 | --------- |
---|
| 28 | |
---|
| 29 | .. list-table:: |
---|
| 30 | :widths: 15 50 |
---|
| 31 | :header-rows: 1 |
---|
| 32 | |
---|
| 33 | * - NAME |
---|
| 34 | - DESCRIPTION |
---|
| 35 | * - :ref:`ZOO.Geometry.Curve <ZOO.Geometry.Curve>` |
---|
| 36 | - |
---|
| 37 | * - :ref:`getLength <getLength>` |
---|
| 38 | - {Float} The length of the curve |
---|
| 39 | |
---|
| 40 | **Properties** |
---|
| 41 | |
---|
| 42 | .. _componentTypes: |
---|
| 43 | |
---|
| 44 | componentTypes |
---|
| 45 | ``{Array(String)}`` An array of class names representing the types of components that the |
---|
| 46 | collection can include. A null value means the component types are not restricted. |
---|
| 47 | |
---|
| 48 | **Functions** |
---|
| 49 | |
---|
| 50 | .. _ZOO.Geometry.Curve: |
---|
| 51 | |
---|
| 52 | ZOO.Geometry.Curve |
---|
| 53 | |
---|
| 54 | *Parameters* |
---|
| 55 | |
---|
| 56 | ``point`` {Array(:ref:`ZOO.Geometry.Point <api-zoo-geometry-point>`)} |
---|
| 57 | |
---|
| 58 | .. _getLength: |
---|
| 59 | |
---|
| 60 | getLength |
---|
| 61 | |
---|
| 62 | :: |
---|
| 63 | |
---|
| 64 | getLength: function() |
---|
| 65 | |
---|
| 66 | *Returns* |
---|
| 67 | |
---|
| 68 | ``{Float}`` The length of the curve |
---|
Note: See
TracBrowser
for help on using the repository browser.