Rotation3D

eulerAngles

eulerAngles(order: SDKHandle): EulerAngles

func eulerAngles(order: __SPEulerAngleOrder) -> EulerAngles

inverse

get inverse(): Rotation3D

var inverse: Rotation3D { get }

isIdentity

get isIdentity(): boolean

var isIdentity: Bool { get }

isZero

get isZero(): boolean

var isZero: Bool { get }

init

static initAngleAxis(angle: Angle2D, axis: RotationAxis3D): Rotation3D

init(angle: Angle2D, axis: RotationAxis3D)

init

static initForwardUp(forward: Vector3D, up: Vector3D): Rotation3D

init(forward: Vector3D, up: Vector3D)

init

static initEulerAngles(eulerAngles: EulerAngles): Rotation3D

init(eulerAngles: EulerAngles)

swing

swing(twistAxis: RotationAxis3D): Rotation3D

func swing(twistAxis: RotationAxis3D) -> Rotation3D

twist

twist(twistAxis: RotationAxis3D): Rotation3D

func twist(twistAxis: RotationAxis3D) -> Rotation3D

identity

static get identity(): Rotation3D

static let identity: Rotation3D

zero

static get zero(): Rotation3D

static let zero: Rotation3D

quaternion

get quaternion(): SDKHandle

var quaternion: simd_quatd { get set }

quaternion

set quaternion(value: SDKHandle)

var quaternion: simd_quatd { get set }

vector

get vector(): SDKHandle

var vector: simd_double4 { get set }

vector

set vector(value: SDKHandle)

var vector: simd_double4 { get set }

init

static initQuaternion(quaternion: SDKHandle): Rotation3D

init(quaternion: simd_quatd)

init

static initQuaternion76540(quaternion: SDKHandle): Rotation3D

init(quaternion: simd_quatd)

init

static initQuaternion70374(quaternion: SDKHandle): Rotation3D

init(quaternion: simd_quatf)

swingTwist

swingTwist(twistAxis: RotationAxis3D): { "swing": Rotation3D; "twist": Rotation3D }

func swingTwist(twistAxis: RotationAxis3D) -> (swing: Rotation3D, twist: Rotation3D)

Returns the rotation's swing-twist decomposition for a given twist axis. - Parameter twistAxis The twist axis. - Returns: A tuple that contains the swing rotation and the twist rotation.

description

get description(): string

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.

customMirror

get customMirror(): SDKHandle

var customMirror: Mirror { get }

The custom mirror for this instance.

isApproximatelyEqual

isApproximatelyEqual(other: Rotation3D, tolerance?: number): boolean

func isApproximatelyEqual(to other: Rotation3D, tolerance: Double = sqrt(.ulpOfOne)) -> Bool

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

init

static initEyeTargetUp(eye: Point3D, target: Point3D, up?: Vector3D): Rotation3D

init(eye: Point3D, target: Point3D, up: Vector3D = Vector3D(x: 0, y: 1, z: 0))

init

static initAxisAngle(axis: RotationAxis3D, angle: Angle2D): Rotation3D

init(axis: RotationAxis3D, angle: Angle2D)

axis

get axis(): RotationAxis3D

var axis: RotationAxis3D { get set }

The axis of the rotation.

axis

set axis(value: RotationAxis3D)

var axis: RotationAxis3D { get set }

The axis of the rotation.

angle

get angle(): Angle2D

var angle: Angle2D { get set }

The angle of the rotation.

angle

set angle(value: Angle2D)

var angle: Angle2D { get set }

The angle of the rotation.

slerp

static slerp(from: Rotation3D, to: Rotation3D, t: number, path?: Rotation3D_SlerpPath): Rotation3D

static func slerp(from: Rotation3D, to: Rotation3D, t: Double, along path: Rotation3D.SlerpPath = .shortest) -> Rotation3D

Returns the spherical linear interpolation along the either the shortest or longest arc between two rotations.

spline

static spline(r0: Rotation3D, r1: Rotation3D, r2: Rotation3D, r3: Rotation3D, t: number): Rotation3D

static func spline(leftEndpoint r0: Rotation3D, from r1: Rotation3D, to r2: Rotation3D, rightEndpoint r3: Rotation3D, t: Double) -> Rotation3D

Returns an interpolated value between two rotations along a spherical cubic spline. - Parameter leftEndpoint: The left endpoint of the previous interval. - Parameter from: The starting rotation. - Parameter to: The ending rotation. - Parameter rightEndpoint: The right endpoint of the previous interval. Use this function to smoothly interpolate between a sequence of rotations. - returns: A new rotation that's the interpolated value between the two rotations along a spherical cubic spline.

init

static initForward(forward: Vector3D): Rotation3D

init(forward: Vector3D)

Returns a rotation with the specified forward vector. - Parameter forward The forward direction. - note: This function creates a rotation with an up vector that's `Vector3D(x: 0, y: 1, z: 0)` and where `+z` is forward.

rotated

rotatedBy(rotation: Rotation3D): Rotation3D

func rotated(by rotation: Rotation3D) -> Rotation3D

Returns the entity rotated by the specified rotation around the origin. - Parameter rotation: The rotation. - Returns The rotated primitive.

rotated

rotatedBy67528(quaternion: SDKHandle): Rotation3D

func rotated(by quaternion: simd_quatd) -> Rotation3D

Returns the entity rotated by the specified quaternion around the origin. - Parameter quaternion: The quaternion that defines the rotation. - Returns The rotated primitive.

applying

applying(transform: ProjectiveTransform3D): Rotation3D

func applying(_ transform: ProjectiveTransform3D) -> Rotation3D

Returns a rotation that's transformed by the specified projective transform. - Parameter transform: The projective transform. - Returns The transformed rotation. In the case where Spatial is unable to successfully apply the transform, the function returns `.identity`. This function applies the transform to the rotation.

init

static initPositionTargetUp(position: Point3D, target: Point3D, up?: Vector3D): Rotation3D

init(position: Point3D = Point3D(x: 0, y: 0, z: 0), target: Point3D, up: Vector3D = Vector3D(x: 0, y: 1, z: 0))

Returns a rotation that's the look at direction from the eye position to the target. - Parameter position: The eye position. - Parameter target: The point that the rotation looks at. - Parameter up: The up direction. - note: This function creates a rotation where `+z` is forward.

init

static init(): Rotation3D

@backDeployed(before: macOS 14.0, iOS 17.0, tvOS 17.0, watchOS 10.0)
init()

init

static init50532(rotation: Rotation3DFloat): Rotation3D

init(_ rotation: Rotation3DFloat)

Returns a double-precision rotation from a single-precision rotation.

init

static init42427(quaternion: SDKHandle): Rotation3D

init(_ quaternion: simd_quatd)

init

static init98869(quaternion: SDKHandle): Rotation3D

init(_ quaternion: simd_quatf)

Returns a new rotation from a single-precision quaternion. - note: This function is provided as a convenience. All Spatial storage and calculations are double-precision.

init

static init15708(source: SDKHandle): Rotation3D

init(_ source: simd_packed_double4)

Creates a Spatial rotation from a simd packed vector.

init

static init61098(): Rotation3D

init()