Rotation3DFloat

eulerAngles

eulerAngles(order: SDKHandle): EulerAnglesFloat

func eulerAngles(order: __SPEulerAngleOrder) -> EulerAnglesFloat

inverse

get inverse(): Rotation3DFloat

var inverse: Rotation3DFloat { get }

isIdentity

get isIdentity(): boolean

var isIdentity: Bool { get }

init

static initEulerAngles(eulerAngles: EulerAnglesFloat): Rotation3DFloat

init(eulerAngles: EulerAnglesFloat)

swing

swing(twistAxis: RotationAxis3DFloat): Rotation3DFloat

func swing(twistAxis: RotationAxis3DFloat) -> Rotation3DFloat

twist

twist(twistAxis: RotationAxis3DFloat): Rotation3DFloat

func twist(twistAxis: RotationAxis3DFloat) -> Rotation3DFloat

identity

static get identity(): Rotation3DFloat

static let identity: Rotation3DFloat

quaternion

get quaternion(): SDKHandle

var quaternion: simd_quatf { get set }

quaternion

set quaternion(value: SDKHandle)

var quaternion: simd_quatf { get set }

vector

get vector(): SDKHandle

var vector: simd_float4 { get set }

vector

set vector(value: SDKHandle)

var vector: simd_float4 { get set }

init

static initQuaternion(quaternion: SDKHandle): Rotation3DFloat

init(quaternion: simd_quatf)

swingTwist

swingTwist(twistAxis: RotationAxis3DFloat): { "swing": Rotation3DFloat; "twist": Rotation3DFloat }

func swingTwist(twistAxis: RotationAxis3DFloat) -> (swing: Rotation3DFloat, twist: Rotation3DFloat)

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: Rotation3DFloat, tolerance?: number): boolean

func isApproximatelyEqual(to other: Rotation3DFloat, tolerance: Float = 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.

axis

get axis(): RotationAxis3DFloat

var axis: RotationAxis3DFloat { get set }

The axis of the rotation.

axis

set axis(value: RotationAxis3DFloat)

var axis: RotationAxis3DFloat { get set }

The axis of the rotation.

init

static initAngleAxis(angle: Angle2DFloat, axis: RotationAxis3DFloat): Rotation3DFloat

init(angle: Angle2DFloat, axis: RotationAxis3DFloat)

angle

get angle(): Angle2DFloat

var angle: Angle2DFloat { get set }

The angle of the rotation.

angle

set angle(value: Angle2DFloat)

var angle: Angle2DFloat { get set }

The angle of the rotation.

slerp

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

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

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

spline

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

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

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 initForwardUp(forward: Vector3DFloat, up: Vector3DFloat): Rotation3DFloat

init(forward: Vector3DFloat, up: Vector3DFloat)

init

static initForward(forward: Vector3DFloat): Rotation3DFloat

init(forward: Vector3DFloat)

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: Rotation3DFloat): Rotation3DFloat

func rotated(by rotation: Rotation3DFloat) -> Rotation3DFloat

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

rotated

rotatedBy56809(quaternion: SDKHandle): Rotation3DFloat

func rotated(by quaternion: simd_quatf) -> Rotation3DFloat

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: ProjectiveTransform3DFloat): Rotation3DFloat

func applying(_ transform: ProjectiveTransform3DFloat) -> Rotation3DFloat

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: Point3DFloat, target: Point3DFloat, up?: Vector3DFloat): Rotation3DFloat

init(position: Point3DFloat = Point3DFloat(x: 0, y: 0, z: 0), target: Point3DFloat, up: Vector3DFloat = Vector3DFloat(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(): Rotation3DFloat

init()

init

static init76276(rotation: Rotation3D): Rotation3DFloat

init(_ rotation: Rotation3D)

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

init

static init31072(quaternion: SDKHandle): Rotation3DFloat

init(_ quaternion: simd_quatd)

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

init

static init1738(quaternion: SDKHandle): Rotation3DFloat

init(_ quaternion: simd_quatf)

init

static init38047(source: SDKHandle): Rotation3DFloat

init(_ source: simd_packed_float4)

Creates a Spatial rotation from a simd packed vector.

init

static init76481(): Rotation3DFloat

init()