vreModelSet.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
#pragma once
//! \file vreModelSet.h
//! \ingroup vreUtil
//! \brief Defines the model set for VREngage objects
//!
//! This file defines the DtVreModelSet class which manages collections of models
//! available to users for editing or creation. It extends the base VRF model set
//! with VREngage-specific functionality for handling entity files and models.
 
#include "vreUtil/export.h"
#include "vreUtil/vreModelSetEntry.h"
 
#include <vrfobjparam/modelSet.h>
 
namespace makVre
{
class DtVrfModelSetEntry;
 
//! \brief VREngage-specific model set implementation
//!
//! This class extends the base VRF model set to provide VREngage-specific
//! functionality for managing collections of entity models, including loading
//! entity files and resolving variable bindings.
class UTIL_DLL DtVreModelSet : public DtModelSet
{
public:
   //! \brief Default constructor
   //!
   //! Creates an empty model set with no name or registry
   DtVreModelSet();
 
   //! \brief Named constructor with optional registry
   //! \param name The name of the model set
   //! \param parentRegistry Optional parent registry for resource loading
   DtVreModelSet(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources owned by the model set
   virtual ~DtVreModelSet() override;
 
   //! \brief Copy constructor
   //! \param orig The model set to copy
   //! \param parentRegistry Optional parent registry for resource loading
   DtVreModelSet(const DtVreModelSet& orig, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Gets the fast lookup map of model set entries
   //! \return Constant reference to the map of model set entries by name
   //!
   //! This method provides efficient access to the model set entries using a hash map.
   virtual const boost::unordered_map<DtString, DtModelSetEntry*>& fastMap() const;
 
   //! \brief Loads a model set entry from an entity file
   //! \param filename Path to the .entity file to load
   //! \param smsSearchPaths Search paths for SMS files
   //! \param initializer Optional initializer for the loaded entity
   //! \return Shared pointer to the loaded model set entry
   //!
   //! This method loads an entity file and creates a corresponding model set entry.
   std::shared_ptr<makVre::DtVreModelSetEntry> loadEntityFile(
      const std::string& filename, const SearchPaths& smsSearchPaths, DtInitializer* initializer = 0);
 
   //! \brief Factory method for creating model set instances
   //! \param name The name of the model set to create
   //! \param parentRegistry Optional parent registry for resource loading
   //! \return Pointer to the newly created model set
   //!
   //! This static method creates a new instance of DtVreModelSet. Used by the factory system.
   static DtModelSet* Create(const DtString& name, DtReaderWriterRegistry* parentRegistry);
 
   // Helper functions
public:
   //! \brief Recursively searches for variable bindings in SMS files
   //! \param smsList List of SMS file paths to search
   //! \param binding The variable binding name to search for
   //! \param searchPaths Output parameter to store the found binding paths
   //!
   //! This utility function recursively searches through SMS files and their included files
   //! to find all locations of a particular variable binding.
   static void recursiveFindVariableBindingPaths(
      const std::vector<DtString>& smsList, const std::string& binding, std::vector<DtFilename>* searchPaths);
 
   //! \brief Gets all SMS files included by a list of SMS files
   //! \param smsList List of SMS file paths to process
   //! \param includedSMSs Output parameter to store the list of included SMS files
   //!
   //! This utility function recursively searches through SMS files to find all
   //! SMS files they include, building a complete list of dependencies.
   static void getIncludedSMSs(const std::vector<DtString>& smsList, std::vector<DtString>* includedSMSs);
 
   //! \brief Gets a specific variable binding from an SMS file
   //! \param smsFile Path to the SMS file to search
   //! \param bindingToLookFor The variable binding name to search for
   //! \return Path from the binding, or empty if not found
   //!
   //! This utility function looks for a specific variable binding in a single SMS file
   //! and returns its value if found.
   static DtFilename getVariableBinding(const DtString& smsFile, const std::string& bindingToLookFor);
};
 
} // namespace makVre