Skip to content

raisim::ArticulatedSystem::IKResult ​

struct · #include <raisim/object/ArticulatedSystem/ArticulatedSystem.hpp>

Result of solveIK().

Public attributes ​

success ​

cpp
bool success

True if both the position and (if enabled) orientation tolerances were met.

iterations ​

cpp
int iterations

Index of the last evaluated iteration.

bestIteration ​

cpp
int bestIteration

Index of the iteration with the lowest residual.

residual ​

cpp
double residual

Combined residual: sqrt(positionResidual^2 + (orientationWeight * orientationResidual)^2).

positionResidual ​

cpp
double positionResidual

Frame position error norm [m].

orientationResidual ​

cpp
double orientationResidual

Frame orientation error norm [rad] (0 if the orientation task is disabled).

bestResidual ​

cpp
double bestResidual

Lowest combined residual found.

bestPositionResidual ​

cpp
double bestPositionResidual

Position residual of the best iterate [m].

bestOrientationResidual ​

cpp
double bestOrientationResidual

Orientation residual of the best iterate [rad].

solution ​

cpp
std::vector<double> solution

Resulting generalized coordinate. On a failure without applyBestOnFailure, this is the original one.

bestSolution ​

cpp
std::vector<double> bestSolution

Generalized coordinate of the best iterate.

bestFramePosition ​

cpp
Vec<3> bestFramePosition

World-frame position of the frame at the best iterate [m].

bestFrameOrientation ​

cpp
Mat<3, 3> bestFrameOrientation

World-frame orientation of the frame at the best iterate.

message ​

cpp
std::string message

"ok" on success; otherwise a description of the failure.

RaiSim — physics for robotics and AI.