Class ImagingInterface

inc/osvr/PluginKit/ImagingInterface.h:76–128

@brief A class wrapping an imaging interface for a device.

    /// @brief A class wrapping an imaging interface for a device.
    class ImagingInterface {
      public:
        /// @brief Default constructor or constructor from an existing
        /// OSVR_ImagingDeviceInterface (assumed to be registered with an
        /// OSVR_DeviceInitOptions already)
        ImagingInterface(OSVR_ImagingDeviceInterface iface = NULL)
            : m_iface(iface) {}

        /// @brief Constructor that registers an imaging interface with the
        /// device init options object.
        explicit ImagingInterface(OSVR_DeviceInitOptions opts,
                                  OSVR_ChannelCount numSensors = 1) {
            OSVR_ReturnCode ret =
                osvrDeviceImagingConfigure(opts, &m_iface, numSensors);
            if (OSVR_RETURN_SUCCESS != ret) {
                throw std::logic_error("Could not initialize an Imaging "
                                       "Interface with the device options "
                                       "given!");
            }
        }

        /// @brief Send method - usually called by
        /// osvr::pluginkit::DeviceToken::send()
        void send(DeviceToken &dev, ImagingMessage const &message,
                  OSVR_TimeValue const &timestamp) {
            if (!m_iface) {
                throw std::logic_error(
                    "Must initialize the imaging interface before using it!");
            }
            cv::Mat const &frame(message.getFrame());
            util::NumberTypeData typedata =
                util::opencvNumberTypeData(frame.type());
            OSVR_ImagingMetadata metadata;
            metadata.channels = frame.channels();
            metadata.depth = typedata.getSize();
            metadata.width = frame.cols;
            metadata.height = frame.rows;
            metadata.type = typedata.isFloatingPoint()
                                ? OSVR_IVT_FLOATING_POINT
                                : (typedata.isSigned() ? OSVR_IVT_SIGNED_INT
                                                       : OSVR_IVT_UNSIGNED_INT);

            OSVR_ReturnCode ret =
                osvrDeviceImagingReportFrame(dev, m_iface, metadata, frame.data,
                                             message.getSensor(), &timestamp);
            if (OSVR_RETURN_SUCCESS != ret) {
                throw std::runtime_error("Could not send imaging message!");
            }
        }

      private:
        OSVR_ImagingDeviceInterface m_iface;
    };
    /// @}
} // namespace pluginkit
} // namespace osvr