类 SpringConstraint

En

The SpringConstraint class represents a type of constraint that simulates spring behavior in a physics simulation.

Zh

SpringConstraint 类表示一种在物理模拟中模拟弹簧行为的约束类型。

层级 (查看层级一览)

ConstraintComponent
- SpringConstraint

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

owner

owner: Sprite3D

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

访问器

anchor

get anchor(): Vector3
返回 Vector3
En
The anchor point.

Zh
锚点
继承自 ConstraintComponent.anchor
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:149
set anchor(value: Vector3): void
参数
- value: Vector3
返回 void
继承自 ConstraintComponent.anchor
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:153

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 ConstraintComponent.awaked
- 定义于 src/layaAir/laya/components/Component.ts:133

breakForce

get breakForce(): number
返回 number
En
The maximum force the joint can withstand before breaking.

Zh
关节在断裂前能承受的最大力。
继承自 ConstraintComponent.breakForce
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:123
set breakForce(value: number): void
参数
- value: number
返回 void
继承自 ConstraintComponent.breakForce
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:127

breakTorque

get breakTorque(): number
返回 number
En
The maximum torque the joint can withstand before breaking.

Zh
关节在断裂前能承受的最大扭矩。
继承自 ConstraintComponent.breakTorque
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:136
set breakTorque(value: number): void
参数
- value: number
返回 void
继承自 ConstraintComponent.breakTorque
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:140

connectAnchor

get connectAnchor(): Vector3
返回 Vector3
En
The connected anchor point.

Zh
连接锚点位置
继承自 ConstraintComponent.connectAnchor
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:162
set connectAnchor(value: Vector3): void
参数
- value: Vector3
返回 void
继承自 ConstraintComponent.connectAnchor
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:166

connectedBody

get connectedBody(): PhysicsColliderComponent
返回 PhysicsColliderComponent
En
Physical components of joint connections rigid body

Zh
关节连接的物理组件刚体
继承自 ConstraintComponent.connectedBody
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:61
set connectedBody(value: PhysicsColliderComponent): void
参数
- value: PhysicsColliderComponent
返回 void
继承自 ConstraintComponent.connectedBody
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:65

currentForce

get currentForce(): Vector3
返回 Vector3
En
The total force applied to the joint.

Zh
作用在关节上的总力。
继承自 ConstraintComponent.currentForce
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:95

currentTorque

get currentTorque(): Vector3
返回 Vector3
En
The total torque applied to the joint.

Zh
作用在关节上的总力矩。
继承自 ConstraintComponent.currentTorque
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:109

damping

get damping(): number
返回 number
En
The damping of the spring.

Zh
弹簧的阻尼值。
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:115
set damping(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:119

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 ConstraintComponent.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:141

enableCollison

get enableCollison(): boolean
返回 boolean
En
Enables or disables collision between the connected bodies of the joint.

Zh
是否启用关节连接体之间的碰撞。
继承自 ConstraintComponent.enableCollison
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:175
set enableCollison(value: boolean): void
参数
- value: boolean
返回 void
继承自 ConstraintComponent.enableCollison
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:178

enabled

get enabled(): boolean
返回 boolean
En
whether the component is enabled.

Zh
是否启用组件。
继承自 ConstraintComponent.enabled
- 定义于 src/layaAir/laya/components/Component.ts:117
set enabled(value: boolean): void
参数
- value: boolean
返回 void
继承自 ConstraintComponent.enabled
- 定义于 src/layaAir/laya/components/Component.ts:121

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 ConstraintComponent.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:67
set hideFlags(value: number): void
参数
- value: number
返回 void
继承自 ConstraintComponent.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:71

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 ConstraintComponent.id
- 定义于 src/layaAir/laya/components/Component.ts:109

maxDistance

get maxDistance(): number
返回 number
En
the maximum distance in a spring constraint, where the spring starts pulling the objects together if they exceed this distance.

Zh
两个物体之间的最大允许距离。当物体间距超过这个值时，弹簧会施加拉力使物体靠近。
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:75
set maxDistance(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:79

minDistance

get minDistance(): number
返回 number
En
the minimum distance at which a spring constraint begins to exert a separating force when the distance between objects reaches or falls below this value. If the objects get closer than this, the spring applies a separating force to push them apart to a safe distance. When the distance is at or above the set value, the spring doesn't exert any stretching force.

Zh
弹簧关节在物体间距达到或小于此值时开始施加分离力的最小距离。如果物体间距小于这个值，弹簧会施加分离力将它们推开到安全距离。而当距离达到或超过设定值时，弹簧不会施加任何拉伸力。
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:62
set minDistance(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:66

ownBody

get ownBody(): PhysicsColliderComponent
返回 PhysicsColliderComponent
En
The owner rigid body of the joint, which is the physical component that the joint is attached to.

Zh
关节所属的物理组件刚体。
继承自 ConstraintComponent.ownBody
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:78
set ownBody(value: PhysicsColliderComponent): void
参数
- value: PhysicsColliderComponent
返回 void
继承自 ConstraintComponent.ownBody
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:82

spring

get spring(): number
返回 number
En
used to set the stiffness of a spring or constraint, adjusting the strength of the force or constraint between objects.

Zh
弹簧的刚度，以控制物体之间的弹力或约束强度。
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:102
set spring(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:106

tolerance

get tolerance(): number
返回 number
En
refers to the allowable margin of error in a physics engine, used to handle contact or constraints between objects, ensuring the system has a certain degree of tolerance in calculations.

Zh
弹簧的误差容限。用于处理物体之间的接触或约束时，确保系统在计算中具有一定的容忍度，以避免由于数值计算精度问题导致的不稳定或错误行为。
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:89
set tolerance(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/physics/constraints/SpringConstraint.ts:93

方法

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 ConstraintComponent.destroy
- 定义于 src/layaAir/laya/components/Component.ts:289

hasHideFlag

hasHideFlag(flag: number): boolean
参数
- flag: number
  The hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.

Zh
检查组件是否设置了特定的隐藏标志。
继承自 ConstraintComponent.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:101

initJoint

initJoint(): void
返回 void
En
Initializes the joint instance.

Zh
初始化关节实例。
继承自 ConstraintComponent.initJoint
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:39

onAdded

onAdded(): void
返回 void
En
Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

Zh
组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。
继承自 ConstraintComponent.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:329

onAwake

onAwake(): void
返回 void
En
Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

Zh
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。
继承自 ConstraintComponent.onAwake
- 定义于 src/layaAir/laya/components/Component.ts:344

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

Zh
手动调用节点销毁时执行。
继承自 ConstraintComponent.onDestroy
- 定义于 src/layaAir/laya/components/Component.ts:395

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

Zh
组件被禁用时执行，比如从节点从舞台移除后。
继承自 ConstraintComponent.onDisable
- 定义于 src/layaAir/laya/components/Component.ts:388

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

Zh
组件被启用后执行，比如节点被添加到舞台后。
继承自 ConstraintComponent.onEnable
- 定义于 src/layaAir/laya/components/Component.ts:351

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。
继承自 ConstraintComponent.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:370

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。
继承自 ConstraintComponent.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。
继承自 ConstraintComponent.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:376

`可选`onReset

onReset(): void
返回 void
En
Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

Zh
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 ConstraintComponent.onReset
- 定义于 src/layaAir/laya/components/Component.ts:338

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

Zh
在第一次执行 update 之前执行，只会执行一次。
继承自 ConstraintComponent.onStart
- 定义于 src/layaAir/laya/components/Component.ts:358

`可选`onUpdate

onUpdate(): void
返回 void
En
Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

Zh
每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。
继承自 ConstraintComponent.onUpdate
- 定义于 src/layaAir/laya/components/Component.ts:364

setConstraintEnabled

setConstraintEnabled(enable: boolean): void
参数
- enable: boolean
  True to enable the constraint, false to disable it.
返回 void
En
Enables or disables the constraint.

Zh
启用或禁用约束。
继承自 ConstraintComponent.setConstraintEnabled
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:212

setOverrideNumSolverIterations

setOverrideNumSolverIterations(overideNumIterations: number): void
参数
- overideNumIterations: number
  The number of iterations to override with.
返回 void
En
Sets the number of solver iterations used to resolve the constraint. Higher values increase the precision but may reduce performance.

Zh
设置用于解决约束的求解器迭代次数。次数越高，精度越准确，但可能会降低性能。
继承自 ConstraintComponent.setOverrideNumSolverIterations
- 定义于 src/layaAir/laya/d3/physics/constraints/ConstraintComponent.ts:202

类 SpringConstraint

En

Zh

层级 (查看层级一览)

索引

属性

访问器

方法

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

访问器

anchor

返回 Vector3

En

Zh

参数

返回 void

awaked

返回 boolean

En

Zh

breakForce

返回 number

En

Zh

参数

返回 void

breakTorque

返回 number

En

Zh

参数

返回 void

connectAnchor

返回 Vector3

En

Zh

参数

返回 void

connectedBody

返回 PhysicsColliderComponent

En

Zh

参数

返回 void

currentForce

返回 Vector3

En

Zh

currentTorque

返回 Vector3

En

Zh

damping

返回 number

En

Zh

参数

返回 void

destroyed

返回 boolean

En

Zh