Drake
KinematicsResults< T > Class Template Reference

A class containing the kinematics results from a RigidBodyPlant system. More...

#include <drake/multibody/rigid_body_plant/kinematics_results.h>

Public Member Functions

 KinematicsResults (const RigidBodyTree< T > *tree)
 Constructs a KinematicsResults object associated with. More...
 
void Update (const Eigen::Ref< const VectorX< T >> &q, const Eigen::Ref< const VectorX< T >> &v)
 Updates the KinematicsResults object given the configuration vector. More...
 
int get_num_bodies () const
 Returns the number of bodies in the kinematics results. More...
 
int get_num_positions () const
 Returns the number of generalized positions. More...
 
int get_num_velocities () const
 Returns the number of generalized velocities. More...
 
Quaternion< T > get_body_orientation (int body_index) const
 Returns the quaternion representation of the three dimensional orientation of body body_index in the world's frame. More...
 
Vector3< T > get_body_position (int body_index) const
 Returns the three dimensional position of body body_index in world's frame. More...
 
Isometry3< T > get_pose_in_world (const RigidBody< T > &body) const
 Returns the pose of body body with respect to the world. More...
 
TwistVector< T > get_twist_in_world_frame (const RigidBody< T > &body) const
 Returns the twist of body with respect to the world, expressed in world frame. More...
 
TwistVector< T > get_twist_in_world_aligned_body_frame (const RigidBody< T > &body) const
 Returns the twist of body with respect to the world, expressed in world frame. More...
 
Eigen::VectorBlock< const VectorX< T > > get_joint_position (const RigidBody< T > &body) const
 Returns the joint position vector associated with the joint between body and body's parent. More...
 
Eigen::VectorBlock< const VectorX< T > > get_joint_velocity (const RigidBody< T > &body) const
 Returns the joint velocity vector associated with the joint between body and body's parent. More...
 
const KinematicsCache< T > & get_cache () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 KinematicsResults (const KinematicsResults &)=default
 
KinematicsResultsoperator= (const KinematicsResults &)=default
 
 KinematicsResults (KinematicsResults &&)=default
 
KinematicsResultsoperator= (KinematicsResults &&)=default
 

Friends

class RigidBodyPlant< T >
 

Detailed Description

template<typename T>
class drake::systems::KinematicsResults< T >

A class containing the kinematics results from a RigidBodyPlant system.

Template Parameters
TThe scalar type. Must be a valid Eigen scalar.

Constructor & Destructor Documentation

KinematicsResults ( const KinematicsResults< T > &  )
default
KinematicsResults ( KinematicsResults< T > &&  )
default
KinematicsResults ( const RigidBodyTree< T > *  tree)
explicit

Constructs a KinematicsResults object associated with.

Parameters
tree.An alias to
treeis maintained so that the tree's lifetime must exceed this object's lifetime.

Member Function Documentation

Quaternion< T > get_body_orientation ( int  body_index) const

Returns the quaternion representation of the three dimensional orientation of body body_index in the world's frame.

Here is the call graph for this function:

Vector3< T > get_body_position ( int  body_index) const

Returns the three dimensional position of body body_index in world's frame.

const KinematicsCache<T>& get_cache ( ) const
inline

Here is the caller graph for this function:

Eigen::VectorBlock< const VectorX< T > > get_joint_position ( const RigidBody< T > &  body) const

Returns the joint position vector associated with the joint between body and body's parent.

TODO(tkoolen) should pass in joint instead of body, but that's currently not convenient.

Here is the call graph for this function:

Eigen::VectorBlock< const VectorX< T > > get_joint_velocity ( const RigidBody< T > &  body) const

Returns the joint velocity vector associated with the joint between body and body's parent.

TODO(tkoolen) should pass in joint instead of body, but that's currently not convenient.

Here is the call graph for this function:

int get_num_bodies ( ) const

Returns the number of bodies in the kinematics results.

int get_num_positions ( ) const

Returns the number of generalized positions.

int get_num_velocities ( ) const

Returns the number of generalized velocities.

Isometry3< T > get_pose_in_world ( const RigidBody< T > &  body) const

Returns the pose of body body with respect to the world.

Here is the call graph for this function:

Here is the caller graph for this function:

TwistVector< T > get_twist_in_world_aligned_body_frame ( const RigidBody< T > &  body) const

Returns the twist of body with respect to the world, expressed in world frame.

Here is the call graph for this function:

TwistVector< T > get_twist_in_world_frame ( const RigidBody< T > &  body) const

Returns the twist of body with respect to the world, expressed in world frame.

Here is the call graph for this function:

Here is the caller graph for this function:

KinematicsResults& operator= ( KinematicsResults< T > &&  )
default
KinematicsResults& operator= ( const KinematicsResults< T > &  )
default
void Update ( const Eigen::Ref< const VectorX< T >> &  q,
const Eigen::Ref< const VectorX< T >> &  v 
)

Updates the KinematicsResults object given the configuration vector.

Parameters
qand velocity vector
v.

Friends And Related Function Documentation

friend class RigidBodyPlant< T >
friend

The documentation for this class was generated from the following files: