Public Attributes | List of all members
playrho::d2::BaseShapeConf Struct Reference

Base configuration for initializing shapes. More...

#include <ShapeConf.hpp>

Public Attributes

NonNegative< Real > friction = NonNegative<Real>{Real{2} / Real{10}}
 Friction coefficient. More...
 
Finite< Real > restitution = Finite<Real>{0}
 Restitution (elasticity) of the associated shape. More...
 
NonNegative< AreaDensity > density = NonNegative<AreaDensity>{0_kgpm2}
 Area density of the associated shape. More...
 

Detailed Description

Base configuration for initializing shapes.

Note
This is a nested base value class for initializing shapes.

Definition at line 34 of file ShapeConf.hpp.

Member Data Documentation

◆ friction

NonNegative<Real> playrho::d2::BaseShapeConf::friction = NonNegative<Real>{Real{2} / Real{10}}

Friction coefficient.

Note
This must be a value between 0 and +infinity. It is safer however to keep the value below the square root of the max value of a Real.
This is usually in the range [0,1].
The square-root of the product of this value multiplied by a touching fixture's friction becomes the friction coefficient for the contact.

Definition at line 44 of file ShapeConf.hpp.

◆ restitution

Finite<Real> playrho::d2::BaseShapeConf::restitution = Finite<Real>{0}

Restitution (elasticity) of the associated shape.

Note
This should be a valid finite value.
This is usually in the range [0,1].

Definition at line 51 of file ShapeConf.hpp.

◆ density

NonNegative<AreaDensity> playrho::d2::BaseShapeConf::density = NonNegative<AreaDensity>{0_kgpm2}

Area density of the associated shape.

Note
This must be a non-negative value.
Use 0 to indicate that the shape's associated mass should be 0.

Definition at line 58 of file ShapeConf.hpp.

The documentation for this struct was generated from the following file: