vreFwlParameters.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreFwlParameters.h
//! \ingroup vreVrfRtdobjparam
//! \brief Fixed-wing parameters for VREngage
//!
//! This file defines the DtVreFwlParameters class, which contains the configuration
//! parameters for fixed-wing aircraft in VREngage. It includes settings for
//! control response, aircraft limits, and simulation fidelity.
 
#pragma once
 
#include <vreVrfRtdobjparam/export.h>
 
#include <vreVrfRtdobjparam/RTDVRFConfigWarnsForExternalIncludes.h>
RTDVRFConfigWarnsForExternalIncludes()
#include <vrfobjparam/fixedWingEntityParameters.h>
#pragma warning(pop)
 
   class DtString;
class DtReaderWriterRegistry;
 
namespace FwlCgfVrf
{
class Controller;
 
//! \brief Type string for VREngage fixed-wing parameters
//!
//! Constant used to identify this parameter type in the simulation system.
const char TS_Parameter[] = "fixedwinglib-cgf-vr-engage-param";
//! \brief Fixed-wing parameters for VREngage
//!
//! This class contains the configuration parameters for fixed-wing aircraft
//! in VREngage. It extends the base fixed-wing entity parameters with
//! VREngage-specific settings for control response, aircraft limits, and
//! simulation fidelity options.
class RTD_VRF_BACKEND_OBJPARAM_DLL DtVreFwlParameters : public DtFixedWingEntityParameters
{
   //! Friend class that needs direct access to parameter internals
   friend class Controller;
 
public:
#if RTD_VRF_PLUGIN_VER == 411
   //! \brief Constructor
   //! \param name The name of the parameters
   //! \param parentRegistry Parent registry for reader/writer functionality
   //!
   //! Initializes a new fixed-wing parameters object with default values.
   DtVreFwlParameters(const DtString& name = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = NULL);
#else
   //! \brief Constructor
   //! \param name The name of the parameters
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \param env Environment for parameter values
   //! \param objectNode Node containing parameter values
   //!
   //! Initializes a new fixed-wing parameters object with values from the provided environment.
   DtVreFwlParameters(const DtString& name = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = NULL,
      DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
#endif
   //! \brief Copy constructor
   //! \param orig The source parameters to copy from
   //! \param name The name for the new parameters
   //! \param parentRegistry Parent registry for reader/writer functionality
   //!
   //! Creates a new parameters object as a copy of the provided original parameters.
   DtVreFwlParameters(const DtVreFwlParameters& orig, const DtString& name, DtReaderWriterRegistry* parentRegistry);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the parameters object.
   virtual ~DtVreFwlParameters() override;
 
#if RTD_VRF_PLUGIN_VER == 411
   //! \brief Creator function for this parameter type
   //! \return Pointer to a new parameters object of this type
   //!
   //! Static factory function used for parameter creation.
   static DtVrfObjectParameters* creator();
#else
   //! \brief Creator function for this parameter type
   //! \param env Environment for parameter values
   //! \param root Root node containing parameter values
   //! \return Pointer to a new parameters object of this type
   //!
   //! Static factory function used for parameter creation with environment support.
   static DtVrfObjectParameters* creator(DtEnvironmentSP env, DtEnvValueSP* root);
#endif
 
   //! \brief Assignment operator
   //! \param orig The source parameters to copy from
   //! \return Reference to this parameters object after assignment
   //!
   //! Assigns the contents of the provided parameters to this parameters object.
   const DtVreFwlParameters& operator=(const DtVreFwlParameters& orig);
 
   //! \brief Assignment operator from base class
   //! \param orig The source base parameters to copy from
   //! \return Reference to this parameters object after assignment
   //!
   //! Assigns the contents of the provided base parameters to this parameters object.
   const DtVreFwlParameters& operator=(const DtFixedWingEntityParameters& orig);
 
   //! \brief Creates a clone of these parameters
   //! \param name The name for the cloned parameters
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to a new parameters object that is a clone of this one
   //!
   //! Creates a new parameters object as a deep copy of this parameters object.
   virtual DtVrfObjectParameters* clone(const DtString& name = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the parameters type
   //! \return The type string for these parameters
   //!
   //! Returns TS_Parameter as the parameters type identifier.
   virtual DtString type() const override;
 
   //! \brief Gets the aircraft dynamics parameter file path
   //! \return The file path to the aircraft dynamics parameters
   //!
   //! Returns the path to the file containing detailed aircraft dynamics parameters.
   DtString getSimpleAirplaneParameterFile() const;
 
   //! \brief Gets the altitude offset
   //! \return The altitude offset value
   //!
   //! Returns the altitude offset applied to the aircraft's position.
   DtReal getAltitudeOffset() const;
 
   //! \brief Gets the lateral control deadzone
   //! \return The lateral control deadzone value
   //!
   //! Returns the deadzone value for lateral (roll) control inputs.
   DtReal getLateralControlDeadzone() const;
 
   //! \brief Gets the longitudinal control deadzone
   //! \return The longitudinal control deadzone value
   //!
   //! Returns the deadzone value for longitudinal (pitch) control inputs.
   DtReal getLongitudinalControlDeadzone() const;
 
   //! \brief Gets the pedal control deadzone
   //! \return The pedal control deadzone value
   //!
   //! Returns the deadzone value for pedal (rudder) control inputs.
   DtReal getPedalDeadzone() const;
 
   //! \brief Gets the default maximum load factor
   //! \return The default maximum load factor
   //!
   //! Returns the default maximum load factor (G-force) for the aircraft.
   DtReal getDefaultMaxLoad() const;
 
   //! \brief Gets the default roll rate
   //! \return The default roll rate
   //!
   //! Returns the default roll rate for the aircraft.
   DtReal getDefaultRollRate() const;
 
   //! \brief Gets the default vertical speed
   //! \return The default vertical speed
   //!
   //! Returns the default vertical speed for the aircraft.
   DtReal getDefaultVertSpeed() const;
 
   //! \brief Gets whether high-fidelity terrain queries are enabled
   //! \return True if high-fidelity terrain queries are enabled, false otherwise
   //!
   //! Returns whether high-fidelity terrain queries are enabled for this aircraft.
   DtBoolean getHighFidelityTerrainQueries() const;
 
   //! \brief Gets the maximum altitude limit
   //! \return Reference to the maximum altitude value
   //!
   //! Returns the maximum altitude limit for the aircraft.
   const DtRwReal& getMaxAltitude() const { return myMaxAltitude; }
 
   //! \brief Gets the maximum speed limit
   //! \return Reference to the maximum speed value
   //!
   //! Returns the maximum speed limit for the aircraft.
   const DtRwReal& getMaxSpeed() const { return myMaxSpeed; }
 
   //! \brief Inherits values from another parameters object
   //! \param benefactor The parameters object to inherit from
   //! \return True if values were successfully inherited, false otherwise
   //!
   //! Inherits values from another parameters object, if it is of a compatible type.
   virtual bool inheritValues(const DtVrfObjectParameters* benefactor) override;
 
   //! \brief Inherits values from another parameters object of the same type
   //! \param pars The parameters object to inherit from
   //!
   //! Inherits values from another parameters object of the same type.
   virtual void inheritValuesFromThisType(const DtVreFwlParameters* pars);
 
protected:
   //! \brief Altitude offset value
   //!
   //! Offset applied to the aircraft's altitude.
   DtRwReal myAltitudeOffset;
 
   //! \brief Lateral control deadzone value
   //!
   //! Deadzone for lateral (roll) control inputs.
   DtRwReal myLateralControlDeadZone;
 
   //! \brief Longitudinal control deadzone value
   //!
   //! Deadzone for longitudinal (pitch) control inputs.
   DtRwReal myLongitudinalControlDeadZone;
 
   //! \brief Pedal control deadzone value
   //!
   //! Deadzone for pedal (rudder) control inputs.
   DtRwReal myPedalDeadZone;
 
   //! \brief Default maximum load factor
   //!
   //! Default maximum load factor (G-force) for the aircraft.
   DtRwReal myDefaultMaxLoad;
 
   //! \brief Default roll rate
   //!
   //! Default roll rate for the aircraft.
   DtRwReal myDefaultRollRate;
 
   //! \brief Default vertical speed
   //!
   //! Default vertical speed for the aircraft.
   DtRwReal myDefaultVertSpeed;
 
   //! \brief Flag for high-fidelity terrain queries
   //!
   //! When true, high-fidelity terrain queries are used for this aircraft.
   DtRwBoolean myHighFidelityTerrainQueries;
 
private:
   //! \brief File path to the aircraft dynamics parameters
   //!
   //! Path to the file containing detailed aircraft dynamics parameters.
   DtRwString myDynamicsParameterFile;
};
 
} // namespace FwlCgfVrf