vreFwlStateRepository.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreFwlStateRepository.h
//! \ingroup vreVrfRtd
//! \brief Fixed-wing state repository for VREngage
//!
//! This file defines the DtVreFwlStateRepository class, which manages the state
//! information for fixed-wing aircraft in VREngage, including position, orientation,
//! and other simulation state variables.
 
#pragma once
 
#include <vrfobjcore/fixedWingEntityStateRepository.h>
#include <vreVrfRtd/vreRtdBackendLibCommon.h>
 
class DtSimResource;
 
namespace FwlCgfVrf
{
class DtVreFwlParameters;
class Cgf;
 
//! \brief Type string for VREngage fixed-wing state repository component
//!
//! Constant used to identify this component type in the simulation system.
const char TS_VREngageStateRepository[] = "fixedwinglib-cgf-vr-engage-state-repository";
//! \brief Fixed-wing aircraft state repository for VREngage
//!
//! This class maintains the state information for fixed-wing aircraft within
//! the VREngage simulation, including position, orientation, velocity, and other
//! aircraft state variables. It provides methods for initializing, updating, and
//! querying this state information.
class RTD_VRF_BACKEND_PLUGIN_EXPORT DtVreFwlStateRepository : public DtFixedWingEntityStateRepository
{
   //! Friend class that needs direct access to state repository internals
   friend class Controller;
 
private:
   //! \brief Copy constructor (not implemented)
   //! \param orig The source object
   DtVreFwlStateRepository(const DtVreFwlStateRepository& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \param orig The source object
   //! \return Reference to this object
   const DtVreFwlStateRepository& operator=(const DtVreFwlStateRepository& orig);
 
public:
   //! \brief Constructor
   //! \param vrfObject The local object this repository belongs to
   //! \param name The name of the repository
   //! \param parentRegistry Parent registry for reader/writer functionality
   //!
   //! Initializes a new fixed-wing state repository for VREngage control.
   DtVreFwlStateRepository(DtLocalObject* vrfObject, const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the state repository.
   virtual ~DtVreFwlStateRepository() override;
 
   //! \brief Initializes the state repository
   //! \return True if initialization was successful
   //!
   //! Performs initial setup of the state repository, including configuration
   //! loading and state initialization.
   virtual bool init() override;
 
   //! \brief Gets the component type
   //! \return The type string for this component
   //!
   //! Returns TS_VREngageStateRepository as the component type identifier.
   virtual DtString type() const override;
 
   //! \brief Initializes state from parameters
   //!
   //! Sets up the initial state values based on the parameters defined
   //! in the component's descriptor.
   virtual void initializeFromParameters() override;
 
   //! \brief Component factory function
   //! \param name The name for the new repository
   //! \param vrfObject The local object the repository will belong to
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to the newly created repository
   //!
   //! Static factory function used for component creation through the component registry.
   static DtVrfObjectStateRepository* creator(
      const DtString& name, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
   //! \brief Gets the fixed-wing parameters
   //! \return Pointer to the fixed-wing parameters
   //!
   //! Returns the parameters used to configure this fixed-wing aircraft.
   const DtVreFwlParameters* getFWParameters() const;
 
   //! \brief Places the aircraft at a specified location and heading
   //! \param location The position vector where the aircraft should be placed
   //! \param heading The heading (in radians) the aircraft should face
   //! \param clampToGroundFlag If true, adjusts the aircraft altitude to ground level
   //! \param dataAvailable Optional output parameter indicating if terrain data is available
   //! \param requireAllData If true, requires complete terrain data to be available
   //!
   //! Moves the aircraft to the specified location and orientation, optionally
   //! adjusting its altitude to maintain proper ground clearance.
   virtual void place(const DtVector& location,
      const DtReal heading,
      bool clampToGroundFlag = true,
      bool* dataAvailable = 0,
      bool requireAllData = false) override;
};
} // namespace FwlCgfVrf