diff --git a/source/RobotAPI/components/ArViz/Client/ScopedClient.h b/source/RobotAPI/components/ArViz/Client/ScopedClient.h index a6c52c3f2fc5325bff0b9caffa64e9cba47333fd..23271b5ba6de545b183728ba04fdaa86f7938e0a 100644 --- a/source/RobotAPI/components/ArViz/Client/ScopedClient.h +++ b/source/RobotAPI/components/ArViz/Client/ScopedClient.h @@ -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