====== polygon ======

**Category**: Data structure



===== Functions =====

----

==== containsPoint ====

''[[:data-types#boolean|boolean]] **polygon.containsPoint**(//object//, //point//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |

----

==== getClosestPoint ====

''[[:api:vec2f|vec2f]] **polygon.getClosestPoint**(//object//, //point//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |

''[[:api:vec2f|vec2f]] **polygon.getClosestPoint**(//object//, //point//, //outPosition//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |
| //''outPosition''// | ''[[:data-types#float|float]]'' | //[[:annotations#out_argument|Out argument]]// |

----

==== distance ====

''[[:data-types#float|float]] **polygon.distance**(//object//, //point//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |

''[[:data-types#float|float]] **polygon.distance**(//object//, //polygon//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''polygon''// | ''[[:data-types#polygon|polygon]]'' |  |

----

==== distance2 ====

''[[:data-types#float|float]] **polygon.distance2**(//object//, //point//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |

''[[:data-types#float|float]] **polygon.distance2**(//object//, //polygon//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''polygon''// | ''[[:data-types#polygon|polygon]]'' |  |

----

==== edgeDistance ====

''[[:data-types#float|float]] **polygon.edgeDistance**(//object//, //point//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |

''[[:data-types#float|float]] **polygon.edgeDistance**(//object//, //polygon//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''polygon''// | ''[[:data-types#polygon|polygon]]'' |  |

----

==== edgeDistance2 ====

''[[:data-types#float|float]] **polygon.edgeDistance2**(//object//, //point//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''point''// | ''[[:api:vec2f|vec2f]]'' |  |

''[[:data-types#float|float]] **polygon.edgeDistance2**(//object//, //polygon//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''polygon''// | ''[[:data-types#polygon|polygon]]'' |  |

----

==== reverseOrder ====

''void **polygon.reverseOrder**(//object//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |

----

==== computeCentroid ====

''[[:api:vec2f|vec2f]] **polygon.computeCentroid**(//object//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |

----

==== computeArea ====

''[[:data-types#float|float]] **polygon.computeArea**(//object//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |

----

==== computeAbsoluteArea ====

''[[:data-types#float|float]] **polygon.computeAbsoluteArea**(//object//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |

----

==== isClockWise ====

''[[:data-types#boolean|boolean]] **polygon.isClockWise**(//object//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |

----

==== isComplex ====

''[[:data-types#boolean|boolean]] **polygon.isComplex**(//object//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |

----

==== getMinMax ====

''void **polygon.getMinMax**(//object//, //outMin//, //outMax//)''

^ Name ^ Type ^ Description ^
| //''object''// | ''polygon'' |  |
| //''outMin''// | ''[[:api:vec2f|vec2f]]'' | //[[:annotations#out_argument|Out argument]]// |
| //''outMax''// | ''[[:api:vec2f|vec2f]]'' | //[[:annotations#out_argument|Out argument]]// |