Difference between revisions of "love.physics.setMeter"
m |
m (Depending on when the function is called, the result of the physics could be different. Added notice to call this function before any use ofthe physics module) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{newin|[[0.8.0]]|type=function}} | + | {{newin|[[0.8.0]]|080|type=function}} |
| − | Sets the meter scale factor. | + | Sets the pixels to meter scale factor. |
| − | All coordinates in the physics module are divided by this number, | + | All coordinates in the physics module are divided by this number and converted to meters, and it creates a convenient way to draw the objects directly to the screen without the need for graphics transformations. |
| + | |||
| + | It is recommended to create shapes no larger than 10 times the scale. This is important because Box2D is tuned to work well with shape sizes from 0.1 to 10 meters. The default meter scale is 30. | ||
| + | |||
| + | {{notice|love.physics.setMeter does not apply retroactively to created objects. Created objects retain their meter coordinates but the scale factor will affect their pixel coordinates. It is recommended to call this function before any further use of the [[love.physics]] module}} | ||
| − | |||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 14: | Line 17: | ||
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
| + | == Examples == | ||
| + | === Note that the body's coordinates in meters remain unchanged === | ||
| + | <source lang="lua"> | ||
| + | love.physics.setMeter(30) -- set 30 pixels/meter | ||
| + | body = love.physics.newBody(world, 300, 300, "dynamic") -- place the body at pixel coordinates (300,300) or in meter coordinates (10,10) | ||
| + | love.physics.setMeter(10) -- set 10 pixels/meter | ||
| + | body:getPosition() -- returns pixel coordinates (100,100) | ||
| + | </source> | ||
== See Also == | == See Also == | ||
* [[parent::love.physics]] | * [[parent::love.physics]] | ||
Latest revision as of 09:20, 12 April 2019
| Available since LÖVE 0.8.0 |
| This function is not supported in earlier versions. |
Sets the pixels to meter scale factor.
All coordinates in the physics module are divided by this number and converted to meters, and it creates a convenient way to draw the objects directly to the screen without the need for graphics transformations.
It is recommended to create shapes no larger than 10 times the scale. This is important because Box2D is tuned to work well with shape sizes from 0.1 to 10 meters. The default meter scale is 30.
|
love.physics.setMeter does not apply retroactively to created objects. Created objects retain their meter coordinates but the scale factor will affect their pixel coordinates. It is recommended to call this function before any further use of the love.physics module |
Contents
Function
Synopsis
love.physics.setMeter( scale )
Arguments
number scale- The scale factor as an integer.
Returns
Nothing.
Examples
Note that the body's coordinates in meters remain unchanged
love.physics.setMeter(30) -- set 30 pixels/meter
body = love.physics.newBody(world, 300, 300, "dynamic") -- place the body at pixel coordinates (300,300) or in meter coordinates (10,10)
love.physics.setMeter(10) -- set 10 pixels/meter
body:getPosition() -- returns pixel coordinates (100,100)
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
