Collider Extension: how to work with .IsTargetObscured() and .CameraWasDisplaced() ?

Hi Guys,

I am having trouble understanding how to work with both .IsTargetObscured() and .CameraWasDisplaced()

It never returns true, even though obviously, the camera is displaced and or the target is obscured.

I am using the scene Free Look collider, from the examples, and I have this component attached to the CM FreeLook1

Code (CSharp):

1. using System.Collections;
2. using System.Collections.Generic;
3. using UnityEngine;
4.  
5. using Cinemachine;
6.  
7. [RequireComponent(typeof(CinemachineCollider))]
8. public class ColliderWatcher : MonoBehaviour {
9.  
10.     public bool IsTargetObscured;
11.     public bool CameraWasDisplaced;
12.  
13.     CinemachineCollider _cache;
14.  
15.     public CinemachineVirtualCameraBase VirtualCamera;
16.  
17.     // Use this for initialization
18.     void Start () {
19.         _cache = this.GetComponent<CinemachineCollider> ();
20.  
21.     }
22.    
23.     // Update is called once per frame
24.     void Update () {
25.         if (_cache != null) {
26.  
27.             VirtualCamera = _cache.VirtualCamera;
28.  
29.             if (_cache.IsTargetObscured (_cache.VirtualCamera)) {
30.                 Debug.Log ("IsTargetObscured");
31.             }
32.  
33.             if (_cache.CameraWasDisplaced (_cache.VirtualCamera)) {
34.                 Debug.Log ("CameraWasDisplaced");
35.             }
36.  
37.  
38.             IsTargetObscured = _cache.IsTargetObscured (_cache.VirtualCamera);
39.             CameraWasDisplaced = _cache.CameraWasDisplaced (_cache.VirtualCamera);
40.  
41.         }
42.     }
43. }

but IsTargetObscured and CameraWasDisplaced are never true. I disabled Avoid Obstacles in the collider to clearly get to a point where I can not see the target but IsTargetObscured is never set to true, and if I set it back to Avoid obstacle, the camera is clearly displaced, but CameraWasDisplacedis never true.

What am I doing wrong here?

Thanks,

Jean

 

Hi,

thanks for taking a look at this

I am using
- Unity 2017.1f3
- Cinemachine latest ( 2.1.10)
- the default example scene "Free Look collider" to which I add my ColliderWatcher which should log in the console everytime IsTargetObscured and CameraWasDisplaced are true and show it in the inspector as well.


I made a small screencast to check that I am indeed getting nothing out of these, and that from what I am doing with the camera and player:

https://imgur.com/Qm8Ielb

It must be something very simple if you have no problem on your end, but it's odd that I get it straight from the example scene.

Bye,

Jean

 

I am not too sure what you mean by vcam's lookat target tags... but I guess you have these infos from the scene, as I using the one provided without any modification. Right?

Bye,

Jean

 

Hi,

Excellent! it works

Thanks,

Jean

 

Hi,

.LiveChildOrSelf is now out with the latest version of Cinemachine distributed via the Package Manager.

how would that work now, what would be the right way to get the camera base?

Bye,

Jean

 

Hi,

Thanks for the snippet

If the rigs radius are exotic/oddly setup, would it not make sense to catch the current rig being used? the middle rig might not be used at the time of collision or displacement, no?


Bye,

Jean

 

Hi,

Ok, I am going to just port the feature back. I really wonder why you got rid of it... doesn't make sense to me to remvoe this feature which seems not available in another form in the latest version of cinemachine.

/// <summary>Returns the rig with the greatest weight</summary>
public override ICinemachineCamera LiveChildOrSelf
{
get
{
// Do not update the rig cache here or there will be infinite loop at creation time
if (m_Rigs == null || m_Rigs.Length != 3)
return this;
if (m_YAxis.Value < 0.33f)
return m_Rigs[2];
if (m_YAxis.Value > 0.66f)
return m_Rigs[0];
return m_Rigs[1];
}
}

Bye,

Jean

 

Hi,

Yeah, you are right. I think I'll leverage the new way so that I can make one package for all cinemachine versions.

Thanks for your help

Bye,

Jean

 

Ok,

one more thing. The problem with your snippet is that it assumes the virtualCamera is a CinemachineFreeLook, but really, I am making this as a generic system, so I can't implement that as is actually. so how can I get to the CameraBase with just a virtualCamera?

Typically, I am working on a variant of the FreeLook Camera that has only one camera and not 3, as it's easier to setup for most case. Ideally, the component I am making should work for this variant too as it is meant to work with CinemachineCollider right?

Bye,

Jean

ps: also struggling big time with 2018, visual studio is not seeing your package and doesn't see your namespace... trying to look for a solution on this as well

 

Hi,

ok, I'll figure something out, because that doesn't scale well at all. Thanks for your time

Bye,

Jean

 

Hi,

Because for every new component, I'll need an if statement. the LiveChildOrSelf was making a lot of sense to grow on that side of this type of components.

Let me explain the context, maybe I am missing the obvious...

I am porting Cinemachine to PlayMaker, and for this I need some proxy components or actions that the user can use to point to a ColliderExtension and get its infos like wether it's obscured or displaced.




So, the problem is then that if I start putting if statements for every possible CinemachineVirtualCameraBase components, then I'll never be able to provide a stable solution over time that guarantee that when you have a pointer to a ColliderExtension you can query its status.

I think LiveChildOrSelf was meant to account for this situation, and I am not sure what's the best replacement now that you removed that feature. If the new solution is to hardcode it, then that's an issue. Maybe there is a motivation behind removing this LiveChildOrSelf, but If it was purely because you though it was not used, then I'd like to raise a case where it would be good to have it back so that extensions are truly generic, which I think should be the case.

again, I may miss the obvious, but the api is quite permeable I admit I am having a hard time with it and trying the understand the various concepts and approaches to make the most out of it and find the right points of entry to provide the best possible support for PlayMaker.

Bye,

Jean

 

Hi,

Yeah, you are right, I'll go with this Thanks for your help and patience.

Bye,

Jean