Class BabylonRay

Rays: a start point and a direction, optionally with a length, used to pick what lies along a line of sight or to test intersections. createPickingRay builds the ray from the camera through the pointer, the others build one from points.

Index

Constructors

create

createPickingRay createRay createRayFromTo

get

getOrigin getDirection getLength

Constructors

constructor

new BabylonRay(): Bit.BabylonRay
Returns Bit.BabylonRay

create

createPickingRay

createPickingRay(): Ray
Builds a ray from the active camera through the pointer's current position on the canvas, the ray a click would pick with.

Returns Ray
The ray
Example
```
const ray = bitbybit.babylon.ray.createPickingRay();
const pick = bitbybit.babylon.pick.pickWithRay({ ray });
```
- Defined in bitbybit-docs.d.ts:51689

createRay

createRay(inputs: BaseRayDto): Ray
Builds a ray starting at origin and pointing along direction; length limits how far it reaches, and 0 or nothing leaves it unlimited.
Parameters
- inputs: BaseRayDto
  The origin, the direction and the optional length
Returns Ray
The ray
Example
```
const ray = bitbybit.babylon.ray.createRay({ origin: [0, 10, 0], direction: [0, -1, 0], length: 100 });
```
- Defined in bitbybit-docs.d.ts:51702

createRayFromTo

createRayFromTo(inputs: FromToDto): Ray
Builds a ray that starts at from, points toward to and is exactly as long as the distance between them.
Parameters
- inputs: FromToDto
  The start point and the end point
Returns Ray
The ray
Example
```
const ray = bitbybit.babylon.ray.createRayFromTo({ from: [0, 10, 0], to: [0, 0, 0] });
```
- Defined in bitbybit-docs.d.ts:51715

get

getOrigin

getOrigin(inputs: Bit.Inputs.BabylonRay.RayDto): Point3
Reads the point a ray starts from, as a point in the scene.
Parameters
- inputs: Bit.Inputs.BabylonRay.RayDto
  The ray
Returns Point3
The origin point
- Defined in bitbybit-docs.d.ts:51723

getDirection

getDirection(inputs: Bit.Inputs.BabylonRay.RayDto): Vector3
Reads the direction a ray points in, as a unit vector.
Parameters
- inputs: Bit.Inputs.BabylonRay.RayDto
  The ray
Returns Vector3
The direction vector
- Defined in bitbybit-docs.d.ts:51731

getLength

getLength(inputs: Bit.Inputs.BabylonRay.RayDto): number
Reads how far a ray reaches; an unlimited ray reports a very large number.
Parameters
- inputs: Bit.Inputs.BabylonRay.RayDto
  The ray
Returns number
The length
- Defined in bitbybit-docs.d.ts:51739