Class IntegrationParameters

Constructors

Properties

raw: RawIntegrationParameters

Accessors

  • get contact_erp(): number
  • The Error Reduction Parameter in [0, 1] is the proportion of the positional error to be corrected at each time step (default: 0.2).

    Returns number

  • set contact_natural_frequency(value): void
  • Parameters

    • value: number

    Returns void

  • get dt(): number
  • The timestep length (default: 1.0 / 60.0)

    Returns number

  • set dt(value): void
  • Parameters

    • value: number

    Returns void

  • get lengthUnit(): number
  • Returns number

  • set lengthUnit(value): void
  • Parameters

    • value: number

    Returns void

  • get maxCcdSubsteps(): number
  • Maximum number of substeps performed by the solver (default: 1).

    Returns number

  • set maxCcdSubsteps(value): void
  • Parameters

    • value: number

    Returns void

  • get normalizedAllowedLinearError(): number
  • Normalized amount of penetration the engine won’t attempt to correct (default: 0.001m).

    This threshold considered by the physics engine is this value multiplied by the lengthUnit.

    Returns number

  • set normalizedAllowedLinearError(value): void
  • Parameters

    • value: number

    Returns void

  • get normalizedPredictionDistance(): number
  • The maximal normalized distance separating two objects that will generate predictive contacts (default: 0.02).

    This threshold considered by the physics engine is this value multiplied by the lengthUnit.

    Returns number

  • set normalizedPredictionDistance(value): void
  • Parameters

    • value: number

    Returns void

  • get numInternalPgsIterations(): number
  • Number of internal Project Gauss Seidel (PGS) iterations run at each solver iteration (default: 1).

    Returns number

  • set numInternalPgsIterations(value): void
  • Sets the number of internal Project Gauss Seidel (PGS) iterations run at each solver iteration (default: 1).

    Parameters

    • value: number

    Returns void

  • get numSolverIterations(): number
  • The number of solver iterations run by the constraints solver for calculating forces (default: 4).

    Returns number

  • set numSolverIterations(value): void
  • Sets the number of solver iterations run by the constraints solver for calculating forces (default: 4).

    Parameters

    • value: number

    Returns void

  • get softBodiesContactStiffening(): number
  • Factor applied to the contact softness natural frequencies for the soft-body contacts (default: 4.0).

    Returns number

  • set softBodiesContactStiffening(value): void
  • Parameters

    • value: number

    Returns void

  • get softBodiesFemLinearTolerance(): number
  • Relative residual at which the conjugate gradient of the FEM soft-body solver stops (default: 1.0e-5).

    Returns number

  • set softBodiesFemLinearTolerance(value): void
  • Parameters

    • value: number

    Returns void

  • get softBodiesFemMaxDenseDofs(): number
  • Largest number of degrees of freedom for which a FEM soft body is factorized directly (default: 600); the larger ones rely on the conjugate gradient.

    Returns number

  • set softBodiesFemMaxDenseDofs(value): void
  • Parameters

    • value: number

    Returns void

  • get softBodiesFemMaxLinearIterations(): number
  • Hard cap on the conjugate-gradient iterations of the FEM soft-body solver, whatever the residual (default: 20).

    Returns number

  • set softBodiesFemMaxLinearIterations(value): void
  • Parameters

    • value: number

    Returns void

  • get softBodiesMaxExtraSubsteps(): number
  • Maximum number of extra substeps a soft body requests for its island while it is hit fast (default: 4; 0 disables the impact-adaptive substeps).

    Returns number

  • set softBodiesMaxExtraSubsteps(value): void
  • Parameters

    • value: number

    Returns void

  • get softBodiesRecovery(): SoftRecoverySettings
  • The tangle detection and recovery settings shared by every soft body of the world.

    This gives back a copy: change it and assign it back to apply it.

    Returns SoftRecoverySettings

  • set softBodiesRecovery(value): void
  • Parameters

    Returns void

  • get softBodiesResweepStrain(): number
  • Strain beyond which a soft-body constraint is re-solved after the contacts inside every substep, so a light body buried under heavier ones is not torn (default: 0.75).

    Returns number

  • set softBodiesResweepStrain(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Free the WASM memory used by these integration parameters.

    Returns void