Difference between revisions of "love.physics.newGearJoint"

m (Typo.)
m (Returns GearJoint even in 0.7.x)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
Create a gear joint connecting two joints.
+
Create a [[GearJoint]] connecting two Joints.
  
 
The gear joint connects two joints that must be either [[PrismaticJoint| prismatic]] or [[RevoluteJoint | revolute]] joints. Using this joint requires that the joints it uses connect their respective bodies to the ground and have the ground as the first body. When destroying the bodies and joints you must make sure you destroy the gear joint before the other joints.
 
The gear joint connects two joints that must be either [[PrismaticJoint| prismatic]] or [[RevoluteJoint | revolute]] joints. Using this joint requires that the joints it uses connect their respective bodies to the ground and have the ground as the first body. When destroying the bodies and joints you must make sure you destroy the gear joint before the other joints.
  
 
The gear joint has a ratio the determines how the angular or distance values of the connected joints relate to each other. The formula <tt>coordinate1 + ratio * coordinate2</tt> always has a constant value that is set when the gear joint is created.
 
The gear joint has a ratio the determines how the angular or distance values of the connected joints relate to each other. The formula <tt>coordinate1 + ratio * coordinate2</tt> always has a constant value that is set when the gear joint is created.
 +
 +
[[File:physicsJointGear.png]]
 +
 +
== Function ==
 +
{{newin|[[0.8.0]]|080|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
joint = love.physics.newGearJoint( joint1, joint2, ratio, collideConnected )
 +
</source>
 +
=== Arguments ===
 +
{{param|Joint|joint1|The first joint to connect with a gear joint.}}
 +
{{param|Joint|joint2|The second joint to connect with a gear joint.}}
 +
{{param|number|ratio (1)|The gear ratio.}}
 +
{{param|boolean|collideConnected (false)|Specifies whether the two bodies should collide with each other.}}
 +
=== Returns ===
 +
{{param|GearJoint|joint|The new gear joint.}}
 +
 
== Function ==
 
== Function ==
 +
{{oldin|[[0.8.0]]|080|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 10: Line 28:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Body|joint1|The first joint to connect with a gear joint.}}
+
{{param|Joint|joint1|The first joint to connect with a gear joint.}}
{{param|Body|joint2|The second joint to connect with a gear joint.}}
+
{{param|Joint|joint2|The second joint to connect with a gear joint.}}
{{param|number|ratio|The gear ratio.}}
+
{{param|number|ratio (1)|The gear ratio.}}
 
=== Returns ===
 
=== Returns ===
{{param|Joint|joint|The new gear joint.}}
+
{{param|GearJoint|joint|The new gear joint.}}
 +
 
 
== See Also ==
 
== See Also ==
 
* [[parent::love.physics]]
 
* [[parent::love.physics]]
 +
* [[Constructs::GearJoint]]
 +
* [[Constructs::Joint]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Create a gear joint connecting two joints.
+
{{#set:Description=Create a [[GearJoint]] connecting two Joints.}}
}}
+
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.physics.newGearJoint}}

Latest revision as of 18:57, 26 December 2016

Create a GearJoint connecting two Joints.

The gear joint connects two joints that must be either prismatic or revolute joints. Using this joint requires that the joints it uses connect their respective bodies to the ground and have the ground as the first body. When destroying the bodies and joints you must make sure you destroy the gear joint before the other joints.

The gear joint has a ratio the determines how the angular or distance values of the connected joints relate to each other. The formula coordinate1 + ratio * coordinate2 always has a constant value that is set when the gear joint is created.

physicsJointGear.png

Function

Available since LÖVE 0.8.0
This variant is not supported in earlier versions.

Synopsis

joint = love.physics.newGearJoint( joint1, joint2, ratio, collideConnected )

Arguments

Joint joint1
The first joint to connect with a gear joint.
Joint joint2
The second joint to connect with a gear joint.
number ratio (1)
The gear ratio.
boolean collideConnected (false)
Specifies whether the two bodies should collide with each other.

Returns

GearJoint joint
The new gear joint.

Function

Removed in LÖVE 0.8.0
This variant is not supported in that and later versions.

Synopsis

joint = love.physics.newGearJoint( joint1, joint2, ratio )

Arguments

Joint joint1
The first joint to connect with a gear joint.
Joint joint2
The second joint to connect with a gear joint.
number ratio (1)
The gear ratio.

Returns

GearJoint joint
The new gear joint.

See Also


Other Languages