vreConsoleCommands.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreConsoleCommands.h
//! \ingroup vreVrfobjcore
//! \brief Console command management functions for VREngage
//!
//! This file provides functions for registering and removing VREngage-specific
//! console commands with the simulation environment. These commands extend the
//! functionality of the simulation console by adding VREngage-specific commands
//! that can be executed during runtime.
 
#pragma once
 
#include "vreVrfobjcore/export.h"
 
namespace makVre
{
//! \brief Registers VREngage console commands with the simulation
//! \param mgr Pointer to the local object manager
//!
//! This function registers all VREngage-specific console commands with the
//! simulation environment. It should be called during initialization to make
//! VREngage console commands available to the user. The commands are registered
//! with the provided local object manager.
VREVRFOBJCORE_DLL void addVreConsoleCommands(DtLocalObjectManager* mgr);
 
//! \brief Removes previously registered VREngage console commands
//!
//! This function removes all VREngage-specific console commands that were
//! previously registered with addVreConsoleCommands(). It should be called
//! during shutdown to clean up registered commands.
VREVRFOBJCORE_DLL void removeVreConsoleCommands();
} // namespace makVre