Difference between revisions of "R3d.Body:setAngularDamping"

From GiderosMobile
 
(2 intermediate revisions by one other user not shown)
Line 4: Line 4:
 
=== Description ===
 
=== 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).
 
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 ===
Line 12: Line 15:
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
self.body = xworld:createBody(view:getMatrix())
 
self.body = xworld:createBody(view:getMatrix())
 
self.body:setAngularDamping(1)
 
self.body:setAngularDamping(1)
</source>
+
</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)