Difference between revisions of "Shape:testSegment"
m (1 revision: Imported docs from potato.) |
|||
| Line 1: | Line 1: | ||
| − | + | Checks whether a line segment intersects a shape. | |
| + | This function will either return the "time" of impact and the surface normal at the point of collision, or nil if the line does not intersect the shape. The "time" is a value between 0.0 and 1.0 and can be used to calculate where the collision occured. | ||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 18: | Line 19: | ||
* [[parent::Shape]] | * [[parent::Shape]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=}} | + | {{#set:Description=Checks whether a line segment intersects a shape. |
| + | }} | ||
Revision as of 16:17, 14 February 2010
Checks whether a line segment intersects a shape. This function will either return the "time" of impact and the surface normal at the point of collision, or nil if the line does not intersect the shape. The "time" is a value between 0.0 and 1.0 and can be used to calculate where the collision occured.
Function
Synopsis
t, xn, yn = Shape:testSegment( x1, y1, x2, y2 )
Arguments
number x1- The x-component of the first endpoint.
number y1- The y-component of the first endpoint.
number x2- The x-component of the second endpoint.
number y2- The y-component of the second endpoint.
Returns
number t- The time of impact, or nil if no impact.
number xn- The x-component of the surface normal.
number yn- The y-component of the surface normal.
