| | | 1 | | using DCL.Models; |
| | | 2 | | using UnityEngine; |
| | | 3 | | using System.Collections.Generic; |
| | | 4 | | using System.Collections; |
| | | 5 | | using System; |
| | | 6 | | |
| | | 7 | | namespace DCL.Controllers |
| | | 8 | | { |
| | | 9 | | public class SceneBoundsChecker : ISceneBoundsChecker |
| | | 10 | | { |
| | | 11 | | public event Action<IDCLEntity, bool> OnEntityBoundsCheckerStatusChanged; |
| | 2757 | 12 | | public bool enabled => entitiesCheckRoutine != null; |
| | 1055 | 13 | | public float timeBetweenChecks { get; set; } = 0.5f; |
| | 2 | 14 | | public int entitiesToCheckCount => entitiesToCheck.Count; |
| | | 15 | | |
| | | 16 | | private const bool VERBOSE = false; |
| | 665 | 17 | | private Logger logger = new Logger("SceneBoundsChecker") {verboseEnabled = VERBOSE}; |
| | 665 | 18 | | private HashSet<IDCLEntity> entitiesToCheck = new HashSet<IDCLEntity>(); |
| | 665 | 19 | | private HashSet<IDCLEntity> checkedEntities = new HashSet<IDCLEntity>(); |
| | 665 | 20 | | private HashSet<IDCLEntity> persistentEntities = new HashSet<IDCLEntity>(); |
| | | 21 | | private ISceneBoundsFeedbackStyle feedbackStyle; |
| | | 22 | | private Coroutine entitiesCheckRoutine = null; |
| | | 23 | | private float lastCheckTime; |
| | | 24 | | |
| | | 25 | | public void Initialize() |
| | | 26 | | { |
| | 665 | 27 | | Start(); |
| | 665 | 28 | | } |
| | | 29 | | |
| | 665 | 30 | | public SceneBoundsChecker(ISceneBoundsFeedbackStyle feedbackStyle = null) |
| | | 31 | | { |
| | 665 | 32 | | this.feedbackStyle = feedbackStyle ?? new SceneBoundsFeedbackStyle_Simple(); |
| | 665 | 33 | | } |
| | | 34 | | |
| | | 35 | | public void SetFeedbackStyle(ISceneBoundsFeedbackStyle feedbackStyle) |
| | | 36 | | { |
| | 35 | 37 | | this.feedbackStyle.CleanFeedback(); |
| | 35 | 38 | | this.feedbackStyle = feedbackStyle; |
| | 35 | 39 | | Restart(); |
| | 35 | 40 | | } |
| | | 41 | | |
| | 69 | 42 | | public ISceneBoundsFeedbackStyle GetFeedbackStyle() { return feedbackStyle; } |
| | | 43 | | |
| | 0 | 44 | | public List<Material> GetOriginalMaterials(MeshesInfo meshesInfo) { return feedbackStyle.GetOriginalMaterials(me |
| | | 45 | | |
| | | 46 | | |
| | | 47 | | // TODO: Improve MessagingControllersManager.i.timeBudgetCounter usage once we have the centralized budget contr |
| | | 48 | | private IEnumerator CheckEntities() |
| | | 49 | | { |
| | 31595 | 50 | | while (true) |
| | | 51 | | { |
| | 32295 | 52 | | float elapsedTime = Time.realtimeSinceStartup - lastCheckTime; |
| | 32295 | 53 | | if ((entitiesToCheck.Count > 0) && (timeBetweenChecks <= 0f || elapsedTime >= timeBetweenChecks)) |
| | | 54 | | { |
| | | 55 | | //TODO(Brian): Remove later when we implement a centralized way of handling time budgets |
| | 64 | 56 | | var messagingManager = Environment.i.messaging.manager as MessagingControllersManager; |
| | | 57 | | |
| | | 58 | | void processEntitiesList(HashSet<IDCLEntity> entities) |
| | | 59 | | { |
| | 64 | 60 | | if (messagingManager != null && messagingManager.timeBudgetCounter <= 0f) |
| | | 61 | | { |
| | | 62 | | if(VERBOSE) |
| | | 63 | | logger.Verbose("Time budget reached, escaping entities processing until next iteration.. |
| | 0 | 64 | | return; |
| | | 65 | | } |
| | | 66 | | |
| | 64 | 67 | | using HashSet<IDCLEntity>.Enumerator iterator = entities.GetEnumerator(); |
| | 129 | 68 | | while (iterator.MoveNext()) |
| | | 69 | | { |
| | 65 | 70 | | if (messagingManager != null && messagingManager.timeBudgetCounter <= 0f) |
| | | 71 | | { |
| | 0 | 72 | | if(VERBOSE) |
| | | 73 | | logger.Verbose("Time budget reached, escaping entities processing until next iterati |
| | | 74 | | return; |
| | | 75 | | } |
| | | 76 | | |
| | 65 | 77 | | float startTime = Time.realtimeSinceStartup; |
| | | 78 | | |
| | 65 | 79 | | RunEntityEvaluation(iterator.Current); |
| | 65 | 80 | | checkedEntities.Add(iterator.Current); |
| | | 81 | | |
| | 65 | 82 | | float finishTime = Time.realtimeSinceStartup; |
| | | 83 | | |
| | 65 | 84 | | if ( messagingManager != null ) |
| | 65 | 85 | | messagingManager.timeBudgetCounter -= (finishTime - startTime); |
| | | 86 | | } |
| | 128 | 87 | | } |
| | | 88 | | |
| | 64 | 89 | | processEntitiesList(entitiesToCheck); |
| | | 90 | | |
| | | 91 | | // As we can't modify the hashset while traversing it, we keep track of the entities that should be |
| | 64 | 92 | | using (var iterator = checkedEntities.GetEnumerator()) |
| | | 93 | | { |
| | 129 | 94 | | while (iterator.MoveNext()) |
| | | 95 | | { |
| | 65 | 96 | | RemoveEntity(iterator.Current, removeIfPersistent: false, resetState: false); |
| | | 97 | | } |
| | 64 | 98 | | } |
| | | 99 | | |
| | | 100 | | if(VERBOSE) |
| | | 101 | | logger.Verbose($"Finished checking entities: checked entities {checkedEntities.Count}; entitiesT |
| | | 102 | | |
| | 64 | 103 | | checkedEntities.Clear(); |
| | | 104 | | |
| | 64 | 105 | | lastCheckTime = Time.realtimeSinceStartup; |
| | | 106 | | } |
| | | 107 | | |
| | 32295 | 108 | | yield return null; |
| | | 109 | | } |
| | | 110 | | } |
| | | 111 | | |
| | | 112 | | public void Restart() |
| | | 113 | | { |
| | 35 | 114 | | Stop(); |
| | 35 | 115 | | Start(); |
| | 35 | 116 | | } |
| | | 117 | | |
| | | 118 | | public void Start() |
| | | 119 | | { |
| | 700 | 120 | | if (entitiesCheckRoutine != null) |
| | 0 | 121 | | return; |
| | | 122 | | |
| | 700 | 123 | | lastCheckTime = Time.realtimeSinceStartup; |
| | 700 | 124 | | entitiesCheckRoutine = CoroutineStarter.Start(CheckEntities()); |
| | 700 | 125 | | } |
| | | 126 | | |
| | | 127 | | public void Stop() |
| | | 128 | | { |
| | 721 | 129 | | if (entitiesCheckRoutine == null) |
| | 21 | 130 | | return; |
| | | 131 | | |
| | 700 | 132 | | CoroutineStarter.Stop(entitiesCheckRoutine); |
| | 700 | 133 | | entitiesCheckRoutine = null; |
| | 700 | 134 | | } |
| | | 135 | | |
| | | 136 | | public void Dispose() |
| | | 137 | | { |
| | 665 | 138 | | Stop(); |
| | 665 | 139 | | } |
| | | 140 | | |
| | | 141 | | public void AddEntityToBeChecked(IDCLEntity entity, bool isPersistent = false, bool runPreliminaryEvaluation = f |
| | | 142 | | { |
| | 1236 | 143 | | if (!enabled || (entity.scene != null && entity.scene.isPersistent)) |
| | 950 | 144 | | return; |
| | | 145 | | |
| | 286 | 146 | | if (runPreliminaryEvaluation) |
| | | 147 | | { |
| | | 148 | | // The outer bounds check is cheaper than the regular check |
| | 230 | 149 | | RunEntityEvaluation(entity, onlyOuterBoundsCheck: true); |
| | | 150 | | |
| | | 151 | | // No need to add the entity to be checked later if we already found it outside scene outer boundaries. |
| | | 152 | | // When the correct events are triggered again, the entity will be checked again. |
| | 230 | 153 | | if (!isPersistent && !entity.isInsideSceneOuterBoundaries) |
| | 82 | 154 | | return; |
| | | 155 | | } |
| | | 156 | | |
| | 204 | 157 | | entitiesToCheck.Add(entity); |
| | | 158 | | |
| | 204 | 159 | | if (isPersistent) |
| | 6 | 160 | | persistentEntities.Add(entity); |
| | 204 | 161 | | } |
| | | 162 | | |
| | | 163 | | public void RemoveEntity(IDCLEntity entity, bool removeIfPersistent = false, bool resetState = false) |
| | | 164 | | { |
| | 528 | 165 | | if (!enabled || (!removeIfPersistent && persistentEntities.Contains(entity))) |
| | 0 | 166 | | return; |
| | | 167 | | |
| | 528 | 168 | | entitiesToCheck.Remove(entity); |
| | 528 | 169 | | persistentEntities.Remove(entity); |
| | | 170 | | |
| | 528 | 171 | | if(resetState) |
| | 461 | 172 | | SetMeshesAndComponentsInsideBoundariesState(entity, true); |
| | 528 | 173 | | } |
| | | 174 | | |
| | 7 | 175 | | public bool WasAddedAsPersistent(IDCLEntity entity) { return persistentEntities.Contains(entity); } |
| | | 176 | | |
| | | 177 | | // TODO: When we remove the DCLBuilderEntity class we'll be able to remove this overload |
| | | 178 | | public void RunEntityEvaluation(IDCLEntity entity) |
| | | 179 | | { |
| | 79 | 180 | | RunEntityEvaluation(entity, false); |
| | 79 | 181 | | } |
| | | 182 | | |
| | | 183 | | public void RunEntityEvaluation(IDCLEntity entity, bool onlyOuterBoundsCheck) |
| | | 184 | | { |
| | 320 | 185 | | if (entity == null || entity.gameObject == null || entity.scene == null || entity.scene.isPersistent) |
| | 7 | 186 | | return; |
| | | 187 | | |
| | | 188 | | // Recursively evaluate entity children as well, we need to check this up front because this entity may not |
| | 313 | 189 | | if (entity.children.Count > 0) |
| | | 190 | | { |
| | 9 | 191 | | using (var iterator = entity.children.GetEnumerator()) |
| | | 192 | | { |
| | 18 | 193 | | while (iterator.MoveNext()) |
| | | 194 | | { |
| | 9 | 195 | | RunEntityEvaluation(iterator.Current.Value, onlyOuterBoundsCheck); |
| | | 196 | | } |
| | 9 | 197 | | } |
| | | 198 | | } |
| | | 199 | | |
| | | 200 | | // If it has a mesh we don't evaluate its position due to artists "pivot point sloppiness", we evaluate its |
| | 313 | 201 | | if (HasMesh(entity)) |
| | 146 | 202 | | EvaluateMeshBounds(entity, onlyOuterBoundsCheck); |
| | | 203 | | else |
| | 167 | 204 | | EvaluateEntityPosition(entity, onlyOuterBoundsCheck); |
| | 167 | 205 | | } |
| | | 206 | | |
| | | 207 | | private void EvaluateMeshBounds(IDCLEntity entity, bool onlyOuterBoundsCheck = false) |
| | | 208 | | { |
| | | 209 | | // TODO: Can we cache the MaterialTransitionController somewhere to avoid this GetComponent() call? |
| | | 210 | | // If the mesh is being loaded we should skip the evaluation (it will be triggered again later when the load |
| | 146 | 211 | | if (entity.meshRootGameObject.GetComponent<MaterialTransitionController>()) // the object's MaterialTransiti |
| | 0 | 212 | | return; |
| | | 213 | | |
| | 146 | 214 | | var loadWrapper = Environment.i.world.state.GetLoaderForEntity(entity); |
| | 146 | 215 | | if (loadWrapper != null && !loadWrapper.alreadyLoaded) |
| | 8 | 216 | | return; |
| | | 217 | | |
| | 138 | 218 | | entity.isInsideSceneOuterBoundaries = entity.scene.IsInsideSceneOuterBoundaries(entity.meshesInfo.mergedBoun |
| | | 219 | | |
| | 138 | 220 | | if (!entity.isInsideSceneOuterBoundaries) |
| | 87 | 221 | | SetMeshesAndComponentsInsideBoundariesState(entity, false); |
| | | 222 | | |
| | 138 | 223 | | if (!onlyOuterBoundsCheck) |
| | 42 | 224 | | SetMeshesAndComponentsInsideBoundariesState(entity, IsEntityMeshInsideSceneBoundaries(entity)); |
| | 138 | 225 | | } |
| | | 226 | | |
| | | 227 | | private void EvaluateEntityPosition(IDCLEntity entity, bool onlyOuterBoundsCheck = false) |
| | | 228 | | { |
| | 167 | 229 | | Vector3 entityGOPosition = entity.gameObject.transform.position; |
| | 167 | 230 | | entity.isInsideSceneOuterBoundaries = entity.scene.IsInsideSceneOuterBoundaries(entityGOPosition); |
| | | 231 | | |
| | 167 | 232 | | if (!entity.isInsideSceneOuterBoundaries) |
| | | 233 | | { |
| | 32 | 234 | | SetEntityInsideBoundariesState(entity, false); |
| | 32 | 235 | | SetComponentsInsideBoundariesValidState(entity, false); |
| | | 236 | | } |
| | | 237 | | |
| | 167 | 238 | | if (!onlyOuterBoundsCheck) |
| | | 239 | | { |
| | 34 | 240 | | bool isInsideBoundaries = entity.scene.IsInsideSceneBoundaries(entityGOPosition + CommonScriptableObject |
| | 34 | 241 | | SetEntityInsideBoundariesState(entity, isInsideBoundaries); |
| | 34 | 242 | | SetComponentsInsideBoundariesValidState(entity, isInsideBoundaries); |
| | | 243 | | } |
| | 167 | 244 | | } |
| | | 245 | | |
| | | 246 | | private void SetEntityInsideBoundariesState(IDCLEntity entity, bool isInsideBoundaries) |
| | | 247 | | { |
| | 656 | 248 | | if (entity.isInsideSceneBoundaries == isInsideBoundaries) |
| | 540 | 249 | | return; |
| | | 250 | | |
| | 116 | 251 | | entity.isInsideSceneBoundaries = isInsideBoundaries; |
| | 116 | 252 | | OnEntityBoundsCheckerStatusChanged?.Invoke(entity, isInsideBoundaries); |
| | 3 | 253 | | } |
| | | 254 | | |
| | | 255 | | private bool HasMesh(IDCLEntity entity) |
| | | 256 | | { |
| | 313 | 257 | | return entity.meshRootGameObject != null |
| | | 258 | | && (entity.meshesInfo.colliders.Count > 0 |
| | | 259 | | || (entity.meshesInfo.renderers != null |
| | | 260 | | && entity.meshesInfo.renderers.Length > 0)); |
| | | 261 | | } |
| | | 262 | | |
| | | 263 | | public bool IsEntityMeshInsideSceneBoundaries(IDCLEntity entity) |
| | | 264 | | { |
| | 83 | 265 | | if (entity.meshesInfo == null |
| | | 266 | | || entity.meshesInfo.meshRootGameObject == null |
| | | 267 | | || entity.meshesInfo.mergedBounds == null) |
| | 25 | 268 | | return false; |
| | | 269 | | |
| | | 270 | | // 1st check (full mesh AABB) |
| | 58 | 271 | | bool isInsideBoundaries = entity.scene.IsInsideSceneBoundaries(entity.meshesInfo.mergedBounds); |
| | | 272 | | |
| | | 273 | | // 2nd check (submeshes & colliders AABB) |
| | 58 | 274 | | if (!isInsideBoundaries) |
| | | 275 | | { |
| | 24 | 276 | | isInsideBoundaries = AreSubmeshesInsideBoundaries(entity) && AreCollidersInsideBoundaries(entity); |
| | | 277 | | } |
| | | 278 | | |
| | 58 | 279 | | return isInsideBoundaries; |
| | | 280 | | } |
| | | 281 | | |
| | | 282 | | private bool AreSubmeshesInsideBoundaries(IDCLEntity entity) |
| | | 283 | | { |
| | 58 | 284 | | for (int i = 0; i < entity.meshesInfo.renderers.Length; i++) |
| | | 285 | | { |
| | 25 | 286 | | Renderer renderer = entity.meshesInfo.renderers[i]; |
| | 25 | 287 | | if (renderer == null) |
| | | 288 | | continue; |
| | | 289 | | |
| | 25 | 290 | | if (!entity.scene.IsInsideSceneBoundaries(MeshesInfoUtils.GetSafeBounds(renderer.bounds, renderer.transf |
| | 20 | 291 | | return false; |
| | | 292 | | } |
| | | 293 | | |
| | 4 | 294 | | return true; |
| | | 295 | | } |
| | | 296 | | |
| | | 297 | | private bool AreCollidersInsideBoundaries(IDCLEntity entity) |
| | | 298 | | { |
| | 13 | 299 | | foreach (Collider collider in entity.meshesInfo.colliders) |
| | | 300 | | { |
| | 4 | 301 | | if (collider == null) |
| | | 302 | | continue; |
| | | 303 | | |
| | 4 | 304 | | if (!entity.scene.IsInsideSceneBoundaries(MeshesInfoUtils.GetSafeBounds(collider.bounds, collider.transf |
| | 3 | 305 | | return false; |
| | | 306 | | } |
| | | 307 | | |
| | 1 | 308 | | return true; |
| | 3 | 309 | | } |
| | | 310 | | |
| | | 311 | | private void SetMeshesAndComponentsInsideBoundariesState(IDCLEntity entity, bool isInsideBoundaries) |
| | | 312 | | { |
| | 590 | 313 | | SetEntityInsideBoundariesState(entity, isInsideBoundaries); |
| | | 314 | | |
| | 590 | 315 | | SetEntityMeshesValidState(entity.meshesInfo, isInsideBoundaries); |
| | 590 | 316 | | SetEntityCollidersValidState(entity.meshesInfo, isInsideBoundaries); |
| | 590 | 317 | | SetComponentsInsideBoundariesValidState(entity, isInsideBoundaries); |
| | 590 | 318 | | } |
| | | 319 | | |
| | | 320 | | private void SetEntityMeshesValidState(MeshesInfo meshesInfo, bool isInsideBoundaries) |
| | | 321 | | { |
| | 590 | 322 | | feedbackStyle.ApplyFeedback(meshesInfo, isInsideBoundaries); |
| | 590 | 323 | | } |
| | | 324 | | |
| | | 325 | | private void SetEntityCollidersValidState(MeshesInfo meshesInfo, bool isInsideBoundaries) |
| | | 326 | | { |
| | 590 | 327 | | if (meshesInfo == null || meshesInfo.colliders.Count == 0 || !meshesInfo.currentShape.HasCollisions()) |
| | 394 | 328 | | return; |
| | | 329 | | |
| | 862 | 330 | | foreach (Collider collider in meshesInfo.colliders) |
| | | 331 | | { |
| | 235 | 332 | | if (collider == null) continue; |
| | | 333 | | |
| | 235 | 334 | | if (collider.enabled != isInsideBoundaries) |
| | 126 | 335 | | collider.enabled = isInsideBoundaries; |
| | | 336 | | } |
| | 196 | 337 | | } |
| | | 338 | | |
| | | 339 | | private void SetComponentsInsideBoundariesValidState(IDCLEntity entity, bool isInsideBoundaries) |
| | | 340 | | { |
| | 656 | 341 | | if(!DataStore.i.sceneBoundariesChecker.componentsCheckSceneBoundaries.ContainsKey(entity.entityId)) |
| | 648 | 342 | | return; |
| | | 343 | | |
| | 8 | 344 | | List<IOutOfSceneBoundariesHandler> components = DataStore.i.sceneBoundariesChecker.componentsCheckSceneBound |
| | | 345 | | |
| | 32 | 346 | | for (int i = 0; i < components.Count; i++) |
| | | 347 | | { |
| | 8 | 348 | | components[i].UpdateOutOfBoundariesState(isInsideBoundaries); |
| | | 349 | | } |
| | 8 | 350 | | } |
| | | 351 | | } |
| | | 352 | | } |