Skip to content
Snippets Groups Projects
Commit 2bffd0d3 authored by Fabian Reister's avatar Fabian Reister
Browse files

updated class description. thanks, @RainerKartmann

parent 1a3f9651
No related branches found
No related tags found
No related merge requests found
......@@ -26,7 +26,15 @@
namespace armarx::viz
{
/**
* @brief viz::Client that will cleanup layers when destroyed.
* @brief `viz::Client` that will delete (clear) committed layers when destroyed.
*
* Note that, as a consequence, a network call be performed in the destructor.
*
* This might be useful if you have a class `MyTask` perform visualizing while performing some task,
* but whose visualization should be removed when the task finished.
* In this case, `MyTask` can have a `viz::ScopedClient` (which can be created from a regular `viz::Client`).
* When destructing the instance of `MyTask`, all visualization done by `MyTask` will be cleared
* (as `viz::ScopedClient` will go out of scope as well).
*
*/
class ScopedClient: virtual public Client
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment