Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetDriveTargetVelocities(List<float>)

Reads back articulation body joint drive target velocities of the entire hierarchy to the supplied list of floats.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule
public int GetDriveTargetVelocities(List<float> targetVelocities)

Parameters

targetVelocities

Supplied list of floats to read back and store the joint drive target velocities data.

Returns

Type

Description

intTotal degrees of freedom for the entire hierarchy of articulation bodies.

Remarks

This returns joint drive target velocities in the reduced coordinate space for the entire articulation hierarchy starting from root to the supplied list of floats. Every joint target velocity 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 - m/s (meters per second) for linear and rad/s (radians per second) for angular motion.