vreVrfPlugin.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreVrfPlugin.h
//! \ingroup vreVrfSimPlugin
//! \brief Main entry point for the VREngage simulation plugin
//!
//! This file defines the initialization, post-initialization, and unload functions
//! for the VREngage simulation plugin, which extends the base VRF simulation
//! with VREngage-specific functionality.
 
#pragma once
#include <vreVrfSimPlugin/export.h>
 
#include <vrfutil/vrfPluginInformation.h>
 
class DtCgf;
 
namespace makVre
{
//! \brief Namespace containing functions for the VREngage simulation plugin
//!
//! This namespace contains functions to initialize, post-initialize, and unload
//! the VREngage simulation plugin, as well as provide information about the plugin.
namespace DtVreVrfSimPlugin
{
//! \brief Initializes the VREngage simulation plugin
//! \param cgf Pointer to the CGF (Computer Generated Forces) engine
//! \return True if initialization was successful, false otherwise
//!
//! This function is called during the plugin initialization phase. It registers
//! VREngage-specific simulation components, controllers, and actuators with the CGF engine.
VREVRFSIMPLUGIN_DLL bool DtInitializeVreVrfPlugin(DtCgf* cgf);
 
//! \brief Performs post-initialization tasks for the VREngage simulation plugin
//! \param cgf Pointer to the CGF (Computer Generated Forces) engine
//! \return True if post-initialization was successful, false otherwise
//!
//! This function is called after all plugins have been initialized. It performs
//! tasks that depend on other plugins being already initialized, such as
//! establishing inter-plugin connections and dependencies.
VREVRFSIMPLUGIN_DLL bool DtPostInitializeVreVrfPlugin(DtCgf* cgf);
 
//! \brief Unloads the VREngage simulation plugin
//! \param cgf Pointer to the CGF (Computer Generated Forces) engine
//!
//! This function is called when the plugin is being unloaded. It unregisters
//! VREngage-specific components and performs cleanup of any resources allocated
//! during initialization and operation.
VREVRFSIMPLUGIN_DLL void DtUnloadVreVrfPlugin(DtCgf* cgf);
 
//! \brief Provides information about the VREngage simulation 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 plugin, including its name, version, and dependencies.
VREVRFSIMPLUGIN_DLL void DtVreVrfPluginInformation(DtVrfPluginInformation& info);
} // namespace DtVreVrfSimPlugin
} // namespace makVre