Hi, I would like to know if there is a way to add damping to the 3rd Person Follow component collision check, in the same way that the CinemachineCollider extension does, with the ‘Smoothing Time, Damping, and Damping when Occluded’ options.
Currently, when the camera gets occluded, it just jumps to the desired position.
We have added return-to-normal damping, so that the camera can return to normal gradually after a collision. This will be available in an upcoming release of CM.
If you want to add damping yourself, you can copy Cinemachine3rdPersonFollow.cs, rename it, and make whatever modifications you like. That is the general procedure for making custom CM components.
1 Like
Thanks for the answer!
Is there a way to get access to that feature, or maybe an idea of how it was achieved?
I managed to do the damping using slerp when the collision happens, but so far couldn’t get it to work correctly after a collision. (without jitter, anyways).
PS: Also tried with PositionCorrection but it gave bad results for me.
Edit: just found this
https://github.com/Unity-Technologies/com.unity.cinemachine/commit/78cea5505ff1c1601bd2800c8becb95c1e024a7d
1 Like
So… I’ve been trying for a while now, using the latest changes found on github, however I can’t get it to work how I want.
I’ve managed to kind of make it work by doing slerp while colliding, and using the upcoming damping feature when it’s not colliding. However this produces jittering when the player rotates the camera faster than it can reach it’s calculated position.
Is there anything you would recommend to get this working?
Just to clarify: I am trying to accomplish return-to-normal damping + on-collision damping, so that the transition both to and from the collision are smooth. Here is the same code from github, but including what I’ve tried so far
Once again, thanks a lot for your time and help!
public class Custom3rdPersonFollow : CinemachineComponentBase
{
/// <summary>How responsively the camera tracks the target. Each axis (camera-local)
/// can have its own setting. Value is the approximate time it takes the camera
/// to catch up to the target's new position. Smaller values give a more rigid
/// effect, larger values give a squishier one.</summary>
[Tooltip("How responsively the camera tracks the target. Each axis (camera-local) "
+ "can have its own setting. Value is the approximate time it takes the camera "
+ "to catch up to the target's new position. Smaller values give a more "
+ "rigid effect, larger values give a squishier one")]
public Vector3 Damping;
/// <summary>Position of the shoulder pivot relative to the Follow target origin.
/// This offset is in target-local space.</summary>
[Header("Rig")]
[Tooltip("Position of the shoulder pivot relative to the Follow target origin. "
+ "This offset is in target-local space")]
public Vector3 ShoulderOffset;
/// <summary>Vertical offset of the hand in relation to the shoulder.
/// Arm length will affect the follow target's screen position
/// when the camera rotates vertically.</summary>
[Tooltip("Vertical offset of the hand in relation to the shoulder. "
+ "Arm length will affect the follow target's screen position when "
+ "the camera rotates vertically")]
public float VerticalArmLength;
/// <summary>Specifies which shoulder (left, right, or in-between) the camera is on.</summary>
[Tooltip("Specifies which shoulder (left, right, or in-between) the camera is on")]
[Range(0, 1)]
public float CameraSide;
/// <summary>How far baehind the hand the camera will be placed.</summary>
[Tooltip("How far baehind the hand the camera will be placed")]
public float CameraDistance;
/// <summary>Camera will avoid obstacles on these layers.</summary>
[Header("Obstacles")]
[Tooltip("Camera will avoid obstacles on these layers")]
public LayerMask CameraCollisionFilter;
/// <summary>
/// Obstacles with this tag will be ignored. It is a good idea
/// to set this field to the target's tag
/// </summary>
[TagField]
[Tooltip("Obstacles with this tag will be ignored. "
+ "It is a good idea to set this field to the target's tag")]
public string IgnoreTag = string.Empty;
/// <summary>
/// Specifies how close the camera can get to obstacles
/// </summary>
[Tooltip("Specifies how close the camera can get to obstacles")]
public float CameraRadius;
/// <summary>
/// How gradually the camera returns to its normal position after having been corrected by the built-in
/// collision resolution system. Higher numbers will move the camera more gradually back to normal.
/// </summary>
[Range(0, 10)]
[Tooltip("How gradually the camera returns to its normal position after having been corrected by the built-in " +
"collision resolution system. Higher numbers will move the camera more gradually back to normal.")]
public float CollisionDamping;
public bool collided;
// State info
Vector3 m_PreviousFollowTargetPosition;
float m_PreviousHeadingAngle;
float m_HandCollisionCorrection;
float m_CamPosCollisionCorrection;
void OnValidate()
{
CameraSide = Mathf.Clamp(CameraSide, -1.0f, 1.0f);
Damping.x = Mathf.Max(0, Damping.x);
Damping.y = Mathf.Max(0, Damping.y);
Damping.z = Mathf.Max(0, Damping.z);
CameraRadius = Mathf.Max(0.001f, CameraRadius);
CollisionDamping = Mathf.Max(0, CollisionDamping);
}
void Reset()
{
CameraCollisionFilter = 1;
ShoulderOffset = new Vector3(0.5f, -0.4f, 0.0f);
VerticalArmLength = 0.4f;
CameraSide = 1.0f;
CameraDistance = 2.0f;
Damping = new Vector3(0.1f, 0.5f, 0.3f);
CameraRadius = 0.2f;
CollisionDamping = 2f;
}
/// <summary>True if component is enabled and has a Follow target defined</summary>
public override bool IsValid => enabled && FollowTarget != null;
/// <summary>Get the Cinemachine Pipeline stage that this component implements.
/// Always returns the Aim stage</summary>
public override CinemachineCore.Stage Stage { get { return CinemachineCore.Stage.Body; } }
/// <summary>
/// Report maximum damping time needed for this component.
/// </summary>
/// <returns>Highest damping setting in this component</returns>
public override float GetMaxDampTime() { return Mathf.Max(Damping.x, Mathf.Max(Damping.y, Damping.z)); }
/// <summary>Orients the camera to match the Follow target's orientation</summary>
/// <param name="curState">The current camera state</param>
/// <param name="deltaTime">Elapsed time since last frame, for damping calculations.
/// If negative, previous state is reset.</param>
public override void MutateCameraState(ref CameraState curState, float deltaTime)
{
if (IsValid)
{
if (!VirtualCamera.PreviousStateIsValid)
deltaTime = -1;
PositionCamera(ref curState, deltaTime);
}
}
void PositionCamera(ref CameraState curState, float deltaTime)
{
var followTarget = FollowTargetPosition;
if (deltaTime < 0)
{
// No damping - reset all state info
m_PreviousFollowTargetPosition = followTarget;
m_HandCollisionCorrection = m_CamPosCollisionCorrection = 0;
}
var prevTargetPos = m_PreviousFollowTargetPosition;
// Compute damped target pos (compute in camera space)
var dampedTargetPos = Quaternion.Inverse(curState.RawOrientation) * (followTarget - prevTargetPos);
if (deltaTime >= 0)
dampedTargetPos = VirtualCamera.DetachedFollowTargetDamp(
dampedTargetPos, Damping, deltaTime);
dampedTargetPos = prevTargetPos + curState.RawOrientation * dampedTargetPos;
// Get target rotation (worldspace)
var fwd = Vector3.forward;
var up = Vector3.up;
var followTargetRotation = FollowTargetRotation;
var followTargetForward = followTargetRotation * fwd;
var angle = UnityVectorExtensions.SignedAngle(
fwd, followTargetForward.ProjectOntoPlane(up), up);
if (deltaTime < 0)
m_PreviousHeadingAngle = angle; // no damping
var deltaHeading = angle - m_PreviousHeadingAngle;
m_PreviousHeadingAngle = angle;
// Bypass user-sourced rotation
dampedTargetPos = followTarget
+ Quaternion.AngleAxis(deltaHeading, up) * (dampedTargetPos - followTarget);
m_PreviousFollowTargetPosition = dampedTargetPos;
GetRigPositions(out Vector3 root, out _, out Vector3 hand);
// 1. Check if pivot itself is colliding with something, if yes, then move the pivot
// closer to the player. The radius is bigger here than in step 2, to avoid problems
// next to walls. Where the preferred distance would be pulled completely to the
// player, using a bigger radius, this won't happen.
hand = ResolveCollisions(
root, hand, deltaTime, CameraRadius * 1.05f, ref m_HandCollisionCorrection);
// 2. Try to place the camera to the preferred distance
Vector3 camPos = hand - (followTargetForward * CameraDistance);
Vector3 newCamPos = ResolveCollisions(
hand, camPos, deltaTime, CameraRadius, ref m_CamPosCollisionCorrection);
// Set state
// Only lerp if there is an occlusion
if (collided && camPos!=newCamPos)
{
curState.RawPosition = Vector3.Slerp(curState.RawPosition, newCamPos, Time.deltaTime * CollisionDamping);
}
else
{
curState.RawPosition = newCamPos;
}
curState.RawOrientation = followTargetRotation;
curState.ReferenceUp = up;
}
/// <summary>
/// Internal use only. Public for the inspector gizmo
/// </summary>
/// <param name="root">Root of the rig.</param>
/// <param name="shoulder">Shoulder of the rig.</param>
/// <param name="hand">Hand of the rig.</param>
public void GetRigPositions(out Vector3 root, out Vector3 shoulder, out Vector3 hand)
{
root = m_PreviousFollowTargetPosition;
var shoulderPivotReflected = Vector3.Reflect(ShoulderOffset, Vector3.right);
var shoulderOffset = Vector3.Lerp(shoulderPivotReflected, ShoulderOffset, CameraSide);
t_HandOffset.y = VerticalArmLength;
shoulder = root + Quaternion.AngleAxis(m_PreviousHeadingAngle, Vector3.up) * shoulderOffset;
hand = shoulder + FollowTargetRotation * t_HandOffset;
}
Vector3 t_HandOffset = Vector3.zero; // minor opt. - to avoid creating a new vector in GetRigPositions
Vector3 ResolveCollisions(
Vector3 root, Vector3 tip, float deltaTime,
float cameraRadius, ref float collisionCorrection)
{
var dir = tip - root;
var len = dir.magnitude;
dir /= len;
bool hasHit = RuntimeUtility.SphereCastIgnoreTag(
root, cameraRadius, dir, out RaycastHit hitInfo,
len, CameraCollisionFilter, IgnoreTag);
var result = tip;
if (hasHit)
{
// We have a collision - store the delta for damping later
result = hitInfo.point + hitInfo.normal * cameraRadius;
collisionCorrection = (result - tip).magnitude;
collided = true;
}
else if (deltaTime >= 0)
{
collided = false;
// Post collision damping - ease out of last collision
collisionCorrection -= Damper.Damp(
collisionCorrection, CollisionDamping, deltaTime);
if (collisionCorrection > Epsilon)
result -= dir * collisionCorrection;
}
return result;
}
}
Try this
6905405–808679–Custom3rdPersonFollow.cs (9.44 KB)
1 Like
This works like a charm, thanks a lot!!
1 Like