Class ContactPoint

Information about a single contact point during physics collision.

Index

Constructors

Properties

_impulse _normal _position _separation

Accessors

impulse normal position separation

Methods

clone isEqual isEqual

Constructors

constructor

new ContactPoint(
    position?: Immutable<Vector3>,
    normal?: Immutable<Vector3>,
    impulse?: Immutable<Vector3>,
    separation?: number,
): ContactPoint
Parameters
- Optionalposition: Immutable<Vector3>
- Optionalnormal: Immutable<Vector3>
- Optionalimpulse: Immutable<Vector3>
- Optionalseparation: number
Returns ContactPoint

Properties

`Protected`_impulse

_impulse: Vector3

`Protected`_normal

_normal: Vector3

`Protected`_position

_position: Vector3

`Protected`_separation

_separation: number

Accessors

impulse

get impulse(): Vector3

Impulse applied to the objects to keep them from penetrating. Divide by simulation step to get the force.

Returns Vector3

normal

get normal(): Vector3

Contact normal in world space. The contact normal is the direction of the Impulse that is results from the collision. In simple cases, this is simply the surface normal at the contact position, e.g. the up direction when falling on flat ground. Note that this normal faces towards CollisionData::ThisCollider. This means for the objects falling on the ground, the normal will point straight up, while for the ground it will point straight down.

Returns Vector3

position

get position(): Vector3

Contact point in world space.

Returns Vector3

separation

get separation(): number

Determines how far are the objects. Negative value denotes penetration.

Returns number

Methods

clone

clone(): ContactPoint

Clones this instance and returns a new ContactPoint with identical values.

Returns ContactPoint

isEqual

isEqual(this: Immutable<ContactPoint>, other: Immutable<ContactPoint>): boolean
Determines if this ContactPoint instance is equal to the other instance.
Parameters
- this: Immutable<ContactPoint>
- other: Immutable<ContactPoint>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<ContactPoint>, rhs: Immutable<ContactPoint>): boolean
Determines if both ContactPoint instances are equal.
Parameters
- lhs: Immutable<ContactPoint>
- rhs: Immutable<ContactPoint>
Returns boolean