Interface IContactEventHandler

Namespace

Stride.BepuPhysics.Definitions.Contacts

Assembly

Stride.BepuPhysics.dll

Implements handlers for various collision events.

[Obsolete("IContactEventHandler as been superseded by IContactHandler, update your contact methods when migrating to this new class")]
public interface IContactEventHandler : IContactHandler

Inherited Members

IContactHandler.OnStartedTouching<TManifold>(Contacts<TManifold>)

IContactHandler.OnTouching<TManifold>(Contacts<TManifold>)

IContactHandler.OnStoppedTouching<TManifold>(Contacts<TManifold>)

Properties

NoContactResponse

Whether the object this is attached to should let colliders pass through it

[Obsolete("IContactEventHandler as been superseded by IContactHandler, this property will never be called")]
bool NoContactResponse { get; }

Property Value

bool

Methods

OnContactAdded<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, int, BepuSimulation)

Fires when a contact is added.

[Obsolete("IContactEventHandler as been superseded by IContactHandler, this method will never be called", true)]
void OnContactAdded<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int contactIndex, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

contactIndex int

Index of the new contact in the contact manifold.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.

Remarks

This may be called before OnStartedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation), contacts are registered when two collidables are close enough, not necessarily when actually touching.

OnContactRemoved<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, int, BepuSimulation)

Fires when a contact is removed.

[Obsolete("IContactEventHandler as been superseded by IContactHandler, this method will never be called", true)]
void OnContactRemoved<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int removedFeatureId, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

removedFeatureId int

Feature id of the contact that was removed and is no longer present in the contact manifold.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.

Remarks

This may be called without a corresponding call to OnStoppedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation), contacts are registered when two collidables are close enough, not necessarily when actually touching. If the two collidables grazed each other, none of the touching methods will be called.

OnPairCreated<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation)

Fires when a pair is observed for the first time.

[Obsolete("IContactEventHandler as been superseded by IContactHandler, this method will never be called", true)]
void OnPairCreated<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.

OnPairEnded(CollidableComponent, CollidableComponent, BepuSimulation)

Fires when a pair ends.

[Obsolete("IContactEventHandler as been superseded by IContactHandler, this method will never be called", true)]
void OnPairEnded(CollidableComponent eventSource, CollidableComponent other, BepuSimulation bepuSimulation)

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

bepuSimulation BepuSimulation

The simulation where the contact occured.

OnPairUpdated<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation)

Fires whenever a pair is updated. Will not fire for sleeping pairs.

[Obsolete("IContactEventHandler as been superseded by IContactHandler, this method will never be called", true)]
void OnPairUpdated<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.

OnStartedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation)

Fires the first time a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold.

[Obsolete("IContactEventHandler as been superseded by IContactHandler")]
void OnStartedTouching<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.

OnStoppedTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation)

Fires when a pair stops touching. Touching means that there are contacts with nonnegative depths in the manifold.

[Obsolete("IContactEventHandler as been superseded by IContactHandler")]
void OnStoppedTouching<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.

OnTouching<TManifold>(CollidableComponent, CollidableComponent, ref TManifold, bool, int, BepuSimulation)

Fires whenever a pair is observed to be touching. Touching means that there are contacts with nonnegative depths in the manifold. Will not fire for sleeping pairs.

[Obsolete("IContactEventHandler as been superseded by IContactHandler")]
void OnTouching<TManifold>(CollidableComponent eventSource, CollidableComponent other, ref TManifold contactManifold, bool flippedManifold, int workerIndex, BepuSimulation bepuSimulation) where TManifold : unmanaged, IContactManifold<TManifold>

Parameters

eventSource CollidableComponent

Collidable that the event was attached to.

other CollidableComponent

Other collider eventSource collided with.

contactManifold TManifold

Set of remaining contacts in the collision.

flippedManifold bool

Whether the manifold's normals and offset is flipped from the source's point of view.

workerIndex int

Index of the worker thread that fired this event.

bepuSimulation BepuSimulation

The simulation where the contact occured.

Type Parameters

TManifold

Type of the contact manifold detected.