Difference between revisions of "B2.MouseJoint"

From GiderosMobile
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''<translate>Supported platforms</translate>:''' [[File:Platform android]][[File:Platform ios]][[File:Platform mac]][[File:Platform pc]]<br/>
+
<!-- GIDEROSOBJ:b2.MouseJoint -->
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''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/>
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/>
+
'''Available since:''' Gideros 2011.6<br/>
=== <translate>Description</translate> ===
+
'''Inherits from:''' [[b2.Joint]]<br/>
<translate><br />
+
 
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 and without applying huge forces.<br />
+
=== Description ===
<br /></translate>
+
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.
=== <translate>Examples</translate> ===
+
 
'''Mouse joint'''<br/>
+
=== Examples ===
<source lang="lua">--create empty box2d body for joint
+
'''Mouse joint'''
 +
<syntaxhighlight lang="lua">
 +
--create empty box2d body for joint
 
local ground = world:createBody({})
 
local ground = world:createBody({})
  
Line 34: Line 36:
 
mouseJoint = nil
 
mouseJoint = nil
 
end
 
end
end</source>
+
end
 +
</syntaxhighlight>
 +
 
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== <translate>Methods</translate> ===
+
=== Methods ===
[[Special:MyLanguage/b2.MouseJoint:getDampingRatio|b2.MouseJoint:getDampingRatio]] ''<translate>returns the damping ratio</translate>''<br/>
+
[[b2.MouseJoint:getDampingRatio]] ''returns the damping ratio''<br/><!--GIDEROSMTD:b2.MouseJoint:getDampingRatio() returns the damping ratio-->
[[Special:MyLanguage/b2.MouseJoint:getFrequency|b2.MouseJoint:getFrequency]] ''<translate>returns the response frequency in Hertz</translate>''<br/>
+
[[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]] ''<translate>returns the maximum force in N</translate>''<br/>
+
[[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]] ''<translate>returns the x and y coordinates of the target point</translate>''<br/>
+
[[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]] ''<translate>sets the damping ratio (0 = no damping, 1 = critical damping)</translate>''<br/>
+
[[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]] ''<translate>sets the response frequency in Hertz</translate>''<br/>
+
[[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]] ''<translate>sets the maximum force in N</translate>''<br/>
+
[[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]] ''<translate>updates the target point</translate>''<br/>
+
[[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;"|
=== <translate>Events</translate> ===
+
=== Events ===
=== <translate>Constants</translate> ===
+
=== Constants ===
 
|}
 
|}
 +
 +
----
 +
*'''[[B2.Joint]]'''
 +
*'''[[LiquidFun]]'''

Latest revision as of 01:57, 1 December 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
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

Methods

b2.MouseJoint:getDampingRatio returns the damping ratio
b2.MouseJoint:getFrequency returns the response frequency in Hertz
b2.MouseJoint:getMaxForce returns the maximum force in N
b2.MouseJoint:getTarget returns the x and y coordinates of the target point
b2.MouseJoint:setDampingRatio sets the damping ratio (0 = no damping, 1 = critical damping)
b2.MouseJoint:setFrequency sets the response frequency in Hertz
b2.MouseJoint:setMaxForce sets the maximum force in N
b2.MouseJoint:setTarget updates the target point

Events

Constants