JBoxSettings (fxgl 0.3.9 API)

java.lang.Object
- com.almasb.fxgl.physics.box2d.common.JBoxSettings

```
public class JBoxSettings
extends Object
```
Global tuning constants based on MKS units and various integer maximums (vertices per shape, pairs, etc.).

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`aabbExtension` This is used to fatten AABBs in the dynamic tree.
`static float`	`aabbMultiplier` This is used to fatten AABBs in the dynamic tree.
`static float`	`angularSleepTolerance` A body cannot sleep if its angular velocity is above this tolerance.
`static float`	`angularSlop` A small angle used as a collision and constraint tolerance.
`static float`	`baumgarte` This scale factor controls how fast overlap is resolved.
`static int`	`CONTACT_STACK_INIT_SIZE`
`static float`	`EPSILON` A "close to zero" float epsilon value for use.
`static boolean`	`FAST_ABS`
`static boolean`	`FAST_ATAN2`
`static boolean`	`FAST_CEIL`
`static boolean`	`FAST_FLOOR`
`static boolean`	`FAST_POW`
`static boolean`	`FAST_ROUND`
`static int`	`invalidParticleIndex` A symbolic constant that stands for particle allocation error.
`static float`	`linearSleepTolerance` A body cannot sleep if its linear velocity is above this tolerance.
`static float`	`linearSlop` A small length used as a collision and constraint tolerance.
`static float`	`maxAngularCorrection` The maximum angular position correction used when solving constraints.
`static float`	`maxLinearCorrection` The maximum linear position correction used when solving constraints.
`static int`	`maxManifoldPoints` The maximum number of contact points between two convex shapes.
`static float`	`maxParticleWeight` The upper limit for particle weight used in pressure calculation.
`static int`	`maxPolygonVertices` The maximum number of vertices on a convex polygon.
`static float`	`maxRotation` The maximum angular velocity of a body.
`static float`	`maxRotationSquared`
`static int`	`maxSubSteps` Maximum number of sub-steps per contact in continuous physics simulation.
`static int`	`maxTOIContacts` Maximum number of contacts to be handled to solve a TOI island.
`static float`	`maxTranslation` The maximum linear velocity of a body.
`static float`	`maxTranslationSquared`
`static int`	`maxTriadDistance` The maximum distance between particles in a triad, divided by the particle radius.
`static int`	`maxTriadDistanceSquared`
`static int`	`minParticleBufferCapacity` The initial size of particle data buffers.
`static float`	`minParticleWeight` The minimum particle weight that produces pressure.
`static float`	`particleStride` The standard distance between particles, divided by the particle radius.
`static float`	`PI` Pi.
`static float`	`polygonRadius` The radius of the polygon/edge shape skin.
`static boolean`	`SINCOS_LUT_ENABLED`
`static int`	`SINCOS_LUT_LENGTH`
`static boolean`	`SINCOS_LUT_LERP` Use if the table's precision is large (eg .006 or greater).
`static float`	`SINCOS_LUT_PRECISION` smaller the precision, the larger the table.
`static float`	`timeToSleep` The time that a body must be still before it will go to sleep.
`static float`	`toiBaugarte`
`static float`	`velocityThreshold` A velocity threshold for elastic collisions.

Constructor Summary

Constructors
Constructor and Description

JBoxSettings()

Constructors
Constructor and Description
`JBoxSettings()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static float`	`mixFriction(float friction1, float friction2)` Friction mixing law.
`static float`	`mixRestitution(float restitution1, float restitution2)` Restitution mixing law.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EPSILON
```
public static final float EPSILON
```
    A "close to zero" float epsilon value for use.
    
    See Also:
    
    Constant Field Values
  - PI
```
public static final float PI
```
    Pi.
    
    See Also:
    
    Constant Field Values
  - FAST_ABS
```
public static boolean FAST_ABS
```
  - FAST_FLOOR
```
public static boolean FAST_FLOOR
```
  - FAST_CEIL
```
public static boolean FAST_CEIL
```
  - FAST_ROUND
```
public static boolean FAST_ROUND
```
  - FAST_ATAN2
```
public static boolean FAST_ATAN2
```
  - FAST_POW
```
public static boolean FAST_POW
```
  - CONTACT_STACK_INIT_SIZE
```
public static int CONTACT_STACK_INIT_SIZE
```
  - SINCOS_LUT_ENABLED
```
public static boolean SINCOS_LUT_ENABLED
```
  - SINCOS_LUT_PRECISION
```
public static final float SINCOS_LUT_PRECISION
```
    smaller the precision, the larger the table. If a small table is used (eg, precision is .006 or greater), make sure you set the table to lerp it's results. Accuracy chart is in the JBoxUtils source. Good lerp precision values:
    - .0092
    - .008201
    - .005904
    - .005204
    - .004305
    - .002807
    - .001508
    - 9.32500E-4
    - 7.48000E-4
    - 8.47000E-4
    - .0005095
    - .0001098
    - 9.50499E-5
    - 6.08500E-5
    - 3.07000E-5
    - 1.53999E-5
    See Also:
    
    Constant Field Values
  - SINCOS_LUT_LENGTH
```
public static final int SINCOS_LUT_LENGTH
```
  - SINCOS_LUT_LERP
```
public static boolean SINCOS_LUT_LERP
```
    Use if the table's precision is large (eg .006 or greater). Although it is more expensive, it greatly increases accuracy. Look in the JBoxUtils source for some test results on the accuracy and speed of lerp vs non lerp.
  - maxManifoldPoints
```
public static int maxManifoldPoints
```
    The maximum number of contact points between two convex shapes.
  - maxPolygonVertices
```
public static int maxPolygonVertices
```
    The maximum number of vertices on a convex polygon.
  - aabbExtension
```
public static float aabbExtension
```
    This is used to fatten AABBs in the dynamic tree. This allows proxies to move by a small amount without triggering a tree adjustment. This is in meters.
  - aabbMultiplier
```
public static float aabbMultiplier
```
    This is used to fatten AABBs in the dynamic tree. This is used to predict the future position based on the current displacement. This is a dimensionless multiplier.
  - linearSlop
```
public static float linearSlop
```
    A small length used as a collision and constraint tolerance. Usually it is chosen to be numerically significant, but visually insignificant.
  - angularSlop
```
public static float angularSlop
```
    A small angle used as a collision and constraint tolerance. Usually it is chosen to be numerically significant, but visually insignificant.
  - polygonRadius
```
public static float polygonRadius
```
    The radius of the polygon/edge shape skin. This should not be modified. Making this smaller means polygons will have and insufficient for continuous collision. Making it larger may create artifacts for vertex collision.
  - maxSubSteps
```
public static int maxSubSteps
```
    Maximum number of sub-steps per contact in continuous physics simulation.
  - maxTOIContacts
```
public static int maxTOIContacts
```
    Maximum number of contacts to be handled to solve a TOI island.
  - velocityThreshold
```
public static float velocityThreshold
```
    A velocity threshold for elastic collisions. Any collision with a relative linear velocity below this threshold will be treated as inelastic.
  - maxLinearCorrection
```
public static float maxLinearCorrection
```
    The maximum linear position correction used when solving constraints. This helps to prevent overshoot.
  - maxAngularCorrection
```
public static float maxAngularCorrection
```
    The maximum angular position correction used when solving constraints. This helps to prevent overshoot.
  - maxTranslation
```
public static float maxTranslation
```
    The maximum linear velocity of a body. This limit is very large and is used to prevent numerical problems. You shouldn't need to adjust this.
  - maxTranslationSquared
```
public static float maxTranslationSquared
```
  - maxRotation
```
public static float maxRotation
```
    The maximum angular velocity of a body. This limit is very large and is used to prevent numerical problems. You shouldn't need to adjust this.
  - maxRotationSquared
```
public static float maxRotationSquared
```
  - baumgarte
```
public static float baumgarte
```
    This scale factor controls how fast overlap is resolved. Ideally this would be 1 so that overlap is removed in one time step. However using values close to 1 often lead to overshoot.
  - toiBaugarte
```
public static float toiBaugarte
```
  - timeToSleep
```
public static float timeToSleep
```
    The time that a body must be still before it will go to sleep.
  - linearSleepTolerance
```
public static float linearSleepTolerance
```
    A body cannot sleep if its linear velocity is above this tolerance.
  - angularSleepTolerance
```
public static float angularSleepTolerance
```
    A body cannot sleep if its angular velocity is above this tolerance.
  - invalidParticleIndex
```
public static final int invalidParticleIndex
```
    A symbolic constant that stands for particle allocation error.
    
    See Also:
    
    Constant Field Values
  - particleStride
```
public static final float particleStride
```
    The standard distance between particles, divided by the particle radius.
    
    See Also:
    
    Constant Field Values
  - minParticleWeight
```
public static final float minParticleWeight
```
    The minimum particle weight that produces pressure.
    
    See Also:
    
    Constant Field Values
  - maxParticleWeight
```
public static final float maxParticleWeight
```
    The upper limit for particle weight used in pressure calculation.
    
    See Also:
    
    Constant Field Values
  - maxTriadDistance
```
public static final int maxTriadDistance
```
    The maximum distance between particles in a triad, divided by the particle radius.
    
    See Also:
    
    Constant Field Values
  - maxTriadDistanceSquared
```
public static final int maxTriadDistanceSquared
```
    See Also:
    
    Constant Field Values
  - minParticleBufferCapacity
```
public static final int minParticleBufferCapacity
```
    The initial size of particle data buffers.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JBoxSettings
```
public JBoxSettings()
```
- Method Detail
  - mixFriction
```
public static float mixFriction(float friction1,
                                float friction2)
```
    Friction mixing law. Feel free to customize this.
    
    Parameters:
    
    friction1 - friction1
    
    friction2 - friction2
    
    Returns:
    
    mixed friction
  - mixRestitution
```
public static float mixRestitution(float restitution1,
                                   float restitution2)
```
    Restitution mixing law. Feel free to customize this.
    
    Parameters:
    
    restitution1 - restitution1
    
    restitution2 - restitution2
    
    Returns:
    
    mixed restitution

Class JBoxSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EPSILON

PI

FAST_ABS

FAST_FLOOR

FAST_CEIL

FAST_ROUND

FAST_ATAN2

FAST_POW

CONTACT_STACK_INIT_SIZE

SINCOS_LUT_ENABLED

SINCOS_LUT_PRECISION

SINCOS_LUT_LENGTH

SINCOS_LUT_LERP

maxManifoldPoints

maxPolygonVertices

aabbExtension

aabbMultiplier

linearSlop

angularSlop

polygonRadius

maxSubSteps

maxTOIContacts

velocityThreshold

maxLinearCorrection

maxAngularCorrection

maxTranslation

maxTranslationSquared

maxRotation

maxRotationSquared

baumgarte

toiBaugarte

timeToSleep

linearSleepTolerance

angularSleepTolerance

invalidParticleIndex

particleStride

minParticleWeight

maxParticleWeight

maxTriadDistance

maxTriadDistanceSquared

minParticleBufferCapacity

Constructor Detail

JBoxSettings

Method Detail

mixFriction

mixRestitution