Geometry Interfaces Module Level 1

Editor’s Draft, 21 July 2014

This version:
http://dev.w3.org/fxtf/geometry/
Latest version:
http://www.w3.org/TR/geometry-1/
Previous Versions:
http://www.w3.org/TR/2014/WD-geometry-1-20140522/
Feedback:
public-fx@w3.org with subject line “[geometry] … message topic …”(archives)
Test Suite:
http://test.csswg.org/suites/geometry-1_dev/nightly-unstable/
Editors:
(Opera Software ASA)
(Adobe Systems Inc.)
(Adobe Systems Inc.)
Issues list:
Bugzilla (file a bug)

Abstract

This specification provides basic geometric interfaces to represent points, rectangles, quadrilaterals and transformation matrices that can be used by other modules or specifications.

CSS is a language for describing the rendering of structured documents (such as HTML and XML) on screen, on paper, in speech, etc.

Status of this document

This is a public copy of the editors' draft. It is provided for discussion only and may change at any moment. Its publication here does not imply endorsement of its contents by W3C. Don’t cite this document other than as work in progress.

The (archived) public mailing list public-fx@w3.org (see instructions) is preferred for discussion of this specification. When sending e-mail, please put the text “geometry” in the subject, preferably like this: “[geometry] …summary of comment…

This document was produced by the CSS Working Group (part of the Style Activity) and the SVG Working Group (part of the Graphics Activity).

This document was produced by groups operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures (CSS) and a public list of any patent disclosures (SVG) made in connection with the deliverables of each group; these pages also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

Table of Contents

1 Introduction

This specification describes several geometry interfaces [WEBIDL] for the representation of points, rectangles, quadrilaterals and transformation matrices with the dimension of 3x2 and 4x4.

The SVG interfaces SVGPoint, SVGRect and SVGMatrix [SVG11] are aliasing the here defined interfaces in favor for common interfaces used by SVG, Canvas 2D Context [2DCONTEXT] and CSS Transforms [CSS3-TRANSFORMS].

2 The DOMPoint interfaces

A 2D or a 3D point can be represented by the following WebIDL interfaces:

[Constructor(unrestricted double x, unrestricted double y,
             unrestricted double z, unrestricted double w)]
interface DOMPointReadOnly {
    readonly attribute unrestricted double x;
    readonly attribute unrestricted double y;
    readonly attribute unrestricted double z;
    readonly attribute unrestricted double w;

    DOMPoint matrixTransform(DOMMatrixReadOnly matrix);
};

[Constructor(optional DOMPointInit point),
 Constructor(optional unrestricted double x = 0, optional unrestricted double y = 0,
             optional unrestricted double z = 0, optional unrestricted double w = 1)]
interface DOMPoint : DOMPointReadOnly {
    inherit attribute unrestricted double x;
    inherit attribute unrestricted double y;
    inherit attribute unrestricted double z;
    inherit attribute unrestricted double w;
};

dictionary DOMPointInit {
    unrestricted double x = 0;
    unrestricted double y = 0;
    unrestricted double z = 0;
    unrestricted double w = 1;
};

The following algorithms assume that DOMPointReadOnly objects have the internal member variables x coordinate, y coordinate, z coordinate and w perspective. DOMPointReadOnly as well as the inheriting interface DOMPoint must be able to access and set the value of these variables.

An interface returning an DOMPointReadOnly object by an attribute or function may be able to modify internal member variable values. Such an interface must specify this ability explicitly in prose.

Internal member variables must not be exposed in any way.

The DOMPointReadOnly(x, y, z, w) constructor, when invoked, must run the following steps:

  1. Set the the current object’s variables x coordinate to x, y coordinate to y, z coordinate to z and w perspective to w.
  2. Return the new DOMPointReadOnly object.

The DOMPoint() constructor, when invoked, must run the following steps:

If invoked with a DOMPointInit argument:
  1. Let point be the argument.
  2. Call the constructor of DOMPointReadOnly with the arguments x, y, z, w, where:
    1. x is the x dictionary member of point.
    2. y is the y dictionary member of point.
    3. z is the z dictionary member of point.
    4. w is the w dictionary member of point.
  3. Return the new DOMPoint object.
Otherwise:
  1. Call the constructor of DOMPointReadOnly with the arguments x, y, z and w, respectively.
  2. Return the new DOMPoint object.
The x attribute, on getting, must return the x coordinate value of the object it was invoked. For the DOMPoint interface, setting the x attribute must set the x coordinate value of the object it was invoked to the new value.

The y attribute, on getting, must return the y coordinate value of the object it was invoked. For the DOMPoint interface, setting the y attribute must set the y coordinate value of the object it was invoked to the new value.

The z attribute, on getting, must return the z coordinate value of the object it was invoked. For the DOMPoint interface, setting the z attribute must set the z coordinate value of the object it was invoked to the new value.

The w attribute, on getting, must return the w perspective value of the object it was invoked. For the DOMPoint interface, setting the w attribute must set the w perspective value of the object it was invoked to the new value.

matrixTransform(matrix), when invoked, must run the following steps:

  1. Create a new DOMPoint point initialized to x, y, z and w of the current point.
  2. Post-multiply point with matrix.
  3. Return point.

matrixTransform() does not modify the current DOMPointReadOnly object and returns a new DOMPoint object.

In this example the method matrixTransform() on point is called with a DOMMatrix argument matrix.

var point = new DOMPoint(5, 4);
var matrix = new DOMMatrix(2, 0, 0, 2, 10, 10);
var transformedPoint = point.matrixTransform(matrix);
  

point creates a new DOMPoint object initialized to the same attribute values as point. This new DOMPoint is now scaled and the translated by matrix. This resulting transformPoint has the attribute values x: 20 and y: 18.

For historical reasons, Window objects must also have a writable, configurable, non-enumerable property named SVGPoint whose value is the DOMPoint interface object.

3 The DOMRect interfaces

Objects implementing the DOMRectReadOnly interface represent a rectangle. The type of box is specified by the method or attribute that returns a DOMRect or DOMRectReadOnly object.

Rectangles have the following properties:

origin
When the rectangle has a non-negative width, the rectangle’s horizontal origin is the left edge; otherwise, it is the right edge. Similarly, when the rectangle has a non-negative height, the rectangle’s vertical origin is the top edge; otherwise, it is the bottom edge.
x coordinate
The horizontal distance between the viewport’s left edge and the rectangle’s origin.
y coordinate
The vertical distance between the viewport’s top edge and the rectangle’s origin.
width dimension
The width of the rectangle. Can be negative.
height dimension
The height of the rectangle. Can be negative.
[Constructor(unrestricted double x = 0, unrestricted double y = 0,
             unrestricted double width = 0, unrestricted double height = 0)]
interface DOMRect : DOMRectReadOnly {
    inherit attribute unrestricted double x;
    inherit attribute unrestricted double y;
    inherit attribute unrestricted double width;
    inherit attribute unrestricted double height;
};

[Constructor(unrestricted double x, unrestricted double y,
             unrestricted double width, unrestricted double height)]
interface DOMRectReadOnly {
    readonly attribute unrestricted double x;
    readonly attribute unrestricted double y;
    readonly attribute unrestricted double width;
    readonly attribute unrestricted double height;
    readonly attribute unrestricted double top;
    readonly attribute unrestricted double right;
    readonly attribute unrestricted double bottom;
    readonly attribute unrestricted double left;
};

dictionary DOMRectInit {
    unrestricted double x = 0;
    unrestricted double y = 0;
    unrestricted double width = 0;
    unrestricted double height = 0;
};

The following algorithms assume that DOMRectReadOnly objects have the internal member variables x coordinate, y coordinate, width dimension and height dimension. DOMRectReadOnly as well as the inheriting interface DOMRect must be able to access and set the value of these variables.

An interface returning an DOMRectReadOnly object by an attribute or function may be able to modify internal member variable values. Such an interface must specify this ability explicitly in prose.

Internal member variables must not be exposed in any way.

The DOMRectReadOnly(x, y, width, height) constructor, when invoked, must run the following steps:

  1. Set the the current object’s variables x coordinate to x, y coordinate to y, width dimension to width and height dimension to height.
  2. Return the new DOMRectReadOnly object.

The DOMRect(x, y, width, height) constructor, when invoked, must run the following steps:

  1. Call the constructor of DOMRectReadOnly with x, y, width and height.
  2. Return the new DOMRect object.
The x attribute, on getting, must return the x coordinate value of the object it was invoked. For the DOMRect interface, setting the x attribute must set the x coordinate value of the object it was invoked to the new value.

The y attribute, on getting, it must return the y coordinate value of the object it was invoked. For the DOMRect interface, setting the y attribute must set the y coordinate value of the object it was invoked to the new value.

The width attribute, on getting, must return the width value of the object it was invoked. For the DOMRect interface, setting the width attribute must set the width dimension value of the object it was invoked to the new value.

The height attribute, on getting, must return the height value. For the DOMRect interface, setting the height attribute must set the height dimension value to the new value.

The top attribute, on getting, must return min(y coordinate, y coordinate + height dimension) of the object it was invoked.

The right attribute, on getting, must return max(x coordinate, x coordinate + width dimension) of the object it was invoked.

The bottom attribute, on getting, must return max(y coordinate, y coordinate + height dimension) of the object it was invoked.

The left attribute, on getting, must return min(x coordinate, x coordinate + width dimension) of the object it was invoked.

For historical reasons, Window objects must also have a writable, configurable, non-enumerable property named SVGRect whose value is the DOMRect interface object.

4 The DOMRectList Interface

[NoInterfaceObject,
 ArrayClass]
interface DOMRectList {
    readonly attribute unsigned long length;
    getter DOMRect? item(unsigned long index);
};

The length attribute must return the total number of DOMRect objects associated with the object.

The item(index) method, when invoked, must return a null value when index is greater than or equal to the number of DOMRect objects associated with the DOMRectList. Otherwise, the DOMRect object at index must be returned. Indices are zero-based.

DOMRectList must be supported for legacy reasons. Specifications are strongly advised not to make use of the DOMRectList interface and use Sequences [WEBIDL] instead.

5 The DOMQuad interface

Objects implementing the DOMQuad interface represents a quadrilateral.

[Constructor(optional DOMPointInit p1, optional DOMPointInit p2,
             optional DOMPointInit p3, optional DOMPointInit p4),
 Constructor(optional DOMRectInit rect)]
interface DOMQuad {
    [SameObject] readonly attribute DOMPoint p1;
    [SameObject] readonly attribute DOMPoint p2;
    [SameObject] readonly attribute DOMPoint p3;
    [SameObject] readonly attribute DOMPoint p4;
    [SameObject] readonly attribute DOMRectReadOnly bounds;
};

The DOMQuad() constructor, when invoked, must run the following steps:

If invoked with one argument:
  1. Let rect be the argument.
  2. Let x, y, width and height be the value of rect’s x, y, width and height attributes, respectively.
  3. Let point 1 be a new DOMPoint object with x set to x, y set to y, z set to zero and w set to one.
  4. Let point 2 be a new DOMPoint object with x set to x + width, y set to y, z set to zero and w set to one.
  5. Let point 3 be a new DOMPoint object with x set to x + width, y set to y + height, z set to zero and w set to one.
  6. Let point 4 be a new DOMPoint object with x set to x, y set to y + height, z set to zero and w set to one.
  7. Return a new DOMQuad with p1 set to point 1, p2 set to point 2, p3 set to point 3 and p4 set to point 4, and let the associated bounding rectangle be bounds.

Otherwise:
  1. Let p1, p2, p3 and p4 be the given arguments, in the same order.
  2. Let point 1 be a new DOMPoint object with its attributes set to the values of the namesake dictionary members in p1.
  3. Let point 2 be a new DOMPoint object with its attributes set to the values of the namesake dictionary members in p2.
  4. Let point 3 be a new DOMPoint object with its attributes set to the values of the namesake dictionary members in p3.
  5. Let point 4 be a new DOMPoint object with its attributes set to the values of the namesake dictionary members in p4.
  6. Return a new DOMQuad with p1 set to point 1, p2 set to point 2, p3 set to point 3 and p4 set to point 4, and let the associated bounding rectangle be bounds.

Note: It is possible to pass DOMPoint/DOMPointReadOnly arguments as well. The passed arguments will be transformed to the correct object type internally following the WebIDL rules [WEBIDL].

The p1 attribute must return a DOMPoint that represents p1 of the quadrilateral it was invoked. The author can modify the returned DOMPoint object, which has direct affect on the quadrilateral.

The p2 attribute must return a DOMPoint that represents p2 of the quadrilateral it was invoked. The author can modify the returned DOMPoint object, which has direct affect on the quadrilateral.

The p3 attribute must return a DOMPoint that represents p3 of the quadrilateral it was invoked. The author can modify the returned DOMPoint object, which has direct affect on the quadrilateral.

The p4 attribute must return a DOMPoint that represents p4 of the quadrilateral it was invoked. The author can modify the returned DOMPoint object, which has direct affect on the quadrilateral.

The bounds attribute must return the associated bounding rectangle of the quadrilateral it was invoked.

DOMQuad objects have an associated bounding rectangle set to a DOMRectReadOnly object when created. DOMQuad objects must have read and write access to the internal member variables of the associated bounding rectangle. The associated bounding rectangle is live; whenever the objects for p1, p2, p3 or p4 change, the associated bounding rectangle must update its internal member variable values as appropriate to describe the new smallest bounding box of the four points.

The associated bounding rectangle is computed as follows:

  1. Let bounds be a DOMRectReadOnly object.
  2. Let left be the minimum of p1.x, p2.x, p3.x and p4.x.
  3. Let top be the minimum of p1.y, p2.y, p3.y and p4.y.
  4. Let right be the maximum of p1.x, p2.x, p3.x and p4.x.
  5. Let bottom be the maximum of p1.y, p2.y, p3.y and p4.y.
  6. Let x coordinate of bounds be left, y coordinate of bounds be top, width dimension of bounds be right - left and height dimension of bounds be bottom - top.

In this example the DOMQuad constructor is called with arguments of type DOMPoint and DOMPointInit. Both arguments are accepted and can be used.

var point = new DOMPoint(2, 0);
var quad1 = new DOMQuad(point, {x: 12, y: 0}, {x: 2, y: 10}, {x: 12, 10});

The attribute values of the resulting DOMQuad quad1 above are also equal to the attribute values of the following DOMQuad quad2:

var rect = new DOMRect(2, 0, 10, 10);
var quad2 = new DOMQuad(rect);

This is an example of an irregular quadrilateral:

new DOMQuad({x: 40, y: 25}, {x: 180, y: 8}, {x: 210, y: 150}, {x: 10, y: 180});
An irregular quadrilateral with none of the sides being vertical or horizontal. Its four corners are marked with red circles. Around this quadrilateral is a dashed rectangle. All sides of this rectangle are vertical or horizontal and tangent the quadrilateral.

An irregular quadrilateral represented by a DOMQuad. The four red colored circles represent the DOMPoint attributes p1 to p4. The dashed rectangle represents the associated bounding rectangle bounds of the DOMQuad.

6 The DOMMatrix interfaces

The DOMMatrix and DOMMatrixReadOnly interfaces represent a mathematical matrix with the purpose of describing transformations in a graphical context. The following sections describe the details of the interface.

The DOMMatrix and DOMMatrixReadOnly interfaces replace the SVGMatrix interface from SVG [SVG11].

For legacy reasons, if the user agent supports SVG, Window objects must have a writable, configurable, non-enumerable property named SVGMatrix whose value is the DOMMatrix interface object. [SVG11]

m11m21m31m41m12m22m32m42m13m23m33m43m14m24m34m44

A 4x4 matrix representing a DOMMatrix with items m11 to m44.

In the following sections, terms have the following meaning:

post-multiply
Term A post-multiplied by term B is equal to A · B.
pre-multiply
Term A pre-multiplied by term B is equal to B · A.
multiply
Multiply term A by term B is equal to A · B.
interface DOMMatrixReadOnly {
    // These attributes are simple aliases for certain elements of the 4x4 matrix
    readonly attribute unrestricted double a;
    readonly attribute unrestricted double b;
    readonly attribute unrestricted double c;
    readonly attribute unrestricted double d;
    readonly attribute unrestricted double e;
    readonly attribute unrestricted double f;

    readonly attribute unrestricted double m11;
    readonly attribute unrestricted double m12;
    readonly attribute unrestricted double m13;
    readonly attribute unrestricted double m14;
    readonly attribute unrestricted double m21;
    readonly attribute unrestricted double m22;
    readonly attribute unrestricted double m23;
    readonly attribute unrestricted double m24;
    readonly attribute unrestricted double m31;
    readonly attribute unrestricted double m32;
    readonly attribute unrestricted double m33;
    readonly attribute unrestricted double m34;
    readonly attribute unrestricted double m41;
    readonly attribute unrestricted double m42;
    readonly attribute unrestricted double m43;
    readonly attribute unrestricted double m44;

    readonly attribute boolean is2D;
    readonly attribute boolean isIdentity;

    // Immutable transform methods
    DOMMatrix translate(unrestricted double tx,
                        unrestricted double ty,
                        optional unrestricted double tz = 0);
    DOMMatrix scale(unrestricted double scale,
                    optional unrestricted double originX = 0,
                    optional unrestricted double originY = 0);
    DOMMatrix scale3d(unrestricted double scale,
                      optional unrestricted double originX = 0,
                      optional unrestricted double originY = 0,
                      optional unrestricted double originZ = 0);
    DOMMatrix scaleNonUniform(unrestricted double scaleX,
                              optional unrestricted double scaleY = 1,
                              optional unrestricted double scaleZ = 1,
                              optional unrestricted double originX = 0,
                              optional unrestricted double originY = 0,
                              optional unrestricted double originZ = 0);
    DOMMatrix rotate(unrestricted double angle,
                     optional unrestricted double originX = 0,
                     optional unrestricted double originY = 0);
    DOMMatrix rotateFromVector(unrestricted double x,
                               unrestricted double y);
    DOMMatrix rotateAxisAngle(unrestricted double x,
                              unrestricted double y,
                              unrestricted double z,
                              unrestricted double angle);
    DOMMatrix skewX(unrestricted double sx);
    DOMMatrix skewY(unrestricted double sy);
    DOMMatrix multiply(DOMMatrix other);
    DOMMatrix flipX();
    DOMMatrix flipY();
    DOMMatrix inverse();

    DOMPoint            transformPoint(optional DOMPointInit point);
    Float32Array        toFloat32Array();
    Float64Array        toFloat64Array();
                        stringifier;
};

[Constructor,
 Constructor(DOMString transformList),
 Constructor(DOMMatrixReadOnly other),
 Constructor(Float32Array array32),
 Constructor(Float64Array array64),
 Constructor(sequence<unrestricted double> numberSequence)]
interface DOMMatrix : DOMMatrixReadOnly {
    // These attributes are simple aliases for certain elements of the 4x4 matrix
    inherit attribute unrestricted double a;
    inherit attribute unrestricted double b;
    inherit attribute unrestricted double c;
    inherit attribute unrestricted double d;
    inherit attribute unrestricted double e;
    inherit attribute unrestricted double f;

    inherit attribute unrestricted double m11;
    inherit attribute unrestricted double m12;
    inherit attribute unrestricted double m13;
    inherit attribute unrestricted double m14;
    inherit attribute unrestricted double m21;
    inherit attribute unrestricted double m22;
    inherit attribute unrestricted double m23;
    inherit attribute unrestricted double m24;
    inherit attribute unrestricted double m31;
    inherit attribute unrestricted double m32;
    inherit attribute unrestricted double m33;
    inherit attribute unrestricted double m34;
    inherit attribute unrestricted double m41;
    inherit attribute unrestricted double m42;
    inherit attribute unrestricted double m43;
    inherit attribute unrestricted double m44;

    // Mutable transform methods
    DOMMatrix multiplySelf(DOMMatrix other);
    DOMMatrix preMultiplySelf(DOMMatrix other);
    DOMMatrix translateSelf(unrestricted double tx,
                     unrestricted double ty,
                     optional unrestricted double tz = 0);
    DOMMatrix scaleSelf(unrestricted double scale,
                 optional unrestricted double originX = 0,
                 optional unrestricted double originY = 0);
    DOMMatrix scale3dSelf(unrestricted double scale,
                   optional unrestricted double originX = 0,
                   optional unrestricted double originY = 0,
                   optional unrestricted double originZ = 0);
    DOMMatrix scaleNonUniformSelf(unrestricted double scaleX,
                           optional unrestricted double scaleY = 1,
                           optional unrestricted double scaleZ = 1,
                           optional unrestricted double originX = 0,
                           optional unrestricted double originY = 0,
                           optional unrestricted double originZ = 0);
    DOMMatrix rotateSelf(unrestricted double angle,
                  optional unrestricted double originX = 0,
                  optional unrestricted double originY = 0);
    DOMMatrix rotateFromVectorSelf(unrestricted double x,
                            unrestricted double y);
    DOMMatrix rotateAxisAngleSelf(unrestricted double x,
                           unrestricted double y,
                           unrestricted double z,
                           unrestricted double angle);
    DOMMatrix skewXSelf(unrestricted double sx);
    DOMMatrix skewYSelf(unrestricted double sy);
    DOMMatrix invertSelf();

    DOMMatrix setMatrixValue(DOMString transformList);
};

For historical reasons, Window objects must also have a writable, configurable, non-enumerable property named SVGMatrix whose value is the DOMMatrix interface object.

6.1 DOMMatrix constructors

The DOMMatrix() constructor, when invoked, must run the following steps:

  1. If invoked with no arguments:
    1. set the m12, m13, m14, m21, m23, m24, m31, m32, m34, m41, m42, m43 attributes to 0 and the m11, m22, m33, m44 attributes to 1.
    2. Set is2D to true.
  2. If invoked with a DOMString argument transformList:
    1. Parse transformList by following the syntax description in “Syntax of the SVG ‘transform’ attribute[CSS3-TRANSFORMS] to a <transform-list>. If parsing is not successful or any <transform-function> has <length> values without absolute length units, throw an SyntaxError exception.
    2. Set is2D to false if the <transform-list> consists of any 3D Transform functions. Otherwise set is2D to true.
    3. Transform all <transform-function>s to 4x4 matrices by following the “Mathematical Description of Transform Functions[CSS3-TRANSFORMS].
    4. Post-multiply all matrices from left to right to a combined 4x4 matrix.
    5. Set the m11 to m44 attributes to the element values of the 4x4 matrix in column-major order.
  3. If invoked with a DOMMatrixReadOnly argument other:
    1. Set m11 to m44 attributes to the corresponding attribute values of other.
    2. Set is2D to the corresponding flag of other.
  4. If invoked with a Float32Array argument array32:
  5. If invoked with a Float64Array argument array64:
  6. If invoked with a sequence<unrestricted double> argument numberSequence:

6.2 DOMMatrix attributes

The following attributes m11 to m44 correspond to the 16 items of the matrix interfaces. If the attributes m31, m32, m13, m23, m43, m14, m24, m34 are set to something else than 0 or m33, m44 are set to something else than 1 set is2D to false.

m11
The value of the element in column 1, row 1 of the matrix.
m12
The value of the element in column 1, row 2 of the matrix.
m13
The value of the element in column 1, row 3 of the matrix.
m14
The value of the element in column 1, row 4 of the matrix.
m21
The value of the element in column 2, row 1 of the matrix.
m22
The value of the element in column 2, row 2 of the matrix.
m23
The value of the element in column 2, row 3 of the matrix.
m24
The value of the element in column 2, row 4 of the matrix.
m31
The value of the element in column 3, row 1 of the matrix.
m32
The value of the element in column 3, row 2 of the matrix.
m33
The value of the element in column 3, row 3 of the matrix.
m34
The value of the element in column 3, row 4 of the matrix.
m41
The value of the element in column 4, row 1 of the matrix.
m42
The value of the element in column 4, row 2 of the matrix.
m43
The value of the element in column 4, row 3 of the matrix.
m44
The value of the element in column 4, row 4 of the matrix.

The following attributes a to b correspond to the 2D components of the matrix interfaces.

a
Corresponds to the attribute m11.
b
Corresponds to the attribute m12.
c
Corresponds to the attribute m21.
d
Corresponds to the attribute m22.
e
Corresponds to the attribute m41.
f
Corresponds to the attribute m42.

The following attribute provide status information about DOMMatrixReadOnly.

is2D

Every DOMMatrixReadOnly object must be flagged with a boolean is2D. This flag indicates that

  1. The current matrix was initialized as a 2D matrix. See individual constructors for more details.
  2. Only 2D transformation operations were applied. Each mutable or immutable transformation method defines if is2D must be set to false.

is2D can never be set to true when it was set to false before on a DOMMatrix object with the exception of calling the setMatrixValue() method.

Returns the value of is2D.

isIdentity
Returns true if m12, m13, m14, m21, m23, m24, m31, m32, m34, m41, m42, m43 are 0 and m11, m22, m33, m44 are 1. Otherwise returns false.

6.3 Immutable transformation methods

The following methods do not modify the current matrix and return a new DOMMatrix object.

translate(tx, ty, tz)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a translateSelf() transformation on result with the arguments tx, ty, tz.
  3. Return result.

The current matrix is not modified.

scale(scale, originX, originY)
  1. Let other be the resulting matrix initialized to the values of the current matrix.
  2. Perform a scaleSelf() transformation on result with the arguments scale, originX, originY.
  3. Return result.

The current matrix is not modified.

scale3d(scale, originX, originY, originZ)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a scale3dSelf() transformation on result with the arguments scale, originX, originY, originZ.
  3. Return result.

The current matrix is not modified.

scaleNonUniform(scaleX, scaleY, scaleZ, originX, originY, originZ)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a scaleNonUniformSelf() transformation on result with the arguments scaleX, scaleY, scaleZ, originX, originY, originZ.
  3. Return result.

The current matrix is not modified.

rotate(angle, originX, originY)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a rotateSelf() transformation on result with the arguments angle, originX, originY.
  3. Return result.

The current matrix is not modified.

rotateFromVector(x, y)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a rotateFromVectorSelf() transformation on result with the arguments x, y.
  3. Return result.

The current matrix is not modified.

rotateAxisAngle(x, y, z, angle)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a rotateAxisAngleSelf() transformation on result with the arguments x, y, z, angle.
  3. Return result.

The current matrix is not modified.

skewX(sx)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a skewXSelf() transformation on result with the argument sx.
  3. Return result.

The current matrix is not modified.

skewY(sy)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a skewYSelf() transformation on result with the argument sy.
  3. Return result.

The current matrix is not modified.

multiply(other)
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a multiply() transformation on result with the argument other.
  3. Return result.

The current matrix is not modified.

flipX()
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Post-multiply result with DOMMatrix(-1, 0, 0, 1, 0, 0).
  3. Return result.

The current matrix is not modified.

flipY()
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Post-multiply result with DOMMatrix(1, 0, 0, -1, 0, 0).
  3. Return result.

The current matrix is not modified.

inverse()
  1. Let result be the resulting matrix initialized to the values of the current matrix.
  2. Perform a invertSelf() transformation on result.
  3. Return result.

The current matrix is not modified.

The following methods do not modify the current matrix.

transformPoint(point)
The point argument is post-multiplied to the current matrix and returns the resulting point. The passed argument does not get modified.

Note: Even though is2D of the current matrix may return true, a 4x4 matrix multiplication must be performed if the z attribute of point is not 0 or the w attribute of point is not 1.

toFloat32Array()
Returns the serialized 16 elements m11 to m44 of the current matrix in column-major order as Float32Array [typedarray].
toFloat64Array()
Returns the serialized 16 elements m11 to m44 of the current matrix in column-major order as Float64Array [typedarray].
stringifier()
If is2D is true
Return a DOMString in the form of a CSS Transforms <matrix()> function where a is a attribute, b is b attribute, c is c attribute, d is d attribute, e is e attribute, f is f attribute, [CSS3-TRANSFORMS].
Otherwise
Return a DOMString in the form of a CSS Transforms <matrix3d()> function where m11 to m44 are set to m11 to m44 attributes [CSS3-TRANSFORMS].

In this example a matrix is created and several methods with 2D transformations are called.

var matrix = new DOMMatrix();
matrix.scaleSelf(2);
matrix.translateSelf(20,20);

Calling matrix.toString() returns the DOMString:

"matrix(2, 0, 0, 2, 20, 20)"

For 3D operations, the stringifier returns a DOMString representing a 3D matrix.

var matrix = new DOMMatrix();
matrix.scale3dSelf(2);

Calling matrix.toString() after the snippet above returns the DOMString:

"matrix3d(2, 0, 0, 0, 0, 2, 0, 0, 0, 0, 2, 0, 0, 0, 0, 1)"

6.4 Mutable transformation methods

The following methods do modify the current matrix. Each method returns the current matrix the method was called on. This allows authors to chain method calls.

The following code example

var matrix = new DOMMatrix();
matrix.translateSelf(20, 20);
matrix.scaleSelf(2);
matrix.translateSelf(-20, -20);

is equivalent to

var matrix = new DOMMatrix();
matrix.translateSelf(20, 20).scaleSelf(2).translateSelf(-20, -20);

Note: Authors who use chained method calls are recommended to use mutable transformation methods to avoid unnecessary memory allocations due to intermediate DOMMatrix creations in User Agents.

multiplySelf(other)
  1. The other matrix gets post-multiplied to the current matrix.
  2. If is2D of other is false, set is2D of the current matrix to false.
  3. Return the current matrix.
preMultiplySelf(other)
  1. The other matrix gets pre-multiplied to the current matrix.
  2. If is2D of other is false, set is2D of the current matrix to false.
  3. Return the current matrix.
translateSelf(tx, ty, tz)
  1. Post-multiply a translation transformation on the current matrix. The 3D translation matrix is described in CSS Transforms [CSS3-TRANSFORMS].

  2. If tz is specified and not 0, set is2D of the current matrix to false.

  3. Return the current matrix.
scaleSelf(scale, originX, originY)
  1. Apply a translateSelf(originX, originY) transformation to the current matrix.
  2. Post-multiply a uniform 2D scale transformation (m11 = m22 = scale) on the current matrix. The 2D scale matrix is described in CSS Transforms with sx = sy = scale. [CSS3-TRANSFORMS].
  3. Apply a translateSelf(-originX, -originY) transformation to the current matrix.
  4. Return the current matrix.
scale3dSelf(scale, originX, originY, originZ)
  1. Apply a translateSelf(originX, originY, originZ) transformation to the current matrix.
  2. Post-multiply a uniform 3D scale transformation (m11 = m22 = m33 = scale) on the current matrix. The 3D scale matrix is described in CSS Transforms with sx = sy = sz = scale. [CSS3-TRANSFORMS].
  3. Apply a translateSelf(-originX, -originY, -originZ) transformation to the current matrix.
  4. If scale is not 1, set is2D of the current matrix to false.
  5. Return the current matrix.
scaleNonUniformSelf(scaleX, scaleY, scaleZ, originX, originY, originZ)
  1. Apply a translateSelf(originX, originY, originZ) transformation to the current matrix.
  2. Post-multiply a non-uniform scale transformation on the current matrix. The 3D scale matrix is described in CSS Transforms with sx = scaleX, sy = scaleY and sz = scaleZ. [CSS3-TRANSFORMS].
  3. Apply a translateSelf(-originX, -originY, -originZ) transformation to the current matrix.
  4. If scaleZ is specified and not 1 or originZ is specified and not 0, set is2D of the current matrix to false.
  5. Return the current matrix.
rotateSelf(angle, originX, originY)
  1. Apply a translateSelf(originX, originY) transformation to the current matrix.
  2. Post-multiply a rotation transformation on the current matrix with the specified rotation angle in degrees. The 2D rotation matrix is described in CSS Transforms with alpha = angle in degrees. [CSS3-TRANSFORMS].
  3. Apply a translateSelf(-originX, -originY) transformation to the current matrix.
  4. Return the current matrix.
rotateFromVectorSelf(x, y)
  1. Post-multiply a rotation transformation on the current matrix. The rotation angle is determined by the angle between the vector (1,0)T and (x,y)T in the clockwise direction. If x and y should both be zero, the angle is specified as zero. The 2D rotation matrix is described in CSS Transforms where alpha is the angle between the vector (1,0)T and (x,y)T in degrees [CSS3-TRANSFORMS].
  2. Return the current matrix.
rotateAxisAngleSelf(x, y, z, angle)
  1. Post-multiply a rotation transformation on the current matrix around the specified vector x, y, z by the specified rotation angle in degrees. The 3D rotation matrix is described in CSS Transforms with alpha = angle in degrees [CSS3-TRANSFORMS].
  2. If z is not 0, set is2D of the current matrix to false.
  3. Return the current matrix.
skewXSelf(sx)
  1. Post-multiply a skewX transformation on the current matrix by the specified angle sx in degrees. The 2D skewX matrix is described in CSS Transforms with alpha = sx in degrees [CSS3-TRANSFORMS].
  2. Return the current matrix.
skewYSelf(sy)
  1. Post-multiply a skewX transformation on the current matrix by the specified angle sy in degrees. The 2D skewY matrix is described in CSS Transforms with beta = sy in degrees [CSS3-TRANSFORMS].
  2. Return the current matrix.
invertSelf()
  1. Invert the current matrix.
  2. If the current matrix is not invertible set all attributes to NaN and set is2D to false.
  3. Return the current matrix.
setMatrixValue(transformList)
  1. Parse transformList by following the syntax description in “Syntax of the SVG ‘transform’ attribute[CSS3-TRANSFORMS] to a <transform-list>. If parsing is not successful or any <transform-function> has <length> values without absolute length units, throw an SyntaxError exception.
  2. Set is2D to false if the <transform-list> consists of any 3D Transform functions. Otherwise set is2D to true.
  3. Transform all <transform-function>s to 4x4 matrices by following the “Mathematical Description of Transform Functions[CSS3-TRANSFORMS].
  4. Post-multiply all matrices from left to right to a combined 4x4 matrix.
  5. Set the m11 to m44 attributes to the element values of the 4x4 matrix in column-major order.
  6. Return the current matrix.

Changes since last publication

The following changes were made since the 22 May 2014 First Public Working Draft.

Acknowledgments

The editors would like to thank Robert O’Callahan for contributing to this specification. Many thanks to Dean Jackson for his initial proposal of DOMMatrix. Thanks to Brian Birtles, Benoit Jacob, Cameron McCormack, Kari Pihkala, Adenilson Cavalcanti and Boris Zbarsky for their careful reviews, comments, and corrections.

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words "for example" or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word "Note" and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

Advisements are normative sections styled to evoke special attention and are set apart from other normative text with <strong class="advisement">, like this: UAs MUST provide an accessible alternative.

Conformance classes

Conformance to this specification is defined for three conformance classes:

style sheet
A CSS style sheet.
renderer
A UA that interprets the semantics of a style sheet and renders documents that use them.
authoring tool
A UA that writes a style sheet.

A style sheet is conformant to this specification if all of its statements that use syntax defined in this module are valid according to the generic CSS grammar and the individual grammars of each feature defined in this module.

A renderer is conformant to this specification if, in addition to interpreting the style sheet as defined by the appropriate specifications, it supports all the features defined by this specification by parsing them correctly and rendering the document accordingly. However, the inability of a UA to correctly render a document due to limitations of the device does not make the UA non-conformant. (For example, a UA is not required to render color on a monochrome monitor.)

An authoring tool is conformant to this specification if it writes style sheets that are syntactically correct according to the generic CSS grammar and the individual grammars of each feature in this module, and meet all other conformance requirements of style sheets as described in this module.

Partial implementations

So that authors can exploit the forward-compatible parsing rules to assign fallback values, CSS renderers must treat as invalid (and ignore as appropriate) any at-rules, properties, property values, keywords, and other syntactic constructs for which they have no usable level of support. In particular, user agents must not selectively ignore unsupported component values and honor supported values in a single multi-value property declaration: if any value is considered invalid (as unsupported values must be), CSS requires that the entire declaration be ignored.

Experimental implementations

To avoid clashes with future CSS features, the CSS2.1 specification reserves a prefixed syntax for proprietary and experimental extensions to CSS.

Prior to a specification reaching the Candidate Recommendation stage in the W3C process, all implementations of a CSS feature are considered experimental. The CSS Working Group recommends that implementations use a vendor-prefixed syntax for such features, including those in W3C Working Drafts. This avoids incompatibilities with future changes in the draft.

Non-experimental implementations

Once a specification reaches the Candidate Recommendation stage, non-experimental implementations are possible, and implementors should release an unprefixed implementation of any CR-level feature they can demonstrate to be correctly implemented according to spec.

To establish and maintain the interoperability of CSS across implementations, the CSS Working Group requests that non-experimental CSS renderers submit an implementation report (and, if necessary, the testcases used for that implementation report) to the W3C before releasing an unprefixed implementation of any CSS features. Testcases submitted to W3C are subject to review and correction by the CSS Working Group.

Further information on submitting testcases and implementation reports can be found from on the CSS Working Group’s website at http://www.w3.org/Style/CSS/Test/. Questions should be directed to the public-css-testsuite@w3.org mailing list.

References

Normative References

[CSS3-TRANSFORMS]
Simon Fraser; et al. CSS Transforms. 11 September 2012. W3C Working Draft. (Work in progress.) URL: http://www.w3.org/TR/2012/WD-css3-transforms-20120911/
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. URL: http://www.ietf.org/rfc/rfc2119.txt
[WEBIDL]
Cameron McCormack. Web IDL. 19 April 2012. W3C Candidate Recommendation. (Work in progress.) URL: http://www.w3.org/TR/2012/CR-WebIDL-20120419/

Informative References

[2DCONTEXT]
Rik Cabanier; et al. HTML Canvas 2D Context. 6 August 2013. W3C Candidate Recommendation. (Work in progress.) URL: http://www.w3.org/TR/2013/CR-2dcontext-20130806/
[SVG11]
Erik Dahlström; et al. Scalable Vector Graphics (SVG) 1.1 (Second Edition). 16 August 2011. W3C Recommendation. URL: http://www.w3.org/TR/2011/REC-SVG11-20110816/
[typedarray]
David Herman; Kenneth Russell. Typed Array Specification. 2013-06-26. Khronos Working Draft. URL: https://www.khronos.org/registry/typedarray/specs/latest/

Index

Property index

No properties defined.