vreJoystickControllerDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreJoystickControllerDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Joystick controller descriptor for VREngage
//!
//! This file defines the DtVreJoystickControllerDescriptor class, which configures
//! joystick controller components in VREngage. It provides parameters for joystick
//! input handling and port group configuration.
 
#pragma once
 
#include "vreVrfobjparam/export.h"
#include <vrfobjparam/joyDeviceControllerDescriptor.h>
 
namespace makVre
{
//! \brief Type identifier string for the joystick controller descriptor
const char DtVreJoystickControllerDescriptorType[] = "vre-joystick-controller-descriptor";
 
//! \brief Joystick controller descriptor for VREngage
//!
//! This class defines a descriptor for joystick controller components in VREngage.
//! It extends the base joystick device controller descriptor to add configuration for
//! port group assignment, allowing joystick inputs to be directed to appropriate
//! control systems in the simulation.
class VREVRFOBJPARAM_DLL DtVreJoystickControllerDescriptor : public DtJoyDeviceControllerDescriptor
{
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreJoystickControllerDescriptor();
 
public:
   //! \brief Constructor with component name
   //! \param componentName The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new joystick controller descriptor with the specified name.
   DtVreJoystickControllerDescriptor(const DtString& componentName, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Constructor with component name as symbol string
   //! \param componentName The name of this component as a symbol string
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new joystick controller descriptor with the specified name.
   DtVreJoystickControllerDescriptor(
      const DtSymbolString& componentName, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new joystick controller descriptor as a copy of the provided original.
   DtVreJoystickControllerDescriptor(
      const DtVreJoystickControllerDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtVreJoystickControllerDescriptor() override;
 
   //! \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 one.
   DtVreJoystickControllerDescriptor& operator=(const DtVreJoystickControllerDescriptor& orig);
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Will return DtVreJoystickControllerDescriptorType.
   virtual DtString type() const override;
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return Pointer to a new descriptor that is a clone of this one
   //!
   //! Creates a new joystick controller descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
   //! \brief Gets the port group name
   //! \return String identifying the port group
   //!
   //! Returns the name of the port group that this joystick controller is assigned to.
   //! Port groups are used to direct joystick inputs to appropriate control systems.
   virtual std::string portGroupName() const;
 
   //! \brief Sets the port group name
   //! \param name String identifying the port group
   //!
   //! Sets the name of the port group that this joystick controller is assigned to.
   //! Port groups are used to direct joystick inputs to appropriate control systems.
   virtual void setPortGroupName(std::string name);
 
protected:
   //! \brief Port group name
   //!
   //! The name of the port group that this joystick controller is assigned to.
   //! Port groups are used to direct joystick inputs to appropriate control systems.
   DtRwString myPortGroupName;
};
} // namespace makVre