Class SoftBody

柔体组件

Export

Date

2023.4.19

Author

lyx

Hierarchy

Constructors

constructor

Properties

_engine _entity _id _updateFlag isSoftBody proxySoftBody userData

Accessors

enabled engine entity id

Methods

_onAwake _onDestroy _onDisable _onEnable addAeroForceToNode addEventListener addForce appendAnchor destroy dispatchEvent dispose onLateUpdate onUpdate removeAllEventListeners removeEventListener removeEventListenerByEventId setActive setConfig setMass setMaterial setTotalMass setTransform updateProperties

Constructors

constructor

Properties

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Protected _id

_id: number

Protected _updateFlag

_updateFlag: BoolUpdateFlag

Readonly isSoftBody

isSoftBody: true = true

柔体标识

Memberof

SoftBody

proxySoftBody

proxySoftBody: ISoftBody

代理柔体

Memberof

SoftBody

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

id

  • get id(): number

  • 获取编号

    Returns number

    Memberof

    PhysicsBody

Methods

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁组件

    Returns void

    Memberof

    SoftBody

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用组件

    Returns void

    Memberof

    SoftBody

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用组件

    Returns void

    Memberof

    SoftBody

addAeroForceToNode

  • 添加风速

    Parameters

    • windVelocity: number[] | Vector3
    • nodeIndex: number

    Returns void

addEventListener

  • 添加事件监听器

    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

addForce

  • 添加作用力

    Parameters

    • force: number[] | Vector3
    • Optional node: number

    Returns void

appendAnchor

  • 附加锚点

    Parameters

    • node: number
    • body: RigidBody
    • disableCollisionBetweenLinkedBodies: boolean
    • influence: number

    Returns void

    Memberof

    SoftBody

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

onLateUpdate

  • 延迟更新柔体组件，物理更新后

    Returns void

    Memberof

    SoftBody

onUpdate

  • 更新柔体组件，物理更新前

    Returns void

    Memberof

    SoftBody

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    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

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setConfig

  • 设置配置数据

    Parameters

    • cfg: {
          [key: string]: any;
      }

      配置数据

      • [key: string]: any

    Returns void

    Memberof

    SoftBody

setMass

  • 设置指定结点质量

    Parameters

    • node: number

      结点编号

    • mass: number

      质量

    Returns void

    Memberof

    SoftBody

setMaterial

  • 设置物理材质

    Parameters

    • node: number

      结点编号

    • material: {
          [key: string]: any;
      }

      物理材质

      • [key: string]: any

    Returns void

    Memberof

    SoftBody

setTotalMass

  • 设置总质量

    Parameters

    • mass: number

      质量

    • fromfaces: boolean

    Returns void

    Memberof

    SoftBody

setTransform

  • 设置方位信息

    Parameters

    Returns void

    Memberof

    SoftBody

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

Settings

Member Visibility

Theme

On This Page