gainValueTransform.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file
//! \brief Value transformation that applies gain (amplification) to input values
 
#pragma once
 
#include "vreInput/export.h"
#include "vreInput/valueTransform.h"
 
namespace makVre
{
//! \brief Value transformation that multiplies input values by a gain factor
//!
//! This transform applies a gain (amplification factor) to input values.
//! It's useful for increasing or decreasing the sensitivity of input devices
//! like joysticks, mice, or other analog inputs.
class VREINPUT_DLL DtGainValueTransform : public DtValueTransform
{
public:
   //! \brief Default constructor
   //!
   //! Initializes the gain value to 1.0 (no change)
   DtGainValueTransform();
 
   //! \brief Virtual destructor
   virtual ~DtGainValueTransform() override;
 
   //! \brief Initialize the gain transform from configuration
   //!
   //! Reads the gain value from the configuration table.
   //! The expected configuration parameter is "Gain" which specifies
   //! the multiplication factor to apply to input values.
   //!
   //! \param config Pointer to the configuration table
   virtual void init(DtInitTable* config) override;
 
   //! \brief Apply the gain transformation to an input value
   //!
   //! Multiplies the input value by the gain factor.
   //!
   //! \param value The raw input value to transform
   //! \return The transformed value (input * gain)
   virtual float transform(float value) override;
 
protected:
   //! \brief Gain multiplication factor
   //!
   //! Input values are multiplied by this factor to increase or decrease sensitivity
   float myGain;
};
 
} // namespace makVre