Skip to main content

Physics.HingeConstraint

Class

Constraints translation and a single axis of rotation.

  • 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

Constraints translation and a single axis of rotation. See also: ConstraintComponent.

Index

Example

// Create a constraint on an object
var hingeConstraint = hingeObj.createComponent(ConstraintComponent.getTypeName());

// Set up options on that constraint
hingeConstraint.debugDrawEnabled = true;
hingeConstraint.constraint = Physics.Constraint.create(Physics.ConstraintType.Hinge);

Extends

Properties

constraintType

readonly constraintType: ConstraintType

The type of constraint that is applied.

Since

Lens Scripting Version 164

Inherited from

Constraint.constraintType


limitSettings

limitSettings: HingeLimitSettings

Settings limiting the behaviour of hinge constraint in respect to the applied forces.

Since

Lens Scripting Version 164


motorSettings

motorSettings: HingeMotorSettings

Settings describing the independent force (motor) applied to the constraint.

Since

Lens Scripting Version 164

Methods

create()

static create(type): Constraint

Create a constraint of the given type, with default settings.

Parameters

ParameterType
typeConstraintType

Returns

Constraint

Since

Lens Scripting Version 164

Inherited from

Constraint.create


getTypeName()

static getTypeName(): TypeName<HingeConstraint>

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<HingeConstraint>

Since

Lens Scripting Version 164

Overrides

Constraint.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Constraint.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

Constraint.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

Constraint.isSame