pencil.js / vector / Vector

Class: Vector

Defined in: vector.ts:51

Segment between two positions

Constructors

Constructor

new Vector(start?, end?): Vector;

Defined in: vector.ts:63

Vector constructor

Parameters

Parameter	Type	Description
start?	PositionDefinition	Starting vector's position
end?	PositionDefinition	Ending vector's position

Returns

Vector

Properties

Property	Type	Description	Defined in
end	Position	Ending position	vector.ts:56
start	Position	Starting position	vector.ts:53

Accessors

height

Get Signature

get height(): number;

Defined in: vector.ts:78

Get this vector vertical component

Returns

number

---

length

Get Signature

get length(): number;

Defined in: vector.ts:85

Return this vector's length

Returns

number

---

width

Get Signature

get width(): number;

Defined in: vector.ts:71

Get this vector horizontal component

Returns

number

Methods

add()

add(modification): this;

Defined in: vector.ts:117

Add a vector (move its end)

Parameters

Parameter	Type	Description
modification	| number | PositionDefinition | VectorDefinition	Any Vector or Position or Number

Returns

this

Itself

---

clone()

clone(): Vector;

Defined in: vector.ts:92

Create a new copy of this vector

Returns

Vector

---

equals()

equals(vectorDefinition): boolean;

Defined in: vector.ts:100

Determine if is equal to another vector

Parameters

Parameter	Type	Description
vectorDefinition	VectorDefinition	Any vector

Returns

boolean

---

getClosestToPoint()

getClosestToPoint(positionDefinition): Position;

Defined in: vector.ts:195

Find the closest position to a point on this vector

Parameters

Parameter	Type	Description
positionDefinition	PositionDefinition	Any position

Returns

Position

---

getDelta()

getDelta(): Position;

Defined in: vector.ts:108

Get the vector move with start at (0, 0)

Returns

Position

---

getIntersectionPoint()

getIntersectionPoint(vectorDefinition): Position | null;

Defined in: vector.ts:172

Return the intersection point between two vector or null if no intersection happen

Parameters

Parameter	Type	Description
vectorDefinition	VectorDefinition	Any vector

Returns

Position | null

---

intersect()

intersect(vectorDefinition): boolean;

Defined in: vector.ts:149

Define if this vector intersect another

Parameters

Parameter	Type	Description
vectorDefinition	VectorDefinition	Any vector

Returns

boolean

---

multiply()

multiply(modification): this;

Defined in: vector.ts:139

Multiply this vector's length (keeping its start in place)

Parameters

Parameter	Type	Description
modification	| number | PositionDefinition | VectorDefinition	Any Vector or Position or Number

Returns

this

Itself

---

toJSON()

toJSON(): [[number, number], [number, number]];

Defined in: vector.ts:213

Return a JSON ready Vector definition

Returns

[[number, number], [number, number]]

---

translate()

translate(modification): this;

Defined in: vector.ts:127

Move this vector

Parameters

Parameter	Type	Description
modification	| number | PositionDefinition | VectorDefinition	Any Vector or Position or Number

Returns

this

Itself

---

from()

static from(vectorDefinition?): Vector;

Defined in: vector.ts:221

Create a Vector from a generic definition

Parameters

Parameter	Type	Description
vectorDefinition?	VectorDefinition	Vector definition

Returns

Vector