API / geotoolkit / util / Transformation / Transformation

Class: Transformation

util.Transformation.Transformation

Create transformation matrix

Constructors

[new Transformation()](/solutions/geotoolkit/apis/classes/geotoolkit.util.transformation.transformation.md#new transformation())	[new Transformation(properties)](/solutions/geotoolkit/apis/classes/geotoolkit.util.transformation.transformation.md#new transformation(properties))	[new Transformation(tr)](/solutions/geotoolkit/apis/classes/geotoolkit.util.transformation.transformation.md#new transformation(tr))
[new Transformation(xx, yx, xy, yy, dx, dy)](/solutions/geotoolkit/apis/classes/geotoolkit.util.transformation.transformation.md#new transformation(xx, yx, xy, yy, dx, dy))

Methods

clone	concatenate	createInverse
fastEquals	getAngle	getClassName
getDeterminant	getLengthToXRatioAt	getLengthToYRatioAt
getProperties	getScaleX	getScaleY
getShearX	getShearY	getTranslate
getTranslateX	getTranslateY	inverseTransform
inverseTransformDimension	inverseTransformPoint	inverseTransformRect
inverseTransformXY	isIdentity	isRotated
preConcatenate	rotate	scale
setPointsToPointsTransformation	setProperties	setRectToRectTransformation
setScale	setToIdentity	setTransformation
setTranslate	shear	toString
transform	transformDimension	transformPath
transformPoint	transformPoints	transformPolygon
transformRect	transformX	transformXY
transformY	translate	canCreatePointsToPointsInstance
canCreateRectToRectInstance	divide	getClassName
getPointsToPointsInstance	getRectToRectInstance	getRotateInstance
getScaleInstance	getSegmentToSegmentInstance	getShearInstance
getTranslateInstance	multiply

Css Properties

Name	Type	Description
`dx`	`number`	X axis translation
`dy`	`number`	Y axis translation
`xx`	`number`	X scale
`xy`	`number`	Xy skew
`yx`	`number`	Yx skew
`yy`	`number`	Y scale

Constructors

new Transformation()

• new Transformation()

Creates identity matrix

new Transformation(properties)

• new Transformation(properties)

Parameters

Name	Type	Description
`properties`	`Properties`	object to copy

new Transformation(tr)

• new Transformation(tr)

Parameters

Name	Type	Description
`tr`	`Transformation`	Transformation instance to copy

new Transformation(xx, yx, xy, yy, dx, dy)

• new Transformation(xx, yx, xy, yy, dx, dy)

Parameters

Name	Type	Description
`xx`	`number`	x scale
`yx`	`number`	yx skew
`xy`	`number`	xy skew
`yy`	`number`	y scale
`dx`	`number`	x axis translation
`dy`	`number`	y axis translation

Methods

clone

▸ clone(): Transformation

Return clone object.

Returns

Transformation

a copy of this transformation

concatenate

▸ concatenate(Tx): Transformation

Concatenates Tx to transformation

Parameters

Name	Type	Description
`Tx`	`Transformation`	transformation

Returns

Transformation

this

createInverse

▸ createInverse(): Transformation

Create inverse transformation

Returns

Transformation

fastEquals

▸ fastEquals(Tx): boolean

Return true if transformation are identical

Parameters

Name	Type	Description
`Tx`	`Transformation`	transformation

Returns

boolean

getAngle

▸ getAngle(): number

Gets rotation angle Note: only for transformation without skewing

Returns

number

rotation angle

getClassName

▸ getClassName(): string

Returns

string

getDeterminant

▸ getDeterminant(): number

Returns matrix determinant

Returns

number

getLengthToXRatioAt

▸ getLengthToXRatioAt(): number

Return length to X ratio

Returns

number

getLengthToYRatioAt

▸ getLengthToYRatioAt(): number

Return length to Y ratio

Returns

number

getProperties

▸ getProperties(): Properties

Gets all the properties pertaining to this object

Returns

Properties

An object containing the properties to set

getScaleX

▸ getScaleX(): number

Returns X Scale(xx)

Returns

number

getScaleY

▸ getScaleY(): number

Returns Y Scale(yy)

Returns

number

getShearX

▸ getShearX(): number

Returns X sheer (xy)

Returns

number

getShearY

▸ getShearY(): number

Returns Y sheer (yx)

Returns

number

getTranslate

▸ getTranslate(): Point

Returns translation in both X & Y (dx, dy)

Returns

Point

getTranslateX

▸ getTranslateX(): number

Returns X translation (dx)

Returns

number

getTranslateY

▸ getTranslateY(): number

Returns Y translation (dy)

Returns

number

inverseTransform

▸ inverseTransform<T>(source, destination?): T

Performs an inverse transform using points, rect or dimension

Type parameters

Name	Type
`T`	extends `Point` \| `Rect` \| `Dimension`

Parameters

Name	Type	Description
`source`	`T`	source rect
`Optional` `destination`	`T`	destination rect

Returns

T

transformation from source to destination

inverseTransformDimension

▸ inverseTransformDimension(sourceSize, targetSize?): Dimension

Inverse transforms the specified dimension

Parameters

Name	Type	Description
`sourceSize`	`Dimension`	the point to be inverse transformed
`Optional` `targetSize`	`Dimension`	the size to hold the transformed point

Returns

Dimension

the result of the inverse transform.

inverseTransformPoint

▸ inverseTransformPoint(sourcePoint, destinationPoint?): Point

Inverse transforms the specified point

Parameters

Name	Type	Description
`sourcePoint`	`Point`	source point to transform
`Optional` `destinationPoint`	`Point`	optional destination point

Returns

Point

the result of the inverse transform.

inverseTransformRect

▸ inverseTransformRect(source, destination?): Rect

Inverse transform rectangle

Parameters

Name	Type	Description
`source`	`Rect`	source rectangle
`Optional` `destination`	`Rect`	destination rectangle

Returns

Rect

the transformed rect

inverseTransformXY

▸ inverseTransformXY(x, y): Point

Inverse transform point defined by two coordinates X and Y

Parameters

Name	Type	Description
`x`	`number`	x coordinate
`y`	`number`	y coordinate

Returns

Point

isIdentity

▸ isIdentity(): boolean

Is identity transformation

Returns

boolean

is this identity transformation.

isRotated

▸ isRotated(): boolean

Is rotated transformation

Returns

boolean

rotation flag

preConcatenate

▸ preConcatenate(Tx): Transformation

Pre-concatenates transformation matrix with Tx

Parameters

Name	Type	Description
`Tx`	`Transformation`	transformation

Returns

Transformation

this

rotate

▸ rotate(theta): Transformation

Rotate

Parameters

Name	Type	Description
`theta`	`number`	angle to rotate

Returns

Transformation

this

scale

▸ scale(sx, sy): Transformation

Scale

Parameters

Name	Type	Description
`sx`	`number`	scale factor along x coordinate
`sy`	`number`	scale factor along y coordinate

Returns

Transformation

this

setPointsToPointsTransformation

▸ setPointsToPointsTransformation(src1, src2, src3, dst1, dst2, dst3): Transformation

Sets transformation based on three (source => destination) point pairs

Throws

Error if determinant === 0

Parameters

Name	Type	Description
`src1`	`Point`	first source point
`src2`	`Point`	second source point
`src3`	`Point`	third source point
`dst1`	`Point`	first destination point
`dst2`	`Point`	second destination point
`dst3`	`Point`	third destination point

Returns

Transformation

this

setProperties

▸ setProperties(properties?): Transformation

Sets all the properties pertaining to this object

Parameters

Name	Type	Description
`Optional` `properties`	`Properties`	An object containing the properties to set

Returns

Transformation

this

setRectToRectTransformation

▸ setRectToRectTransformation(source, destination, horizontalFlip?, verticalFlip?, aspectRatio?): Transformation

Sets rect to rect transformation

Throws

if illegal source or destination rectangle

Parameters

Name	Type	Description
`source`	`Rect`	source rectangle
`destination`	`Rect`	destination rectangle
`Optional` `horizontalFlip`	`boolean`	horizontal flip
`Optional` `verticalFlip`	`boolean`	vertical flip
`Optional` `aspectRatio`	`boolean`	keeps aspect ratio

Returns

Transformation

this

setScale

▸ setScale(xx, yy): Transformation

Sets X & Y Scale by xx and yy

Parameters

Name	Type	Description
`xx`	`number`	x scale
`yy`	`number`	y scale

Returns

Transformation

this

setToIdentity

▸ setToIdentity(): Transformation

Resets this transform to the Identity transform.

Returns

Transformation

this

setTransformation

▸ setTransformation(xx): Transformation

Sets transformation

Parameters

Name	Type	Description
`xx`	`Transformation`	Transformation

Returns

Transformation

this

▸ setTransformation(xx, yx, xy, yy, dx, dy): Transformation

Sets transformation

Parameters

Name	Type	Description
`xx`	`number`	x scale
`yx`	`number`	yx skew
`xy`	`number`	xy skew
`yy`	`number`	y scale
`dx`	`number`	x axis translation
`dy`	`number`	y axis translation

Returns

Transformation

this

setTranslate

▸ setTranslate(dx, dy): Transformation

Sets X & Y translation by dx and dy

Parameters

Name	Type	Description
`dx`	`number`	x offset
`dy`	`number`	y offset

Returns

Transformation

this

shear

▸ shear(shx, shy): Transformation

Applies a shear mapping to the transform

Parameters

Name	Type	Description
`shx`	`number`	shear coefficient along x coordinate
`shy`	`number`	shear coefficient along y coordinate

Returns

Transformation

this

toString

▸ toString(): string

Returns transformation parameters as one string

Returns

string

transform

▸ transform<T>(source, destination?): T

Transforms from one point, rect, or dimension to another

Type parameters

Name	Type
`T`	extends `Point` \| `Rect` \| `GraphicsPath` \| `Dimension`

Parameters

Name	Type	Description
`source`	`T`	origin to be transformed from
`Optional` `destination`	`T`	destination rectangle

Returns

T

transformation from source to destination

▸ transform(x, y): Point

Transform point defined by two coordinates X and Y

Parameters

Name	Type	Description
`x`	`number`	x coordinate
`y`	`number`	y coordinate

Returns

Point

transformDimension

▸ transformDimension(sourceSize, targetSize?): Dimension

Inverse transforms the specified dimension

Parameters

Name	Type	Description
`sourceSize`	`TextMetrics` \| `Dimension`	the point to be inverse transformed
`Optional` `targetSize`	`Dimension`	the size to hold the transformed point

Returns

Dimension

the result of the transform.

transformPath

▸ transformPath(srcPath, dstPath?): GraphicsPath

Transforms GraphicsPath

Parameters

Name	Type	Description
`srcPath`	`GraphicsPath`	source path to transform
`Optional` `dstPath`	`GraphicsPath`	transformed path

Returns

GraphicsPath

transformed path

transformPoint

▸ transformPoint(src, dst?): Point

Transform point

Parameters

Name	Type	Description
`src`	`Point`	source point to transform
`Optional` `dst`	`Point`	optional returned transformed point

Returns

Point

the transformed point

transformPoints

▸ transformPoints(x, y, count): void

Transform a set of point defined by two arrays

Parameters

Name	Type	Description
`x`	`number`[]	an array of x-coordinates
`y`	`number`[]	an array of y-coordinates
`count`	`number`	a count of point to transform

Returns

void

transformPolygon

▸ transformPolygon(source, destination?): Polygon

Transform polygon

Parameters

Name	Type	Description
`source`	`Polygon`	source polygon
`Optional` `destination`	`Polygon`	destination polygon

Returns

Polygon

transformRect

▸ transformRect(source, destination?): Rect

Transform rectangle

Throws

if destination is readonly mode

Parameters

Name	Type	Description
`source`	`Rect`	source rectangle
`Optional` `destination`	`Rect`	destination rectangle

Returns

Rect

transformX

▸ transformX(x, y): number

Apply X transformation to x,y

Parameters

Name	Type	Description
`x`	`number`	x coordinate
`y`	`number`	y coordinate

Returns

number

transformXY

▸ transformXY(x, y): Point

Transform point defined by two coordinates X and Y

Parameters

Name	Type	Description
`x`	`number`	x coordinate
`y`	`number`	y coordinate

Returns

Point

transformY

▸ transformY(x, y): number

Apply Y transformation to x,y

Parameters

Name	Type	Description
`x`	`number`	x coordinate
`y`	`number`	y coordinate

Returns

number

translate

▸ translate(tx, ty): Transformation

Translate

Parameters

Name	Type	Description
`tx`	`number`	x offset along x coordinate
`ty`	`number`	y offset along y coordinate

Returns

Transformation

this

canCreatePointsToPointsInstance

▸ Static canCreatePointsToPointsInstance(src1, src2, src3): boolean

Returns true if transformation can be created from provided source points

Parameters

Name	Type	Description
`src1`	`Point`	first source point
`src2`	`Point`	second source point
`src3`	`Point`	third source point

Returns

boolean

canCreateRectToRectInstance

▸ Static canCreateRectToRectInstance(source, destination): boolean

Return true if transformation can be created from source rectangle to destination rectangle. Vertical or horizontal dimension can be empty

Parameters

Name	Type	Description
`source`	`Rect`	source rectangle
`destination`	`Rect`	destination rectangle

Returns

boolean

divide

▸ Static divide(a, b, dst?): Transformation

Divide two matrices

Parameters

Name	Type	Description
`a`	`Transformation`	the first matrix
`b`	`Transformation`	the second matrix
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation

getClassName

▸ Static getClassName(): string

Returns

string

getPointsToPointsInstance

▸ Static getPointsToPointsInstance(src1, src2, src3, dst1, dst2, dst3, destination?): Transformation

Returns transformation based on three (source => destination) point pairs

Parameters

Name	Type	Description
`src1`	`Point`	first source point
`src2`	`Point`	second source point
`src3`	`Point`	third source point
`dst1`	`Point`	first destination point
`dst2`	`Point`	second destination point
`dst3`	`Point`	third destination point
`Optional` `destination`	`Transformation`	destination transformation object

Returns

Transformation

getRectToRectInstance

▸ Static getRectToRectInstance(source, destination, horizontalFlip?, verticalFlip?, aspectRatio?, dst?): Transformation

Gets rect to rect transformation

Throws

Error if source or destination is null

Parameters

Name	Type	Description
`source`	`Rect`	source rectangle
`destination`	`Rect`	destination rectangle
`Optional` `horizontalFlip`	`boolean`	horizontal flip
`Optional` `verticalFlip`	`boolean`	vertical flip
`Optional` `aspectRatio`	`boolean`	keeps aspect ratio
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation

getRotateInstance

▸ Static getRotateInstance(theta, x, y, dst?): Transformation

Gets rotate instance

Throws

Error if x, y or theta is null

Parameters

Name	Type	Description
`theta`	`number`	angle
`x`	`number`	x coordinate
`y`	`number`	y coordinate
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation

getScaleInstance

▸ Static getScaleInstance(scaleX, scaleY, dst?): Transformation

Get a new transformation instance based on scale values

Throws

Error if scaleX or scaleY is null

Parameters

Name	Type	Description
`scaleX`	`number`	scale factor along x coordinate
`scaleY`	`number`	scale factor along y coordinate
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation

getSegmentToSegmentInstance

▸ Static getSegmentToSegmentInstance(from1, from2, to1, to2, dst?): Transformation

Gets segment to segment transformation

Throws

Error if source or destination is null

Parameters

Name	Type	Description
`from1`	`Point`	first source segment point
`from2`	`Point`	second source segment point
`to1`	`Point`	first destination segment point
`to2`	`Point`	second destination segment point
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

transformation that transforms point from1 => to1, and from2 => to2

getShearInstance

▸ Static getShearInstance(shx, shy, dst?): Transformation

Get a new transformation instance based on shear values

Throws

Error if shx or shy is null

Parameters

Name	Type	Description
`shx`	`number`	shear coefficient along x coordinate
`shy`	`number`	shear coefficient along y coordinate
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation

getTranslateInstance

▸ Static getTranslateInstance(x, y, dst?): Transformation

Gets translate instance

Throws

Error if x or y is null

Parameters

Name	Type	Description
`x`	`number`	x coordinate
`y`	`number`	y coordinate
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation

multiply

▸ Static multiply(a, b, dst?): Transformation

Multiply two matrices

Parameters

Name	Type	Description
`a`	`Transformation`	the first matrix
`b`	`Transformation`	the second matrix
`Optional` `dst`	`Transformation`	destination transformation object

Returns

Transformation

new transformation