plugin.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
 
//! \file plugin.h
//! \brief Plugin entry point for the QML HUD example demonstrating QML overlay integration.
 
#pragma once
 
#ifdef _WIN32
   #ifdef qmlHud_EXPORTS
      #define QMLHUD_DLL __declspec(dllexport)
   #else
      #define QMLHUD_DLL __declspec(dllimport)
   #endif
#else
   #define QMLHUD_DLL
#endif
 
namespace makVre
{
class DtPlayerStationApp;
}
 
extern "C"
{
   //! \brief Plugin entry point for VR-Engage player station module loading.
   //!
   //! This function is called by VR-Engage when the qmlHud plugin is loaded. It registers
   //! the DtDriverQmlHudComponent with the application's component factory, making it
   //! available for use in role configurations.
   //!
   //! This example demonstrates the standard VR-Engage plugin initialization pattern where
   //! components are registered by type string that matches their usage in role XML files.
   //!
   //! \param app The player station application instance providing access to the component factory
   //! \return true if registration succeeds, false otherwise
   QMLHUD_DLL bool initPlayerStationModule(makVre::DtPlayerStationApp* app);
};