Vision · IOS API REFERENCE

HumanBodyPose3DObservation

struct · iOS 18.0+ · SDK 27.1

struct HumanBodyPose3DObservation

An observation that provides the three-dimensional body points the request recognizes.

Members (16)

get · iOS 18.0+

bodyHeight

TypeScript

get bodyHeight(): _Foundation_Measurement<_Foundation_UnitLength>

Swift declaration

let bodyHeight: Measurement<UnitLength>

The estimated human body height.

get · iOS 18.0+

confidence

TypeScript

get confidence(): number

Swift declaration

let confidence: Float

The level of confidence normalized to `[0, 1]` where `1` is most confident. The only exception is results coming from `CoreMLRequest`, where confidence values are forwarded as is from relevant CoreML models

get · iOS 18.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.

method · iOS 18.0+

pointInImage

TypeScript

pointInImage(jointName: HumanBodyPose3DObservation_JointName): NormalizedPoint

Swift declaration

func pointInImage(for jointName: HumanBodyPose3DObservation.JointName) -> NormalizedPoint

Returns a 2D point for the joint name you specify, relative to the input image. - Parameters: - jointName: The name of the human body joint. - Returns: A projection of the 3D position onto the original 2D image in normalized, lower left origin coordinates.

method · iOS 18.0+

parentJointName

TypeScript

parentJointName(jointName: HumanBodyPose3DObservation_JointName): HumanBodyPose3DObservation_JointName

Swift declaration

func parentJointName(for jointName: HumanBodyPose3DObservation.JointName) -> HumanBodyPose3DObservation.JointName

Returns the parent joint of the joint name you specify.

get · iOS 18.0+

cameraOriginMatrix

TypeScript

get cameraOriginMatrix(): SDKHandle

Swift declaration

let cameraOriginMatrix: simd_float4x4

A transform from the skeleton hip to the camera.

get · iOS 18.0+

availableJointNames

TypeScript

get availableJointNames(): Array<HumanBodyPose3DObservation_JointName>

Swift declaration

var availableJointNames: [HumanBodyPose3DObservation.JointName] { get }

The names of the available joints in the observation.

method · iOS 18.0+

cameraRelativePosition

TypeScript

cameraRelativePosition(jointName: HumanBodyPose3DObservation_JointName): SDKHandle

Swift declaration

func cameraRelativePosition(for jointName: HumanBodyPose3DObservation.JointName) -> simd_float4x4

Returns a position relative to the camera for the body joint you specify. - Parameters: - jointName: The name of the human body joint. - Returns: The joint position, in meters.

get · iOS 18.0+

availableJointsGroupNames

TypeScript

get availableJointsGroupNames(): Array<HumanBodyPose3DObservation_JointsGroupName>

Swift declaration

var availableJointsGroupNames: [HumanBodyPose3DObservation.JointsGroupName] { get }

The names of the available joint groupings in the observation.

get · iOS 18.0+

heightEstimationTechnique

TypeScript

get heightEstimationTechnique(): HumanBodyPose3DObservation_EstimationTechnique

Swift declaration

let heightEstimationTechnique: HumanBodyPose3DObservation.EstimationTechnique

The technique the framework uses to estimate body height.

get · iOS 18.0+

originatingRequestDescriptor

TypeScript

get originatingRequestDescriptor(): (RequestDescriptor) | null

Swift declaration

let originatingRequestDescriptor: RequestDescriptor?

The descriptor of the request that produced the observation.

get · iOS 18.0+

uuid

TypeScript

get uuid(): string

Swift declaration

let uuid: UUID

The unique identifier for the observation.

method · iOS 18.0+

joint

TypeScript

joint(jointName: HumanBodyPose3DObservation_JointName): (Joint3D) | null

Swift declaration

func joint(for jointName: HumanBodyPose3DObservation.JointName) -> Joint3D?

Retrieves a joint for a given joint name.

method · iOS 18.0+

allJoints

TypeScript

allJoints(groupName?: (HumanBodyPose3DObservation_JointsGroupName) | null): NativeMap<HumanBodyPose3DObservation_JointName, Joint3D>

Swift declaration

func allJoints(in groupName: HumanBodyPose3DObservation.JointsGroupName? = nil) -> [HumanBodyPose3DObservation.JointName : Joint3D]

Retrieves a dictionary of joints for a joint group.

get · iOS 18.0+

timeRange

TypeScript

get timeRange(): (_CoreMedia_CMTimeRange) | null

Swift declaration

let timeRange: CMTimeRange?

The time range of the reported observation. When evaluating a sequence of image buffers, use this property to determine each observation’s start time and duration.

init · iOS 18.0+

init

TypeScript

static init(observation: VNHumanBodyPose3DObservation): HumanBodyPose3DObservation

Swift declaration

init(_ observation: VNHumanBodyPose3DObservation)

Skipped declarations

No declarations were skipped in this snapshot.

All Vision types →