Class RigidBody

刚体组件

Export

Date

2023.4.21

Author

lyx

Hierarchy

CollisionBody
- RigidBody

Constructors

constructor

new RigidBody(entity, parameters?): RigidBody
Parameters
- entity: Entity
- parameters: CollisionBodyParameters = {}
Returns RigidBody

Overrides CollisionBody.constructor

Properties

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

`Protected` _id

_id: number

`Protected` _isStatic

_isStatic: boolean

`Protected` _shapes

_shapes: CollisionShape[] = []

`Protected` _updateFlag

_updateFlag: BoolUpdateFlag

proxyBody

proxyBody: ICollisionBody

代理碰撞体

Memberof

CollisionBody

userData

userData: {
[key: string]: any;
} = {}

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from CollisionBody.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from CollisionBody.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from CollisionBody.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from CollisionBody.entity

id

get id(): number
获取编号

Returns number

Memberof
PhysicsBody

Inherited from CollisionBody.id

isStatic

get isStatic(): boolean
呼气是否为静态

Returns boolean

Memberof
CollisionBody

Inherited from CollisionBody.isStatic

shapes

get shapes(): readonly CollisionShape[]
获取所有碰撞外形

Returns readonly CollisionShape[]

Memberof
CollisionBody

Inherited from CollisionBody.shapes

Methods

`Protected` _createProxyBody

_createProxyBody(parameters): ICollisionBody
Protected
创建代理碰撞体
Parameters
- parameters: CollisionBodyParameters
  
  参数
Returns ICollisionBody

Memberof
RigidBody

Overrides CollisionBody._createProxyBody

`Protected` _onAwake

_onAwake(): void
Protected
唤醒组件

Returns void

Memberof
Component

Inherited from CollisionBody._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁组件

Returns void

Memberof
CollisionBody

Inherited from CollisionBody._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用组件

Returns void

Memberof
CollisionBody

Inherited from CollisionBody._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用组件

Returns void

Memberof
CollisionBody

Inherited from CollisionBody._onEnable

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from CollisionBody.addEventListener

addShape

addShape(shape): void
添加一个碰撞外形
Parameters
- shape: CollisionShape
  
  碰撞外形
Returns void

Memberof
CollisionBody

Inherited from CollisionBody.addShape

applyCentralForce

applyCentralForce(force): void
施加中心作用力
Parameters
- force: number[] | Vector3
  
  作用力
Returns void

Memberof
RigidBody

applyCentralImpulse

applyCentralImpulse(impulse): void
施加中心推动力
Parameters
- impulse: number[] | Vector3
  
  推动力
Returns void

Memberof
RigidBody

applyCentralLocalForce

applyCentralLocalForce(force): void
施加局部中心作用力
Parameters
- force: number[] | Vector3
  
  作用力
Returns void

Memberof
RigidBody

applyForce

applyForce(force, relativePosition): void
施加作用力
Parameters
- force: number[] | Vector3
  
  作用力
- relativePosition: number[] | Vector3
  
  相对位置
Returns void

Memberof
RigidBody

applyImpulse

applyImpulse(impulse, relativePosition): void
施加推动力
Parameters
- impulse: number[] | Vector3
  
  推动力
- relativePosition: number[] | Vector3
  
  相对位置
Returns void

Memberof
RigidBody

applyLocalTorque

applyLocalTorque(torque): void
施加局部扭矩
Parameters
- torque: number[] | Vector3
  
  扭矩
Returns void

Memberof
RigidBody

applyTorque

applyTorque(torque): void
施加扭矩
Parameters
- torque: number[] | Vector3
  
  扭矩
Returns void

Memberof
RigidBody

applyTorqueImpulse

applyTorqueImpulse(torque): void
施加扭矩推动
Parameters
- torque: number[] | Vector3
  
  扭矩
Returns void

Memberof
RigidBody

clearShapes

clearShapes(): void
清空所有碰撞外形

Returns void

Memberof
CollisionBody

Inherited from CollisionBody.clearShapes

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from CollisionBody.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from CollisionBody.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from CollisionBody.dispose

getForwardDirection

getForwardDirection(): Vector3
获取前进方向

Returns Vector3

Memberof
RigidBody

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from CollisionBody.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from CollisionBody.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from CollisionBody.removeEventListenerByEventId

removeShape

removeShape(shape): void
移除一个碰撞外形
Parameters
- shape: CollisionShape
  
  碰撞外形
Returns void

Memberof
CollisionBody

Inherited from CollisionBody.removeShape

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from CollisionBody.setActive

setAngularFactor

setAngularFactor(angularFactor): void
设置角速度因子
Parameters
- angularFactor: number[] | Vector3
  
  角速度因子
Returns void

Memberof
RigidBody

setAngularVelocity

setAngularVelocity(angularVelocity): void
设置角速度（单位：弧度/秒）
Parameters
- angularVelocity: number[] | Vector3
  
  角速度
Returns void

Memberof
RigidBody

setBounciness

setBounciness(bounciness): void
设置弹力系数
Parameters
- bounciness: number
  
  弹力系数，取值范围[ 0 ~ 1 ]
Returns void

Memberof
RigidBody

setCcdMotionThreshold

setCcdMotionThreshold(threshold): void
设置持续碰撞检测阈值
Parameters
- threshold: number
  
  阈值
Returns void

Memberof
RigidBody

setCcdSweptSphereRadius

setCcdSweptSphereRadius(radius): void
设置持续碰撞检测半径
Parameters
- radius: number
  
  半径
Returns void

Memberof
RigidBody

setDamping

setDamping(linearDamping, angularDamping): void
设置阻尼系数
Parameters
- linearDamping: number
  
  线性阻尼
- angularDamping: number
  
  角度阻尼
Returns void

Memberof
RigidBody

setFriction

setFriction(friction): void
设置摩擦系数
Parameters
- friction: number
  
  摩擦系数
Returns void

Memberof
RigidBody

setGravity

setGravity(gravity): void
设置重力加速度
Parameters
- gravity: number[] | Vector3
Returns void

Memberof
RigidBody

setLinearFactor

setLinearFactor(linearFactor): void
设置线性速度因子
Parameters
- linearFactor: number[] | Vector3
  
  线性速度因子
Returns void

Memberof
RigidBody

setLinearVelocity

setLinearVelocity(linearVelocity): void
设置线性速度（单位：米/秒）
Parameters
- linearVelocity: number[] | Vector3
  
  线性速度
Returns void

Memberof
RigidBody

setRollingFriction

setRollingFriction(friction): void
设置滚动摩擦系数
Parameters
- friction: number
  
  摩擦系数
Returns void

Memberof
RigidBody

setTransform

setTransform(transform): void
设置方位信息
Parameters
- transform: Transformation
  
  方位信息
Returns void

Memberof
RigidBody

Overrides CollisionBody.setTransform

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from CollisionBody.updateProperties