Class Transform

Represents the values in a 4x4 transform matrix.

Hierarchy

Transform

Constructors

constructor

new Transform(m: Array16Number): Transform
Create a new matrix from an array of 16 values.
Parameters
- m: Array16Number
  
  Value to assign to the matrix using [n11, n21, n31, n41, n12, n22, n32, n42, n13, n23, n33, n43, n14, n24, n34, n44] format.
Returns Transform
- Defined in Transform.ts:22

Properties

`Private` m

m: Array16Number

Accessors

Determinant

get Determinant(): number
The determinant of this 4x4 matrix.

Returns number
- Defined in Transform.ts:31

IsIdentity

get IsIdentity(): boolean
Return true if this Transform is the identity transform

Returns boolean
- Defined in Transform.ts:59

IsZeroTransformation

get IsZeroTransformation(): boolean
True if all values are 0, except for M33 which is 1.

Returns boolean
- Defined in Transform.ts:73

M

get M(): Array16Number
Gets the transformation array.

Returns Array16Number
- Defined in Transform.ts:45

`Static` Identity

get Identity(): Transform
Gets a new identity transform matrix. An identity matrix defines no transformation.

Returns Transform
- Defined in Transform.ts:52

`Static` ZeroTransformation

get ZeroTransformation(): Transform
ZeroTransformation diagonal = (0,0,0,1)

Returns Transform
- Defined in Transform.ts:66

Methods

Clone

Clone(): Transform
Returns a copy of the transform.

Returns Transform
- Defined in Transform.ts:99

Equals

Equals(other: Transform): boolean
Determines if another transform equals this transform value.
Parameters
- other: Transform
  
  The transform to compare.
Returns boolean
- Defined in Transform.ts:85

MultiplyMatrix

MultiplyMatrix(other: Transform): Transform
Multiplies (combines) two transformations.

Returns
The result of the multiplication.
Parameters
- other: Transform
  
  The second transform.
Returns Transform
- Defined in Transform.ts:151

MultiplyScalar

MultiplyScalar(scalar: number): Transform
Multiplies a transformation by a scalar.

Returns
The result of the multiplication.
Parameters
- scalar: number
  
  The scalar.
Returns Transform
- Defined in Transform.ts:176

ToArray

ToArray(): Array16Number
Returns the transform as an array.

Returns Array16Number
- Defined in Transform.ts:106

Transpose

Transpose(): Transform
Transpose the matrix and return a new one.

Returns Transform
- Defined in Transform.ts:512

TryGetInverse

TryGetInverse(): null | Transform
Attempts to get the inverse transform of this transform.

Returns null | Transform
- Defined in Transform.ts:542

toString

toString(): string
override toString

Returns string
- Defined in Transform.ts:584

`Static` CombineTransforms

CombineTransforms(transforms: Transform[]): Transform
Constructs a new transform by combining given transforms in order Note: as transforms multiplication is not commutative, the order matters. If none given, identity transform is returned.

Returns
The combined transform.
Parameters
- transforms: Transform[]
  
  The transforms array.
Returns Transform
- Defined in Transform.ts:315

`Static` Mirror

Mirror(plane: Plane): Transform
Constructs a new Mirror transformation.

Returns
A transformation matrix which mirrors geometry in a specified plane.
Parameters
- plane: Plane
  
  Plane that defines the mirror orientation and position.
Returns Transform
- Defined in Transform.ts:382

`Static` MultiplyMatrix

MultiplyMatrix(a: Transform, b: Transform): Transform
Multiplies (combines) two transformations.

Returns
The result of the multiplication.
Parameters
- a: Transform
  
  The first transform.
- b: Transform
  
  The second transform.
Returns Transform
- Defined in Transform.ts:116

`Static` MultiplyScalar

MultiplyScalar(a: Transform, s: number): Transform
Multiplies a transformation by a scalar.

Returns
The result of the multiplication.
Parameters
- a: Transform
  
  The transform.
- s: number
  
  The scalar.
Returns Transform
- Defined in Transform.ts:161

`Static` PlanarProjection

PlanarProjection(plane: Plane): Transform
Constructs a projection transformation.

Returns
A transformation matrix which projects geometry onto a specified plane.
Parameters
- plane: Plane
  
  Plane onto which everything will be perpendicularly projected.
Returns Transform
- Defined in Transform.ts:346

`Static` PlaneToPlane

PlaneToPlane(fromPlane: Plane, toPlane: Plane): Transform
Create a transformation that orients plane0 to plane1. If you want to orient objects from one plane to another, use this form of transformation.

Returns
A transformation matrix which orients from fromPlane to toPlane
Parameters
- fromPlane: Plane
  
  The plane to orient from.
- toPlane: Plane
  
  the plane to orient to.
Returns Transform
- Defined in Transform.ts:505

`Static` RotateAtOrigin

RotateAtOrigin(angle: number, axis: Vector3d): Transform
Constructs a new rotation transformation with specified angle and rotation axis. This function assume the rotation origin is the world origin.
Parameters
- angle: number
  
  Angle (in Radians) of the rotation.
- axis: Vector3d
  
  The axis to ratate around
Returns Transform
- Defined in Transform.ts:211

`Static` Rotation

Rotation(angle: number, rotationAxis?: Vector3d, rotationCenter?: Point3d): Transform
Constructs a new rotation transformation with specified angle and rotation axis.
Parameters
- angle: number
  
  Angle (in Radians) of the rotation.
- rotationAxis: Vector3d = Vector3d.ZAxis
  
  The axis to ratate around, default Vector3D.ZAxis
- rotationCenter: Point3d = Point3d.Origin
  
  The center of the rotation, default (0,0,0).
Returns Transform
- Defined in Transform.ts:188

`Static` RotationX

RotationX(angle: number): Transform
Constructs a new rotation transformation that rotates around X axis. this is also called "roll"
Parameters
- angle: number
  
  Angle (in Radians) of the rotation.
Returns Transform
- Defined in Transform.ts:233

`Static` RotationY

RotationY(angle: number): Transform
Constructs a new rotation transformation that rotates around Y axis. this is also called "pitch"
Parameters
- angle: number
  
  Angle (in Radians) of the rotation.
Returns Transform
- Defined in Transform.ts:242

`Static` RotationZ

RotationZ(angle: number): Transform
Constructs a new rotation transformation that rotates around Z axis. this is also called "yaw"
Parameters
- angle: number
  
  Angle (in Radians) of the rotation.
Returns Transform
- Defined in Transform.ts:251

`Static` RotationZYX

RotationZYX(z: number, y: number, x: number): Transform
Create rotation transformation From ZYX angles.
Parameters
- z: number
  
  Yaw: Angle in radians to rotate around Z axis.
- y: number
  
  Pitch: Angle in radians to rotate around Y axis.
- x: number
  
  Roll: Angle in radians to rotate around X axis.
Returns Transform
- Defined in Transform.ts:262

`Static` Scale

Scale(location: Point3d, scalar: number): Transform
Constructs a new uniform scaling transformation with a specified scaling anchor point.

Returns
The scaled transform
Parameters
- location: Point3d
  
  The location to scale from
- scalar: number
  
  The scaling factor
Returns Transform
- Defined in Transform.ts:291

`Static` ScaleAtOrigin

ScaleAtOrigin(sx: number, sy: number, sz: number): Transform
Constructs a new uniform scaling transformation. a sacle matrix looks like [ sx 0 0 0] [ 0 sy 0 0] [ 0 0 sz 0] [ 0 0 0 1]

Returns
The scaled transform
Parameters
- sx: number
  
  The scaling factor in the x dimension
- sy: number
  
  The scaling factor in the y dimension
- sz: number
  
  The scaling factor in the z dimension
Returns Transform
- Defined in Transform.ts:337

`Static` Translation

Translation(v: Vector3d): Transform
Constructs a new translation (move) transformation. a translation matrix looks like [ 1 0 0 tx] [ 0 1 0 ty] [ 0 0 1 tz] [ 0 0 0 1]

Returns
The translated transform
Parameters
- v: Vector3d
  
  The vector to scale by
Returns Transform
- Defined in Transform.ts:281

`Static` VectorToVector

VectorToVector(fromVector: Vector3d, toVector: Vector3d): Transform
Constructs a rotation transformation that rotates one vecor to another

Returns
A rotation matrix which rotates fromVector to toVector
Parameters
- fromVector: Vector3d
  
  the from vector
- toVector: Vector3d
  
  the to vector
Returns Transform
- Defined in Transform.ts:417

`Static` frameToFrame

frameToFrame(origin1: Point3d, xAxis1: Vector3d, yAxis1: Vector3d, zAxis1: Vector3d, origin2: Point3d, xAxis2: Vector3d, yAxis2: Vector3d, zAxis2: Vector3d): Transform
Helper method for creating the transformation for an arbitrary Frame to an arbitrary Frame by mapping xy plane through the transformation

Returns
transformation matrix
Parameters
- origin1: Point3d
  
  origin of the frame
- xAxis1: Vector3d
  
  x axis of the frame
- yAxis1: Vector3d
  
  y axis of the frame
- zAxis1: Vector3d
  
  z axis of the frame
- origin2: Point3d
  
  origin of the frame
- xAxis2: Vector3d
  
  x axis of the frame
- yAxis2: Vector3d
  
  y axis of the frame
- zAxis2: Vector3d
  
  z axis of the frame
Returns Transform
- Defined in Transform.ts:481

`Static` frameToFramePoint

frameToFramePoint(origin1: Point3d, xAxis1: Vector3d, yAxis1: Vector3d, zAxis1: Vector3d, origin2: Point3d, xAxis2: Vector3d, yAxis2: Vector3d, zAxis2: Vector3d, point: Point3d): Point3d
Helper method to map a point through an arbitrary Frame to an arbitray Frame transformation

Returns
transformed point
Parameters
- origin1: Point3d
  
  origin of the frame
- xAxis1: Vector3d
  
  x axis of the frame
- yAxis1: Vector3d
  
  y axis of the frame
- zAxis1: Vector3d
  
  z axis of the frame
- origin2: Point3d
  
  origin of the frame
- xAxis2: Vector3d
  
  x axis of the frame
- yAxis2: Vector3d
  
  y axis of the frame
- zAxis2: Vector3d
  
  z axis of the frame
- point: Point3d
  
  point to be transformed
Returns Point3d
- Defined in Transform.ts:450

`Static` worldXYToFrame

worldXYToFrame(origin: Point3d, xAxis: Vector3d, yAxis: Vector3d, zAxis: Vector3d): Transform
WorldXY to Frame transformation

Returns
the transformation matrix
Parameters
- origin: Point3d
  
  origin of the frame
- xAxis: Vector3d
  
  x axis of the frame
- yAxis: Vector3d
  
  y axis of the frame
- zAxis: Vector3d
  
  z axis of the frame
Returns Transform
- Defined in Transform.ts:433

Class Transform

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

m: Array16Number

Returns Transform

Properties

Private m

Accessors

Determinant

Returns number

IsIdentity

Returns boolean

IsZeroTransformation

Returns boolean

M

Returns Array16Number

Static Identity

Returns Transform

Static ZeroTransformation

Returns Transform

Methods

Clone

Returns Transform

Equals

Parameters

other: Transform

Returns boolean

MultiplyMatrix

Returns

Parameters

other: Transform

Returns Transform

MultiplyScalar

Returns

Parameters

scalar: number

Returns Transform

ToArray

Returns Array16Number

Transpose

Returns Transform

TryGetInverse

Returns null | Transform

toString

Returns string

Static CombineTransforms

Returns

Parameters

transforms: Transform[]

Returns Transform

Static Mirror

Returns

Parameters

plane: Plane

Returns Transform

Static MultiplyMatrix

Returns

Parameters

a: Transform

b: Transform

Returns Transform

Static MultiplyScalar

Returns

Parameters

a: Transform

s: number

Returns Transform

Static PlanarProjection

Returns

Parameters

plane: Plane

Returns Transform

Static PlaneToPlane

`Private` m

`Static` Identity

`Static` ZeroTransformation

`Static` CombineTransforms

`Static` Mirror

`Static` MultiplyMatrix

`Static` MultiplyScalar

`Static` PlanarProjection

`Static` PlaneToPlane

`Static` RotateAtOrigin

`Static` Rotation

`Static` RotationX

`Static` RotationY

`Static` RotationZ

`Static` RotationZYX

`Static` Scale

`Static` ScaleAtOrigin

`Static` Translation

`Static` VectorToVector

`Static` frameToFrame