scaleValueTransform.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file
//! \brief Value transformation that scales input values by a speed factor
 
#pragma once
 
#include "vreInput/export.h"
#include "vreInput/valueTransform.h"
 
namespace makVre
{
//! \brief Value transformation that applies speed-based scaling to input values
//!
//! This transform scales input values by a speed factor. It's useful for adjusting
//! the speed of movement or rotation in response to input, such as camera or
//! character movement speeds.
class VREINPUT_DLL DtScaleValueTransform : public DtValueTransform
{
public:
   //! \brief Default constructor
   //!
   //! Initializes the speed value to 1.0 (no scaling)
   DtScaleValueTransform();
 
   //! \brief Virtual destructor
   virtual ~DtScaleValueTransform() override;
 
   //! \brief Initialize the scale transform from configuration
   //!
   //! Reads the speed value from the configuration table.
   //! The expected configuration parameter is "Speed" which specifies
   //! the scaling factor to apply to input values.
   //!
   //! \param config Pointer to the configuration table
   virtual void init(DtInitTable* config) override;
 
   //! \brief Apply the scaling transformation to an input value
   //!
   //! Multiplies the input value by the speed factor.
   //!
   //! \param value The raw input value to transform
   //! \return The transformed value (input * speed)
   virtual float transform(float value) override;
 
protected:
   //! \brief Speed scaling factor
   //!
   //! Input values are multiplied by this factor to adjust movement or rotation speed
   float mySpeed;
};
 
} // namespace makVre