Difference between revisions of "Contact:getNormal"

 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
Get the normal vector between two shapes that are in contact.
  
 
+
This function returns the coordinates of a unit vector that points from the first shape to the second.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Contact:getNormal( )
+
nx, ny = Contact:getNormal( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
Nothing.
+
{{param|number|nx|The x component of the normal vector.}}
 +
{{param|number|ny|The y component of the normal vector.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Contact]]
 
* [[parent::Contact]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Get the normal vector between two shapes that are in contact.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|Contact:getNormal}}

Latest revision as of 10:57, 25 March 2011

Get the normal vector between two shapes that are in contact.

This function returns the coordinates of a unit vector that points from the first shape to the second.

Function

Synopsis

nx, ny = Contact:getNormal( )

Arguments

None.

Returns

number nx
The x component of the normal vector.
number ny
The y component of the normal vector.

See Also


Other Languages