Class NineSliceVertex

Vertex data for the NineSlice Game Object.

This class consists of all the information required for a single vertex.

Hierarchy (View Summary)

Math.Vector2
- NineSliceVertex

Index

Constructors

constructor

new NineSliceVertex(x: number, y: number, u: number, v: number): NineSliceVertex
Parameters
- x: number
  The x position of the vertex.
- y: number
  The y position of the vertex.
- u: number
  The UV u coordinate of the vertex.
- v: number
  The UV v coordinate of the vertex.
Returns NineSliceVertex
Overrides Vector2.constructor
- Defined in types/phaser.d.ts:29006

Properties

u

u: number

UV u coordinate of this vertex.

v

v: number

UV v coordinate of this vertex.

vx

vx: number

The projected x coordinate of this vertex.

vy

vy: number

The projected y coordinate of this vertex.

x

x: number

The x component of this Vector.

y

y: number

The y component of this Vector.

`Static` `Readonly`DOWN

DOWN: Math.Vector2

A static down Vector2 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`LEFT

LEFT: Math.Vector2

A static left Vector2 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`ONE

ONE: Math.Vector2

A static one Vector2 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`RIGHT

RIGHT: Math.Vector2

A static right Vector2 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`UP

UP: Math.Vector2

A static up Vector2 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

`Static` `Readonly`ZERO

ZERO: Math.Vector2

A static zero Vector2 for use by reference.

This constant is meant for comparison operations and should not be modified directly.

Methods

add

add(src: Vector2Like): Math.Vector2
Add a given Vector to this Vector. Addition is component-wise.
Parameters
- src: Vector2Like
  The Vector to add to this Vector.
Returns Math.Vector2
Inherited from Vector2.add
- Defined in types/phaser.d.ts:72703

angle

angle(): number
Calculate the angle between this Vector and the positive x-axis, in radians.

Returns number
Inherited from Vector2.angle
- Defined in types/phaser.d.ts:72691

ceil

ceil(): Math.Vector2
Runs the x and y components of this Vector2 through Math.ceil and then sets them.

Returns Math.Vector2
Inherited from Vector2.ceil
- Defined in types/phaser.d.ts:72654

clone

clone(): Math.Vector2
Make a clone of this Vector2.

Returns Math.Vector2
Inherited from Vector2.clone
- Defined in types/phaser.d.ts:72623

copy

copy(src: Vector2Like): Math.Vector2
Copy the components of a given Vector into this Vector.
Parameters
- src: Vector2Like
  The Vector to copy the components from.
Returns Math.Vector2
Inherited from Vector2.copy
- Defined in types/phaser.d.ts:72629

cross

cross(src: Vector2Like): number
Calculate the cross product of this Vector and the given Vector.
Parameters
- src: Vector2Like
  The Vector2 to cross with this Vector2.
Returns number
Inherited from Vector2.cross
- Defined in types/phaser.d.ts:72793

distance

distance(src: Vector2Like): number
Calculate the distance between this Vector and the given Vector.
Parameters
- src: Vector2Like
  The Vector to calculate the distance to.
Returns number
Inherited from Vector2.distance
- Defined in types/phaser.d.ts:72742

distanceSq

distanceSq(src: Vector2Like): number
Calculate the distance between this Vector and the given Vector, squared.
Parameters
- src: Vector2Like
  The Vector to calculate the distance to.
Returns number
Inherited from Vector2.distanceSq
- Defined in types/phaser.d.ts:72748

divide

divide(src: Vector2Like): Math.Vector2
Perform a component-wise division between this Vector and the given Vector.

Divides this Vector by the given Vector.
Parameters
- src: Vector2Like
  The Vector to divide this Vector by.
Returns Math.Vector2
Inherited from Vector2.divide
- Defined in types/phaser.d.ts:72731

dot

dot(src: Vector2Like): number
Calculate the dot product of this Vector and the given Vector.
Parameters
- src: Vector2Like
  The Vector2 to dot product with this Vector2.
Returns number
Inherited from Vector2.dot
- Defined in types/phaser.d.ts:72787

equals

equals(v: Vector2Like): boolean
Check whether this Vector is equal to a given Vector.

Performs a strict equality check against each Vector's components.
Parameters
- v: Vector2Like
  The vector to compare with this Vector.
Returns boolean
Inherited from Vector2.equals
- Defined in types/phaser.d.ts:72679

floor

floor(): Math.Vector2
Runs the x and y components of this Vector2 through Math.floor and then sets them.

Returns Math.Vector2
Inherited from Vector2.floor
- Defined in types/phaser.d.ts:72659

fuzzyEquals

fuzzyEquals(v: Vector2Like, epsilon?: number): boolean
Check whether this Vector is approximately equal to a given Vector.
Parameters
- v: Vector2Like
  The vector to compare with this Vector.
- Optionalepsilon: number
  The tolerance value. Default 0.0001.
Returns boolean
Inherited from Vector2.fuzzyEquals
- Defined in types/phaser.d.ts:72686

invert

invert(): Math.Vector2
Swaps the x and y components of this Vector2.

Returns Math.Vector2
Inherited from Vector2.invert
- Defined in types/phaser.d.ts:72664

length

length(): number
Calculate the length (or magnitude) of this Vector.

Returns number
Inherited from Vector2.length
- Defined in types/phaser.d.ts:72753

lengthSq

lengthSq(): number
Calculate the length of this Vector squared.

Returns number
Inherited from Vector2.lengthSq
- Defined in types/phaser.d.ts:72764

lerp

lerp(src: Vector2Like, t?: number): Math.Vector2
Linearly interpolate between this Vector and the given Vector.

Interpolates this Vector towards the given Vector.
Parameters
- src: Vector2Like
  The Vector2 to interpolate towards.
- Optionalt: number
  The interpolation percentage, between 0 and 1. Default 0.
Returns Math.Vector2
Inherited from Vector2.lerp
- Defined in types/phaser.d.ts:72802

limit

limit(max: number): Math.Vector2
Limit the length (or magnitude) of this Vector.
Parameters
- max: number
  The maximum length.
Returns Math.Vector2
Inherited from Vector2.limit
- Defined in types/phaser.d.ts:72825

mirror

mirror(axis: Math.Vector2): Math.Vector2
Reflect this Vector across another.
Parameters
- axis: Math.Vector2
  A vector to reflect across.
Returns Math.Vector2
Inherited from Vector2.mirror
- Defined in types/phaser.d.ts:72837

multiply

multiply(src: Vector2Like): Math.Vector2
Perform a component-wise multiplication between this Vector and the given Vector.

Multiplies this Vector by the given Vector.
Parameters
- src: Vector2Like
  The Vector to multiply this Vector by.
Returns Math.Vector2
Inherited from Vector2.multiply
- Defined in types/phaser.d.ts:72717

negate

negate(): Math.Vector2
Negate the x and y components of this Vector.

Returns Math.Vector2
Inherited from Vector2.negate
- Defined in types/phaser.d.ts:72736

normalize

normalize(): Math.Vector2
Normalize this Vector.

Makes the vector a unit length vector (magnitude of 1) in the same direction.

Returns Math.Vector2
Inherited from Vector2.normalize
- Defined in types/phaser.d.ts:72771

normalizeLeftHand

normalizeLeftHand(): Math.Vector2
Rotate this Vector to its perpendicular, in the negative direction.

Returns Math.Vector2
Inherited from Vector2.normalizeLeftHand
- Defined in types/phaser.d.ts:72781

normalizeRightHand

normalizeRightHand(): Math.Vector2
Rotate this Vector to its perpendicular, in the positive direction.

Returns Math.Vector2
Inherited from Vector2.normalizeRightHand
- Defined in types/phaser.d.ts:72776

project

project(src: Math.Vector2): Math.Vector2
Project this Vector onto another.
Parameters
- src: Math.Vector2
  The vector to project onto.
Returns Math.Vector2
Inherited from Vector2.project
- Defined in types/phaser.d.ts:72849

projectUnit

projectUnit(vecB: Math.Vector2, out?: Math.Vector2): Math.Vector2
Calculates the vector projection of this Vector2 onto the non-zero vecB. This is the orthogonal projection of this vector onto a straight line parallel to vecB.
Parameters
- vecB: Math.Vector2
  The vector to project onto.
- Optionalout: Math.Vector2
  The Vector2 object to store the position in. If not given, a new Vector2 instance is created.
Returns Math.Vector2
Inherited from Vector2.projectUnit
- Defined in types/phaser.d.ts:72857

reflect

reflect(normal: Math.Vector2): Math.Vector2
Reflect this Vector off a line defined by a normal.
Parameters
- normal: Math.Vector2
  A vector perpendicular to the line.
Returns Math.Vector2
Inherited from Vector2.reflect
- Defined in types/phaser.d.ts:72831

reset

reset(): Math.Vector2
Make this Vector the zero vector (0, 0).

Returns Math.Vector2
Inherited from Vector2.reset
- Defined in types/phaser.d.ts:72819

resize

resize(
    x: number,
    y: number,
    width: number,
    height: number,
    originX: number,
    originY: number,
): this
Resizes this Vertex by setting the x and y coordinates, then transforms this vertex by an identity matrix and dimensions, storing the results in vx and vy.
Parameters
- x: number
  The x position of the vertex.
- y: number
  The y position of the vertex.
- width: number
  The width of the parent object.
- height: number
  The height of the parent object.
- originX: number
  The originX of the parent object.
- originY: number
  The originY of the parent object.
Returns this
- Defined in types/phaser.d.ts:29045

rotate

rotate(delta: number): Math.Vector2
Rotate this Vector by an angle amount.
Parameters
- delta: number
  The angle to rotate by, in radians.
Returns Math.Vector2
Inherited from Vector2.rotate
- Defined in types/phaser.d.ts:72843

scale

scale(value: number): Math.Vector2
Scale this Vector by the given value.
Parameters
- value: number
  The value to scale this Vector by.
Returns Math.Vector2
Inherited from Vector2.scale
- Defined in types/phaser.d.ts:72723

set

set(x: number, y?: number): Math.Vector2
Set the x and y components of the this Vector to the given x and y values.
Parameters
- x: number
  The x value to set for this Vector.
- Optionaly: number
  The y value to set for this Vector. Default x.
Returns Math.Vector2
Inherited from Vector2.set
- Defined in types/phaser.d.ts:72642

setAngle

setAngle(angle: number): Math.Vector2
Set the angle of this Vector.
Parameters
- angle: number
  The angle, in radians.
Returns Math.Vector2
Inherited from Vector2.setAngle
- Defined in types/phaser.d.ts:72697

setFromObject

setFromObject(obj: Vector2Like): Math.Vector2
Set the component values of this Vector from a given Vector2Like object.
Parameters
- obj: Vector2Like
  The object containing the component values to set for this Vector.
Returns Math.Vector2
Inherited from Vector2.setFromObject
- Defined in types/phaser.d.ts:72635

setLength

setLength(length: number): Math.Vector2
Set the length (or magnitude) of this Vector.
Parameters
- length: number
  The new magnitude of this Vector.
Returns Math.Vector2
Inherited from Vector2.setLength
- Defined in types/phaser.d.ts:72759

setTo

setTo(x: number, y?: number): Math.Vector2
This method is an alias for Vector2.set.
Parameters
- x: number
  The x value to set for this Vector.
- Optionaly: number
  The y value to set for this Vector. Default x.
Returns Math.Vector2
Inherited from Vector2.setTo
- Defined in types/phaser.d.ts:72649

setToPolar

setToPolar(angle: number, length?: number): Math.Vector2
Sets the x and y components of this Vector from the given angle and length.
Parameters
- angle: number
  The angle from the positive x-axis, in radians.
- Optionallength: number
  The distance from the origin. Default 1.
Returns Math.Vector2
Inherited from Vector2.setToPolar
- Defined in types/phaser.d.ts:72671

setUVs

setUVs(u: number, v: number): this
Sets the U and V properties.
Parameters
- u: number
  The UV u coordinate of the vertex.
- v: number
  The UV v coordinate of the vertex.
Returns this
- Defined in types/phaser.d.ts:29033

subtract

subtract(src: Vector2Like): Math.Vector2
Subtract the given Vector from this Vector. Subtraction is component-wise.
Parameters
- src: Vector2Like
  The Vector to subtract from this Vector.
Returns Math.Vector2
Inherited from Vector2.subtract
- Defined in types/phaser.d.ts:72709

transformMat3

transformMat3(mat: Matrix3): Math.Vector2
Transform this Vector with the given Matrix.
Parameters
- mat: Matrix3
  The Matrix3 to transform this Vector2 with.
Returns Math.Vector2
Inherited from Vector2.transformMat3
- Defined in types/phaser.d.ts:72808

transformMat4

transformMat4(mat: Math.Matrix4): Math.Vector2
Transform this Vector with the given Matrix.
Parameters
- mat: Math.Matrix4
  The Matrix4 to transform this Vector2 with.
Returns Math.Vector2
Inherited from Vector2.transformMat4
- Defined in types/phaser.d.ts:72814