vreRtdTraitJoyControllerExtension.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreRtdTraitJoyControllerExtension.h
//! \ingroup vreVrfRtd
//! \brief Extension trait for joystick controllers in VREngage
//!
//! This file defines the DtVreRtdTraitJoyControllerExtension class, which provides
//! common functionality for joystick controllers in the VREngage RTD system,
//! including joystick state management and port creation.
 
#pragma once
#include <vreVrfRtd/vreRtdBackendLibCommon.h>
 
class DtBooleanOutputPort;
 
namespace vreRtd
{
//! \brief Extension trait for joystick controllers in VREngage
//!
//! This class provides common functionality for joystick controllers in the
//! VREngage RTD system. It handles joystick state management, port creation,
//! and state transitions for controllers. This trait is used by both fixed-wing
//! and rotary-wing joystick controllers to share common functionality.
class RTD_VRF_BACKEND_PLUGIN_EXPORT DtVreRtdTraitJoyControllerExtension
{
public:
   //! \brief Constructor
   //!
   //! Initializes a new joystick controller extension trait with default values.
   DtVreRtdTraitJoyControllerExtension();
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the joystick controller extension trait.
   virtual ~DtVreRtdTraitJoyControllerExtension();
 
   //! \brief Performs per-frame processing
   //! \param myJoystickEnabled Whether the joystick is currently enabled
   //!
   //! Called once per simulation frame to update the joystick controller state.
   //! This function handles state transitions when joystick control is enabled
   //! or disabled.
   virtual void tick(bool myJoystickEnabled);
 
   //! \brief Creates the joystick enabled output port
   //! \return True if the port was successfully created, false otherwise
   //!
   //! Creates the output port that indicates whether joystick control is enabled.
   //! This port can be connected to other components to synchronize control states.
   virtual bool createJoystickEnabledPort();
 
#if RTD_VRF_PLUGIN_VER < 440
   //! \brief Processes a joystick device switch message
   //! \param msg The message to process
   //!
   //! Processes a message that indicates a change in the joystick device state.
   //! This function is only available in RTD VRF plugin versions earlier than 4.40.
   virtual void processSetJoyDeviceSwitch(DtSimMessage* msg);
#endif
 
   //! \brief Disables the joystick controller
   //!
   //! Disables joystick input processing, usually when player
   //! control is deactivated.
   virtual void disable();
 
   //! \brief Enables the joystick controller
   //!
   //! Enables joystick input processing, usually when player
   //! control is activated.
   virtual void enable();
 
   //! \brief Sets the enabled state of the joystick controller
   //! \param yes True to enable the controller, false to disable
   //!
   //! Directly sets the enabled state of the joystick controller.
   virtual void setIsEnabled(bool yes);
 
protected:
   //! \brief Output port for joystick enabled state
   //!
   //! Port that indicates whether the joystick is currently enabled.
   DtBooleanOutputPort* myJoystickEnabledPort;
 
   //! \brief Flag indicating whether this is the first tick
   //!
   //! Used to handle initialization during the first simulation frame.
   bool myFirstTick;
 
   //! \brief Previous joystick state
   //!
   //! Stores the joystick state from the previous frame to detect state changes.
   bool myPreviousJoystickState;
};
 
} // namespace vreRtd