vreLocalEntitySetController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreLocalEntitySetController.h
//! \ingroup vreVrfmodel
//! \brief Controller for managing sets of local entities
//!
//! This file defines the DtVreLocalEntitySetController class which extends
//! the base local entity set controller to provide VR-Engage specific functionality
//! for managing groups of local entities.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfmodel/vreSetController.h"
 
#include <vrfmodel/localEntitySetController.h>
 
namespace makVre
{
//! \brief Type identifier for the VRE local entity set controller component
static const char* DtVreLocalEntitySetControllerType = "vre-local-entity-set-controller";
 
//! \brief Controller for managing sets of local entities with VR-Engage extensions
//!
//! DtVreLocalEntitySetController extends the base local entity set controller
//! with VR-Engage specific functionality for managing groups of local entities.
//! It inherits from DtVreSetController which provides common behavior for all
//! VR-Engage set controllers.
class VREVRFMODEL_DLL DtVreLocalEntitySetController : public DtVreSetController<DtLocalEntitySetController>
{
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param owner The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor with configuration parameters
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new local entity set controller component with the specified parameters.
   DtVreLocalEntitySetController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreLocalEntitySetControllerType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param owner The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory method used by the component creation system to instantiate
   //! new instances of this component type.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreLocalEntitySetController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreLocalEntitySetController(const DtVreLocalEntitySetController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreLocalEntitySetController& operator=(const DtVreLocalEntitySetController& orig);
};
} // namespace makVre