From 882f6bb12176a9e6577ff3529b7fdd08f468818b Mon Sep 17 00:00:00 2001 From: Benjamin Perseghetti Date: Sat, 18 May 2024 15:29:04 -0400 Subject: [PATCH] Add back/gui/follow doxygen. Signed-off-by: Benjamin Perseghetti --- examples/standalone/scene_provider/README.md | 4 ++-- src/plugins/camera_tracking/CameraTracking.cc | 9 +++++---- src/plugins/camera_tracking/CameraTracking.hh | 3 +++ .../camera_tracking_config/CameraTrackingConfig.cc | 1 + .../camera_tracking_config/CameraTrackingConfig.hh | 1 + .../camera_tracking_config/CameraTrackingConfig.qml | 1 + 6 files changed, 13 insertions(+), 6 deletions(-) diff --git a/examples/standalone/scene_provider/README.md b/examples/standalone/scene_provider/README.md index 342e94b95..ce2da00fc 100644 --- a/examples/standalone/scene_provider/README.md +++ b/examples/standalone/scene_provider/README.md @@ -76,13 +76,13 @@ Update follow offset from track topic: gz topic -t /gui/track -m gz.msgs.CameraTrack -p 'track_mode: 2, follow_target: {name: "box_model"}, follow_offset: {x: -1, y: 0, z: 1}' ``` -Follow box from service (depricated): +Follow box from service (deprecated): ```bash gz service -s /gui/follow --reqtype gz.msgs.StringMsg --reptype gz.msgs.Boolean --timeout 2000 --req 'data: "box_model"' ``` -Update follow offset from follow offset service (depricated): +Update follow offset from follow offset service (deprecated): ```bash gz service -s /gui/follow/offset --reqtype gz.msgs.Vector3d --reptype gz.msgs.Boolean --timeout 2000 --req 'x: 5, y: 5, z: 5' diff --git a/src/plugins/camera_tracking/CameraTracking.cc b/src/plugins/camera_tracking/CameraTracking.cc index c007e48f4..2edc94b72 100644 --- a/src/plugins/camera_tracking/CameraTracking.cc +++ b/src/plugins/camera_tracking/CameraTracking.cc @@ -120,6 +120,7 @@ class CameraTrackingPrivate /// \brief Offset on target to be tracked public: math::Vector3d trackOffset = math::Vector3d(0, 0, 0); + /// \brief Camera tracking message public: gz::msgs::CameraTrack trackMsg; /// \brief Flag to indicate new tracking @@ -159,10 +160,10 @@ class CameraTrackingPrivate /// \brief Move to service public: std::string moveToService; - /// \brief Follow service + /// \brief Follow service (deprecated) public: std::string followService; - /// \brief Follow offset service + /// \brief Follow offset service (deprecated) public: std::string followOffsetService; /// \brief The pose set from the move to pose service. @@ -223,7 +224,7 @@ void CameraTrackingPrivate::Initialize() this->node.Advertise(this->followService, &CameraTrackingPrivate::OnFollow, this); gzmsg << "Follow service on [" - << this->followService << "]" << std::endl; + << this->followService << "] (deprecated)" << std::endl; // track this->trackTopic = "/gui/track"; @@ -259,7 +260,7 @@ void CameraTrackingPrivate::Initialize() this->node.Advertise(this->followOffsetService, &CameraTrackingPrivate::OnFollowOffset, this); gzmsg << "Follow offset service on [" - << this->followOffsetService << "]" << std::endl; + << this->followOffsetService << "] (deprecated)" << std::endl; } ///////////////////////////////////////////////// diff --git a/src/plugins/camera_tracking/CameraTracking.hh b/src/plugins/camera_tracking/CameraTracking.hh index 395d99477..ae6833b9c 100644 --- a/src/plugins/camera_tracking/CameraTracking.hh +++ b/src/plugins/camera_tracking/CameraTracking.hh @@ -31,6 +31,9 @@ namespace gz::gui::plugins /// and "follow". /// /// Services: + /// * `/gui/follow`: Set the user camera to follow a given target, + /// identified by name (deprecated). + /// * `/gui/follow/offset`: Set the offset for following (deprecated). /// * `/gui/move_to`: Move the user camera to look at a given target, /// identified by name. /// * `/gui/move_to/pose`: Move the user camera to a given pose. diff --git a/src/plugins/camera_tracking_config/CameraTrackingConfig.cc b/src/plugins/camera_tracking_config/CameraTrackingConfig.cc index 287fc8de4..c61f8ac44 100644 --- a/src/plugins/camera_tracking_config/CameraTrackingConfig.cc +++ b/src/plugins/camera_tracking_config/CameraTrackingConfig.cc @@ -1,4 +1,5 @@ /* + * Copyright (C) 2024 CogniPilot Foundation * Copyright (C) 2024 Rudis Laboratories LLC * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/plugins/camera_tracking_config/CameraTrackingConfig.hh b/src/plugins/camera_tracking_config/CameraTrackingConfig.hh index 5080d8ea6..dca58a52e 100644 --- a/src/plugins/camera_tracking_config/CameraTrackingConfig.hh +++ b/src/plugins/camera_tracking_config/CameraTrackingConfig.hh @@ -1,4 +1,5 @@ /* + * Copyright (C) 2024 CogniPilot Foundation * Copyright (C) 2024 Rudis Laboratories LLC * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/src/plugins/camera_tracking_config/CameraTrackingConfig.qml b/src/plugins/camera_tracking_config/CameraTrackingConfig.qml index 2f9a0fda6..91c5e144a 100644 --- a/src/plugins/camera_tracking_config/CameraTrackingConfig.qml +++ b/src/plugins/camera_tracking_config/CameraTrackingConfig.qml @@ -1,4 +1,5 @@ /* + * Copyright (C) 2024 CogniPilot Foundation * Copyright (C) 2024 Rudis Laboratories LLC * * Licensed under the Apache License, Version 2.0 (the "License");