Struct CollisionPlane

Namespace

Box3D

Assembly

Box3D.NET.dll

A constraint handed to the character plane solver.

public readonly record struct CollisionPlane : IEquatable<CollisionPlane>

Implements

IEquatable<CollisionPlane>

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Remarks

Built from a Box3D.CharacterContact once you have decided how the surface should behave. Box3D.CollisionPlane.PushLimit is what separates a solid wall from something soft; Box3D.CollisionPlane.ClipsVelocity is what stops the character accumulating speed into a surface it cannot pass.

Constructors

CollisionPlane(Vector3, float, float, bool)

Initializes a new instance of the Box3D.CollisionPlane struct.

Properties

ClipsVelocity

Gets a value indicating whether velocity is clipped against this plane.

Normal

Gets the outward plane normal.

Offset

Gets the plane offset along its normal.

Push

Gets how far the solver actually pushed along this plane.

PushLimit

Gets how far the solver may push the capsule out of this plane.

Methods

From(CharacterContact, float, bool)

Builds a solver plane from a reported contact.