Class ray

Basic Geometry: ray.

Hierarchy

ray
- ray

Index

Constructors

constructor

Properties

Accessors

type

Methods

Constructors

constructor

newRay(ox?: number, oy?: number, oz?: number, dx?: number, dy?: number, dz?: number): ray

- Defined in cocos/core/geometry/ray.ts:158
en

Construct a ray;

zh

构造一条射线。

Parameters
- Default value ox: number = 0
  
  起点的 x 部分。
- Default value oy: number = 0
  
  起点的 y 部分。
- Default value oz: number = 0
  
  起点的 z 部分。
- Default value dx: number = 0
  
  方向的 x 部分。
- Default value dy: number = 0
  
  方向的 y 部分。
- Default value dz: number = -1
  
  方向的 z 部分。
Returns ray

Properties

Protected Readonly _type

_type: number

d

The direction of the ray.

o

The origin of the ray.

Accessors

type

get type(): number

- Defined in cocos/core/geometry/ray.ts:154
Gets the type of the shape.

Returns number

Methods

computeHit

computeHit(out: IVec3Like, distance: number): void

- Defined in cocos/core/geometry/ray.ts:187
Compute a point with the distance between the origin.

Parameters
- out: IVec3Like
  
  射线上的另一点。
- distance: number
  
  给定距离。
Returns void

Static clone

clone(a: ray): ray

- Defined in cocos/core/geometry/ray.ts:68
Creates a new ray initialized with values from an existing ray

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

克隆出的新对象。

Static copy

copy(out: ray, a: ray): ray

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

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

out 接受操作的 ray。

Static create

create(ox?: number, oy?: number, oz?: number, dx?: number, dy?: number, dz?: number): ray

- Defined in cocos/core/geometry/ray.ts:56
create a new ray

Parameters
- Default value ox: number = 0
  
  起点的 x 部分。
- Default value oy: number = 0
  
  起点的 y 部分。
- Default value oz: number = 0
  
  起点的 z 部分。
- Default value dx: number = 0
  
  方向的 x 部分。
- Default value dy: number = 0
  
  方向的 y 部分。
- Default value dz: number = 1
  
  方向的 z 部分。
Returns ray

射线。

Static fromPoints

fromPoints(out: ray, origin: Vec3, target: Vec3): ray

- Defined in cocos/core/geometry/ray.ts:101
create a ray from two points

Parameters
- out: ray
  
  接受操作的射线。
- origin: Vec3
  
  射线的起点。
- target: Vec3
  
  射线上的一点。
Returns ray

out 接受操作的射线。

Static set

set(out: ray, ox: number, oy: number, oz: number, dx: number, dy: number, dz: number): ray

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

Parameters
- out: ray
  
  接受操作的射线。
- ox: number
  
  起点的 x 部分。
- oy: number
  
  起点的 y 部分。
- oz: number
  
  起点的 z 部分。
- dx: number
  
  方向的 x 部分。
- dy: number
  
  方向的 y 部分。
- dz: number
  
  方向的 z 部分。
Returns ray

out 接受操作的射线。

Generated using TypeDoc