# Difference between revisions of "Path2D:getPathPoints"

Line 4: | Line 4: | ||

'''<translate>Class</translate>:''' [[Special:MyLanguage/Path2D|Path2D]]<br/> | '''<translate>Class</translate>:''' [[Special:MyLanguage/Path2D|Path2D]]<br/> | ||

=== <translate>Description</translate> === | === <translate>Description</translate> === | ||

− | <translate>Compute points location along the path. To do so, the path is converted into a series of straight segments and particular points are sampled along it. The resulting table outputs, for each point, its location (x,y) | + | <translate>Compute points location along the path. To do so, the path is converted into a series of straight segments and particular points are sampled along it. The resulting table outputs, for each point, its location (x,y), its tangent orientation (angle) and its offset from the start of the path (offset).</translate> |

<source lang="lua"> | <source lang="lua"> | ||

(table) = Path2D:getPathPoints(interval,offset,maxpts,flatness,subdiv_limit) | (table) = Path2D:getPathPoints(interval,offset,maxpts,flatness,subdiv_limit) | ||

</source> | </source> | ||

=== <translate>Parameters</translate> === | === <translate>Parameters</translate> === | ||

− | '''interval''': (number) <translate>distance between each considered point</translate> <br/> | + | '''interval''': (number) <translate>distance between each considered point.</translate>'''optional''' <br/> |

'''offset''': (number) <translate>distance to first point of interest. Defaults to 0.</translate> <translate>'''optional'''</translate> <br/> | '''offset''': (number) <translate>distance to first point of interest. Defaults to 0.</translate> <translate>'''optional'''</translate> <br/> | ||

'''maxpts''': (number) <translate>maximum number of points to sample. Defaults to 1000.</translate> <translate>'''optional'''</translate> <br/> | '''maxpts''': (number) <translate>maximum number of points to sample. Defaults to 1000.</translate> <translate>'''optional'''</translate> <br/> |

## Latest revision as of 12:57, 16 October 2020

**Available since:** Gideros 2018.12

**Class:** Path2D

### Description

Compute points location along the path. To do so, the path is converted into a series of straight segments and particular points are sampled along it. The resulting table outputs, for each point, its location (x,y), its tangent orientation (angle) and its offset from the start of the path (offset).

```
(table) = Path2D:getPathPoints(interval,offset,maxpts,flatness,subdiv_limit)
```

### Parameters

**interval**: (number) distance between each considered point.**optional**

**offset**: (number) distance to first point of interest. Defaults to 0. **optional**

**maxpts**: (number) maximum number of points to sample. Defaults to 1000. **optional**

**flatness**: (number) maximum acceptable deviation for real curve. Defaults to 1. **optional**

**subdiv_limit**: (number) maximum curve subdivision limit. Defaults to 10. **optional**

### Return values

**Returns** (table) information about selected points