Class Vector3d

Represents the 3d vector in three-dimensional space.

Hierarchy

Vector3d

Index

Constructors

constructor

new Vector3d(x: number, y: number, z: number): Vector3d
Initializes a new instance of a vector, using its three components.
Parameters
- x: number
- y: number
- z: number
Returns Vector3d
- Defined in Vector3d.ts:17

Properties

X

X: number

Gets or sets the X (first) component of the vector.

Y

Y: number

Gets or sets the Y (second) component of the vector.

Z

Z: number

Gets or sets the Z (third) component of the vector.

`Static` XAxis

XAxis: Vector3d = ...

Gets the value of the vector with components 1,0,0.

`Static` YAxis

YAxis: Vector3d = ...

Gets the value of the vector with components 0,1,0.

`Static` ZAxis

ZAxis: Vector3d = ...

Gets the value of the vector with components 0,0,1.

`Static` Zero

Zero: Vector3d = ...

Gets the value of the vector with components 0,0,0.

Accessors

IsUnitVector

get IsUnitVector(): boolean
Gets a value indicating whether or not this is a unit vector. A unit vector has length 1.

Returns boolean
- Defined in Vector3d.ts:60

IsZero

get IsZero(): boolean
Gets a value indicating whether the X, Y, and Z values are all equal to 0.0.

Returns boolean
- Defined in Vector3d.ts:67

Length

get Length(): number
Computes the length (or magnitude, or size) of this vector.

Returns number
- Defined in Vector3d.ts:74

Methods

Add

Add(other: Vector3d): Vector3d
Add a vector to this vector and returns a new vector.

Returns
A new vector that is the sum of this and vector.
Parameters
- other: Vector3d
Returns Vector3d
- Defined in Vector3d.ts:127

AddToPoint

AddToPoint(other: Point3d): Point3d
Add a point to this vector and returns a new point.

Returns
A new point that is the sum of this and vector.
Parameters
- other: Point3d
Returns Point3d
- Defined in Vector3d.ts:136

CrossProduct

CrossProduct(other: Vector3d): Vector3d
cross product of this vector and other vector
Parameters
- other: Vector3d
  
  Another vector to cross product with.
Returns Vector3d
- Defined in Vector3d.ts:242

DistanceTo

DistanceTo(other: Vector3d): number
Computes distance to another point.
Parameters
- other: Vector3d
Returns number
- Defined in Vector3d.ts:260

Divide

Divide(factor: number): Vector3d
Divides this vector by a factor and returns a new vector.

Returns
A new vector
Parameters
- factor: number
  
  the factor to divide this vector by.
Returns Vector3d
- Defined in Vector3d.ts:195

DotProduct

DotProduct(other: Vector3d): number
dot product of this vector and other vector
Parameters
- other: Vector3d
  
  Another vector to dot product with.
Returns number
- Defined in Vector3d.ts:223

Equals

Equals(other: Vector3d): boolean
Determines whether it equials to other vector.
Parameters
- other: Vector3d
  
  Another vector to compare.
Returns boolean
- Defined in Vector3d.ts:278

GetPerpendicularVector

GetPerpendicularVector(): Vector3d
Get an arbitrary vector perpendicular to this vector

Returns Vector3d
- Defined in Vector3d.ts:418

IsParallelTo

IsParallelTo(other: Vector3d): ParallelIndicator
Determines whether a vector is parallel to another vector
Parameters
- other: Vector3d
  
  Another vector to compare.
Returns ParallelIndicator
- Defined in Vector3d.ts:379

IsPerpendicularTo

IsPerpendicularTo(other: Vector3d): boolean
Determines whether a vector is perpendicular to another vector
Parameters
- other: Vector3d
  
  Another vector to compare.
Returns boolean
- Defined in Vector3d.ts:401

IsTiny

IsTiny(tolerance?: number): boolean
Determines whether a vector is very short.

Returns
Parameters
- tolerance: number = Open3d.EPSILON
  
  A nonzero value used as the coordinate zero tolerance.
Returns boolean
- Defined in Vector3d.ts:355

Multiply

Multiply(factor: number): Vector3d
Multiplies this vector by a factor and returns a new vector.

Returns
A new vector
Parameters
- factor: number
  
  the factor to multiply this vector by.
Returns Vector3d
- Defined in Vector3d.ts:174

Reverse

Reverse(): Vector3d
return a reversed vector

Returns Vector3d
- Defined in Vector3d.ts:329

Subtract

Subtract(other: Vector3d): Vector3d
Subtract a vector from this vector and returns a new vector.

Returns
A new vector
Parameters
- other: Vector3d
Returns Vector3d
- Defined in Vector3d.ts:155

Transform

Transform(transformation: Transform): Vector3d
Transforms the vector and return a new vector The transformation matrix acts on the left of the vector; i.e., result = transformation * vector
Parameters
- transformation: Transform
  
  Transformation matrix to apply.
Returns Vector3d
- Defined in Vector3d.ts:481

Unitize

Unitize(): Vector3d
return a unitized vector

Returns Vector3d
- Defined in Vector3d.ts:346

VectorAngle

VectorAngle(other: Vector3d): number
Compute the angle between two vectors.

Returns
The angle between this and other in radians.
Parameters
- other: Vector3d
  
  Another vector to compare.
Returns number
- Defined in Vector3d.ts:315

VectorRotate

VectorRotate(angle: number, axis: Vector3d): Vector3d
Rotates this vector around a given axis.
Parameters
- angle: number
  
  Angle of rotation (in radians).
- axis: Vector3d
  
  Axis of rotation.
Returns Vector3d
- Defined in Vector3d.ts:410

toString

toString(): string
override toString

Returns string
- Defined in Vector3d.ts:498

`Static` Add

Add(a: Vector3d, b: Vector3d): Vector3d
Sums up two vectors.

Returns
A sum vector.
Parameters
- a: Vector3d
  
  A vector.
- b: Vector3d
  
  A second vector.
Returns Vector3d
- Defined in Vector3d.ts:108

`Static` AddToPoint

AddToPoint(vector: Vector3d, point: Point3d): Point3d
Sums up a vector to a point and returns a new point.

Returns
The new point from the addition of vector and point.
Parameters
- vector: Vector3d
  
  A vector.
- point: Point3d
  
  A point.
Returns Point3d
- Defined in Vector3d.ts:118

`Static` CreateFromPoint3d

CreateFromPoint3d(point: Point3d): Vector3d
Initializes a new instance of a vector, copying the three components from the three coordinates of a point.
Parameters
- point: Point3d
  
  A point3d.
Returns Vector3d
- Defined in Vector3d.ts:36

`Static` CreateFromVector

CreateFromVector(vector: Vector3d): Vector3d
Initializes a new instance of a vector, copying the three components from a vector.
Parameters
- vector: Vector3d
  
  A vector.
Returns Vector3d
- Defined in Vector3d.ts:28

`Static` CrossProduct

CrossProduct(a: Vector3d, b: Vector3d): Vector3d
Computes the cross product (or vector product, or exterior product) of two vectors. This operation is not commutative.

Returns
A new vector that is perpendicular to both a and b, has Length == a.Length * b.Length * sin(theta) where theta is the angle between a and b. The resulting vector is oriented according to the right hand rule.
Parameters
- a: Vector3d
  
  First vector.
- b: Vector3d
  
  Second vector.
Returns Vector3d
- Defined in Vector3d.ts:234

`Static` Distance

Distance(a: Vector3d, b: Vector3d): number
Computes distance between two points.
Parameters
- a: Vector3d
  
  First vector.
- b: Vector3d
  
  Second vector.
Returns number
- Defined in Vector3d.ts:251

`Static` Divide

Divide(vector: Vector3d, t: number): Vector3d
Divides a Vector3d by a number, having the effect of shrinking it.

Returns
A new vector that is componentwise divided by t.
Parameters
- vector: Vector3d
  
  A vector.
- t: number
  
  A number.
Returns Vector3d
- Defined in Vector3d.ts:184

`Static` DotProduct

DotProduct(a: Vector3d, b: Vector3d): number
returning the dot product of two vectors
Parameters
- a: Vector3d
  
  A vector.
- b: Vector3d
  
  A second vector.
Returns number
- Defined in Vector3d.ts:215

`Static` Equals

Equals(a: Vector3d, b: Vector3d): boolean
Determines whether two vectors have the same value.

Returns
true if vector has the same coordinates as this; otherwise false.
Parameters
- a: Vector3d
  
  A vector.
- b: Vector3d
  
  A second vector.
Returns boolean
- Defined in Vector3d.ts:270

`Static` Interpolate

Interpolate(v1: Vector3d, v2: Vector3d, t: number): Vector3d
Interpolate between two points/vectors.

Returns
A new vector that is the linear interpolation between a and b at t.
Parameters
- v1: Vector3d
- v2: Vector3d
- t: number
  
  A number in the range [0,1].
Returns Vector3d
- Defined in Vector3d.ts:206

`Static` IsParallel

IsParallel(a: Vector3d, b: Vector3d): ParallelIndicator
Determines whether a vector is parallel to another vector

Returns
ParallelIndicator
Parameters
- a: Vector3d
  
  First vector for angle.
- b: Vector3d
  
  Second vector for angle.
Returns ParallelIndicator
- Defined in Vector3d.ts:367

`Static` IsPerpendicular

IsPerpendicular(a: Vector3d, b: Vector3d): boolean
Determines whether a vector is perpendicular to another vector

Returns
true if vectors form Pi-radians (90-degree) angles with each other; otherwise false.
Parameters
- a: Vector3d
  
  First vector for angle.
- b: Vector3d
  
  Second vector for angle.
Returns boolean
- Defined in Vector3d.ts:389

`Static` Multiply

Multiply(vector: Vector3d, t: number): Vector3d
Multiplies a vector by a number, having the effect of scaling it.

Returns
A new vector that is the original vector coordinatewise multiplied by t.
Parameters
- vector: Vector3d
  
  A vector.
- t: number
  
  A number.
Returns Vector3d
- Defined in Vector3d.ts:165

`Static` Reverse

Reverse(v: Vector3d): Vector3d
Reverse a vector.
Parameters
- v: Vector3d
Returns Vector3d
- Defined in Vector3d.ts:322

`Static` Subtract

Subtract(a: Vector3d, b: Vector3d): Vector3d
Subtracts the second vector from the first one.

Returns
A subtract vector.
Parameters
- a: Vector3d
  
  A vector.
- b: Vector3d
  
  A second vector.
Returns Vector3d
- Defined in Vector3d.ts:146

`Static` Unitize

Unitize(v: Vector3d): Vector3d
Unitize a vector.
Parameters
- v: Vector3d
Returns Vector3d
- Defined in Vector3d.ts:336

`Static` VectorAngle

VectorAngle(a: Vector3d, b: Vector3d, reference?: Vector3d | Plane): number
Compute the angle between two vectors.

Returns
The angle between a and b in radians.
Parameters
- a: Vector3d
  
  First vector for angle.
- b: Vector3d
  
  Second vector for angle.
- Optional reference: Vector3d | Plane
  
  (optional) Reference direction when positive angle is required. If not provided, the angle is the smallest one (commutative).
Returns number
- Defined in Vector3d.ts:289

Class Vector3d

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

x: number

y: number

z: number

Returns Vector3d

Properties

X

Y

Z

Static XAxis

Static YAxis

Static ZAxis

Static Zero

Accessors

IsUnitVector

Returns boolean

IsZero

Returns boolean

Length

Returns number

Methods

Add

Returns

Parameters

other: Vector3d

Returns Vector3d

AddToPoint

Returns

Parameters

other: Point3d

Returns Point3d

CrossProduct

Parameters

other: Vector3d

Returns Vector3d

DistanceTo

Parameters

other: Vector3d

Returns number

Divide

Returns

Parameters

factor: number

Returns Vector3d

DotProduct

Parameters

other: Vector3d

Returns number

Equals

Parameters

other: Vector3d

Returns boolean

GetPerpendicularVector

Returns Vector3d

IsParallelTo

Parameters

other: Vector3d

Returns ParallelIndicator

IsPerpendicularTo

Parameters

other: Vector3d

Returns boolean

IsTiny

Returns

Parameters

tolerance: number = Open3d.EPSILON

Returns boolean

Multiply

Returns

Parameters

factor: number

`Static` XAxis

`Static` YAxis

`Static` ZAxis

`Static` Zero

`Static` Add

`Static` AddToPoint

`Static` CreateFromPoint3d

`Static` CreateFromVector

`Static` CrossProduct

`Static` Distance

`Static` Divide

`Static` DotProduct

`Static` Equals