We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent c934e8e commit 87323aaCopy full SHA for 87323aa
1 file changed
packages/roslib/src/tf/TFClient.ts
@@ -14,6 +14,27 @@ import BaseTFClient from "./BaseTFClient.ts";
14
15
/**
16
* A TF Client that listens to TFs from tf2_web_republisher.
17
+ *
18
+ * @example Canceling Goals
19
+ * ```javascript
20
+ * const tfClient = new TFClient({
21
+ * ros: ros,
22
+ * fixedFrame: 'world'
23
+ * });
24
25
+ * // Subscribe to a frame
26
+ * tfClient.subscribe('turtle1', function(tf) {
27
+ * console.log('Transform received:', tf);
28
29
30
+ * // Cancel the current goal only
31
+ * if (tfClient.currentGoal) {
32
+ * tfClient.currentGoal.cancel();
33
+ * }
34
35
+ * // Cancel all goals associated with this TF client
36
+ * tfClient.actionClient.cancel();
37
+ * ```
38
*/
39
export default class TFClient extends BaseTFClient {
40
currentGoal:
0 commit comments