< Summary

Class:DCL.Components.PBRMaterial
Assembly:MainScripts
File(s):/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/Components/Materials/PBRMaterial.cs
Covered lines:120
Uncovered lines:29
Coverable lines:149
Total lines:326
Line coverage:80.5% (120 of 149)
Covered branches:0
Total branches:0

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity NPath complexity Sequence coverage
Model()0%110100%
GetDataFromJSON(...)0%110100%
PBRMaterial()0%110100%
GetModel()0%2100%
GetClassId()0%2100%
AttachTo(...)0%2.032080%
ApplyChanges(...)0%440100%
SetupTransparencyMode()0%168050%
LoadMaterial(...)0%4.054085.71%
OnMaterialAttached(...)0%330100%
InitMaterial(...)0%8.518080%
OnShapeUpdated(...)0%220100%
OnMaterialDetached(...)0%440100%
SetMaterialTexture(...)0%4.054085.71%
AreSameTextureComponent(...)0%2.152066.67%
SwitchTextureComponent(...)0%220100%
Dispose()0%660100%

File(s)

/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/Components/Materials/PBRMaterial.cs

#LineLine coverage
 1using DCL.Controllers;
 2using DCL.Helpers;
 3using DCL.Models;
 4using System.Collections;
 5using UnityEngine;
 6using UnityEngine.Rendering;
 7
 8namespace DCL.Components
 9{
 10    public class PBRMaterial : BaseDisposable
 11    {
 12        [System.Serializable]
 13        public class Model : BaseModel
 14        {
 15            [Range(0f, 1f)]
 6316            public float alphaTest = 0.5f;
 17
 6318            public Color albedoColor = Color.white;
 19            public string albedoTexture;
 6320            public float metallic = 0.5f;
 6321            public float roughness = 0.5f;
 6322            public float microSurface = 1f; // Glossiness
 6323            public float specularIntensity = 1f;
 24
 25            public string alphaTexture;
 26            public string emissiveTexture;
 6327            public Color emissiveColor = Color.black;
 6328            public float emissiveIntensity = 2f;
 6329            public Color reflectivityColor = Color.white;
 6330            public float directIntensity = 1f;
 31            public string bumpTexture;
 6332            public bool castShadows = true;
 33
 34            [Range(0, 4)]
 6335            public int transparencyMode = 4; // 0: OPAQUE; 1: ALPHATEST; 2: ALPHBLEND; 3: ALPHATESTANDBLEND; 4: AUTO (En
 36
 2237            public override BaseModel GetDataFromJSON(string json) { return Utils.SafeFromJson<Model>(json); }
 38        }
 39
 40        enum TransparencyMode
 41        {
 42            OPAQUE,
 43            ALPHA_TEST,
 44            ALPHA_BLEND,
 45            ALPHA_TEST_AND_BLEND,
 46            AUTO
 47        }
 48
 049        public Material material { get; set; }
 50        private string currentMaterialResourcesFilename;
 51
 52        const string MATERIAL_RESOURCES_PATH = "Materials/";
 53        const string PBR_MATERIAL_NAME = "ShapeMaterial";
 54
 55        DCLTexture albedoDCLTexture = null;
 56        DCLTexture alphaDCLTexture = null;
 57        DCLTexture emissiveDCLTexture = null;
 58        DCLTexture bumpDCLTexture = null;
 59
 1960        public PBRMaterial()
 61        {
 1962            model = new Model();
 63
 1964            LoadMaterial(PBR_MATERIAL_NAME);
 65
 1966            OnAttach += OnMaterialAttached;
 1967            OnDetach += OnMaterialDetached;
 1968        }
 69
 070        new public Model GetModel() { return (Model) model; }
 71
 072        public override int GetClassId() { return (int) CLASS_ID.PBR_MATERIAL; }
 73
 74        public override void AttachTo(IDCLEntity entity, System.Type overridenAttachedType = null)
 75        {
 2076            if (attachedEntities.Contains(entity))
 77            {
 078                return;
 79            }
 80
 2081            entity.RemoveSharedComponent(typeof(BasicMaterial));
 2082            base.AttachTo(entity);
 2083        }
 84
 85        public override IEnumerator ApplyChanges(BaseModel newModel)
 86        {
 2287            Model model = (Model) newModel;
 88
 2289            LoadMaterial(PBR_MATERIAL_NAME);
 90
 2291            material.SetColor(ShaderUtils.BaseColor, model.albedoColor);
 92
 2293            if (model.emissiveColor != Color.clear && model.emissiveColor != Color.black)
 94            {
 495                material.EnableKeyword("_EMISSION");
 96            }
 97
 98            // METALLIC/SPECULAR CONFIGURATIONS
 2299            material.SetColor(ShaderUtils.EmissionColor, model.emissiveColor * model.emissiveIntensity);
 22100            material.SetColor(ShaderUtils.SpecColor, model.reflectivityColor);
 101
 22102            material.SetFloat(ShaderUtils.Metallic, model.metallic);
 22103            material.SetFloat(ShaderUtils.Smoothness, 1 - model.roughness);
 22104            material.SetFloat(ShaderUtils.EnvironmentReflections, model.microSurface);
 22105            material.SetFloat(ShaderUtils.SpecularHighlights, model.specularIntensity * model.directIntensity);
 106
 107            // FETCH AND LOAD EMISSIVE TEXTURE
 22108            SetMaterialTexture(ShaderUtils.EmissionMap, model.emissiveTexture, emissiveDCLTexture);
 109
 22110            SetupTransparencyMode();
 111
 112            // FETCH AND LOAD TEXTURES
 22113            SetMaterialTexture(ShaderUtils.BaseMap, model.albedoTexture, albedoDCLTexture);
 22114            SetMaterialTexture(ShaderUtils.AlphaTexture, model.alphaTexture, alphaDCLTexture);
 22115            SetMaterialTexture(ShaderUtils.BumpMap, model.bumpTexture, bumpDCLTexture);
 116
 50117            foreach (IDCLEntity decentralandEntity in attachedEntities)
 118            {
 3119                InitMaterial(decentralandEntity.meshRootGameObject);
 120            }
 121
 22122            return null;
 123        }
 124
 125        private void SetupTransparencyMode()
 126        {
 22127            Model model = (Model) this.model;
 128
 129            // Reset shader keywords
 22130            material.DisableKeyword("_ALPHATEST_ON"); // Cut Out Transparency
 22131            material.DisableKeyword("_ALPHABLEND_ON"); // Fade Transparency
 22132            material.DisableKeyword("_ALPHAPREMULTIPLY_ON"); // Transparent
 133
 22134            TransparencyMode transparencyMode = (TransparencyMode) model.transparencyMode;
 135
 22136            if (transparencyMode == TransparencyMode.AUTO)
 137            {
 14138                if (!string.IsNullOrEmpty(model.alphaTexture) || model.albedoColor.a < 1f) //AlphaBlend
 139                {
 0140                    transparencyMode = TransparencyMode.ALPHA_BLEND;
 0141                }
 142                else // Opaque
 143                {
 14144                    transparencyMode = TransparencyMode.OPAQUE;
 145                }
 146            }
 147
 148            switch (transparencyMode)
 149            {
 150                case TransparencyMode.OPAQUE:
 14151                    material.renderQueue = (int) UnityEngine.Rendering.RenderQueue.Geometry;
 14152                    material.SetFloat(ShaderUtils.AlphaClip, 0);
 14153                    break;
 154                case TransparencyMode.ALPHA_TEST: // ALPHATEST
 0155                    material.EnableKeyword("_ALPHATEST_ON");
 156
 0157                    material.SetInt(ShaderUtils.SrcBlend, (int) UnityEngine.Rendering.BlendMode.One);
 0158                    material.SetInt(ShaderUtils.DstBlend, (int) UnityEngine.Rendering.BlendMode.Zero);
 0159                    material.SetInt(ShaderUtils.ZWrite, 1);
 0160                    material.SetFloat(ShaderUtils.AlphaClip, 1);
 0161                    material.SetFloat(ShaderUtils.Cutoff, model.alphaTest);
 0162                    material.SetInt("_Surface", 0);
 0163                    material.renderQueue = (int) UnityEngine.Rendering.RenderQueue.AlphaTest;
 0164                    break;
 165                case TransparencyMode.ALPHA_BLEND: // ALPHABLEND
 8166                    material.EnableKeyword("_ALPHABLEND_ON");
 167
 8168                    material.SetInt(ShaderUtils.SrcBlend, (int) UnityEngine.Rendering.BlendMode.SrcAlpha);
 8169                    material.SetInt(ShaderUtils.DstBlend, (int) UnityEngine.Rendering.BlendMode.OneMinusSrcAlpha);
 8170                    material.SetInt(ShaderUtils.ZWrite, 0);
 8171                    material.SetFloat(ShaderUtils.AlphaClip, 0);
 8172                    material.renderQueue = (int) UnityEngine.Rendering.RenderQueue.Transparent;
 8173                    material.SetInt("_Surface", 1);
 8174                    break;
 175                case TransparencyMode.ALPHA_TEST_AND_BLEND:
 0176                    material.EnableKeyword("_ALPHAPREMULTIPLY_ON");
 177
 0178                    material.SetInt(ShaderUtils.SrcBlend, (int) UnityEngine.Rendering.BlendMode.One);
 0179                    material.SetInt(ShaderUtils.DstBlend, (int) UnityEngine.Rendering.BlendMode.OneMinusSrcAlpha);
 0180                    material.SetInt(ShaderUtils.ZWrite, 0);
 0181                    material.SetFloat(ShaderUtils.AlphaClip, 1);
 0182                    material.renderQueue = (int) UnityEngine.Rendering.RenderQueue.Transparent;
 0183                    material.SetInt("_Surface", 1);
 184                    break;
 185            }
 0186        }
 187
 188        private void LoadMaterial(string resourcesFilename)
 189        {
 41190            if (material == null || currentMaterialResourcesFilename != resourcesFilename)
 191            {
 19192                if (material != null)
 0193                    Object.Destroy(material);
 194
 19195                material = new Material(Utils.EnsureResourcesMaterial(MATERIAL_RESOURCES_PATH + resourcesFilename));
 196#if UNITY_EDITOR
 19197                material.name = "PBRMaterial_" + id;
 198#endif
 19199                currentMaterialResourcesFilename = resourcesFilename;
 200            }
 41201        }
 202
 203        void OnMaterialAttached(IDCLEntity entity)
 204        {
 20205            entity.OnShapeUpdated -= OnShapeUpdated;
 20206            entity.OnShapeUpdated += OnShapeUpdated;
 207
 20208            if (entity.meshRootGameObject != null)
 209            {
 17210                var meshRenderer = entity.meshRootGameObject.GetComponent<MeshRenderer>();
 211
 17212                if (meshRenderer != null)
 213                {
 17214                    InitMaterial(entity.meshRootGameObject);
 215                }
 216            }
 20217        }
 218
 219        void InitMaterial(GameObject meshGameObject)
 220        {
 28221            if (meshGameObject == null)
 222            {
 7223                return;
 224            }
 225
 21226            var meshRenderer = meshGameObject.GetComponent<MeshRenderer>();
 21227            if (meshRenderer == null)
 0228                return;
 21229            Model model = (Model) this.model;
 230
 21231            meshRenderer.shadowCastingMode = model.castShadows ? ShadowCastingMode.On : ShadowCastingMode.Off;
 21232            if (meshRenderer.sharedMaterial != material)
 233            {
 18234                MaterialTransitionController
 235                    matTransition = meshGameObject.GetComponent<MaterialTransitionController>();
 236
 18237                if (matTransition != null && matTransition.canSwitchMaterial)
 238                {
 0239                    matTransition.finalMaterials = new Material[] { material };
 0240                    matTransition.PopulateTargetRendererWithMaterial(matTransition.finalMaterials);
 241                }
 242
 18243                meshRenderer.sharedMaterial = material;
 18244                SRPBatchingHelper.OptimizeMaterial(material);
 245            }
 21246        }
 247
 248        private void OnShapeUpdated(IDCLEntity entity)
 249        {
 8250            if (entity != null)
 251            {
 8252                InitMaterial(entity.meshRootGameObject);
 253            }
 8254        }
 255
 256        void OnMaterialDetached(IDCLEntity entity)
 257        {
 13258            if (entity.meshRootGameObject == null)
 259            {
 9260                return;
 261            }
 262
 4263            entity.OnShapeUpdated -= OnShapeUpdated;
 264
 4265            var meshRenderer = entity.meshRootGameObject.GetComponent<MeshRenderer>();
 266
 4267            if (meshRenderer && meshRenderer.sharedMaterial == material)
 268            {
 4269                meshRenderer.sharedMaterial = null;
 270            }
 4271        }
 272
 273        void SetMaterialTexture(int materialPropertyId, string textureComponentId, DCLTexture cachedDCLTexture)
 274        {
 88275            if (!string.IsNullOrEmpty(textureComponentId))
 276            {
 19277                if (!AreSameTextureComponent(cachedDCLTexture, textureComponentId))
 278                {
 19279                    CoroutineStarter.Start(DCLTexture.FetchTextureComponent(scene, textureComponentId,
 280                        (fetchedDCLTexture) =>
 281                        {
 19282                            if (material != null)
 283                            {
 19284                                material.SetTexture(materialPropertyId, fetchedDCLTexture.texture);
 19285                                SwitchTextureComponent(cachedDCLTexture, fetchedDCLTexture);
 286                            }
 19287                        }));
 288                }
 19289            }
 290            else
 291            {
 69292                material.SetTexture(materialPropertyId, null);
 69293                cachedDCLTexture?.DetachFrom(this);
 294            }
 0295        }
 296
 297        bool AreSameTextureComponent(DCLTexture dclTexture, string textureId)
 298        {
 19299            if (dclTexture == null)
 19300                return false;
 0301            return dclTexture.id == textureId;
 302        }
 303
 304        void SwitchTextureComponent(DCLTexture cachedTexture, DCLTexture newTexture)
 305        {
 19306            cachedTexture?.DetachFrom(this);
 19307            cachedTexture = newTexture;
 19308            cachedTexture.AttachTo(this);
 19309        }
 310
 311        public override void Dispose()
 312        {
 12313            albedoDCLTexture?.DetachFrom(this);
 12314            alphaDCLTexture?.DetachFrom(this);
 12315            emissiveDCLTexture?.DetachFrom(this);
 12316            bumpDCLTexture?.DetachFrom(this);
 317
 12318            if (material != null)
 319            {
 12320                Utils.SafeDestroy(material);
 321            }
 322
 12323            base.Dispose();
 12324        }
 325    }
 326}
Generated by: ReportGenerator 4.8.9.0
01/09/2022 - 01:39:35
GitHub | www.palmmedia.de

Methods/Properties

Model()
GetDataFromJSON(System.String)
material()
material(UnityEngine.Material)
PBRMaterial()
GetModel()
GetClassId()
AttachTo(DCL.Models.IDCLEntity, System.Type)
ApplyChanges(BaseModel)
SetupTransparencyMode()
LoadMaterial(System.String)
OnMaterialAttached(DCL.Models.IDCLEntity)
InitMaterial(UnityEngine.GameObject)
OnShapeUpdated(DCL.Models.IDCLEntity)
OnMaterialDetached(DCL.Models.IDCLEntity)
SetMaterialTexture(System.Int32, System.String, DCL.DCLTexture)
AreSameTextureComponent(DCL.DCLTexture, System.String)
SwitchTextureComponent(DCL.DCLTexture, DCL.DCLTexture)
Dispose()