vreModelSetDb.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreModelSetDb.h
//! \ingroup vreManager
//! \brief VREngage model set database for entity and station information
//!
//! This file defines the DtVreModelSetDb class, which manages entity information
//! and station definitions for VREngage-controllable entities.
 
#pragma once
 
#include "vreManager/export.h"
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrfobjparam/modelSet.h>
#include <vrfutil/rwUUID.h>
 
#include <QStringList>
 
#include <vector>
 
namespace makVrv
{
class DtDe;
}
 
namespace makVre
{
class DtVreModelSet;
 
//! \brief Database for VREngage entity and station information
//!
//! This singleton class manages model set information specific to VREngage entities,
//! including loading and accessing entity definition files (.entity) and providing
//! information about available stations/roles for VREngage-controllable entities.
class VREMANAGER_DLL DtVreModelSetDb : public makVrv::DtVirtualBaseClass
{
public:
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the model set database.
   virtual ~DtVreModelSetDb() override;
 
   //! \brief Loads entity definition files
   //! \param baseDir The base directory to search in
   //! \param paths Additional search paths for entity files
   //!
   //! Loads files of type .entity from the specified directories. These files
   //! define the available stations/roles for VREngage-controllable entities.
   virtual void loadEntityFiles(const std::string& baseDir, const std::vector<DtFilename>& paths);
 
   //! \brief Finds a model set entry matching an entity type
   //! \param entityType The entity type to find a matching pattern for
   //! \return Pointer to the matching model set entry, or NULL if not found
   //!
   //! Searches the model set for an entry that matches the specified entity type.
   //! Used to determine if an entity can be controlled by VREngage and which
   //! stations/roles are available for it.
   virtual DtModelSetEntry* findMatchingPattern(const DtEntityType& entityType) const;
 
   //! \brief Looks up available station data for an entity
   //! \param uuid The UUID of the entity to look up stations for
   //! \return List of available station names for the entity
   //!
   //! Returns a list of station names (roles) available for the entity with
   //! the specified UUID. These are the roles that can be assigned to a player.
   virtual QStringList lookupEngageStationData(const DtUUID& uuid);
 
   //! \brief Determines if an entity type is VREngage-controllable
   //! \param entityType The entity type to check
   //! \return True if the entity type is VREngage-controllable, false otherwise
   //!
   //! Checks if the specified entity type is defined in a VREngage entity file,
   //! indicating that it can be controlled by VREngage applications.
   virtual bool isVreEntityType(const DtEntityType& entityType) const;
 
   //! \brief Gets the singleton instance of the model set database
   //! \param displayEngine The distributed environment to use
   //! \return Reference to the singleton instance
   //!
   //! Returns the singleton instance of the model set database, creating it
   //! if it doesn't already exist. This is the proper way to access the database.
   static DtVreModelSetDb& instance(makVrv::DtDe& displayEngine);
 
private:
   //! \brief Constructor
   //! \param de The distributed environment reference
   //!
   //! Initializes a new model set database. This constructor is private
   //! because this class is a singleton and should only be accessed via instance().
   DtVreModelSetDb(makVrv::DtDe& de);
 
protected:
   //! \brief The VREngage model set
   //!
   //! Contains information about VREngage entity types and station definitions.
   DtVreModelSet* myModelSet;
 
   //! \brief Reference to the distributed environment
   //!
   //! Used to access simulation state information.
   makVrv::DtDe& myDe;
};
} // namespace makVre