Class obb

Alias of OBB

deprecated: Since v3.0

Hierarchy

obb
- obb

Index

Constructors

constructor

Properties

Accessors

type

Methods

Constructors

constructor

new obb(): obb

Overrides obb.constructor
- Defined in cocos/core/geometry/deprecated-3.0.0.ts:223
Returns obb

Properties

Protected Readonly _type

_type: number

center

center: Vec3

zh: 本地坐标的中心点。

halfExtents

halfExtents: Vec3

zh: 长宽高的一半。

orientation

orientation: Mat3

zh: 方向矩阵。

Accessors

type

get type(): number

Inherited from obb.type
- Defined in cocos/core/geometry/obb.ts:196
Gets the type of the shape.

Returns number

Methods

getBoundary

getBoundary(minPos: Vec3, maxPos: Vec3): void

Inherited from obb.getBoundary
- Defined in cocos/core/geometry/obb.ts:221
Get the bounding points of this shape

Parameters
- minPos: Vec3
  
  最小点。
- maxPos: Vec3
  
  最大点。
Returns void

setScale

setScale(scale: Vec3, out: obb): void

Inherited from obb.setScale
- Defined in cocos/core/geometry/obb.ts:263
zh

将 out 根据这个 obb 的数据进行缩放。

Parameters
- scale: Vec3
  
  缩放值。
- out: obb
  
  缩放的目标。
Returns void

transform

transform(m: Mat4, pos: Vec3, rot: Quat, scale: Vec3, out: obb): void

Inherited from obb.transform
- Defined in cocos/core/geometry/obb.ts:237
Transform this shape

zh

将 out 根据这个 obb 的数据进行变换。

Parameters
- m: Mat4
  
  变换的矩阵。
- pos: Vec3
  
  变换的位置部分。
- rot: Quat
  
  变换的旋转部分。
- scale: Vec3
  
  变换的缩放部分。
- out: obb
  
  变换的目标。
Returns void

translateAndRotate

translateAndRotate(m: Mat4, rot: Quat, out: obb): void

Inherited from obb.translateAndRotate
- Defined in cocos/core/geometry/obb.ts:251
zh

将 out 根据这个 obb 的数据进行变换。

Parameters
- m: Mat4
  
  变换的矩阵。
- rot: Quat
  
  变换的旋转部分。
- out: obb
  
  变换的目标。
Returns void

Static clone

clone(a: obb): obb

Inherited from obb.clone
- Defined in cocos/core/geometry/obb.ts:94
clone a new obb

Parameters
- a: obb
  
  克隆的目标。
Returns obb

克隆出的新对象。

Static copy

copy(out: obb, a: obb): obb

Inherited from obb.copy
- Defined in cocos/core/geometry/obb.ts:111
copy the values from one obb to another

Parameters
- out: obb
  
  接受操作的 obb。
- a: obb
  
  被复制的 obb。
Returns obb

out 接受操作的 obb。

Static create

create(cx: number, cy: number, cz: number, hw: number, hh: number, hl: number, ox_1: number, ox_2: number, ox_3: number, oy_1: number, oy_2: number, oy_3: number, oz_1: number, oz_2: number, oz_3: number): obb

Inherited from obb.create
- Defined in cocos/core/geometry/obb.ts:76
create a new obb

Parameters
- cx: number
  
  形状的相对于原点的 X 坐标。
- cy: number
  
  形状的相对于原点的 Y 坐标。
- cz: number
  
  形状的相对于原点的 Z 坐标。
- hw: number
  
  obb 宽度的一半。
- hh: number
  
  obb 高度的一半。
- hl: number
  
  obb 长度的一半。
- ox_1: number
  
  方向矩阵参数。
- ox_2: number
  
  方向矩阵参数。
- ox_3: number
  
  方向矩阵参数。
- oy_1: number
  
  方向矩阵参数。
- oy_2: number
  
  方向矩阵参数。
- oy_3: number
  
  方向矩阵参数。
- oz_1: number
  
  方向矩阵参数。
- oz_2: number
  
  方向矩阵参数。
- oz_3: number
  
  方向矩阵参数。
Returns obb

返回一个 obb。

Static fromPoints

fromPoints(out: obb, minPos: Vec3, maxPos: Vec3): obb

Inherited from obb.fromPoints
- Defined in cocos/core/geometry/obb.ts:129
create a new obb from two corner points

Parameters
- out: obb
  
  接受操作的 obb。
- minPos: Vec3
  
  obb 的最小点。
- maxPos: Vec3
  
  obb 的最大点。
Returns obb

out 接受操作的 obb。

Static set

set(out: obb, cx: number, cy: number, cz: number, hw: number, hh: number, hl: number, ox_1: number, ox_2: number, ox_3: number, oy_1: number, oy_2: number, oy_3: number, oz_1: number, oz_2: number, oz_3: number): obb

Inherited from obb.set
- Defined in cocos/core/geometry/obb.ts:158
Set the components of a obb to the given values

Parameters
- out: obb
- cx: number
  
  obb 的原点的 X 坐标。
- cy: number
  
  obb 的原点的 Y 坐标。
- cz: number
  
  obb 的原点的 Z 坐标。
- hw: number
  
  obb 宽度的一半。
- hh: number
  
  obb 高度的一半。
- hl: number
  
  obb 长度的一半。
- ox_1: number
  
  方向矩阵参数。
- ox_2: number
  
  方向矩阵参数。
- ox_3: number
  
  方向矩阵参数。
- oy_1: number
  
  方向矩阵参数。
- oy_2: number
  
  方向矩阵参数。
- oy_3: number
  
  方向矩阵参数。
- oz_1: number
  
  方向矩阵参数。
- oz_2: number
  
  方向矩阵参数。
- oz_3: number
  
  方向矩阵参数。
Returns obb

out

Generated using TypeDoc