EK: Created page with "Test if a point lies inside a polygon. == Syntax == isPointInsidePolygon(point, polygon) == Parameters == {| class="ts" |-..."

2023-05-03T20:54:43Z

Created page with "Test if a point lies inside a polygon. == Syntax == <syntaxhighlight lang="lua"> isPointInsidePolygon(point, polygon) </syntaxhighlight> == Parameters == {| class="ts" |-..."

New page

Test if a point lies inside a polygon.

== Syntax ==
<syntaxhighlight lang="lua">
isPointInsidePolygon(point, polygon)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" colspan="2" | Type/Structure
! colspan="2" | Description
|-
| rowspan="2" | point
| rowspan="2" | table
| x (int)
| style="width:25%" | Horizontal position (X coordinate)
| rowspan="2" | Pass the point as a Visionaire "t_point" field: an associative array containing the elements '''x''' and '''y'''.
|-
| y (int)
| Vertical position (Y coordinate)
|-
| polygon
| table of tables
| {{x=int,y=int},...}
| colspan="2" | A single polygon, consisting of a table of Visionaire "t_point" fields. Bear in mind that a field containing multiple polygons (e. g. a way border or object polygon) must be split into single polygons and tested separately. Visionaire uses {-10000,-10000} points ("DIVIDING_POINT" constant) to separate individual polygons from each other in the data structure.
|}

== Return values ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| True if the point lies within the polygon.
|}

== Examples ==

'''Example 1:''' Test if the current position of an active "cloud" animation is inside the polygon of a "window" object on the current scene and store the result in a global variable.
<syntaxhighlight lang ="lua">
local cloudAnim = ActiveAnimations["cloud"]
local windowPolygon = game.CurrentScene.Objects["window"].Polygon

cloudVisible = isPointInsidePolygon(cloudAnim.CurrentPosition, windowPolygon)
</syntaxhighlight>
{{toc}}

Global Command: isPointInsidePolygon - Revision history

EK: Created page with "Test if a point lies inside a polygon. == Syntax == isPointInsidePolygon(point, polygon) == Parameters == {| class="ts" |-..."