vreVrfSoePlugin.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreVrfSoePlugin.h
//! \ingroup vreVrfSimulationObjectEditorPlugin
//! \brief Main entry point for the VREngage Simulation Object Editor plugin
//!
//! This file defines the initialization functions for the VREngage Simulation
//! Object Editor plugin, which extends the base VRF Simulation Object Editor
//! with VREngage-specific functionality and components.
 
#pragma once
#include <vreVrfSimulationObjectEditorPlugin/export.h>
 
#include <vrfGuiCore/vrfGuiExportPlugin.h>
 
//! \brief Commented-out legacy C interface for the plugin
//!
//! This section contains commented-out legacy C interface functions that have been
//! replaced by the C++ namespace interface below. Kept for reference purposes.
// extern "C"
// {
//    DT_DE_PLUGIN_EXPORT_MACRO bool initDeModule(makVrv::DtDe* de);
//    DT_VRF_DLL_PLUGIN void DtPluginInformation(DtVrfPluginInformation& info);
//    DT_VRF_DLL_PLUGIN void postInitDeModule(makVrv::DtDe&);
//    DT_VRF_DLL_PLUGIN bool initQtDesignerModule(makVrv::DtDe&);
//    DT_VRF_DLL_PLUGIN void initializeCommandLineArguments(makVrf::DtVrfGuiCommandLineParser*);
// }
 
 
namespace makVre
{
//! \brief Namespace containing functions for the VREngage Simulation Object Editor plugin
//!
//! This namespace contains functions to initialize and provide information
//! about the VREngage Simulation Object Editor plugin, which extends the
//! standard Simulation Object Editor with VREngage-specific functionality.
namespace DtVreVrfSimulationObjectEditorPlugin
{
//! \brief Initializes the VREngage Simulation Object Editor plugin
//! \param de The document environment providing access to application resources
//!
//! This function is called when the plugin is loaded, and initializes all
//! VREngage-specific Simulation Object Editor components and functionality,
//! such as custom editors, model loaders, and ammunition parameters extensions.
VREVRFSOEPLUGIN_DLL void init(makVrv::DtDe& de);
//! \brief Provides information about the VREngage Simulation Object Editor plugin
//! \param info Reference to a structure to be filled with plugin information
//!
//! This function fills the provided structure with information about the
//! VREngage Simulation Object Editor plugin, including its name, version,
//! and dependencies. This information is used by the plugin system to manage
//! plugin loading and dependencies.
VREVRFSOEPLUGIN_DLL void DtVreVrfPluginInformation(DtVrfPluginInformation& info);
} // namespace DtVreVrfSimulationObjectEditorPlugin
} // namespace makVre