Skip to main content

Type Alias: Constraint

type Constraint = {
    unlockedMotion: UInt32;
    motionLowerLimit: Vec3;
    motionUpperLimit: Vec3;
    motionLimitSpringStiffness: Vec3;
    motionLimitSpringDamping: Vec3;
    swingLimitAngle: Vec2;
    swingSpringStiffness: Float;
    swingSpringDamping: Float;
    twistLimitAngle: Vec2;
    twistSpringStiffness: Float;
    twistSpringDamping: Float;
};

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.

Properties​

unlockedMotion​

unlockedMotion: UInt32;

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

Unlock motion along/around the specified axis.

Default Value​

0;

motionLowerLimit​

motionLowerLimit: Vec3;

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

The lower distance of the limit.

Default Value​

(0, 0, 0);

motionUpperLimit​

motionUpperLimit: Vec3;

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

The upper distance of the limit.

Default Value​

(0, 0, 0);

motionLimitSpringStiffness​

motionLimitSpringStiffness: Vec3;

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

If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

Default Value​

(0, 0, 0);

motionLimitSpringDamping​

motionLimitSpringDamping: Vec3;

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

If greater than zero, this is the damping of the limit spring.

Default Value​

(0, 0, 0);

swingLimitAngle​

swingLimitAngle: Vec2;

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

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. An angle of 0° will not restrict the rotation around the axis. The maximum value for each angle is 180°.

Default Value​

(0, 0);

swingSpringStiffness​

swingSpringStiffness: Float;

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

If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

Default Value​

0;

swingSpringDamping​

swingSpringDamping: Float;

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

If greater than zero, this is the damping of the limit spring.

Default Value​

0;

twistLimitAngle​

twistLimitAngle: Vec2;

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

The twist limit controls the range of motion around the twist axis. The limit angle range is (-360, 360).

Default Value​

(0, 0);

twistSpringStiffness​

twistSpringStiffness: Float;

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

If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

Default Value​

0;

twistSpringDamping​

twistSpringDamping: Float;

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

If greater than zero, this is the damping of the limit spring.

Default Value​

0;