Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

ArticulationBody.GetJointForces

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Declaration

public int GetJointForces(List<float> forces);

Parameters

forces Supplied list of floats to read back and store the joint forces data.

Returns

int Total degrees of freedom for the entire hierarchy of articulation bodies.

Description

Reads back articulation body joint forces of the entire hierarchy to the supplied list of floats .

This returns joint forces in the reduced coordinate space for the entire articulation hierarchy starting from root to the supplied list of floats. Every joint force DOF is represented by one float value, however depending on the type of the articulation joint there might be zero, one or 3 DOFs per joint. The exact location of the data in resulting list for the specific articulation body can be found by calling ArticulationBody.GetDofStartIndices and indexing returned dofStartIndices list by the particular body index via ArticulationBody.index. Number of degrees of freedom for the articulation body can be found using ArticulationBody.dofCount.

Units of measurement - N (newtons) for linear and Nm (newton-meters) for angular motion.

Additional resources: index, GetDofStartIndices, dofCount, SetJointForces.