# Class: PhysicsSystem

物理系统，管理着场景中的所有[轮廓](Shape)和[刚体](Rigidbody)。

## Hierarchy

- [`Component`](Component)

  ↳ **`PhysicsSystem`**

## Table of contents

### Constructors

- constructor

### Events

- onAdd
- onRelease
- onRemove
- onTick
- onUpdate

### Properties

- enableSimulation
- fixedDeltaTime
- maxPhysicsDeltaTime
- priority
- schema
- EVENTS

### Accessors

- el
- gravity
- scene
- version

### Methods

- getData
- ignoreLayerCollision
- raycast
- setData
- setDataOne

## Constructors

### constructor

• **new PhysicsSystem**()

#### Overrides

[Component](Component).[constructor](Component#constructor)

## Events

### onAdd

▸ **onAdd**(): `void`

所挂载的`element`被挂载到场景时触发的回调。

#### Returns

`void`

#### Inherited from

[Component](Component).[onAdd](Component#onAdd)

___

### onRelease

▸ **onRelease**(`data`): `void`

从被挂载的`element`上被移除，或是`element`被销毁时，触发的回调。
一般用于释放持有的资源。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRelease](Component#onRelease)

___

### onRemove

▸ **onRemove**(`parent`, `data`): `void`

所挂载的`element`从父节点`parent`被移除时，或者自己从`element`上被移除时，触发的回调。
一般用于消除功能的运作。
**如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。**

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRemove](Component#onRemove)

___

### onTick

• **onTick**: 

#### Inherited from

[Component](Component).[onTick](Component#onTick)

___

### onUpdate

▸ **onUpdate**(`data`, `preData`): `void`

数据更新时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData) |
| `preData` | [`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onUpdate](Component#onUpdate)

## Properties

### enableSimulation

• **enableSimulation**: `boolean` = `false`

是否进行物理模拟。

___

### fixedDeltaTime

• **fixedDeltaTime**: `number` = `0.02`

___

### maxPhysicsDeltaTime

• **maxPhysicsDeltaTime**: `number` = `0.1`

___

### priority

• `Readonly` **priority**: `number`

自定义组件的更新优先级。

#### Inherited from

[Component](Component).[priority](Component#priority)

___

### schema

• `Readonly` **schema**: [`IComponentSchema`](/miniprogram/dev/reference/xr-frame/api/interfaces/IComponentSchema) = `{}`

自定义组件的`schema`。

#### Inherited from

[Component](Component).[schema](Component#schema)

___

### EVENTS

▪ `Static` **EVENTS**: `string`[] = `[]`

#### Inherited from

[Component](Component).[EVENTS](Component#EVENTS)

## Accessors

### el

• `get` **el**(): [`Element`](Element)

挂载的元素。

#### Returns

[`Element`](Element)

___

### gravity

• `get` **gravity**(): [`Vector3`](Vector3)

全局重力。

**`default`** [0, -9.8, 0]

#### Returns

[`Vector3`](Vector3)

• `set` **gravity**(`v`): `void`

全局重力。

#### Parameters

| Name | Type |
| :------ | :------ |
| `v` | [`Vector3`](Vector3) |

#### Returns

`void`

___

### scene

• `get` **scene**(): [`Scene`](Scene)

当前场景。

#### Returns

[`Scene`](Scene)

___

### version

• `get` **version**(): `number`

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

#### Returns

`number`

## Methods

### getData

▸ **getData**(`key`): [`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData)[`T`]

获取一个当前值。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends `never` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |

#### Returns

[`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData)[`T`]

#### Inherited from

[Component](Component).[getData](Component#getData)

___

### ignoreLayerCollision

▸ **ignoreLayerCollision**(`layer1`, `layer2`, `ignore?`): `void`

设定某一对layer之间是否会发生碰撞。

#### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `layer1` | `number` | `undefined` | - |
| `layer2` | `number` | `undefined` | - |
| `ignore` | `boolean` | `true` | `true`表示**不**碰撞。 |

#### Returns

`void`

___

### raycast

▸ **raycast**(`desc`): `boolean`

射线检测，判断给定射线是否与至少一个轮廓相交，并返回与**最近**的那个轮廓相交的信息。
返回的信息记录在desc.hit里，需要事先创建一个RaycastHit对象来负责接收。

#### Parameters

| Name | Type |
| :------ | :------ |
| `desc` | [`RaycastDesc`](../modules#RaycastDesc) |

#### Returns

`boolean`

___

### setData

▸ **setData**(`data`): `void`

不通过`xml`而是直接设置`data`，注意值的类型需要和`schema`中一致。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `Partial` |

#### Returns

`void`

#### Inherited from

[Component](Component).[setData](Component#setData)

___

### setDataOne

▸ **setDataOne**(`key`, `value`): `void`

设置一个数据。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends `never` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |
| `value` | [`IPhysicsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IPhysicsSystemData)[`T`] |

#### Returns

`void`

#### Inherited from

[Component](Component).[setDataOne](Component#setDataOne)