Difference between revisions of "B2.createMouseJointDef"

 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<languages />
 
<languages />
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/b2|b2]]<br/>
+
'''Class:''' [[Special:MyLanguage/b2|b2]]<br/>
=== <translate>Description</translate> ===
+
 
<translate><br />
+
=== Description ===
Creates and returns a mouse joint definition table with the bodies, world target point, maxForce and optional frequencyHz and dampingRatio.<br />
+
Creates and returns a mouse joint definition table with the bodies, world target point, maxForce and optional frequencyHz and dampingRatio.
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a mouse joint).<br />
+
 
<br /></translate>
+
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a mouse joint).
 
<source lang="lua">
 
<source lang="lua">
 
(table) = b2.createMouseJointDef(bodyA,bodyB,targetx,targety,maxForce,frequencyHz,dampingRatio)
 
(table) = b2.createMouseJointDef(bodyA,bodyB,targetx,targety,maxForce,frequencyHz,dampingRatio)
 
</source>
 
</source>
=== <translate>Parameters</translate> ===
+
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
+
=== Parameters ===
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
+
'''bodyA''': (b2.Body) the first attached body <br/>
'''targetx''': (number) <translate>the x coordinate of the world target point</translate> <br/>
+
'''bodyB''': (b2.Body) the second attached body <br/>
'''targety''': (number) <translate>the y coordinate of the world target point</translate> <br/>
+
'''targetx''': (number) the x coordinate of the world target point <br/>
'''maxForce''': (number) <translate>the maximum constraint force that can be exerted to move the candidate body</translate> <br/>
+
'''targety''': (number) the y coordinate of the world target point <br/>
'''frequencyHz''': (number, default = 5) <translate>the response speed</translate> <br/>
+
'''maxForce''': (number) the maximum constraint force that can be exerted to move the candidate body <br/>
'''dampingRatio''': (number, default = 0.7) <translate>the damping ratio. 0 = no damping, 1 = critical damping</translate> <br/>
+
'''frequencyHz''': (number, default = 5) the response speed <br/>
=== <translate>Return values</translate> ===
+
'''dampingRatio''': (number, default = 0.7) the damping ratio. 0 = no damping, 1 = critical damping <br/>
'''<translate>Returns</translate>''' (table) <translate>A new mouse joint definition table</translate><br/>
+
 
=== <translate>Examples</translate> ===
+
=== Return values ===
'''Mouse joint'''<br/>
+
'''Returns''' (table) A new mouse joint definition table<br/>
<source lang="lua">--create empty box2d body for joint
+
 
 +
=== Examples ===
 +
<source lang="lua">
 +
--create empty box2d body for joint
 
local ground = world:createBody({})
 
local ground = world:createBody({})
  
Line 48: Line 51:
 
mouseJoint = nil
 
mouseJoint = nil
 
end
 
end
end</source>
+
end
 +
</source>
 +
 
 +
{{B2}}

Latest revision as of 05:47, 17 February 2020


Available since: Gideros 2011.6
Class: b2

Description

Creates and returns a mouse joint definition table with the bodies, world target point, maxForce and optional frequencyHz and dampingRatio.

(Please refer to b2.World:createJoint function for more information about all the information needed to create a mouse joint).

(table) = b2.createMouseJointDef(bodyA,bodyB,targetx,targety,maxForce,frequencyHz,dampingRatio)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
targetx: (number) the x coordinate of the world target point
targety: (number) the y coordinate of the world target point
maxForce: (number) the maximum constraint force that can be exerted to move the candidate body
frequencyHz: (number, default = 5) the response speed
dampingRatio: (number, default = 0.7) the damping ratio. 0 = no damping, 1 = critical damping

Return values

Returns (table) A new mouse joint definition table

Examples

--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





LiquidFun