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 declaration for playerStateAttribute example
//!
//! This header declares the plugin initialization function that VR-Engage calls
//! when loading the plugin DLL. The function uses C linkage (extern "C") to prevent
//! C++ name mangling and ensure VR-Engage can locate the function by name.
 
#include "export.h"
 
#pragma once
 
// Forward declare the Player Station App to avoid including the full header
// This keeps compilation dependencies minimal in the plugin interface
namespace makVre
{
class DtPlayerStationApp;
}
 
//! \brief Plugin initialization entry point for VR-Engage player station modules.
//!
//! This function is called automatically by VR-Engage when the plugin DLL is loaded.
//! It must be exported with C linkage (extern "C") to prevent C++ name mangling,
//! which allows VR-Engage to locate the function by its exact name.
//!
//! PATTERN: All VR-Engage player station plugins must export a function with this
//! exact signature and name. The plugin system searches for "initPlayerStationModule"
//! in loaded DLLs and calls it during plugin initialization.
//!
//! \param app Pointer to the player station application instance. Used to access
//!            the component factory for registering custom components.
//! \return true if the plugin initialized successfully, false on failure
//!
//! REUSABLE: This header structure is identical for all VR-Engage player station plugins.
extern "C"
{
   PLAYERSTATEATTRIBUTE_DLL bool initPlayerStationModule(makVre::DtPlayerStationApp* app);
};