Skip to main content

Physics.HingeLimitSettings

Class

Settings that describe how the position of the object should be limited in respect to the applied forces.

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

Index

Example

//@input Physics.ConstraintComponent constraintComponent

let constraint = script.constraintComponent.constraint;

let limitSettings = constraint.limitSettings;
limitSettings.enabled = true;
limitSettings.low = 0;
limitSettings.high = Math.PI;
limitSettings.bias = 3;
limitSettings.relaxation = 2;
constraint.limitSettings = limitSettings;

Properties

bias

bias: number

Controls how strictly constraint respects the limits.

Default Value

0.3

enabled

enabled: boolean

Enable or disable constraint limits.

Default Value

false

high

high: number

Maximum allowed angle (in radians), relative to the constraint resting state.

Default Value

0

low

low: number

Minimum allowed angle (in radians), relative to the constraint resting state.

Default Value

0

relaxation

relaxation: number

Controls how strictly the limit is enforced. Greater values relate to more "bouncy" behaviour of the constraint.

Default Value

1

Methods

getTypeName()

static getTypeName(): TypeName<HingeLimitSettings>

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