NestedModelData Class Reference

Helper class to store nested models data. More...

#include <ModelData.hh>

Public Member Functions

int Depth () const
 Get the depth of the nested model. More...
 
std::string Name () const
 Get the unscoped name of the model. More...
 
ignition::math::Pose3d Pose () const
 Get the pose of the nested model. More...
 
void SetName (const std::string &_name)
 Set the name of the model. More...
 
void SetPose (const ignition::math::Pose3d &_pose)
 Set the pose of the model. More...
 

Public Attributes

std::map< std::string, rendering::VisualWeakPtrlinks
 Links inside this model. More...
 
std::map< std::string, rendering::VisualWeakPtrmodels
 Models inside this model. More...
 
sdf::ElementPtr modelSDF
 SDF representing the model data. More...
 
rendering::VisualPtr modelVisual
 Visual representing this model. More...
 

Detailed Description

Helper class to store nested models data.

Member Function Documentation

◆ Depth()

int Depth ( ) const

Get the depth of the nested model.

The root model has depth 1.

Returns
Depth of nested model. Returns -1 if depth cannot be found.

◆ Name()

std::string Name ( ) const

Get the unscoped name of the model.

Returns
Name of model.

◆ Pose()

ignition::math::Pose3d Pose ( ) const

Get the pose of the nested model.

Returns
Pose of nested model.

◆ SetName()

void SetName ( const std::string &  _name)

Set the name of the model.

Parameters
[in]_nameName of model.

◆ SetPose()

void SetPose ( const ignition::math::Pose3d &  _pose)

Set the pose of the model.

Parameters
[in]_posePose of model.

Member Data Documentation

◆ links

std::map<std::string, rendering::VisualWeakPtr> links

Links inside this model.

◆ models

std::map<std::string, rendering::VisualWeakPtr> models

Models inside this model.

◆ modelSDF

sdf::ElementPtr modelSDF

SDF representing the model data.

◆ modelVisual

rendering::VisualPtr modelVisual

Visual representing this model.


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