Pose3D

position

get position(): Point3D

var position: Point3D

position

set position(value: Point3D)

var position: Point3D

rotation

get rotation(): Rotation3D

var rotation: Rotation3D

rotation

set rotation(value: Rotation3D)

var rotation: Rotation3D

isIdentity

get isIdentity(): boolean

var isIdentity: Bool { get }

Returns `true` if the pose is the identity transform.

translated

translatedBy(offset: Vector3D): Pose3D

func translated(by offset: Vector3D) -> Pose3D

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

translated

translatedBy72346(size: Size3D): Pose3D

func translated(by size: Size3D) -> Pose3D

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

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.

concatenating

concatenating(transform: Pose3D): Pose3D

func concatenating(_ transform: Pose3D) -> Pose3D

Returns a transform that's constructed by concatenating two existing poses. - Parameter transform: The second pose.

concatenating

concatenating63023(transform: ScaledPose3D): ScaledPose3D

func concatenating(_ transform: ScaledPose3D) -> ScaledPose3D

Returns a transform that's constructed by concatenating two a pose and a scaled pose. - Parameter transform: The second scaled pose.

isApproximatelyEqual

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

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

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

flip

flip(axis: Axis3D): void

mutating func flip(along axis: Axis3D)

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

init

static initMatrix(matrix: SDKHandle): (Pose3D) | null

init?(matrix: simd_float4x4)

Creates a pose with the specified single-precision 4 x 4 matrix - Parameter matrix: The source matrix - note If the upper-left 3 x 3 submatrix is not a rotation matrix (that is, orthogonal with a determinant of `+1`), the function returns `nil`. If the bottom row of the matrix is not `[0,0,0,1]`, the functions returns `SPPose3DInvalid`.

init

static initMatrix96210(matrix: SDKHandle): (Pose3D) | null

init?(matrix: simd_double4x4)

Creates a pose with the specified double-precision 4 x 4 matrix - Parameter matrix: The source matrix - note: if the upper-left 3 x 3 submatrix is not a rotation matrix (that is, orthogonal with a determinant of `+1`), the function returns `nil`.

matrix

get matrix(): SDKHandle

var matrix: simd_double4x4 { get }

A 4 x 4 matrix that represents the pose's translation and rotation.

flipped

flipped(axis: Axis3D): Pose3D

func flipped(along axis: Axis3D) -> Pose3D

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

init

static initForwardUp(forward: Vector3D, up?: Vector3D): Pose3D

init(forward: Vector3D, up: Vector3D = Vector3D(x: 0, y: 1, z: 0))

Creates a pose with the specified forward and up vectors. - Parameter forward: The forward direction. - Parameter up: The up direction. - note: This function creates a pose where `+z` is forward.

inverse

get inverse(): Pose3D

var inverse: Pose3D { get }

The inverse of the pose's underlying matrix.

rotated

rotatedBy(quaternion: SDKHandle): Pose3D

func rotated(by quaternion: simd_quatd) -> Pose3D

Returns a pose with a rotation that's rotated by the specified quaternion. - Parameter quaternion: The quaternion that defines the rotation. - Returns A pose with a rotation that's rotated by the specified quaternion.

rotated

rotatedBy97519(rotation: Rotation3D): Pose3D

func rotated(by rotation: Rotation3D) -> Pose3D

Returns a pose with a rotation that's rotated by the specified rotation. - Parameter rotation: The rotation. - Returns A pose with a rotation that's rotated by the specified rotation.

applying

applying(transform: ProjectiveTransform3D): Pose3D

func applying(_ transform: ProjectiveTransform3D) -> Pose3D

Returns a pose that's transformed by the specified projective transform. - Parameter transform: The projective transform. - Returns The transformed pose. This function applies the transform to the pose.

identity

static get identity(): Pose3D

static var identity: Pose3D { get }

The identity pose.

init

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

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

Creates a pose at the specified position that's oriented towards a look at target. - Parameter position: The position of the pose. - Parameter target: The point that the ray looks at. - Parameter up: The up direction. - note: This function creates a pose where `+z` is forward.

init

static initPositionRotation(position: Point3D, rotation: Rotation3D): Pose3D

init(position: Point3D = .zero, rotation: Rotation3D)

Creates a pose from Spatial primitives that describe the position and rotation. - Parameter position: The position of the pose. - Parameter rotation: The rotation of the pose.

init

static initPositionRotation12983(position: SDKHandle, rotation: SDKHandle): Pose3D

init(position: simd_double3 = .zero, rotation: simd_quatd)

Creates a pose from double-precision simd primitives that describe the position and rotation. - Parameter position: The position of the pose. - Parameter rotation: The rotation of the pose.

init

static initPositionRotation32075(position: SDKHandle, rotation: SDKHandle): Pose3D

init(position: simd_float3 = .zero, rotation: simd_quatf)

Creates a pose from single-precision simd primitives that describe the position and rotation. - Parameter position: The position of the pose. - Parameter rotation: The rotation of the pose.

init

static initTransform(transform: AffineTransform3D): (Pose3D) | null

init?(transform: AffineTransform3D)

Creates a pose with with a position and rotation that are defined by an affine transform. - Parameter transform: The source transform. The function only considers the transform's rotation and translation components. - Returns: A pose with a position and rotation that are defined by an affine transform. - note: This function can't extract rotation from a non-scale-rotate-translate affine transform. In that case, the function returns `nil`.

init

static initTransform52696(transform: ProjectiveTransform3D): (Pose3D) | null

init?(transform: ProjectiveTransform3D)

Creates a pose with with a position and rotation that are defined by a projective transform. - Parameter transform: The source transform. The function only considers the transform's rotation and translation components. - Returns: A pose with a position and rotation that are defined by a projective transform. - note: This function can't extract rotation from a non-scale-rotate-translate affine transform. In that case, the function returns `nil`.

init

static init(matrix: SDKHandle): (Pose3D) | null

init?(_ matrix: simd_float4x4)

Creates a pose with the specified single-precision 4 x 4 matrix - Parameter matrix: The source matrix - note: This function can't extract rotation from a non-scale-rotate-translate affine transform. In that case, the function returns `nil`.

init

static init18543(matrix: SDKHandle): (Pose3D) | null

init?(_ matrix: simd_double4x4)

Creates a pose with the specified double-precision 4 x 4 matrix - Parameter matrix: The source matrix - note: This function can't extract rotation from a non-scale-rotate-translate affine transform. In that case, the function returns `nil`.

init

static init208(pose: Pose3DFloat): Pose3D

init(_ pose: Pose3DFloat)

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

init

static initPositionRotation57303(position: Point3D, rotation: Rotation3D): Pose3D

init(position: Point3D, rotation: Rotation3D)

Creates a pose from Spatial primitives that describe the position and rotation. - Parameter position: The position of the pose. - Parameter rotation: The rotation of the pose.

init

static init39526(): Pose3D

init()