Drake
AddMultibodyPlantSceneGraphResult< T > Struct Template Reference

Detailed Description

template<typename T>
struct drake::multibody::AddMultibodyPlantSceneGraphResult< T >

Temporary result from AddMultibodyPlantSceneGraph.

This cannot be constructed outside of this method.

Warning
Do NOT use this as a function argument or member variable. The lifetime of this object should be as short as possible.

#include <drake/multibody/plant/multibody_plant.h>

Public Member Functions

 operator MultibodyPlant< T > & ()
 For assignment to a plant reference (ignoring the scene graph). More...
 
 operator std::tuple< MultibodyPlant< T > *&, geometry::SceneGraph< T > *& > ()
 For assignment to a std::tie of pointers. More...
 

Public Attributes

MultibodyPlant< T > & plant
 
geometry::SceneGraph< T > & scene_graph
 

Friends

AddMultibodyPlantSceneGraphResult AddMultibodyPlantSceneGraph (systems::DiagramBuilder< T > *, std::unique_ptr< MultibodyPlant< T >>, std::unique_ptr< geometry::SceneGraph< T >>)
 

Member Function Documentation

◆ operator MultibodyPlant< T > &()

operator MultibodyPlant< T > & ( )

For assignment to a plant reference (ignoring the scene graph).

◆ operator std::tuple< MultibodyPlant< T > *&, geometry::SceneGraph< T > *& >()

operator std::tuple< MultibodyPlant< T > *&, geometry::SceneGraph< T > *& > ( )

For assignment to a std::tie of pointers.

Friends And Related Function Documentation

◆ AddMultibodyPlantSceneGraph

AddMultibodyPlantSceneGraphResult AddMultibodyPlantSceneGraph ( systems::DiagramBuilder< T > *  ,
std::unique_ptr< MultibodyPlant< T >>   
)
friend

Member Data Documentation

◆ plant

MultibodyPlant<T>& plant

◆ scene_graph

geometry::SceneGraph<T>& scene_graph

The documentation for this struct was generated from the following file: