Class Mat3

constructor

• new Mat3(): Mat3

  Create a new Mat3 instance. It is initialized to the identity matrix.

  Returns Mat3

data

Static ReadonlyIDENTITY

Static ReadonlyZERO

clone

• clone(): Mat3

  Creates a duplicate of the specified matrix.

  Returns Mat3

  A duplicate matrix.

  Example

  const src = new pc.Mat3().translate(10, 20, 30);
  const dst = src.clone();
  console.log("The two matrices are " + (src.equals(dst) ? "equal" : "different"));
  Copy

copy

• copy(rhs: Mat3): Mat3

  Copies the contents of a source 3x3 matrix to a destination 3x3 matrix.

  Parameters

  • rhs: Mat3

    A 3x3 matrix to be copied.

  Returns Mat3

  Self for chaining.

  Example

  const src = new pc.Mat3().translate(10, 20, 30);
  const dst = new pc.Mat3();
  dst.copy(src);
  console.log("The two matrices are " + (src.equals(dst) ? "equal" : "different"));
  Copy

equals

• equals(rhs: Mat3): boolean

  Reports whether two matrices are equal.

  Parameters

  • rhs: Mat3

    The other matrix.

  Returns boolean

  True if the matrices are equal and false otherwise.

  Example

  const a = new pc.Mat3().translate(10, 20, 30);
  const b = new pc.Mat3();
  console.log("The two matrices are " + (a.equals(b) ? "equal" : "different"));
  Copy

getX

• getX(x?: Vec3): Vec3

  Extracts the x-axis from the specified matrix.

  Parameters

  • Optionalx: Vec3 = ...

    The vector to receive the x axis of the matrix.

  Returns Vec3

  The x-axis of the specified matrix.

getY

• getY(y?: Vec3): Vec3

  Extracts the y-axis from the specified matrix.

  Parameters

  • Optionaly: Vec3 = ...

    The vector to receive the y axis of the matrix.

  Returns Vec3

  The y-axis of the specified matrix.

getZ

• getZ(z?: Vec3): Vec3

  Extracts the z-axis from the specified matrix.

  Parameters

  • Optionalz: Vec3 = ...

    The vector to receive the z axis of the matrix.

  Returns Vec3

  The z-axis of the specified matrix.

isIdentity

• isIdentity(): boolean

  Reports whether the specified matrix is the identity matrix.

  Returns boolean

  True if the matrix is identity and false otherwise.

  Example

  const m = new pc.Mat3();
  console.log("The matrix is " + (m.isIdentity() ? "identity" : "not identity"));
  Copy

set

• set(src: number[]): Mat3

  Copies the contents of a source array[9] to a destination 3x3 matrix.

  Parameters

  • src: number[]

    An array[9] to be copied.

  Returns Mat3

  Self for chaining.

  Example

  const dst = new pc.Mat3();
  dst.set([0, 1, 2, 3, 4, 5, 6, 7, 8]);
  Copy

setFromMat4

• setFromMat4(m: Mat4): Mat3

  Converts the specified 4x4 matrix to a Mat3.

  Parameters

  • m: Mat4

    The 4x4 matrix to convert.

  Returns Mat3

  Self for chaining.

setFromQuat

• setFromQuat(r: Quat): Mat3

  Sets this matrix to the given quaternion rotation.

  Parameters

  • r: Quat

    A quaternion rotation.

  Returns Mat3

  Self for chaining.

  Example

  const r = new pc.Quat(1, 2, 3, 4).normalize();
  
  const m = new pc.Mat4();
  m.setFromQuat(r);
  Copy

setIdentity

• setIdentity(): Mat3

  Sets the matrix to the identity matrix.

  Returns Mat3

  Self for chaining.

  Example

  m.setIdentity();
  console.log("The matrix is " + (m.isIdentity() ? "identity" : "not identity"));
  Copy

toString

• toString(): string

  Converts the matrix to string form.

  Returns string

  The matrix in string form.

  Example

  const m = new pc.Mat3();
  // Outputs [1, 0, 0, 0, 1, 0, 0, 0, 1]
  console.log(m.toString());
  Copy

transformVector

• transformVector(vec: Vec3, res?: Vec3): Vec3

  Transforms a 3-dimensional vector by a 3x3 matrix.

  Parameters

  • vec: Vec3

    The 3-dimensional vector to be transformed.
  • Optionalres: Vec3 = ...

    An optional 3-dimensional vector to receive the result of the transformation.

  Returns Vec3

  The input vector v transformed by the current instance.

transpose

• transpose(src?: Mat3): Mat3

  Generates the transpose of the specified 3x3 matrix.

  Parameters

  • Optionalsrc: Mat3 = ...

    The matrix to transpose. If not set, the matrix is transposed in-place.

  Returns Mat3

  Self for chaining.

  Example

  const m = new pc.Mat3();
  
  // Transpose in place
  m.transpose();
  Copy