vreVrfGuiPlugin.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreVrfGuiPlugin.h
//! \ingroup vreVrfGuiPlugin
//! \brief Main entry point for the VREngage GUI plugin
//!
//! This file defines the initialization functions for the VREngage GUI plugin,
//! which extends the base VRF GUI functionality with VREngage-specific features.
 
#pragma once
 
//! Include export definitions for this library
#include "vreVrfGuiPlugin/export.h"
 
//! Include plugin export definitions from VRF GUI Core
#include <vrfGuiCore/vrfGuiExportPlugin.h>
 
namespace makVre
{
//! \brief Namespace containing functions for the VREngage GUI plugin
//!
//! This namespace contains functions to initialize and provide information
//! about the VREngage GUI plugin.
namespace DtVreVrfGuiPlugin
{
//! \brief Initializes the VREngage GUI 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 GUI components and functionality.
VREVRFGUIPLUGIN_DLL void init(makVrv::DtDe& de);
 
//! \brief Provides information about the VREngage GUI plugin
//! \param info Reference to a structure to be filled with plugin information
//!
//! This function fills the provided structure with information about the
//! VREngage GUI plugin, including its name, version, and dependencies.
VREVRFGUIPLUGIN_DLL void DtVreVrfPluginInformation(DtVrfPluginInformation& info);
} // namespace DtVreVrfGuiPlugin
} // namespace makVre