Difference between revisions of "R3d.Fixture:getMaterial"

From GiderosMobile
(Created page with "'''Available since:''' Gideros 2019.10<br/> '''Class:''' R3d.Body<br/> === Description === Gets the body material (bounciness, frictionCoefficient, rollingResistance). <s...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
'''Available since:''' Gideros 2019.10<br/>
 
'''Available since:''' Gideros 2019.10<br/>
'''Class:''' [[R3d.Body]]<br/>
+
'''Class:''' [[R3d.Fixture]]<br/>
  
 
=== Description ===
 
=== Description ===
Gets the body material (bounciness, frictionCoefficient, rollingResistance).
+
Gets the fixture material (bounciness, frictionCoefficient, rollingResistance).
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(bounciness) (frictionCoefficient) (rollingResistance) = r3d.Body:getMaterial()
 
(bounciness) (frictionCoefficient) (rollingResistance) = r3d.Body:getMaterial()
</source>
+
</syntaxhighlight>
  
 
=== Return values ===
 
=== Return values ===
 
values between 0 and 1 (0 means no bounciness, friction or rolling resistance).
 
values between 0 and 1 (0 means no bounciness, friction or rolling resistance).
  
'''Returns''' (bounciness) the bounciness of the body (default = 0.5)<br/>
+
'''Returns''' (bounciness) the bounciness of the fixture (default = 0.5)<br/>
'''Returns''' (frictionCoefficient) the friction coefficient of the body (default = 0.3)<br/>
+
'''Returns''' (frictionCoefficient) the friction coefficient of the fixture (default = 0.3)<br/>
'''Returns''' (rollingResistance) the rolling resistance of the body (default = 0)<br/>
+
'''Returns''' (rollingResistance) the rolling resistance of the fixture (default = 0)<br/>
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
local mat = shipvp.body:getMaterial()
+
-- the body
 +
view.body = xworld:createBody(view:getMatrix())
 +
local shape = r3d.SphereShape.new(params.sizex) -- radius
 +
local fixture = view.body:createFixture(shape, nil, params.mass)
 +
-- materials
 +
local mat = fixture:getMaterial()
 
print(mat.bounciness, mat.frictionCoefficient, mat.rollingResistance) -- returns 0.5, 0.3, 0
 
print(mat.bounciness, mat.frictionCoefficient, mat.rollingResistance) -- returns 0.5, 0.3, 0
</source>
+
</syntaxhighlight>
  
{{R3d.Body}}
+
{{R3d.Fixture}}

Latest revision as of 14:32, 13 July 2023

Available since: Gideros 2019.10
Class: R3d.Fixture

Description

Gets the fixture material (bounciness, frictionCoefficient, rollingResistance).

(bounciness) (frictionCoefficient) (rollingResistance) = r3d.Body:getMaterial()

Return values

values between 0 and 1 (0 means no bounciness, friction or rolling resistance).

Returns (bounciness) the bounciness of the fixture (default = 0.5)
Returns (frictionCoefficient) the friction coefficient of the fixture (default = 0.3)
Returns (rollingResistance) the rolling resistance of the fixture (default = 0)

Example

-- the body
view.body = xworld:createBody(view:getMatrix())
local shape = r3d.SphereShape.new(params.sizex) -- radius
local fixture = view.body:createFixture(shape, nil, params.mass)
-- materials
local mat = fixture:getMaterial()
print(mat.bounciness, mat.frictionCoefficient, mat.rollingResistance) -- returns 0.5, 0.3, 0