Class plane

Basic Geometry: Plane.

Hierarchy

plane
- plane

Index

Constructors

constructor

Properties

Accessors

type
w
x
y
z

Methods

Constructors

constructor

newPlane(nx?: number, ny?: number, nz?: number, d?: number): plane

- Defined in cocos/core/geometry/plane.ts:204
en

Construct a plane.

zh

构造一个平面。

Parameters
- Default value nx: number = 0
  
  法向分量的 x 部分。
- Default value ny: number = 1
  
  法向分量的 y 部分。
- Default value nz: number = 0
  
  法向分量的 z 部分。
- Default value d: number = 0
  
  与原点的距离。
Returns plane

Properties

Protected Readonly _type

_type: number

d

d: number

The distance from the origin to the plane.

n

The normal of the plane.

Accessors

type

get type(): number

- Defined in cocos/core/geometry/plane.ts:190
Gets the type of the shape.

Returns number

w

get w(): number
set w(val: number): void

- Defined in cocos/core/geometry/plane.ts:202
Returns number
- Defined in cocos/core/geometry/plane.ts:201
Parameters
- val: number
Returns void

x

get x(): number
set x(val: number): void

- Defined in cocos/core/geometry/plane.ts:196
Returns number
- Defined in cocos/core/geometry/plane.ts:195
Parameters
- val: number
Returns void

y

get y(): number
set y(val: number): void

- Defined in cocos/core/geometry/plane.ts:198
Returns number
- Defined in cocos/core/geometry/plane.ts:197
Parameters
- val: number
Returns void

z

get z(): number
set z(val: number): void

- Defined in cocos/core/geometry/plane.ts:200
Returns number
- Defined in cocos/core/geometry/plane.ts:199
Parameters
- val: number
Returns void

Methods

transform

transform(mat: Mat4): void

- Defined in cocos/core/geometry/plane.ts:229
transform this plane.

Parameters
- mat: Mat4
Returns void

Static clone

clone(p: plane): plane

- Defined in cocos/core/geometry/plane.ts:71
clone a new plane

Parameters
- p: plane
  
  克隆的来源。
Returns plane

克隆出的对象。

Static copy

copy(out: plane, p: plane): plane

- Defined in cocos/core/geometry/plane.ts:84
copy the values from one plane to another

Parameters
- out: plane
  
  接受操作的对象。
- p: plane
  
  复制的来源。
Returns plane

接受操作的对象。

Static create

create(nx: number, ny: number, nz: number, d: number): plane

- Defined in cocos/core/geometry/plane.ts:59
create a new plane

Parameters
- nx: number
  
  法向分量的 x 部分。
- ny: number
  
  法向分量的 y 部分。
- nz: number
  
  法向分量的 z 部分。
- d: number
  
  与原点的距离。
Returns plane

Static fromNormalAndPoint

fromNormalAndPoint(out: plane, normal: Vec3, point: Vec3): plane

- Defined in cocos/core/geometry/plane.ts:143
create plane from normal and point

Parameters
- out: plane
  
  接受操作的对象。
- normal: Vec3
  
  平面的法线。
- point: Vec3
  
  平面上的一点。
Returns plane

out 接受操作的对象。

Static fromPoints

fromPoints(out: plane, a: Vec3, b: Vec3, c: Vec3): plane

- Defined in cocos/core/geometry/plane.ts:102
create a plane from three points

Parameters
- out: plane
  
  接受操作的对象。
- a: Vec3
  
  点 a。
- b: Vec3
  
  点 b。
- c: Vec3
  
  点 c。
Returns plane

out 接受操作的对象。

Static normalize

normalize(out: plane, a: plane): plane

- Defined in cocos/core/geometry/plane.ts:159
normalize a plane

Parameters
- out: plane
  
  接受操作的对象。
- a: plane
  
  操作的源数据。
Returns plane

out 接受操作的对象。

Static set

set(out: plane, nx: number, ny: number, nz: number, d: number): plane

- Defined in cocos/core/geometry/plane.ts:124
Set the components of a plane to the given values

Parameters
- out: plane
  
  接受操作的对象。
- nx: number
  
  法向分量的 x 部分。
- ny: number
  
  法向分量的 y 部分。
- nz: number
  
  法向分量的 z 部分。
- d: number
  
  与原点的距离。
Returns plane

out 接受操作的对象。

Generated using TypeDoc