One Logo Pool Ball
Spatial · IOS API REFERENCE

AffineTransform3D

struct · iOS 16.0+ · SDK 27.1

struct AffineTransform3D

Members (59)

method · iOS 16.0+

concatenating

TypeScript
concatenating(t2: AffineTransform3D): AffineTransform3D
Swift declaration
func concatenating(_ t2: AffineTransform3D) -> AffineTransform3D
get · iOS 16.0+

matrix3x3

TypeScript
get matrix3x3(): SDKHandle
Swift declaration
var matrix3x3: simd_double3x3 { get }
get · iOS 16.0+

matrix4x4

TypeScript
get matrix4x4(): SDKHandle
Swift declaration
var matrix4x4: simd_double4x4 { get }
get · iOS 16.0+

scale

TypeScript
get scale(): Size3D
Swift declaration
var scale: Size3D { get }
get · iOS 16.0+

isIdentity

TypeScript
get isIdentity(): boolean
Swift declaration
var isIdentity: Bool { get }
get · iOS 16.0+

isInvertible

TypeScript
get isInvertible(): boolean
Swift declaration
var isInvertible: Bool { get }
get · iOS 16.0+

isRectilinear

TypeScript
get isRectilinear(): boolean
Swift declaration
var isRectilinear: Bool { get }
get · iOS 16.0+

isTranslation

TypeScript
get isTranslation(): boolean
Swift declaration
var isTranslation: Bool { get }
get · iOS 16.0+

isUniform

TypeScript
get isUniform(): boolean
Swift declaration
var isUniform: Bool { get }
init · iOS 16.0+

init

TypeScript
static initRotation(rotation: Rotation3D): AffineTransform3D
Swift declaration
init(rotation: Rotation3D)
init · iOS 16.0+

init

TypeScript
static initScale(scale: Size3D): AffineTransform3D
Swift declaration
init(scale: Size3D)
init · iOS 16.0+

init

TypeScript
static initTranslation(offset: Vector3D): AffineTransform3D
Swift declaration
init(translation offset: Vector3D)
init · iOS 16.0+

init

TypeScript
static init(matrix: SDKHandle): AffineTransform3D
Swift declaration
init(_ matrix: simd_double4x3)
init · iOS 18.0+

init

TypeScript
static initTruncating(matrix: SDKHandle): AffineTransform3D
Swift declaration
init(truncating matrix: simd_double4x4)
init · iOS 17.0+

init

TypeScript
static initTruncating63499(transform: ProjectiveTransform3D): AffineTransform3D
Swift declaration
init(truncating transform: ProjectiveTransform3D)
method · iOS 16.0+

rotated

TypeScript
rotatedBy(rotation: Rotation3D): AffineTransform3D
Swift declaration
func rotated(by rotation: Rotation3D) -> AffineTransform3D
method · iOS 16.0+

rotated

TypeScript
rotatedBy49800(quaternion: SDKHandle): AffineTransform3D
Swift declaration
func rotated(by quaternion: simd_quatd) -> AffineTransform3D
method · iOS 16.0+

scaled

TypeScript
scaled(scale: Size3D): AffineTransform3D
Swift declaration
func scaled(by scale: Size3D) -> AffineTransform3D
method · iOS 16.0+

uniformlyScaled

TypeScript
uniformlyScaled(scale: number): AffineTransform3D
Swift declaration
func uniformlyScaled(by scale: Double) -> AffineTransform3D
method · iOS 16.0+

translated

TypeScript
translatedBy(offset: Vector3D): AffineTransform3D
Swift declaration
func translated(by offset: Vector3D) -> AffineTransform3D
get · iOS 16.0+

matrix

TypeScript
get matrix(): SDKHandle
Swift declaration
var matrix: simd_double4x3
set · iOS 16.0+

matrix

TypeScript
set matrix(value: SDKHandle)
Swift declaration
var matrix: simd_double4x3
get · iOS 16.0+

identity

TypeScript
static get identity(): AffineTransform3D
Swift declaration
static let identity: AffineTransform3D
init · iOS 16.0+

init

TypeScript
static initMatrix(matrix: SDKHandle): AffineTransform3D
Swift declaration
init(matrix: simd_double4x3)
init · iOS 18.0+

init

TypeScript
static initScaledPose(scaledPose: ScaledPose3D): AffineTransform3D
Swift declaration
init(scaledPose: ScaledPose3D)
method · iOS 16.0+

translated

TypeScript
translatedBy63138(size: Size3D): AffineTransform3D
Swift declaration
func translated(by size: Size3D) -> AffineTransform3D

Returns the entity translated by the specified size. - Parameter size: The size structure that defines that translation.

init · iOS 18.0+

init

TypeScript
static initTruncating50825(matrix: SDKHandle): AffineTransform3D
Swift declaration
init(truncating matrix: simd_float4x4)

Returns a new affine transform from a single-precision 4 x 4 matrix truncated to a 4 x 3 matrix. - Parameter matrix: The source matrix. - note: This function is provided as a convenience. All Spatial storage and calculations are double-precision.

method · iOS 18.0+

changeBasis

TypeScript
changeBasis(from: AffineTransform3D, to: AffineTransform3D): (AffineTransform3D) | null
Swift declaration
func changeBasis(from: AffineTransform3D = .identity, to: AffineTransform3D) -> AffineTransform3D?

Returns a new affine transform structure by applying a change-of-basis. - Parameter from: The old basis. - Parameter to: The new basis. - returns: A new affine transform structure.

get · iOS 16.0+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

init · iOS 16.0+

init

TypeScript
static initTranslation40947(translation: Size3D): AffineTransform3D
Swift declaration
init(translation: Size3D)
get · iOS 16.0+

translation

TypeScript
get translation(): Vector3D
Swift declaration
var translation: Vector3D { get set }

The translation component

set · iOS 16.0+

translation

TypeScript
set translation(value: Vector3D)
Swift declaration
var translation: Vector3D { get set }

The translation component

get · iOS 18.0+

customMirror

TypeScript
get customMirror(): SDKHandle
Swift declaration
var customMirror: Mirror { get }

The custom mirror for this instance.

init · iOS 16.0+

init

TypeScript
static initProjectiveTransform(transform: ProjectiveTransform3D): (AffineTransform3D) | null
Swift declaration
init?(projectiveTransform transform: ProjectiveTransform3D)

Returns a new affine transform from a projective transform. - Parameter transform: The source projective transform. - Note The projective transform must be affine, that is, its last row must be `0, 0, 0, 1`, otherwise this initialiser returns `nil`.

method · iOS 16.0+

isApproximatelyEqual

TypeScript
isApproximatelyEqual(other: AffineTransform3D, tolerance?: number): boolean
Swift declaration
func isApproximatelyEqual(to other: AffineTransform3D, tolerance: Double = sqrt(.ulpOfOne)) -> Bool

Returns a Boolean value that indicates whether two transforms are equal within a specified tolerance. - Parameter transform: The second transform. - Parameter tolerance: The tolerance of the comparison.

method · iOS 16.0+

flip

TypeScript
flip(axis: Axis3D): void
Swift declaration
mutating func flip(along axis: Axis3D)

Flips the transform along the specified axis. - Parameter axis: The axis of the flip operation.

init · iOS 16.0+

init

TypeScript
static initPose(pose: Pose3D): AffineTransform3D
Swift declaration
init(pose: Pose3D)

Returns a new transform from the specified pose. - Parameter pose: The source pose

init · iOS 16.0+

init

TypeScript
static initScaleRotationTranslation(scale: Size3D, rotation: Rotation3D, translation: Size3D): AffineTransform3D
Swift declaration
init(scale: Size3D = Size3D(width: 1.0, height: 1, depth: 1), rotation: Rotation3D = .zero, translation: Size3D)

Returns a new scale, rotate, translate transform. - Parameter scale: The scale. - Parameter rotation: The rotation. - Parameter translation: The translation.

init · iOS 16.0+

init

TypeScript
static initScaleRotationTranslation39069(scale?: Size3D, rotation?: Rotation3D, translation?: Vector3D): AffineTransform3D
Swift declaration
init(scale: Size3D = Size3D(width: 1.0, height: 1, depth: 1), rotation: Rotation3D = .zero, translation: Vector3D = .zero)

Returns a new scale, rotate, translate transform. - Parameter scale: The scale. - Parameter rotation: The rotation. - Parameter translation: The translation.

init · iOS 16.0+

init

TypeScript
static initShear(shear: AxisWithFactors): AffineTransform3D
Swift declaration
init(shear: AxisWithFactors)

Returns a new shear transform - Parameter shear: The shear.

init · iOS 16.0+

init

TypeScript
static initMatrix68970(matrix: SDKHandle): (AffineTransform3D) | null
Swift declaration
init?(matrix: simd_float4x4)

Returns a new affine transform from a single-precision 4 x 4 matrix. - Parameter matrix: The source matrix. - Note The the last row of the source matrix must be `0, 0, 0, 1`, otherwise this initialiser returns `nil`. - note: This function is provided as a convenience. All Spatial storage and calculations are double-precision.

init · iOS 16.0+

init

TypeScript
static initMatrix33370(matrix: SDKHandle): (AffineTransform3D) | null
Swift declaration
init?(matrix: simd_double4x4)

Returns a new affine transform from a double-precision 4 x 4 matrix. - Parameter matrix: The source matrix. - Note The the last row of the source matrix must be `0, 0, 0, 1`, otherwise this initialiser returns `nil`.

init · iOS 16.0+

init

TypeScript
static initMatrix56657(matrix: SDKHandle): AffineTransform3D
Swift declaration
init(matrix: simd_float4x3)

Returns a new affine transform structure from the specified single-precision 4 x 3 matrix. - note: This function is provided as a convenience. All Spatial storage and calculations are double-precision.

get · iOS 16.0+

offset

TypeScript
get offset(): Vector3D
Swift declaration
var offset: Vector3D { get set }
set · iOS 16.0+

offset

TypeScript
set offset(value: Vector3D)
Swift declaration
var offset: Vector3D { get set }
get · iOS 26.0+

columns

TypeScript
get columns(): [Vector3D, Vector3D, Vector3D, Vector3D]
Swift declaration
var columns: (Vector3D, Vector3D, Vector3D, Vector3D) { get }

The columns of the underlying matrix.

method · iOS 16.0+

flipped

TypeScript
flipped(axis: Axis3D): AffineTransform3D
Swift declaration
func flipped(along axis: Axis3D) -> AffineTransform3D

Returns the transform flipped along the specified axis. - Parameter axis: The axis of the flip operation.

get · iOS 16.0+

inverse

TypeScript
get inverse(): (AffineTransform3D) | null
Swift declaration
var inverse: AffineTransform3D? { get }

The affine transform's inverse. If the source transform isn't invertible, this value is `nil`.

method · iOS 16.0+

sheared

TypeScript
sheared(shear: AxisWithFactors): AffineTransform3D
Swift declaration
func sheared(_ shear: AxisWithFactors) -> AffineTransform3D

Returns the transform sheared by the specified shear. - Parameter shear: The axis and shear factors. - Returns The sheared transform.

method · iOS 16.0+

inverted

TypeScript
inverted(): (AffineTransform3D) | null
Swift declaration
func inverted() -> AffineTransform3D?
get · iOS 16.0+

rotation

TypeScript
get rotation(): (Rotation3D) | null
Swift declaration
var rotation: Rotation3D? { get }

The affine transform's rotation. This function can't extract rotation from a non-scale-rotate-translate affine transform. In that case, the function returns `nil`.

method · iOS 16.0+

scaledBy

TypeScript
scaledBy(x?: number, y?: number, z?: number): AffineTransform3D
Swift declaration
func scaledBy(x: Double = 1, y: Double = 1, z: Double = 1) -> AffineTransform3D

Returns the transform scaled by the specified values. - Parameter x: The scale factor on the `x` dimension. - Parameter y: The scale factor on the `y` dimension. - Parameter z: The scale factor on the `z` dimension. - Returns The scaled transform.

method · iOS 16.0+

isUniform

TypeScript
isUniformOverDimensions(overDimensions: Dimension3DSet): boolean
Swift declaration
func isUniform(overDimensions: Dimension3DSet) -> Bool

Returns `true` if the transform is uniform over the specified dimensions. - Parameter overDimensions: The dimensions that the function tests are uniform. If you specify `overDimensions` as `Dimension3DSet.all`, the function returns the same result as `Transform3D.getter:isUniform`. If you specify as `overDimensions` with zero or one dimension, the function returns the same result as `Transform3D.getter:isRectilinear`.

init · iOS 16.0+

init

TypeScript
static init4476(): AffineTransform3D
Swift declaration
init()

Returns a new identity affine transform.

init · iOS 16.0+

init

TypeScript
static init51967(matrix: SDKHandle): (AffineTransform3D) | null
Swift declaration
init?(_ matrix: simd_float4x4)

Returns a new affine transform from a single-precision 4 x 4 matrix. - Parameter matrix: The source matrix. - Note The the last row of the source matrix must be `0, 0, 0, 1`, otherwise this initialiser returns `nil`. - note: This function is provided as a convenience. All Spatial storage and calculations are double-precision.

init · iOS 16.0+

init

TypeScript
static init50055(matrix: SDKHandle): (AffineTransform3D) | null
Swift declaration
init?(_ matrix: simd_double4x4)

Returns a new affine transform from a double-precision 4 x 4 matrix. - Parameter matrix: The source matrix. - Note The the last row of the source matrix must be `0, 0, 0, 1`, otherwise this initialiser returns `nil`.

init · iOS 26.0+

init

TypeScript
static init74456(transform: AffineTransform3DFloat): AffineTransform3D
Swift declaration
init(_ transform: AffineTransform3DFloat)

Returns a double-precision affine transformation from a single-precision affine transformation.

init · iOS 16.0+

init

TypeScript
static init64960(matrix: SDKHandle): AffineTransform3D
Swift declaration
init(_ matrix: simd_float4x3)

Returns a new affine transform structure from the specified single-precision 4 x 3 matrix. - note: This function is provided as a convenience. All Spatial storage and calculations are double-precision.

init · iOS 16.0+

init

TypeScript
static init74606(): AffineTransform3D
Swift declaration
init()

Returns a new identity affine transform.

Skipped declarations

No declarations were skipped in this snapshot.

All Spatial types →