remapValueTransform.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file
//! \brief Value transformation that remaps input values from one range to another
 
#pragma once
 
#include "vreInput/export.h"
#include "vreInput/valueTransform.h"
 
namespace makVre
{
//! \brief Value transformation that linearly remaps values from one range to another
//!
//! This transform changes the range of input values by mapping them from an input range
//! to an output range using linear interpolation. It's useful for normalizing or
//! scaling values from hardware-specific ranges to standardized ranges.
class VREINPUT_DLL DtRemapValueTransform : public DtValueTransform
{
public:
   //! \brief Default constructor
   //!
   //! Initializes the remap ranges with default values
   DtRemapValueTransform();
 
   //! \brief Virtual destructor
   virtual ~DtRemapValueTransform() override;
 
   //! \brief Initialize the remap transform from configuration
   //!
   //! Reads the input and output range parameters from the configuration table.
   //! Expected configuration parameters are:
   //! - "InputMin": Minimum value of the input range
   //! - "InputMax": Maximum value of the input range
   //! - "OutputMin": Minimum value of the output range
   //! - "OutputMax": Maximum value of the output range
   //!
   //! \param config Pointer to the configuration table
   virtual void init(DtInitTable* config) override;
 
   //! \brief Apply the remapping transformation to an input value
   //!
   //! Linearly remaps the input value from the input range to the output range.
   //! Values outside the input range will be clamped to the output range boundaries.
   //!
   //! \param value The raw input value to transform
   //! \return The remapped value in the output range
   virtual float transform(float value) override;
 
protected:
   //! \brief Minimum value of the input range
   float myInputMin;
 
   //! \brief Maximum value of the input range
   float myInputMax;
 
   //! \brief Minimum value of the output range
   float myOutputMin;
 
   //! \brief Maximum value of the output range
   float myOutputMax;
 
   //! \brief Size of the input range (InputMax - InputMin)
   //!
   //! Pre-calculated for efficiency in the transform function
   float myInputRange;
 
   //! \brief Size of the output range (OutputMax - OutputMin)
   //!
   //! Pre-calculated for efficiency in the transform function
   float myOutputRange;
};
 
} // namespace makVre