# 定向包围盒([name])

表示三维空间中的定向包围盒（OBB）。

## 引入

[name] 是一个附加组件，必须显式导入。请参阅 [link:#manual/introduction/Installation Installation / Addons]。

`import { OBB } from 'three/addons/math/OBB.js';`

## 例子

[example:webgl_math_obb]

## 构造函数

### [name]( [param:Vector3 center], [param:Vector3 halfSize], [param:Matrix3 rotation] )

[page:Vector3 center] — [name] 的中心。（可选）
[page:Vector3 halfSize] — [name] 沿每个轴的正半宽范围。（可选）
[page:Matrix3 rotation] — [name] 的旋转。（可选）

创建一个新的 [name]。

## 属性

### [property:Vector3 center]

[name] 的中心。默认值为 *( 0, 0, 0 )*。

### [property:Vector3 halfSize]

[name] 沿每个轴的正半宽范围。默认值为 *( 0, 0, 0 )*。

### [property:Matrix3 rotation]

[name] 的旋转。默认为单位矩阵。

## 方法

### [method:this applyMatrix4]( [param:Matrix4 matrix] )

[page:Matrix4 matrix] — 一个 4x4 变换矩阵。

将给定的变换矩阵应用于此 [name]。此方法可用于将包围体与 3D 对象的世界矩阵进行转换，以保持两个实体同步。

### [method:Vector3 clampPoint]( [param:Vector3 point], [param:Vector3 clampedPoint] )

[page:Vector3 point] — 应该被限制在该 [name] 范围内的点。
[page:Matrix3 clampedPoint] — 结果将被复制到此向量中。

将给定点限制在该 [name] 范围内。

### [method:OBB clone]()

创建此实例的克隆。

### [method:Boolean containsPoint]( [param:Vector3 point] )

[page:Vector3 point] — 要测试的点。

给定点是否位于此 [name] 内。

### [method:this copy]( [param:OBB obb] )

[page:OBB obb] — 要复制的 [name]。

将给定 [name] 的属性复制到此 [name]。

### [method:Boolean equals]( [param:OBB obb] )

[page:OBB obb] — 要测试的 [name]。

给定的 [name] 是否等于此 [name]。

### [method:this fromBox3]( [param:Box3 box3] )

[page:Box3 box3] — AABB

根据给定的 AABB 定义 [name]。

### [method:Vector3 getSize]( [param:Vector3 size] )

[page:Vector3 size] — 结果将被复制到此向量中。

将此 [name] 的大小返回到给定向量中。

### [method:Boolean intersectsBox3]( [param:Box3 box3] )

[page:Box3 box3] — 要测试的 AABB。

给定的 AABB 是否与此 [name] 相交。

### [method:Boolean intersectsSphere]( [param:Sphere sphere] )

[page:Sphere sphere] — 要测试的边界球体。

给定的边界球体是否与此 [name] 相交。

### [method:Boolean intersectsOBB]( [param:OBB obb], [param:Number epsilon] )

[page:OBB obb] — 要测试的 [name]
[page:Number epsilon] — 一个可选的数值，用于抵消算术错误。默认为 `Number.EPSILON`。

给定的 [name] 是否与此 [name] 相交。

### [method:Boolean intersectsPlane]( [param:Plane plane] )

[page:Plane plane] — 要测试的平面。

给定平面是否与此 [name] 相交。

### [method:Boolean intersectsRay]( [param:Ray ray] )

[page:Ray ray] — 要测试的射线。

给定射线是否与此 [name] 相交。

### [method:Vector3 intersectRay]( [param:Ray ray], [param:Vector3 intersectionPoint] )

[page:Ray ray] — 要测试的射线。
[page:Vector3 intersectionPoint] — 结果将被复制到此向量中。

执行 射线/OBB 相交测试并将相交点存储到给定的 3D 向量。如果没有检测到交叉点则返回 `null`。

### [method:this set]( [param:Vector3 center], [param:Vector3 halfSize], [param:Matrix3 rotation] )

[page:Vector3 center] — [name] 的中心。
[page:Vector3 halfSize] — [name] 沿每个轴的正半宽范围。
[page:Matrix3 rotation] — [name] 的旋转。

定义给定值的 [name]。

## 源代码

[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/math/OBB.js examples/jsm/math/OBB.js]