Struct FilterJointDefinition

Namespace

Box3D

Assembly

Box3D.NET.dll

Applies no constraint. It exists solely to stop two bodies colliding.

public readonly record struct FilterJointDefinition : IEquatable<FilterJointDefinition>

Implements

IEquatable<FilterJointDefinition>

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Examples

// Let a projectile pass through the turret that fired it, and nothing else.
world.CreateFilterJoint(new FilterJointDefinition
{
    Base = JointDefinition.Connect(turret, shell, JointFrame.Identity, JointFrame.Identity),
});

Remarks

Cheaper and more direct than spending a collision category on a single pair. As a side effect the two bodies stay in the same simulation island, so they sleep and wake together.

Properties

Base

Gets the settings shared by every joint.

Default

Gets the engine defaults, with no bodies attached.

Methods

Between(Body, Body)

Stops two bodies from colliding with each other.