bullseyePSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
#pragma once
 
//! \file bullseyePSR.h
//! \ingroup vreVrfobjcore
//! \brief Bullseye process state repository for VREngage
//!
//! This file defines the DtBullseyePSR class, which provides a process state repository
//! for the bullseye controller component in VREngage. It stores and manages references
//! to entities designated as bullseye reference points for tactical communications.
 
#include "vreVrfobjcore/export.h"
#include <vrfobjcore/vrfProcessStateRepository.h>
#include <readerWriter/readerWriter.h>
#include <vrfobjcore/simObjectReference.h>
#include <vrfobjcore/rwSimObjectReference.h>
 
namespace makVre
{
//! \brief Type identifier string for the bullseye process state repository
const char DtBullseyePSRType[] = "bullseye-psr";
 
//! \brief Default name for the bullseye process state repository
const char DtBullseyePSRDefaultName[] = "bullseye-psr-default";
 
//! \brief Process state repository for the bullseye controller component
//!
//! This class provides storage and management for bullseye reference entity data,
//! which is used by the bullseye controller component in VREngage simulations.
//! A bullseye reference point is a tactical position reference commonly used in
//! military simulations for communicating relative positions.
class VREVRFOBJCORE_DLL DtBullseyePSR : public DtVrfProcessStateRepository
{
public:
   //! \brief Constructor with VRF object and optional name
   //! \param vrfObject Pointer to the local object this PSR is associated with
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new bullseye PSR for the specified VRF object.
   DtBullseyePSR(DtLocalObject* vrfObject, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source PSR to copy from
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new bullseye PSR as a copy of the provided original.
   DtBullseyePSR(const DtBullseyePSR& orig, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the PSR.
   virtual ~DtBullseyePSR() override;
 
   //! \brief Assignment operator (not implemented)
   //! \param orig The source PSR to copy from
   //! \return Reference to this PSR after assignment
   //!
   //! Assignment operator is declared but not implemented to prevent assignment.
   DtBullseyePSR& operator=(const DtBullseyePSR& orig);
 
   //! \brief Creates a clone of this PSR
   //! \param rwName Optional reader/writer name for the clone
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to a new PSR that is a clone of this one
   //!
   //! Creates a new bullseye PSR as a deep copy of this one.
   virtual DtVrfProcessStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the type identifier for this PSR
   //! \return String identifying this PSR type
   //!
   //! Returns a unique type identifier string for this PSR type.
   //! Will return DtBullseyePSRType.
   virtual DtString type() const override;
 
   //! \brief Gets the currently selected bullseye entity
   //! \return Reference to the bullseye entity, or an invalid reference if none is set
   //!
   //! Returns a reference to the entity currently designated as the bullseye reference point.
   virtual DtSimObjectReference bullseyeEntity() const;
 
   //! \brief Sets the bullseye entity
   //! \param uuid The UUID of the entity to set as the bullseye reference
   //!
   //! Designates the specified entity as the bullseye reference point.
   virtual void setBullseyeEntity(const DtUUID& uuid);
 
   //! \brief Removes the bullseye entity designation
   //!
   //! Clears the current bullseye reference point, if any.
   virtual void removeBullseyeEntity();
 
   //! \brief Factory function to create a new instance of this PSR
   //! \param rwName The reader/writer name for the new instance
   //! \param vrfObject Pointer to the local object this PSR will be associated with
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to a newly created PSR instance
   //!
   //! Static factory function used by the PSR creation system to instantiate
   //! new instances of this PSR type.
   static DtVrfProcessStateRepository* creator(
      const DtString& rwName, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
protected:
   //! \brief Reference to the selected bullseye entity
   //!
   //! Stores a reference to the entity designated as the bullseye reference point.
   //! This entity serves as a tactical position reference for communicating
   //! relative positions in military simulations.
   DtRwSimObjectReference myBullseyeEntity;
};
 
} // namespace makVre