B2.MouseJoint: Difference between revisions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
<languages /> | <languages /> | ||
<!-- GIDEROSOBJ:b2.MouseJoint --> | <!-- GIDEROSOBJ:b2.MouseJoint --> | ||
''' | '''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/> | ||
''' | '''Available since:''' Gideros 2011.6<br/> | ||
''' | '''Inherits from:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/> | ||
=== | |||
=== Description === | |||
A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch | A mouse joint is used to make a point on a body track a specified world point. This is a soft constraint with a maximum force. This allows the constraint to stretch without applying huge forces. | ||
=== | === Examples === | ||
'''Mouse joint''' | '''Mouse joint''' | ||
<source lang="lua">--create empty box2d body for joint | <source lang="lua"> | ||
--create empty box2d body for joint | |||
local ground = world:createBody({}) | local ground = world:createBody({}) | ||
| Line 36: | Line 37: | ||
mouseJoint = nil | mouseJoint = nil | ||
end | end | ||
end</source> | end | ||
</source> | |||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== | === Methods === | ||
[[Special:MyLanguage/b2.MouseJoint:getDampingRatio|b2.MouseJoint:getDampingRatio]] '' | [[Special:MyLanguage/b2.MouseJoint:getDampingRatio|b2.MouseJoint:getDampingRatio]] ''returns the damping ratio''<br/><!-- GIDEROSMTD:b2.MouseJoint:getDampingRatio() returns the damping ratio --> | ||
[[Special:MyLanguage/b2.MouseJoint:getFrequency|b2.MouseJoint:getFrequency]] '' | [[Special:MyLanguage/b2.MouseJoint:getFrequency|b2.MouseJoint:getFrequency]] ''returns the response frequency in Hertz''<br/><!-- GIDEROSMTD:b2.MouseJoint:getFrequency() returns the response frequency in Hertz --> | ||
[[Special:MyLanguage/b2.MouseJoint:getMaxForce|b2.MouseJoint:getMaxForce]] '' | [[Special:MyLanguage/b2.MouseJoint:getMaxForce|b2.MouseJoint:getMaxForce]] ''returns the maximum force in N''<br/><!-- GIDEROSMTD:b2.MouseJoint:getMaxForce() returns the maximum force in N --> | ||
[[Special:MyLanguage/b2.MouseJoint:getTarget|b2.MouseJoint:getTarget]] '' | [[Special:MyLanguage/b2.MouseJoint:getTarget|b2.MouseJoint:getTarget]] ''returns the x and y coordinates of the target point''<br/><!-- GIDEROSMTD:b2.MouseJoint:getTarget() returns the x and y coordinates of the target point --> | ||
[[Special:MyLanguage/b2.MouseJoint:setDampingRatio|b2.MouseJoint:setDampingRatio]] '' | [[Special:MyLanguage/b2.MouseJoint:setDampingRatio|b2.MouseJoint:setDampingRatio]] ''sets the damping ratio (0 = no damping, 1 = critical damping)''<br/><!-- GIDEROSMTD:b2.MouseJoint:setDampingRatio(ratio) sets the damping ratio (0 = no damping, 1 = critical damping) --> | ||
[[Special:MyLanguage/b2.MouseJoint:setFrequency|b2.MouseJoint:setFrequency]] '' | [[Special:MyLanguage/b2.MouseJoint:setFrequency|b2.MouseJoint:setFrequency]] ''sets the response frequency in Hertz''<br/><!-- GIDEROSMTD:b2.MouseJoint:setFrequency(frequency) sets the response frequency in Hertz --> | ||
[[Special:MyLanguage/b2.MouseJoint:setMaxForce|b2.MouseJoint:setMaxForce]] '' | [[Special:MyLanguage/b2.MouseJoint:setMaxForce|b2.MouseJoint:setMaxForce]] ''sets the maximum force in N''<br/><!-- GIDEROSMTD:b2.MouseJoint:setMaxForce(force) sets the maximum force in N --> | ||
[[Special:MyLanguage/b2.MouseJoint:setTarget|b2.MouseJoint:setTarget]] '' | [[Special:MyLanguage/b2.MouseJoint:setTarget|b2.MouseJoint:setTarget]] ''updates the target point''<br/><!-- GIDEROSMTD:b2.MouseJoint:setTarget(x,y) updates the target point --> | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== | === Events === | ||
=== | === Constants === | ||
|} | |} | ||
---- | |||
*'''[[LiquidFun]]''' | |||
Revision as of 17:55, 17 February 2020
Supported platforms: ![]()
![]()
![]()
![]()
![]()
![]()
![]()
Available since: Gideros 2011.6
Inherits from: b2.Joint
Description
A mouse joint is used to make a point on a body track a specified world point. This is a soft constraint with a maximum force. This allows the constraint to stretch without applying huge forces.
Examples
Mouse joint
--create empty box2d body for joint
local ground = world:createBody({})
--joint with dummy body
local mouseJoint = nil
-- create a mouse joint on mouse down
function self:onMouseDown(event)
local jointDef = b2.createMouseJointDef(ground, body, event.x, event.y, 100000)
mouseJoint = world:createJoint(jointDef)
end
-- update the target of mouse joint on mouse move
function self:onMouseMove(event)
if mouseJoint ~= nil then
mouseJoint:setTarget(event.x, event.y)
end
end
-- destroy the mouse joint on mouse up
function self:onMouseUp(event)
if mouseJoint ~= nil then
world:destroyJoint(mouseJoint)
mouseJoint = nil
end
end
Methodsb2.MouseJoint:getDampingRatio returns the damping ratio |
EventsConstants |