Class PhysicsConstraint

constructor

• new PhysicsConstraint(
      type: PhysicsConstraintType,
      options: PhysicsConstraintParameters,
      scene: Scene,
  ): PhysicsConstraint

  Constructs a new constraint for the physics constraint.

  Parameters

  • type: PhysicsConstraintType

    The type of constraint to create.

  • options: PhysicsConstraintParameters

    The options for the constraint.

  • scene: Scene

    The scene the constraint belongs to.

    This code is useful for creating a new constraint for the physics engine. It checks if the scene has a physics engine, and if the plugin version is correct. If all checks pass, it initializes the constraint with the given type and options.

  Returns PhysicsConstraint

_pluginData

isCollisionsEnabled

• get isCollisionsEnabled(): boolean

  Gets whether collisions are enabled for this physics object.

  Returns boolean

  true if collisions are enabled, false otherwise.

• set isCollisionsEnabled(isEnabled: boolean): void

  Enables or disables collisions for the physics engine.

  Parameters

  • isEnabled: boolean

    A boolean value indicating whether collisions should be enabled or disabled.

  Returns void

isEnabled

• get isEnabled(): boolean

  Returns boolean

  true if constraint is enabled

• set isEnabled(isEnabled: boolean): void

  Enable/disable the constraint

  Parameters

  • isEnabled: boolean

    value for the constraint

  Returns void

options

• get options(): PhysicsConstraintParameters

  Retrieves the options of the physics constraint.

  Returns PhysicsConstraintParameters

  The physics constraint parameters.

type

• get type(): PhysicsConstraintType

  Gets the type of the constraint.

  Returns PhysicsConstraintType

  The type of the constraint.

dispose

• dispose(): void

  Disposes the constraint from the physics engine.

  This method is useful for cleaning up the physics engine when a body is no longer needed. Disposing the body will free up resources and prevent memory leaks.

  Returns void

getBodiesUsingConstraint

• getBodiesUsingConstraint(): ConstrainedBodyPair[]

  Gets all bodies that are using this constraint

  Returns ConstrainedBodyPair[]