| PST SDK 6.0.0.0-272350a

SetRelativeReference

The current reference system is transformed using the supplied transformation matrix

Transform the current reference system using the supplied transformation matrix. The reference system is defined by a homogeneous transformation matrix (a row-major 4x4 matrix) representing a right-handed Cartesian coordinate system. The function checks if a valid, orthogonal transformation matrix has been supplied. When an invalid matrix has been supplied, it will not be applied.

See also: PSTapi/SetReference and PSTapi/SetDefaultReference

Endpoint

      POST /PSTapi/SetRelativeReference    HTTP/1.1
      Host: address:port

TransformationMatrix Object

Key | Value Type | Description
--- | --- | ---
TransformationMatrix | array of double | Transformation Matrix to apply to the Reference Matrix. Array of 16 floats representing a row-major 4x4 homogeneous transformation matrix

POST Payload: Request body parameters example

      {"TransformationMatrix":[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]}

Response

Returns an array of 16 floats representing the new Reference system as a row-major 4x4 homogeneous transformation matrix

ReferenceMatrix Object

Key | Value Type | Description
--- | --- | ---
ReferenceMatrix | Array of numbers | Reference Matrix. Array of 16 floats representing a row-major 4x4 homogeneous transformation matrix

Example

      {"ReferenceMatrix":[1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1]}

Verification table

Status Code | Content Example | Meaning
--- | --- | ---
200 | JSON payload | Success message
400 | {"message":"JSON_ERROR: <...>"} | An error occurred when parsing a JSON object
500 | {"message":"TrackerException: <...>"} | An other type of internal error