Vec
Table of contents
- Properties
- Methods
- abs
- Abs
- add
- Add
- addScalar
- AddScalar
- addXY
- AddXY
- angle
- Angle
- Average
- Cast
- clamp
- Clamp
- Clockwise
- clone
- cpr
- Cpr
- cross
- Cross
- dist
- Dist
- Dist2
- distanceToLineSegment
- DistanceToLineSegment
- DistanceToLineThroughPoint
- DistMin
- div
- Div
- divV
- DivV
- dpr
- Dpr
- equals
- Equals
- equalsXY
- EqualsXY
- From
- FromAngle
- FromArray
- IsNaN
- len
- Len
- len2
- Len2
- lrp
- Lrp
- Max
- Med
- Min
- mul
- Mul
- mulV
- MulV
- NearestPointOnLineSegment
- NearestPointOnLineThroughPoint
- neg
- Neg
- norm
- nudge
- Nudge
- per
- Per
- PointsBetween
- pry
- Pry
- Rescale
- rot
- Rot
- rotWith
- RotWith
- ScaleWithOrigin
- set
- setTo
- slope
- Slope
- Snap
- snapToGrid
- SnapToGrid
- sub
- Sub
- subScalar
- SubScalar
- subXY
- SubXY
- tan
- Tan
- toAngle
- ToAngle
- toArray
- ToArray
- toFixed
- ToFixed
- toJson
- ToJson
- toString
- ToString
- uni
- Uni
Public class
Signature
class Vec {}
Source
packages/editor/src/lib/primitives/Vec.ts
Constructor
Public constructor
Constructs a new instance of the Vec class
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Properties
pressure
Public readonly property
Signature
get pressure(): number
x
Public property
Signature
x: number
y
Public property
Signature
y: number
z
Public property
Signature
z: number
Methods
abs()
Public method
Signature
abs(): this
Abs()
Public static method
Signature
static Abs(A: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
add()
Public method
Signature
add(V: VecLike): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
References
Add()
Public static method
Signature
static Add(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
addScalar()
Public method
Signature
addScalar(n: number): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
AddScalar()
Public static method
Signature
static AddScalar(A: VecLike, n: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
addXY()
Public method
Signature
addXY(x: number, y: number): this
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
this
AddXY()
Public static method
Signature
static AddXY(A: VecLike, x: number, y: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
Vec
References
angle()
Public method
Signature
angle(B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
Angle()
Public static method
Signature
static Angle(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
Average()
Public static method
Signature
static Average(arr: VecLike[]): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
Cast()
Public static method
Signature
static Cast(A: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
clamp()
Public method
Signature
clamp(min: number, max?: number): this
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
this
Clamp()
Public static method
Signature
static Clamp(A: Vec, min: number, max?: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
Vec
References
Clockwise()
Public static method
Signature
static Clockwise(A: VecLike, B: VecLike, C: VecLike): boolean
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
boolean
References
clone()
Public method
Signature
clone(): Vec
References
cpr()
Public method
Signature
cpr(V: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
Cpr()
Public static method
Cross product of two vectors which is used to calculate the area of a parallelogram.
Signature
static Cpr(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
cross()
Public method
Signature
cross(V: VecLike): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
References
Cross()
Public static method
Signature
static Cross(A: VecLike, V: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
dist()
Public method
Signature
dist(V: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
Dist()
Public static method
Signature
static Dist(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
Dist2()
Public static method
Signature
static Dist2(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
distanceToLineSegment()
Public method
Signature
distanceToLineSegment(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
DistanceToLineSegment()
Public static method
Signature
static DistanceToLineSegment(
A: VecLike,
B: VecLike,
P: VecLike,
clamp?: boolean
): number
Parameters
| Name | Description |
|---|---|
| |
| |
| |
| |
Returns
number
References
DistanceToLineThroughPoint()
Public static method
Signature
static DistanceToLineThroughPoint(A: VecLike, u: VecLike, P: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
number
References
DistMin()
Public static method
Signature
static DistMin(A: VecLike, B: VecLike, n: number): boolean
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
boolean
References
div()
Public method
Signature
div(t: number): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
Div()
Public static method
Signature
static Div(A: VecLike, t: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
divV()
Public method
Signature
divV(V: VecLike): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
References
DivV()
Public static method
Signature
static DivV(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
dpr()
Public method
Signature
dpr(V: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
Dpr()
Public static method
Dot product of two vectors which is used to calculate the angle between them.
Signature
static Dpr(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
equals()
Public method
Signature
equals(B: VecLike): boolean
Parameters
| Name | Description |
|---|---|
| |
Returns
boolean
References
Equals()
Public static method
Signature
static Equals(A: VecLike, B: VecLike): boolean
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
boolean
References
equalsXY()
Public method
Signature
equalsXY(x: number, y: number): boolean
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
boolean
EqualsXY()
Public static method
Signature
static EqualsXY(A: VecLike, x: number, y: number): boolean
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
boolean
References
From()
Public static method
Signature
static From({ x, y, z }: VecModel): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
FromAngle()
Public static method
Signature
static FromAngle(r: number, length?: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
FromArray()
Public static method
Signature
static FromArray(v: number[]): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
IsNaN()
Public static method
Signature
static IsNaN(A: VecLike): boolean
Parameters
| Name | Description |
|---|---|
| |
Returns
boolean
References
len()
Public method
Signature
len(): number
Len()
Public static method
Signature
static Len(A: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
len2()
Public method
Signature
len2(): number
Len2()
Public static method
Signature
static Len2(A: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
lrp()
Public method
Signature
lrp(B: VecLike, t: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
Lrp()
Public static method
Linearly interpolate between two points.
Signature
static Lrp(A: VecLike, B: VecLike, t: number): Vec
Parameters
| Name | Description |
|---|---|
| The first point. |
| The second point. |
| The interpolation value between 0 and 1. |
Returns
Vec
The interpolated point.
References
Max()
Public static method
Signature
static Max(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
Med()
Public static method
Signature
static Med(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
Min()
Public static method
Signature
static Min(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
mul()
Public method
Signature
mul(t: number): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
Mul()
Public static method
Signature
static Mul(A: VecLike, t: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
mulV()
Public method
Signature
mulV(V: VecLike): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
References
MulV()
Public static method
Signature
static MulV(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
NearestPointOnLineSegment()
Public static method
Signature
static NearestPointOnLineSegment(
A: VecLike,
B: VecLike,
P: VecLike,
clamp?: boolean
): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
| |
Returns
Vec
References
NearestPointOnLineThroughPoint()
Public static method
Get the nearest point on a line with a known unit vector that passes through point A
Vec.nearestPointOnLineThroughPoint(A, u, Point)
Signature
static NearestPointOnLineThroughPoint(A: VecLike, u: VecLike, P: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| Any point on the line |
| The unit vector for the line. |
| A point not on the line to test. |
Returns
Vec
References
neg()
Public method
Signature
neg(): this
Neg()
Public static method
Signature
static Neg(A: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
norm()
Public method
Signature
norm(): this
nudge()
Public method
Signature
nudge(B: VecLike, distance: number): this
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
this
References
Nudge()
Public static method
Signature
static Nudge(A: VecLike, B: VecLike, distance: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
Vec
References
per()
Public method
Signature
per(): this
Per()
Public static method
Get the perpendicular vector to A.
Signature
static Per(A: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
PointsBetween()
Public static method
Get an array of points (with simulated pressure) between two points.
Signature
static PointsBetween(A: VecModel, B: VecModel, steps?: number): Vec[]
Parameters
| Name | Description |
|---|---|
| The first point. |
| The second point. |
| The number of points to return. |
Returns
Vec[]
References
pry()
Public method
Signature
pry(V: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
Pry()
Public static method
Get the projection of A onto B.
Signature
static Pry(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
Rescale()
Public static method
Signature
static Rescale(A: VecLike, n: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
rot()
Public method
Signature
rot(r: number): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
Rot()
Public static method
Signature
static Rot(A: VecLike, r?: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
rotWith()
Public method
Signature
rotWith(C: VecLike, r: number): this
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
this
References
RotWith()
Public static method
Signature
static RotWith(A: VecLike, C: VecLike, r: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
Vec
References
ScaleWithOrigin()
Public static method
Signature
static ScaleWithOrigin(A: VecLike, scale: number, origin: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
Vec
References
set()
Public method
Signature
set(x?: number, y?: number, z?: number): this
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
this
setTo()
Public method
Signature
setTo({ x, y, z }: VecLike): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
References
slope()
Public method
Signature
slope(B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
Slope()
Public static method
Signature
static Slope(A: VecLike, B: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
number
References
Snap()
Public static method
Signature
static Snap(A: VecLike, step?: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
snapToGrid()
Public method
Signature
snapToGrid(gridSize: number): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
SnapToGrid()
Public static method
Signature
static SnapToGrid(A: VecLike, gridSize?: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
sub()
Public method
Signature
sub(V: VecLike): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
References
Sub()
Public static method
Signature
static Sub(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
subScalar()
Public method
Signature
subScalar(n: number): this
Parameters
| Name | Description |
|---|---|
| |
Returns
this
SubScalar()
Public static method
Signature
static SubScalar(A: VecLike, n: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
subXY()
Public method
Signature
subXY(x: number, y: number): this
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
this
SubXY()
Public static method
Signature
static SubXY(A: VecLike, x: number, y: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
| |
Returns
Vec
References
tan()
Public method
Signature
tan(V: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References
Tan()
Public static method
Signature
static Tan(A: VecLike, B: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
toAngle()
Public method
Signature
toAngle(): number
ToAngle()
Public static method
Signature
static ToAngle(A: VecLike): number
Parameters
| Name | Description |
|---|---|
| |
Returns
number
References
toArray()
Public method
Signature
toArray(): number[]
ToArray()
Public static method
Signature
static ToArray(A: VecLike): number[]
Parameters
| Name | Description |
|---|---|
| |
Returns
number[]
References
toFixed()
Public method
Signature
toFixed(): Vec
References
ToFixed()
Public static method
Signature
static ToFixed(A: VecLike, n?: number): Vec
Parameters
| Name | Description |
|---|---|
| |
| |
Returns
Vec
References
toJson()
Public method
Signature
toJson(): VecModel
References
ToJson()
Public static method
Signature
static ToJson(A: VecLike): {
x: number
y: number
z: number | undefined
}
Parameters
| Name | Description |
|---|---|
| |
Returns
{
x: number
y: number
z: number | undefined
}
References
toString()
Public method
Signature
toString(): string
ToString()
Public static method
Signature
static ToString(A: VecLike): string
Parameters
| Name | Description |
|---|---|
| |
Returns
string
References
uni()
Public method
Signature
uni(): Vec
References
Uni()
Public static method
Get the unit vector of A.
Signature
static Uni(A: VecLike): Vec
Parameters
| Name | Description |
|---|---|
| |
Returns
Vec
References