Prims

Get Relative Pose

Calculates the relative pose between two objects specified by their prim paths.

Supports four modes of operation:

ModeDescription
normalComputes prim1::prim2
inverse_firstComputes ~prim1::prim2
inverse_secondComputes prim1::~prim2
inverse_bothComputes ~prim1::~prim2

The resulting pose is returned in WS 6D format. Rotations are in radians, position in millimeters. The coordinate system used depends on the rotation_type parameter: either 'cartesian' or 'quaternion'.

get/prims/poses/relative

Query parameters

mode'normal' | 'inverse_first' | 'inverse_second' | 'inverse_both'

The mode of operation

rotation_type'cartesian' | 'quaternions'
prim_path_1string required

Prim path of the object

Prim path of the object

prim_path_2string required

Prim path of the object

Prim path of the object

Response

Successfully retrieved the relative pose

OR

Changes

No recorded changes to this endpoint across all 13 revisions of this API.