Skip to content

Commit

Permalink
Added documentation of changeVisualsColor
Browse files Browse the repository at this point in the history
From code review

Co-authored-by: Silvio Traversaro <[email protected]>
  • Loading branch information
S-Dafarra and traversaro authored Sep 17, 2024
1 parent aae81e1 commit c04db86
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/visualization/src/ModelVisualization.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,13 @@ class ModelVisualization: public IModelVisualization
ModelVisualization(const ModelVisualization& other);
ModelVisualization& operator=(const ModelVisualization& other);

bool changeVisualsColor(const LinkIndex& linkIndex, const ColorViz& color, const std::string& name = "");
/**
* @param[in] linkIndex Index of the link
* @param[in] color The color to assign to the specified visual
* @param[in] visualName the name of the visual for which to change the color, or "" to set all the visual of the links
* @return true if all went ok, false otherwise
*/
bool changeVisualsColor(const LinkIndex& linkIndex, const ColorViz& color, const std::string& visualName = "");
public:
ModelVisualization();
~ModelVisualization();
Expand Down

0 comments on commit c04db86

Please sign in to comment.