Class Vertex

A Vertex Geometry Object.

This class consists of all the information required for a single vertex within a Face Geometry Object.

Faces, and thus Vertex objects, are used by the Mesh Game Object in order to render objects in WebGL.

Hierarchy (View Summary)

Math.Vector3
- Vertex

Constructors

constructor

new Vertex(
    x: number,
    y: number,
    z: number,
    u: number,
    v: number,
    color?: number,
    alpha?: number,
    nx?: number,
    ny?: number,
    nz?: number,
): Geom.Mesh.Vertex
Parameters
- x: number
  The x position of the vertex.
- y: number
  The y position of the vertex.
- z: number
  The z position of the vertex.
- u: number
  The UV u coordinate of the vertex.
- v: number
  The UV v coordinate of the vertex.
- Optionalcolor: number
  The color value of the vertex. Default 0xffffff.
- Optionalalpha: number
  The alpha value of the vertex. Default 1.
- Optionalnx: number
  The x normal value of the vertex. Default 0.
- Optionalny: number
  The y normal value of the vertex. Default 0.
- Optionalnz: number
  The z normal value of the vertex. Default 0.
Returns Geom.Mesh.Vertex
Overrides Vector3.constructor
- Defined in types/phaser.d.ts:58329

Properties

alpha

alpha: number

The alpha value of this vertex.

color

color: number

The color value of this vertex.

nx

nx: number

The normalized projected x coordinate of this vertex.

ny

ny: number

The normalized projected y coordinate of this vertex.

nz

nz: number

The normalized projected z coordinate of this vertex.

ta

ta: number

The translated alpha value of this vertex.

tu

tu: number

The translated uv u coordinate of this vertex.

tv

tv: number

The translated uv v coordinate of this vertex.

tx

tx: number

The translated x coordinate of this vertex.

ty

ty: number

The translated y coordinate of this vertex.

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.

vz

vz: number

The projected z coordinate of this vertex.

x

x: number

The x component of this Vector.

y

y: number

The y component of this Vector.

z

z: number

The z component of this Vector.

`Static` `Readonly`BACK

BACK: Math.Vector3

A static back Vector3 for use by reference.

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

`Static` `Readonly`DOWN

DOWN: Math.Vector3

A static down Vector3 for use by reference.

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

`Static` `Readonly`FORWARD

FORWARD: Math.Vector3

A static forward Vector3 for use by reference.

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

`Static` `Readonly`LEFT

LEFT: Math.Vector3

A static left Vector3 for use by reference.

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

`Static` `Readonly`ONE

ONE: Math.Vector3

A static one Vector3 for use by reference.

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

`Static` `Readonly`RIGHT

RIGHT: Math.Vector3

A static right Vector3 for use by reference.

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

`Static` `Readonly`UP

UP: Math.Vector3

A static up Vector3 for use by reference.

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

`Static` `Readonly`ZERO

ZERO: Math.Vector3

A static zero Vector3 for use by reference.

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

Methods

add

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

addScalar

addScalar(s: number): Math.Vector3
Add the given value to each component of this Vector.
Parameters
- s: number
  The amount to add to this Vector.
Returns Math.Vector3
Inherited from Vector3.addScalar
- Defined in types/phaser.d.ts:71234

addScale

addScale(v: Math.Vector2 | Math.Vector3, scale: number): Math.Vector3
Add and scale a given Vector to this Vector. Addition is component-wise.
Parameters
- v: Math.Vector2 | Math.Vector3
  The Vector to add to this Vector.
- scale: number
  The amount to scale v by.
Returns Math.Vector3
Inherited from Vector3.addScale
- Defined in types/phaser.d.ts:71241

addVectors

addVectors(a: Math.Vector3, b: Math.Vector3): Math.Vector3
Adds the two given Vector3s and sets the results into this Vector3.
Parameters
- a: Math.Vector3
  The first Vector to add.
- b: Math.Vector3
  The second Vector to add.
Returns Math.Vector3
Inherited from Vector3.addVectors
- Defined in types/phaser.d.ts:71162

applyMatrix3

applyMatrix3(mat3: Matrix3): Math.Vector3
Takes a Matrix3 and applies it to this Vector3.
Parameters
- mat3: Matrix3
  The Matrix3 to apply to this Vector3.
Returns Math.Vector3
Inherited from Vector3.applyMatrix3
- Defined in types/phaser.d.ts:71330

applyMatrix4

applyMatrix4(mat4: Math.Matrix4): Math.Vector3
Takes a Matrix4 and applies it to this Vector3.
Parameters
- mat4: Math.Matrix4
  The Matrix4 to apply to this Vector3.
Returns Math.Vector3
Inherited from Vector3.applyMatrix4
- Defined in types/phaser.d.ts:71336

clone

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

Returns Math.Vector3
Inherited from Vector3.clone
- Defined in types/phaser.d.ts:71155

copy

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

cross

cross(v: Math.Vector3): Math.Vector3
Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.
Parameters
- v: Math.Vector3
  The Vector to cross product with.
Returns Math.Vector3
Inherited from Vector3.cross
- Defined in types/phaser.d.ts:71315

crossVectors

crossVectors(a: Math.Vector3, b: Math.Vector3): Math.Vector3
Calculate the cross (vector) product of two given Vectors.
Parameters
- a: Math.Vector3
  The first Vector to multiply.
- b: Math.Vector3
  The second Vector to multiply.
Returns Math.Vector3
Inherited from Vector3.crossVectors
- Defined in types/phaser.d.ts:71176

distance

distance(v: Math.Vector2 | Math.Vector3): number
Calculate the distance between this Vector and the given Vector.
Parameters
- v: Math.Vector2 | Math.Vector3
  The Vector to calculate the distance to.
Returns number
Inherited from Vector3.distance
- Defined in types/phaser.d.ts:71280

distanceSq

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

divide

divide(v: Math.Vector2 | Math.Vector3): Math.Vector3
Perform a component-wise division between this Vector and the given Vector.

Divides this Vector by the given Vector.
Parameters
- v: Math.Vector2 | Math.Vector3
  The Vector to divide this Vector by.
Returns Math.Vector3
Inherited from Vector3.divide
- Defined in types/phaser.d.ts:71269

dot

dot(v: Math.Vector3): number
Calculate the dot product of this Vector and the given Vector.
Parameters
- v: Math.Vector3
  The Vector3 to dot product with this Vector3.
Returns number
Inherited from Vector3.dot
- Defined in types/phaser.d.ts:71309

equals

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

Performs a strict equality check against each Vector's components.
Parameters
- v: Math.Vector3
  The Vector3 to compare against.
Returns boolean
Inherited from Vector3.equals
- Defined in types/phaser.d.ts:71184

fromArray

fromArray(array: number[], offset?: number): Math.Vector3
Sets the components of this Vector3 from the given array, based on the offset.

Vector3.x = array[offset] Vector3.y = array[offset + 1] Vector3.z = array[offset + 2]
Parameters
- array: number[]
  The array of values to get this Vector from.
- Optionaloffset: number
  The offset index into the array. Default 0.
Returns Math.Vector3
Inherited from Vector3.fromArray
- Defined in types/phaser.d.ts:71222

length

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

Returns number
Inherited from Vector3.length
- Defined in types/phaser.d.ts:71291

lengthSq

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

Returns number
Inherited from Vector3.lengthSq
- Defined in types/phaser.d.ts:71296

lerp

lerp(v: Math.Vector3, t?: number): Math.Vector3
Linearly interpolate between this Vector and the given Vector.

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

load

load(
    F32: Float32Array,
    U32: Uint32Array,
    offset: number,
    textureUnit: number,
    tintEffect: number,
): number
Loads the data from this Vertex into the given Typed Arrays.
Parameters
- F32: Float32Array
  A Float32 Array to insert the position, UV and unit data in to.
- U32: Uint32Array
  A Uint32 Array to insert the color and alpha data in to.
- offset: number
  The index of the array to insert this Vertex to.
- textureUnit: number
  The texture unit currently in use.
- tintEffect: number
  The tint effect to use.
Returns number
- Defined in types/phaser.d.ts:58482

max

max(v: Math.Vector3): Math.Vector3
Sets the components of this Vector to be the Math.max result from the given vector.
Parameters
- v: Math.Vector3
  The Vector3 to check the maximum values against.
Returns Math.Vector3
Inherited from Vector3.max
- Defined in types/phaser.d.ts:71150

min

min(v: Math.Vector3): Math.Vector3
Sets the components of this Vector to be the Math.min result from the given vector.
Parameters
- v: Math.Vector3
  The Vector3 to check the minimum values against.
Returns Math.Vector3
Inherited from Vector3.min
- Defined in types/phaser.d.ts:71144

multiply

multiply(v: Math.Vector2 | Math.Vector3): Math.Vector3
Perform a component-wise multiplication between this Vector and the given Vector.

Multiplies this Vector by the given Vector.
Parameters
- v: Math.Vector2 | Math.Vector3
  The Vector to multiply this Vector by.
Returns Math.Vector3
Inherited from Vector3.multiply
- Defined in types/phaser.d.ts:71255

negate

negate(): Math.Vector3
Negate the x, y and z components of this Vector.

Returns Math.Vector3
Inherited from Vector3.negate
- Defined in types/phaser.d.ts:71274

normalize

normalize(): Math.Vector3
Normalize this Vector.

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

Returns Math.Vector3
Inherited from Vector3.normalize
- Defined in types/phaser.d.ts:71303

project

project(mat: Math.Matrix4): Math.Vector3
Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection, e.g. unprojecting a 2D point into 3D space.
Parameters
- mat: Math.Matrix4
  The Matrix4 to multiply this Vector3 with.
Returns Math.Vector3
Inherited from Vector3.project
- Defined in types/phaser.d.ts:71367

projectViewMatrix

projectViewMatrix(
viewMatrix: Math.Matrix4,
projectionMatrix: Math.Matrix4,
): Math.Vector3
Multiplies this Vector3 by the given view and projection matrices.
Parameters
- viewMatrix: Math.Matrix4
  A View Matrix.
- projectionMatrix: Math.Matrix4
  A Projection Matrix.
Returns Math.Vector3
Inherited from Vector3.projectViewMatrix
- Defined in types/phaser.d.ts:71374

reset

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

Returns Math.Vector3
Inherited from Vector3.reset
- Defined in types/phaser.d.ts:71400

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, vy and vz.
Parameters
- x: number
  The x position of the vertex.
- y: number
  The y position of the vertex.
- width: number
  The width of the parent Mesh.
- height: number
  The height of the parent Mesh.
- originX: number
  The originX of the parent Mesh.
- originY: number
  The originY of the parent Mesh.
Returns this
- Defined in types/phaser.d.ts:58459

scale

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

scaleUV

scaleUV(x: number, y: number): this
Scales the original UV values by the given amounts.

The original properties Vertex.u and Vertex.v remain unchanged, only the translated properties Vertex.tu and Vertex.tv, as used in rendering, are updated.
Parameters
- x: number
  The amount to scale the UV u coordinate by.
- y: number
  The amount to scale the UV v coordinate by.
Returns this
- Defined in types/phaser.d.ts:58438

scrollUV

scrollUV(x: number, y: number): this
Translates the original UV positions by the given amounts.

The original properties Vertex.u and Vertex.v remain unchanged, only the translated properties Vertex.tu and Vertex.tv, as used in rendering, are updated.
Parameters
- x: number
  The amount to scroll the UV u coordinate by.
- y: number
  The amount to scroll the UV v coordinate by.
Returns this
- Defined in types/phaser.d.ts:58426

set

set(x: number | object, y?: number, z?: number): Math.Vector3
Set the x, y, and z components of this Vector to the given x, y, and z values.
Parameters
- x: number | object
  The x value to set for this Vector, or an object containing x, y and z components.
- Optionaly: number
  The y value to set for this Vector.
- Optionalz: number
  The z value to set for this Vector.
Returns Math.Vector3
Inherited from Vector3.set
- Defined in types/phaser.d.ts:71198

setFromMatrixColumn

setFromMatrixColumn(mat4: Math.Matrix4, index: number): Math.Vector3
Sets the components of this Vector3 from the Matrix4 column specified.
Parameters
- mat4: Math.Matrix4
  The Matrix4 to get the column from.
- index: number
  The column index.
Returns Math.Vector3
Inherited from Vector3.setFromMatrixColumn
- Defined in types/phaser.d.ts:71211

setFromMatrixPosition

setFromMatrixPosition(mat4: Math.Matrix4): Math.Vector3
Sets the components of this Vector3 from the position of the given Matrix4.
Parameters
- mat4: Math.Matrix4
  The Matrix4 to get the position from.
Returns Math.Vector3
Inherited from Vector3.setFromMatrixPosition
- Defined in types/phaser.d.ts:71204

setUVs

setUVs(u: number, v: number): this
Sets the U and V properties.

Also resets the translated uv properties, undoing any scale or shift they may have had.
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:58414

subtract

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

subVectors

subVectors(a: Math.Vector3, b: Math.Vector3): Math.Vector3
Subtracts the two given Vector3s and sets the results into this Vector3.
Parameters
- a: Math.Vector3
  The first Vector to sub.
- b: Math.Vector3
  The second Vector to sub.
Returns Math.Vector3
Inherited from Vector3.subVectors
- Defined in types/phaser.d.ts:71169

transformCoordinates

transformCoordinates(mat: Math.Matrix4): Math.Vector3
Transforms the coordinates of this Vector3 with the given Matrix4.
Parameters
- mat: Math.Matrix4
  The Matrix4 to transform this Vector3 with.
Returns Math.Vector3
Inherited from Vector3.transformCoordinates
- Defined in types/phaser.d.ts:71354

transformCoordinatesLocal

transformCoordinatesLocal(
    transformMatrix: Math.Matrix4,
    width: number,
    height: number,
    cameraZ: number,
): void
Transforms this vertex by the given matrix, storing the results in vx, vy and vz.
Parameters
- transformMatrix: Math.Matrix4
  The transform matrix to apply to this vertex.
- width: number
  The width of the parent Mesh.
- height: number
  The height of the parent Mesh.
- cameraZ: number
  The z position of the MeshCamera.
Returns void
- Defined in types/phaser.d.ts:58447

transformMat3

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

transformMat4

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

transformQuat

transformQuat(q: Quaternion): Math.Vector3
Transform this Vector with the given Quaternion.
Parameters
- q: Quaternion
  The Quaternion to transform this Vector with.
Returns Math.Vector3
Inherited from Vector3.transformQuat
- Defined in types/phaser.d.ts:71360

unproject

unproject(viewport: Vector4, invProjectionView: Math.Matrix4): Math.Vector3
Unproject this point from 2D space to 3D space. The point should have its x and y properties set to 2D screen space, and the z either at 0 (near plane) or 1 (far plane). The provided matrix is assumed to already be combined, i.e. projection * view * model.

After this operation, this vector's (x, y, z) components will represent the unprojected 3D coordinate.
Parameters
- viewport: Vector4
  Screen x, y, width and height in pixels.
- invProjectionView: Math.Matrix4
  Combined projection and view matrix.
Returns Math.Vector3
Inherited from Vector3.unproject
- Defined in types/phaser.d.ts:71395

unprojectViewMatrix

unprojectViewMatrix(
projectionMatrix: Math.Matrix4,
worldMatrix: Math.Matrix4,
): Math.Vector3
Multiplies this Vector3 by the given inversed projection matrix and world matrix.
Parameters
- projectionMatrix: Math.Matrix4
  An inversed Projection Matrix.
- worldMatrix: Math.Matrix4
  A World View Matrix.
Returns Math.Vector3
Inherited from Vector3.unprojectViewMatrix
- Defined in types/phaser.d.ts:71381

up

up(): Math.Vector3
Set this Vector to point up.

Sets the y component of the vector to 1, and the others to 0.

Returns Math.Vector3
Inherited from Vector3.up
- Defined in types/phaser.d.ts:71138

update

update(
    a: number,
    b: number,
    c: number,
    d: number,
    e: number,
    f: number,
    roundPixels: boolean,
    alpha: number,
): this
Updates this Vertex based on the given transform.
Parameters
- a: number
  The parent transform matrix data a component.
- b: number
  The parent transform matrix data b component.
- c: number
  The parent transform matrix data c component.
- d: number
  The parent transform matrix data d component.
- e: number
  The parent transform matrix data e component.
- f: number
  The parent transform matrix data f component.
- roundPixels: boolean
  Round the vertex position or not?
- alpha: number
  The alpha of the parent object.
Returns this
- Defined in types/phaser.d.ts:58472