deadZoneValueTransform.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file
//! \brief Value transformation that applies a dead zone to input values
 
#pragma once
 
#include "vreInput/export.h"
#include "vreInput/valueTransform.h"
 
namespace makVre
{
//! \brief Value transformation that filters out small input values
//!
//! This transform applies a dead zone to input values. Values within the dead zone
//! (close to zero) are filtered out and returned as zero. This helps eliminate
//! noise or small unintentional movements from input devices like joysticks.
class VREINPUT_DLL DtDeadZoneValueTransform : public DtValueTransform
{
public:
   //! \brief Default constructor
   //!
   //! Initializes the dead zone value to zero
   DtDeadZoneValueTransform();
 
   //! \brief Virtual destructor
   virtual ~DtDeadZoneValueTransform() override;
 
   //! \brief Initialize the dead zone transform from configuration
   //!
   //! Reads the dead zone value from the configuration table.
   //! The expected configuration parameter is "DeadZone" which specifies
   //! the threshold below which input values will be zeroed out.
   //!
   //! \param config Pointer to the configuration table
   virtual void init(DtInitTable* config) override;
 
   //! \brief Apply the dead zone transformation to an input value
   //!
   //! Values with absolute magnitude less than the dead zone threshold
   //! are set to zero. Values outside the dead zone are passed through unchanged.
   //!
   //! \param value The raw input value to transform
   //! \return The transformed value (0.0 if within dead zone, original value otherwise)
   virtual float transform(float value) override;
 
protected:
   //! \brief Dead zone threshold value
   //!
   //! Input values with absolute magnitude less than this value will be zeroed out
   float myDeadZone = 0.0;
   float myScale = 1.0;
};
 
} // namespace makVre