Class Damper

Utility to perform realistic damping of float or Vector3 values. The algorithm is based on exponentially decaying the delta until only a negligible amount remains.

Inheritance

object

Damper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

public static class Damper

Fields

kNegligibleResidual

Standard residual

Declaration

public const float kNegligibleResidual = 0.01

Field Value

Type	Description
float

Methods

Damp(float, float, float)

Get a damped version of a quantity. This is the portion of the quantity that will take effect over the given time.

Declaration

public static float Damp(float initial, float dampTime, float deltaTime)

Parameters

Type	Name	Description
float	initial	The amount that will be damped
float	dampTime	The rate of damping. This is the time it would take to reduce the original amount to a negligible percentage
float	deltaTime	The time over which to damp

Returns

Type	Description
float	The damped amount. This will be the original amount scaled by a value between 0 and 1.

Damp(Vector3, float, float)

Get a damped version of a quantity. This is the portion of the quantity that will take effect over the given time.

Declaration

public static Vector3 Damp(Vector3 initial, float dampTime, float deltaTime)

Parameters

Type	Name	Description
Vector3	initial	The amount that will be damped
float	dampTime	The rate of damping. This is the time it would take to reduce the original amount to a negligible percentage
float	deltaTime	The time over which to damp

Returns

Type	Description
Vector3	The damped amount. This will be the original amount scaled by a value between 0 and 1.

Damp(Vector3, Vector3, float)

Get a damped version of a quantity. This is the portion of the quantity that will take effect over the given time.

Declaration

public static Vector3 Damp(Vector3 initial, Vector3 dampTime, float deltaTime)

Parameters

Type	Name	Description
Vector3	initial	The amount that will be damped
Vector3	dampTime	The rate of damping. This is the time it would take to reduce the original amount to a negligible percentage
float	deltaTime	The time over which to damp

Returns

Type	Description
Vector3	The damped amount. This will be the original amount scaled by a value between 0 and 1.