Difference between revisions of "B2.Body:createFixture"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[b2.Body]]<br/>
 +
 
=== Description ===
 
=== Description ===
−
<br />
+
Creates a fixture and attach it to this body. If the density is non-zero, this function automatically  
−
Creates a fixture and attach it to this body. If the density is non-zero, this function automatically<br />
+
updates the mass of the body. Contacts are not created until the next time step. The fixture definition is given as an ordinary table. The fields of the fixture definition table are:
−
updates the mass of the body. Contacts are not created until the next time step. The fixture definition is given<br />
+
 
−
as a ordinary table. The fields of the fixture definition table are:<br />
+
*'''shape''': (b2.Shape) the shape, this must be set
−
<br />
+
*'''friction''': (number) the friction coefficient, usually in the range [0,1]
−
<ul><br />
+
*'''restitution''': (number) the restitution (elasticity) usually in the range [0,1]
−
<li>`shape`: (b2.Shape) The shape, this must be set.</li><br />
+
*'''density''': (number) the density, usually in kg/m^2
−
<li>`friction`: (number) The friction coefficient, usually in the range [0,1].</li><br />
+
*'''isSensor''': (boolean) a sensor shape collects contact information but never generates a collision response
−
<li>`restitution`: (number) The restitution (elasticity) usually in the range [0,1].</li><br />
+
*'''filter''': (table) contact filtering data. The definition of contact filtering data is given at [[b2.Fixture:setFilterData]] function
−
<li>`density`: (number) The density, usually in kg/m^2.</li><br />
+
 
−
<li>`isSensor`: (boolean) A sensor shape collects contact information but never generates a collision response.</li><br />
+
The unset fields get default values.
−
<li>`filter`: (table) Contact filtering data. The definition of contact filtering data is given at `b2.Fixture:setFilterData` function.</li><br />
+
 
−
</ul><br />
+
<syntaxhighlight lang="lua">
−
<br />
 
−
The unset fields gets default values.<br />
 
−
<br />
 
−
<ul><br />
 
−
<li>`Warning`: This function is locked during callbacks.</li><br />
 
−
</ul><br />
 
−
<br />
 
−
<source lang="lua">
 
 
(b2.Fixture) = b2.Body:createFixture(fixtureDef)
 
(b2.Fixture) = b2.Body:createFixture(fixtureDef)
−
</source>
+
</syntaxhighlight>
 +
 
 +
'''Warning''': this function is locked during callbacks.
 +
 
 +
'''Warning''': setting the friction a negative value will crash your game.
 +
 
 
=== Parameters ===
 
=== Parameters ===
 
'''fixtureDef''': (table)  <br/>
 
'''fixtureDef''': (table)  <br/>
 +
 
=== Return values ===
 
=== Return values ===
−
'''Returns''' (b2.Fixture) The created fixture instance.<br/>
+
'''Returns''' (b2.Fixture) the created fixture instance<br/>
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
-- the body
 +
self.body = self.world:createBody{type = b2.DYNAMIC_BODY}
 +
self.body:setFixedRotation(true)
 +
self.body:setPosition(params.posx, params.posy)
 +
-- the shape
 +
self.w, self.h = self.bitmap:getWidth(), self.bitmap:getHeight()
 +
local playershape = b2.CircleShape.new(0, 0, self.w) -- (centerx, centery, radius)
 +
self.fixture = self.body:createFixture{
 +
shape = playershape, density = params.density, restitution = params.restitution, friction = params.friction,
 +
}
 +
</syntaxhighlight>
 +
 
 +
{{B2.Body}}

Latest revision as of 17:03, 12 July 2023

Available since: Gideros 2011.6
Class: b2.Body

Description

Creates a fixture and attach it to this body. If the density is non-zero, this function automatically updates the mass of the body. Contacts are not created until the next time step. The fixture definition is given as an ordinary table. The fields of the fixture definition table are:

  • shape: (b2.Shape) the shape, this must be set
  • friction: (number) the friction coefficient, usually in the range [0,1]
  • restitution: (number) the restitution (elasticity) usually in the range [0,1]
  • density: (number) the density, usually in kg/m^2
  • isSensor: (boolean) a sensor shape collects contact information but never generates a collision response
  • filter: (table) contact filtering data. The definition of contact filtering data is given at b2.Fixture:setFilterData function

The unset fields get default values. 

(b2.Fixture) = b2.Body:createFixture(fixtureDef)

Warning: this function is locked during callbacks.

Warning: setting the friction a negative value will crash your game.

Parameters

fixtureDef: (table)

Return values

Returns (b2.Fixture) the created fixture instance

Example

-- the body
self.body = self.world:createBody{type = b2.DYNAMIC_BODY}
self.body:setFixedRotation(true)
self.body:setPosition(params.posx, params.posy)
-- the shape
self.w, self.h = self.bitmap:getWidth(), self.bitmap:getHeight()
local playershape = b2.CircleShape.new(0, 0, self.w) -- (centerx, centery, radius)
self.fixture = self.body:createFixture{
	shape = playershape, density = params.density, restitution = params.restitution, friction = params.friction,
}


LiquidFun

Retrieved from ‘https://wiki.gideros.rocks/index.php?title=B2.Body:createFixture&oldid=19720’