Struct Damping

Contains the damping data.

Namespace: Unity.LiveCapture.VirtualCamera

Assembly: Unity.LiveCapture.VirtualCamera.dll

Syntax

[Serializable]
public struct Damping

Fields

Aim

Time in seconds for the camera to catch up with the target rotation.

Declaration

[Tooltip("Time in seconds for the camera to catch up with the target rotation.")]
public float Aim

Field Value

Type	Description
float

Remarks

Values should not be negative. Typical values would range between 0 and 3.

Body

Time in seconds for the camera to reach reach the target position.

Declaration

[Tooltip("Time in seconds for the camera to reach reach the target position.")]
public Vector3 Body

Field Value

Type	Description
Vector3

Remarks

Values should not be negative. Typical values would range between 0 and 3.

Default

A rig that applies no damping.

Declaration

public static readonly Damping Default

Field Value

Type	Description
Damping

Enabled

Enable or disable the damping.

Declaration

[Tooltip("Enable or disable damping.")]
public bool Enabled

Field Value

Type	Description
bool

Methods

Equals(object)

Determines whether the specified object is equal to the current Damping.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current Damping.

Returns

Type	Description
bool	true if the specified object is equal to the current Damping; otherwise, false.

Overrides

ValueType.Equals(object)

Equals(Damping)

Determines whether the Damping instances are equal.

Declaration

public bool Equals(Damping other)

Parameters

Type	Name	Description
Damping	other	The other Damping to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Gets the hash code for the Damping.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	The hash value generated for this Damping.

Overrides

ValueType.GetHashCode()

Operators

operator ==(Damping, Damping)

Determines whether the two specified Damping are equal.

Declaration

public static bool operator ==(Damping a, Damping b)

Parameters

Type	Name	Description
Damping	a	The first Damping.
Damping	b	The second Damping.

Returns

Type	Description
bool	true if the specified Damping are equal; otherwise, false.

operator !=(Damping, Damping)

Determines whether the two specified Damping are different.

Declaration

public static bool operator !=(Damping a, Damping b)

Parameters

Type	Name	Description
Damping	a	The first Damping.
Damping	b	The second Damping.

Returns

Type	Description
bool	true if the specified Damping are different; otherwise, false.