Class Paths

This structure is fundamental to the Clipper Library.

It's a list or array of one or more Path structures. (The Path structure contains an ordered list of vertices that make a single contour.)

Paths may be open (a series of line segments), or they may be closed (polygons). Whether or not a path is open depends on context. Closed paths may be 'outer' contours or 'hole' contours. Which they are depends on orientation.

See also:

Methods

Paths:AddPath (path)
Adds a path (more specifically, a copy of it) to the end of the sequence.

Parameters:

Paths:Clear ()
Remove all paths from the sequence.
Paths:GetPath (index[, opts])

Parameters:

  • index uint Index of path, from 1 to #self.
  • opts table

    Options, which may include:

    • out: If this is a Path, it will be populated and used as the return value.
    (optional)

Returns:

    Path Copy of path.

Metamethods

Paths:__len ()

Returns:

    uint Number of paths.
Paths:__tostring ()

Returns:

    string String representation of group.
generated by LDoc 1.4.6 Last updated 2018-08-13 18:06:38