Class ColorMatrix

val

tx

• get tx(): number

  Gets the tx component of the matrix.

  Returns number

  The tx component of the matrix.

ty

• get ty(): number

  Gets the ty component of the matrix.

  Returns number

  The ty component of the matrix.

tz

• get tz(): number

  Gets the tz component of the matrix.

  Returns number

  The tz component of the matrix.

apply

• apply(v: Vector2d | Point | Vector3d): Vector2d | Point | Vector3d

  apply the current transform to the given 2d or 3d vector or point

  Parameters

  • v: Vector2d | Point | Vector3d

    the vector object to be transformed

  Returns Vector2d | Point | Vector3d

  result vector object.

applyInverse

• applyInverse(v: Vector2d | Vector3d): Vector2d | Vector3d

  apply the inverted current transform to the given 2d or 3d vector

  Parameters

  • v: Vector2d | Vector3d

    the vector object to be transformed

  Returns Vector2d | Vector3d

  result vector object.

clone

• clone(): Matrix3d

  Clone the Matrix

  Returns Matrix3d

  a cloned matrix

copy

• copy(m: Matrix3d): ColorMatrix

  Copies over the values from another me.Matrix3d.

  Parameters

  • m: Matrix3d

    the matrix object to copy from

  Returns ColorMatrix

  Reference to this object for method chaining

equals

• equals(m: Matrix3d): boolean

  return true if the two matrices are identical

  Parameters

  • m: Matrix3d

    the other matrix

  Returns boolean

  true if both are equals

fromMat2d

• fromMat2d(m: Matrix2d): ColorMatrix

  Copies over the upper-left 2x2 values from the given me.Matrix2d

  Parameters

  • m: Matrix2d

    the matrix object to copy from

  Returns ColorMatrix

  Reference to this object for method chaining

identity

• identity(): ColorMatrix

  reset the transformation matrix to the identity matrix (no transformation).
  the identity matrix and parameters position :
  

  Returns ColorMatrix

  Reference to this object for method chaining

invert

• invert(): ColorMatrix

  invert this matrix, causing it to apply the opposite transformation.

  Returns ColorMatrix

  Reference to this object for method chaining

isIdentity

• isIdentity(): boolean

  Check if the matrix is an identity matrix.

  Returns boolean

  true if the matrix is an identity matrix

multiply

• multiply(m: Matrix3d | Matrix2d): ColorMatrix

  multiply both matrix

  Parameters

  • m: Matrix3d | Matrix2d

    Other matrix (Matrix3d or Matrix2d)

  Returns ColorMatrix

  Reference to this object for method chaining

ortho

• ortho(
      left: number,
      right: number,
      bottom: number,
      top: number,
      near: number,
      far: number,
  ): ColorMatrix

  generate an orthogonal projection matrix, with the result replacing the current matrix
  

  Parameters

  • left: number

    farthest left on the x-axis

  • right: number

    farthest right on the x-axis

  • bottom: number

    farthest down on the y-axis

  • top: number

    farthest up on the y-axis

  • near: number

    distance to the near clipping plane along the -Z axis

  • far: number

    distance to the far clipping plane along the -Z axis

  Returns ColorMatrix

  Reference to this object for method chaining

perspective

• perspective(fov: number, aspect: number, near: number, far: number): ColorMatrix

  generate a perspective projection matrix, with the result replacing the current matrix

  Parameters

  • fov: number

    vertical field of view in radians

  • aspect: number

    aspect ratio (width / height)

  • near: number

    distance to the near clipping plane along the -Z axis

  • far: number

    distance to the far clipping plane along the -Z axis

  Returns ColorMatrix

  Reference to this object for method chaining

rotate

• rotate(angle: number, v?: Vector3d): ColorMatrix

  rotate this matrix (counter-clockwise) by the specified angle (in radians).

  Parameters

  • angle: number

    Rotation angle in radians.

  • Optionalv: Vector3d

    the axis to rotate around (defaults to Z axis)

  Returns ColorMatrix

  Reference to this object for method chaining

scale

• scale(x: number, y?: number, z?: number): ColorMatrix

  scale the matrix

  Parameters

  • x: number

    a number representing the abscissa of the scaling vector.

  • Optionaly: number = x

    a number representing the ordinate of the scaling vector.

  • Optionalz: number = 1

    a number representing the depth vector

  Returns ColorMatrix

  Reference to this object for method chaining

scaleV

• scaleV(v: Vector3d): ColorMatrix

  adds a 2D scaling transformation.

  Parameters

  • v: Vector3d

    scaling vector

  Returns ColorMatrix

  Reference to this object for method chaining

scaleX

• scaleX(x: number): ColorMatrix

  specifies a 2D scale operation using the [sx, 1] scaling vector

  Parameters

  • x: number

    x scaling vector

  Returns ColorMatrix

  Reference to this object for method chaining

scaleY

• scaleY(y: number): ColorMatrix

  specifies a 2D scale operation using the [1,sy] scaling vector

  Parameters

  • y: number

    y scaling vector

  Returns ColorMatrix

  Reference to this object for method chaining

setTransform

• setTransform(...values: SixteenNumbers): ColorMatrix

  Set the matrix to the specified value.

  Parameters

  • ...values: SixteenNumbers

    The matrix components.

  Returns ColorMatrix

  Reference to this object for method chaining

toArray

• toArray(): Float32Array<ArrayBufferLike>

  return an array representation of this Matrix

  Returns Float32Array<ArrayBufferLike>

  internal matrix values

toMatrix2d

• toMatrix2d(out?: Matrix2d): Matrix2d

  return a Matrix2d projection of this Matrix3d

  Parameters

  • Optionalout: Matrix2d

    an optional Matrix2d to reuse (avoids allocation)

  Returns Matrix2d

  a Matrix2d containing the upper-left 2D affine components

toString

• toString(): string

  convert the object to a string representation

  Returns string

  stringified representation

transform

• transform(
      a: number,
      b: number,
      c: number,
      d: number,
      e: number,
      f: number,
  ): this

  Multiplies the current transformation with a 2D affine matrix (a, b, c, d, e, f). The 2D matrix is promoted to 4x4 internally.

  Parameters

  • a: number

    a component (scale x / cos)

  • b: number

    b component (skew y / sin)

  • c: number

    c component (skew x / -sin)

  • d: number

    d component (scale y / cos)

  • e: number

    e component (translate x)

  • f: number

    f component (translate y)

  Returns this

  Reference to this object for method chaining

• transform(
      b00: number,
      b01: number,
      b02: number,
      b03: number,
      b10: number,
      b11: number,
      b12: number,
      b13: number,
      b20: number,
      b21: number,
      b22: number,
      b23: number,
      b30: number,
      b31: number,
      b32: number,
      b33: number,
  ): this

  Multiplies the current transformation with a full 4x4 matrix specified as 16 individual values (column-major).

  Parameters

  • b00: number
  • b01: number
  • b02: number
  • b03: number
  • b10: number
  • b11: number
  • b12: number
  • b13: number
  • b20: number
  • b21: number
  • b22: number
  • b23: number
  • b30: number
  • b31: number
  • b32: number
  • b33: number

  Returns this

  Reference to this object for method chaining

translate

• translate(x: number, y?: number, z?: number): Matrix3d

  translate the matrix position using the given vector

  Parameters

  • x: number

    a number representing the abscissa of the vector, or a vector object

  • Optionaly: number

    a number representing the ordinate of the vector.

  • Optionalz: number

    a number representing the depth of the vector

  Returns Matrix3d

  Reference to this object for method chaining

• translate(vector: Vector2d | Vector3d): Matrix3d

  translate the matrix position using the given vector

  Parameters

  • vector: Vector2d | Vector3d

  Returns Matrix3d

  Reference to this object for method chaining

transpose

• transpose(): ColorMatrix

  Transpose the value of this matrix.

  Returns ColorMatrix

  Reference to this object for method chaining