Skip to main content

Contact

Class

Contact point between two colliding objects.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v164

Index

Example

// Print out information about each contact point when the collider enters a collision

// @input Physics.ColliderComponent collider

script.collider.onCollisionEnter.add(function(eventArgs) {
var collision = eventArgs.collision;
var contactCount = collision.contactCount;
var contacts = collision.contacts;
for (var i = 0; i < contactCount; ++i) {
var contact = contacts[i];
print("contact[" + i + "]: distance=" + contact.distance + ", impulse=" + contact.impulse);
}
});

Extends

Properties

distance

readonly distance: number

Distance along the normal between the hit collider and this collider.

Since

Lens Scripting Version 164


impulse

readonly impulse: number

Impulse (kg*cm/s) applied along the normal in response to the collision.

Since

Lens Scripting Version 164


normal

readonly normal: vec3

Normal on the hit collider.

Since

Lens Scripting Version 164


position

readonly position: vec3

Position on the hit collider.

Since

Lens Scripting Version 164

Methods

getTypeName()

static getTypeName(): TypeName<Contact>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<Contact>

Since

Lens Scripting Version 164

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame

See also