VClamp (StuyLib v2024.1.5 API)

java.lang.Object

com.stuypulse.stuylib.streams.vectors.filters.VClamp

All Implemented Interfaces:: VFilter

public class VClamp extends Object implements VFilter

A filter that clamps the magnitude of a vector to a certain size

Constructor Summary

Constructors

Constructor

Description

VClamp(Number maxMagnitude)
Method Summary

Modifier and Type

Method

Description

Vector2D

get(Vector2D target)

Get next value in Filter based on the next value given

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.stuypulse.stuylib.streams.vectors.filters.VFilter
add, sub, then

Constructor Details
- VClamp
  
  public VClamp(Number maxMagnitude)
Method Details
- get
  
  public Vector2D get(Vector2D target)
  
  Description copied from interface: VFilter
  
  Get next value in Filter based on the next value given
  
  Specified by:
  
  get in interface VFilter
  
  Parameters:
  
  target - next input value in the stream
  
  Returns:
  
  the output value of the filter