Ray3d

Constructor

new Ray3d(origin, direction): Ray3d

Parameters

Parameter	Type	Description
`origin`	`Point3d`	The origin point of this ray
`direction`	`Vector3d`	‐

Returns

Ray3d

Properties

direction

readonly direction: Vector3d

The normalized direction vector for this ray

origin

readonly origin: Point3d

The origin point of this ray

Methods

projectPoint()

projectPoint(point): Point3d

Projects the given point onto this line

Parameters

Parameter	Type	Description
`point`	`Readonly`<`Point3Like`>	‐

Returns

Point3d

Since

SDK 2.37.0

toString()

toString(): string

Returns

string

between()

static between(start, end): Ray3d

Constructs a ray (line) between two points.

Parameters

Parameter	Type	Description
`start`	`Readonly`<`Point3Like`>	‐
`end`	`Readonly`<`Point3Like`>	‐

Returns

Ray3d

Example

let { Ray3d } = SketchUpApi;
let ray = Ray3d.between([0,0,0],[1,0,0]);
console.log(ray.toString());

Throws

Error if start and end are the same

Since

SDK 2.37.0

create()

static create(input): Ray3d

Creates a Ray from any input that can be interpreted as a Ray.

NOTE For a tuple the second argument is assumed to be a vector rather than a point unless a Point3d is explicitly supplied.

Parameters

Parameter	Type	Description
`input`	`Readonly`<`Ray3dLike`>	‐

Returns

Ray3d

Example

let { Point3d, Ray3d } = SketchUpApi;
// Interpreted as Point+Vector
let a = Ray3d.create([[0,0,0],[1,0,0]]);
// Interpreted as Point+Point
let b = Ray3d.create([[0,0,0],new Point3d(1,0,0)]);
console.log(a.toString(),b.toString());

Since

SDK 2.37.0

Throws

Error on invalid input