vreFwlJoyControllerDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreFwlJoyControllerDescriptor.h
//! \ingroup vreVrfRtdobjparam
//! \brief Fixed-wing joystick controller descriptor for VREngage
//!
//! This file defines the DtVreFwlJoyControllerDescriptor class, which describes the
//! configuration parameters for a fixed-wing joystick controller in VREngage.
//! It contains information used to create and configure DtVreFwlJoyController instances.
 
#pragma once
 
#include <vreVrfRtdobjparam/export.h>
 
#include <vrfobjparam/joyDeviceControllerDescriptor.h>
 
namespace FwlCgfVrf
{
//! \brief Type string for VREngage fixed-wing joystick controller descriptor
//!
//! Constant used to identify this descriptor type in the simulation system.
const char TS_JoyControllerDesc[] = "fixedwinglib-cgf-vr-engage-joy-controller-descriptor";
//! \brief Fixed-wing joystick controller descriptor for VREngage
//!
//! This class describes the configuration parameters for a fixed-wing joystick
//! controller in VREngage. It extends the base joystick device controller descriptor
//! with fixed-wing specific parameters and functionality.
class RTD_VRF_BACKEND_OBJPARAM_DLL DtVreFwlJoyControllerDescriptor : public DtJoyDeviceControllerDescriptor
{
public:
   //! \brief Constructor
   //! \param name The name of the descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality
   //!
   //! Initializes a new fixed-wing joystick controller descriptor with default values.
   DtVreFwlJoyControllerDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality
   //!
   //! Creates a new descriptor as a copy of the provided original descriptor.
   DtVreFwlJoyControllerDescriptor(
      const DtVreFwlJoyControllerDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this descriptor.
   DtVreFwlJoyControllerDescriptor& operator=(const DtVreFwlJoyControllerDescriptor& orig);
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to a new descriptor that is a clone of this one
   //!
   //! Creates a new descriptor as a deep copy of this descriptor.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtVreFwlJoyControllerDescriptor() override;
 
   //! \brief Gets the descriptor type
   //! \return The type string for this descriptor
   //!
   //! Returns TS_JoyControllerDesc as the descriptor type identifier.
   //! This is used to create the descriptor when reading from an MTL file.
   virtual DtString type() const override;
 
   //! \brief Creator function for this descriptor type
   //! \return Pointer to a new descriptor of this type
   //!
   //! Static factory function used for descriptor creation through the
   //! DtSimComponentDescriptorFactory system.
   static DtComponentDescriptor* creator();
};
} // namespace FwlCgfVrf