Difference between revisions of "Shape:testPoint"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 
+
Checks whether a point lies inside the shape.
 +
This is particularly useful for mouse interaction with the shapes. By looping through all shapes and testing the mouse position with this function, we can find which shapes the mouse touches.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 14: Line 15:
 
* [[parent::Shape]]
 
* [[parent::Shape]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Checks whether a point lies inside the shape.
 +
}}

Revision as of 17:17, 14 February 2010

Checks whether a point lies inside the shape. This is particularly useful for mouse interaction with the shapes. By looping through all shapes and testing the mouse position with this function, we can find which shapes the mouse touches.

Function

Synopsis

hit = Shape:testPoint( x, y )

Arguments

number x
The x-component of the point.
number y
The y-component of the point.

Returns

boolean hit
True if inside, false if outside

See Also