Clipper: Difference between revisions
wip |
wip |
||
| Line 25: | Line 25: | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== Methods === | === Methods === | ||
[[ | [[Polygon.new]] ''creates an empty polygon''<br/><!--GIDEROSMTD:Polygon.new() creates an empty polygon--> | ||
[[ | [[Polygon:addPoint]] ''appends a vertex to the polygon''<br/><!--GIDEROSMTD:Polygon:addPoint(x, y) appends a vertex to the polygon--> | ||
[[ | [[Polygon:getPoints]] ''returns all vertices of the polygon as a Lua table''<br/><!--GIDEROSMTD:Polygon:getPoints() returns all vertices of the polygon as a Lua table--> | ||
[[ | [[Polygon:getArea]] ''returns the signed area of the polygon''<br/><!--GIDEROSMTD:Polygon:getArea() returns the signed area of the polygon--> | ||
[[ | [[Polygon:isClockwise]] ''returns the orientation of the polygon''<br/><!--GIDEROSMTD:Polygon:isClockwise() returns the orientation of the polygon--> | ||
[[ | [[Polygon:clean]] ''removes self-intersections and very close vertices from the polygon in place''<br/><!--GIDEROSMTD:Polygon:clean(distance) removes self-intersections and very close vertices from the polygon in place--> | ||
[[ | [[Polygon:reverse]] ''reverses the order of the vertices in place, which flips the orientation of the polygon''<br/><!--GIDEROSMTD:Polygon:reverse() reverses the order of the vertices in place, which flips the orientation of the polygon--> | ||
[[Polygon:simplify]] ''simplifies the polygon by removing redundant vertices and resolving self-intersections, using the given fill rule''<br/><!--GIDEROSMTD:Polygon:simplify(fillType) simplifies the polygon by removing redundant vertices and resolving self-intersections, using the given fill rule--> | |||
[[Polygon:getPolygonOffset]] ''offsets (insets or outsets) the polygon by delta units''<br/><!--GIDEROSMTD:Polygon:getPolygonOffset(delta, joinType, limit, autoFix) offsets (insets or outsets) the polygon by delta units--> | |||
[[Polygon:getLineOffset]] ''offsets an open polyline (a polygon treated as an open path) by delta units, producing one or more parallel polylines''<br/><!--GIDEROSMTD:Polygon:getLineOffset(delta, joinType, endType, limit) offsets an open polyline (a polygon treated as an open path) by delta units, producing one or more parallel polylines--> | |||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
Revision as of 02:44, 14 November 2026
Supported platforms: ![]()
![]()
![]()
![]()
![]()
![]()
![]()
![]()
Available since: Gideros 2015.03.22
Description
The Clipper plugin wraps the Clipper polygon clipping library for Gideros.
require "clipper"
Enable Clipper in Gideros Studio -> Plugins before use. This makes the two classes Polygon and Clipper available as globals.
It provides two classes:
- Polygon: a single polygon (a list of integer points). It can be created, edited, measured, cleaned, reversed, simplified and offset (inset/outset)
- Clipper: a clipping engine that combines one or more subject polygons with one or more clip polygons using boolean operations (intersection, union, difference, exclusion)
All coordinates are integers. The plugin registers a weak table that keeps the C++ objects alive as long as their Lua wrappers exist, so polygons and clippers are garbage collected automatically.
Example
MethodsPolygon.new creates an empty polygon |
EventsConstants |