Difference between revisions of "Shape:testPoint"

 
(Added 0.8.0 variant.)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
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.
  
 +
{{notice|There's a bug in [[0.8.0]] preventing this function from working.}}
  
 
== Function ==
 
== Function ==
 +
{{newin|[[0.8.0]]|080|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
hit = Shape:testPoint( tx, ty, tr, x, y )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|tx|Translates the shape along the x-axis.}}
 +
{{param|number|ty|Translates the shape along the y-axis.}}
 +
{{param|number|tr|Rotates the shape.}}
 +
{{param|number|x|The x-component of the point.}}
 +
{{param|number|y|The y-component of the point.}}
 +
=== Returns ===
 +
{{param|boolean|hit|True if inside, false if outside}}
 +
 +
== Function ==
 +
{{oldin|[[0.8.0]]|080|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 14: Line 32:
 
* [[parent::Shape]]
 
* [[parent::Shape]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Checks whether a point lies inside the shape.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|Shape:testPoint}}

Latest revision as of 12:19, 4 May 2012

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.

O.png There's a bug in 0.8.0 preventing this function from working.  

Function

Available since LÖVE 0.8.0
This variant is not supported in earlier versions.

Synopsis

hit = Shape:testPoint( tx, ty, tr, x, y )

Arguments

number tx
Translates the shape along the x-axis.
number ty
Translates the shape along the y-axis.
number tr
Rotates the shape.
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

Function

Removed in LÖVE 0.8.0
This variant is not supported in that and later versions.

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


Other Languages