Constraint

type Constraint = {
    motionAlongX: Int32;
    motionAlongY: Int32;
    motionAlongZ: Int32;
    motionAroundX: Int32;
    motionAroundY: Int32;
    motionAroundZ: Int32;
    motionLowerLimit: Vec3;
    motionUpperLimit: Vec3;
    motionLimitSpringStiffness: Vec3;
    motionLimitSpringDamping: Vec3;
    swingLimitAngle: Vec2;
    swingSpringStiffness: Float;
    swingSpringDamping: Float;
    twistLimitAngle: Vec2;
    twistSpringStiffness: Float;
    twistSpringDamping: Float;
    linearDriveStiffness: Vec3;
    linearDriveDamping: Vec3;
    linearDriveForceLimit: Vec3;
    angularDriveStiffness: Vec3;
    angularDriveDamping: Vec3;
    angularDriveForceLimit: Vec3;
    driveType: Int8;
    driveLinearVelocity: Vec3;
    driveAngularVelocity: Vec3;
};

Defined in: node_modules/@3dverse/livelink.core/dist/_prebuild/engine_types/components.d.ts:193

A physics constraint that can be configured along 6 degrees of freedom. In its default state it behaves as a fixed constraint - that is, it rigidly fixes the constraint frames of its two entities. However, individual degrees of freedom may be unlocked to permit any combination of rotation around the x-, y- and z- axes, and translation along these axes.

Type declaration

Name	Type	Description
`motionAlongX`	`Int32`	Motion along the X axis
`motionAlongY`	`Int32`	Motion along the Y axis
`motionAlongZ`	`Int32`	Motion along the Z axis
`motionAroundX`	`Int32`	Motion around the X axis
`motionAroundY`	`Int32`	Motion around the Y axis
`motionAroundZ`	`Int32`	Motion around the Z axis
`motionLowerLimit`	`Vec3`	The lower distance of the limit.
`motionUpperLimit`	`Vec3`	The upper distance of the limit.
`motionLimitSpringStiffness`	`Vec3`	If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
`motionLimitSpringDamping`	`Vec3`	If greater than zero, this is the damping of the limit spring.
`swingLimitAngle`	`Vec2`	The limit angle from the Y-axis and the Z-axis of the constraint frame. The cone limit is used if either or both swing axes are limited. The extents are symmetrical and measured in the frame of the parent. If only one swing degree of freedom is limited, the corresponding value from the cone limit defines the limit range.
`swingSpringStiffness`	`Float`	If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
`swingSpringDamping`	`Float`	If greater than zero, this is the damping of the limit spring.
`twistLimitAngle`	`Vec2`	The twist limit controls the range of motion around the twist axis. The limit angle range is (-360, 360).
`twistSpringStiffness`	`Float`	If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
`twistSpringDamping`	`Float`	If greater than zero, this is the damping of the limit spring.
`linearDriveStiffness`	`Vec3`	If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
`linearDriveDamping`	`Vec3`	If greater than zero, this is the damping of the limit spring.
`linearDriveForceLimit`	`Vec3`	The maximum impulse or force that can be exerted by the drive. -1 for no limit.
`angularDriveStiffness`	`Vec3`	If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
`angularDriveDamping`	`Vec3`	If greater than zero, this is the damping of the limit spring.
`angularDriveForceLimit`	`Vec3`	The maximum impulse or force that can be exerted by the drive. -1 for no limit.
`driveType`	`Int8`	The drive type
`driveLinearVelocity`	`Vec3`	The goal velocity for linear drive.
`driveAngularVelocity`	`Vec3`	The goal velocity for angular drive.

Type declaration​

Type declaration