Allow video sources to be added to Shuffleboard (#1453)

Add a Sendable wrapper for VideoSource objects.

Add convenience methods for adding video sources directly to containers
so users won't have to manually wrap video sources.
This commit is contained in:
Sam Carlberg
2018-12-30 14:45:41 -05:00
committed by Peter Johnson
parent a2368a6199
commit 80f87ff8ad
6 changed files with 219 additions and 0 deletions

View File

@@ -0,0 +1,55 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2018 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
/*----------------------------------------------------------------------------*/
#pragma once
#include <string>
#include <cscore_c.h>
#include "frc/smartdashboard/SendableBase.h"
namespace cs {
class VideoSource;
} // namespace cs
namespace frc {
/**
* A wrapper to make video sources sendable and usable from Shuffleboard.
*/
class SendableCameraWrapper : public SendableBase {
private:
struct private_init {};
public:
/**
* Creates a new sendable wrapper. Private constructor to avoid direct
* instantiation with multiple wrappers floating around for the same camera.
*
* @param source the source to wrap
*/
SendableCameraWrapper(CS_Source source, const private_init&);
/**
* Gets a sendable wrapper object for the given video source, creating the
* wrapper if one does not already exist for the source.
*
* @param source the video source to wrap
* @return a sendable wrapper object for the video source, usable in
* Shuffleboard via ShuffleboardTab::Add() and ShuffleboardLayout::Add()
*/
static SendableCameraWrapper& Wrap(const cs::VideoSource& source);
static SendableCameraWrapper& Wrap(CS_Source source);
void InitSendable(SendableBuilder& builder) override;
private:
std::string m_uri;
};
} // namespace frc

View File

@@ -24,6 +24,10 @@
#include "frc/shuffleboard/ShuffleboardComponentBase.h"
#include "frc/shuffleboard/ShuffleboardValue.h"
namespace cs {
class VideoSource;
} // namespace cs
namespace frc {
class ComplexWidget;
@@ -104,6 +108,17 @@ class ShuffleboardContainer : public virtual ShuffleboardValue,
*/
ComplexWidget& Add(const wpi::Twine& title, Sendable& sendable);
/**
* Adds a widget to this container to display the given video stream.
*
* @param title the title of the widget
* @param video the video stream to display
* @return a widget to display the sendable data
* @throws IllegalArgumentException if a widget already exists in this
* container with the given title
*/
ComplexWidget& Add(const wpi::Twine& title, const cs::VideoSource& video);
/**
* Adds a widget to this container to display the given sendable.
*
@@ -115,6 +130,16 @@ class ShuffleboardContainer : public virtual ShuffleboardValue,
*/
ComplexWidget& Add(Sendable& sendable);
/**
* Adds a widget to this container to display the given video stream.
*
* @param video the video to display
* @return a widget to display the sendable data
* @throws IllegalArgumentException if a widget already exists in this
* container with the same title as the video source
*/
ComplexWidget& Add(const cs::VideoSource& video);
/**
* Adds a widget to this container to display the given data.
*