Difference between revisions of "Shape:testSegment"

m (1 revision: Importing from potato (again).)
m (included link to other languages)
Line 1: Line 1:
 
 
Checks whether a line segment intersects a shape.
 
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.
 
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.
Line 21: Line 20:
 
{{#set:Description=Checks whether a line segment intersects a shape.
 
{{#set:Description=Checks whether a line segment intersects a shape.
 
}}
 
}}
 +
== Other Languages ==
 +
{{i18n|Shape:testSegment}}

Revision as of 10:37, 23 January 2011

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.

See Also

Other Languages