Difference between revisions of "R3d.Body:setAngularDamping"

From GiderosMobile
(Created page with "'''Available since:''' Gideros 2020.2<br/> '''Class:''' R3d.Body<br/> === Description === Sets the body angular damping. <source lang="lua"> r3d.Body:setAngularDamping(nu...")
 
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
=== Description ===
 
=== Description ===
Sets the body angular damping.
+
Sets the body angular damping. Damping is the effect of reducing the velocity of the rigid body during the simulation (like air friction for instance).
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
r3d.Body:setAngularDamping(number)
 
r3d.Body:setAngularDamping(number)
</source>
+
</syntaxhighlight>
 +
 
 +
By default, no damping is applied. However, you can choose to damp the linear or/and the angular velocity of a rigid body. For instance, without angular damping a pendulum will never come to rest. You need to use the RigidBody::setLinearDamping() and RigidBody::setAngularDamping() methods to change the damping values. The
 +
damping value has to be positive and a value of zero means no damping at all.
  
 
=== Parameters ===
 
=== Parameters ===
'''number''': (number) body angular damping
+
'''number''': (number) body angular damping between 0 and 1 (default = 0 no damping)
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
</source>
+
self.body = xworld:createBody(view:getMatrix())
 +
self.body:setAngularDamping(1)
 +
</syntaxhighlight>
  
 
{{R3d.Body}}
 
{{R3d.Body}}

Latest revision as of 11:13, 16 December 2025

Available since: Gideros 2020.2
Class: R3d.Body

Description

Sets the body angular damping. Damping is the effect of reducing the velocity of the rigid body during the simulation (like air friction for instance).

r3d.Body:setAngularDamping(number)

By default, no damping is applied. However, you can choose to damp the linear or/and the angular velocity of a rigid body. For instance, without angular damping a pendulum will never come to rest. You need to use the RigidBody::setLinearDamping() and RigidBody::setAngularDamping() methods to change the damping values. The damping value has to be positive and a value of zero means no damping at all.

Parameters

number: (number) body angular damping between 0 and 1 (default = 0 no damping)

Example

self.body = xworld:createBody(view:getMatrix())
self.body:setAngularDamping(1)