237 lines
9.1 KiB
C#
237 lines
9.1 KiB
C#
|
#if UNITY_EDITOR
|
||
|
|
using UnityEditor;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
using System;
|
||
|
|
using System.Dynamic;
|
||
|
|
using UnityEngine.Serialization;
|
||
|
|
|
||
|
|
namespace UnityEngine.Rendering
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// Data-Driven Lens Flare can be added on any gameobject
|
||
|
|
/// </summary>
|
||
|
|
[ExecuteAlways]
|
||
|
|
[AddComponentMenu("Rendering/Lens Flare (SRP)")]
|
||
|
|
public sealed class LensFlareComponentSRP : MonoBehaviour
|
||
|
|
{
|
||
|
|
[SerializeField]
|
||
|
|
private LensFlareDataSRP m_LensFlareData = null;
|
||
|
|
|
||
|
|
enum Version
|
||
|
|
{
|
||
|
|
Initial,
|
||
|
|
}
|
||
|
|
|
||
|
|
#pragma warning disable 414
|
||
|
|
[SerializeField]
|
||
|
|
Version version = Version.Initial;
|
||
|
|
#pragma warning restore 414
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Lens flare asset used on this component
|
||
|
|
/// </summary>
|
||
|
|
public LensFlareDataSRP lensFlareData
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return m_LensFlareData;
|
||
|
|
}
|
||
|
|
set
|
||
|
|
{
|
||
|
|
m_LensFlareData = value;
|
||
|
|
OnValidate();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Intensity
|
||
|
|
/// </summary>
|
||
|
|
[Min(0.0f)]
|
||
|
|
public float intensity = 1.0f;
|
||
|
|
/// <summary>
|
||
|
|
/// Distance used to scale the Distance Attenuation Curve
|
||
|
|
/// </summary>
|
||
|
|
[Min(1e-5f)]
|
||
|
|
public float maxAttenuationDistance = 100.0f;
|
||
|
|
/// <summary>
|
||
|
|
/// Distance used to scale the Scale Attenuation Curve
|
||
|
|
/// </summary>
|
||
|
|
[Min(1e-5f)]
|
||
|
|
public float maxAttenuationScale = 100.0f;
|
||
|
|
/// <summary>
|
||
|
|
/// Attenuation by distance
|
||
|
|
/// </summary>
|
||
|
|
public AnimationCurve distanceAttenuationCurve = new AnimationCurve(new Keyframe(0.0f, 1.0f), new Keyframe(1.0f, 0.0f));
|
||
|
|
/// <summary>
|
||
|
|
/// Scale by distance, use the same distance as distanceAttenuationCurve
|
||
|
|
/// </summary>
|
||
|
|
public AnimationCurve scaleByDistanceCurve = new AnimationCurve(new Keyframe(0.0f, 1.0f), new Keyframe(1.0f, 0.0f));
|
||
|
|
/// <summary>
|
||
|
|
/// If component attached to a light, attenuation the lens flare per light type
|
||
|
|
/// </summary>
|
||
|
|
public bool attenuationByLightShape = true;
|
||
|
|
/// <summary>
|
||
|
|
/// Attenuation used radially, which allow for instance to enable flare only on the edge of the screen
|
||
|
|
/// </summary>
|
||
|
|
public AnimationCurve radialScreenAttenuationCurve = new AnimationCurve(new Keyframe(0.0f, 1.0f), new Keyframe(1.0f, 1.0f));
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Enable Occlusion feature
|
||
|
|
/// </summary>
|
||
|
|
public bool useOcclusion = false;
|
||
|
|
/// <summary>
|
||
|
|
/// Enable Occlusion using Background Cloud (for instance: CloudLayer)
|
||
|
|
/// Please use useFogOpacityOcclusion instead.
|
||
|
|
/// </summary>
|
||
|
|
[Obsolete("Replaced by environmentOcclusion.")]
|
||
|
|
public bool useBackgroundCloudOcclusion = false;
|
||
|
|
|
||
|
|
/// <summary>Enable occlusion from environment effects supported by the render pipeline. This may include opacity from volumetric clouds, background clouds, fog and water.</summary>
|
||
|
|
[FormerlySerializedAs("volumetricCloudOcclusion")]
|
||
|
|
[FormerlySerializedAs("useFogOpacityOcclusion")]
|
||
|
|
public bool environmentOcclusion = false;
|
||
|
|
/// <summary>
|
||
|
|
/// Enable Occlusion with Water
|
||
|
|
/// </summary>
|
||
|
|
[Obsolete("Replaced by environmentOcclusion.")]
|
||
|
|
public bool useWaterOcclusion = false;
|
||
|
|
/// <summary>
|
||
|
|
/// Radius around the light used to occlude the flare (value in world space)
|
||
|
|
/// </summary>
|
||
|
|
[Min(0.0f)]
|
||
|
|
public float occlusionRadius = 0.1f;
|
||
|
|
/// <summary>
|
||
|
|
/// Random Samples Count used inside the disk with 'occlusionRadius'
|
||
|
|
/// </summary>
|
||
|
|
[Range(1, 64)]
|
||
|
|
public uint sampleCount = 32;
|
||
|
|
/// <summary>
|
||
|
|
/// Z Occlusion Offset allow us to offset the plane where the disc of occlusion is place (closer to camera), value on world space.
|
||
|
|
/// Useful for instance to sample occlusion outside a light bulb if we place a flare inside the light bulb
|
||
|
|
/// </summary>
|
||
|
|
public float occlusionOffset = 0.05f;
|
||
|
|
/// <summary>
|
||
|
|
/// Global Scale
|
||
|
|
/// </summary>
|
||
|
|
[Min(0.0f)]
|
||
|
|
public float scale = 1.0f;
|
||
|
|
/// <summary>
|
||
|
|
/// If allowOffScreen is true then If the lens flare is outside the screen we still emit the flare on screen
|
||
|
|
/// </summary>
|
||
|
|
public bool allowOffScreen = false;
|
||
|
|
/// <summary>
|
||
|
|
/// If volumetricCloudOcclusion is true then use the volumetric cloud (on HDRP only) for the occlusion
|
||
|
|
/// Please use useFogOpacityOcclusion instead.
|
||
|
|
/// </summary>
|
||
|
|
[Obsolete("Please use environmentOcclusion instead.")]
|
||
|
|
public bool volumetricCloudOcclusion = false;
|
||
|
|
|
||
|
|
/// Our default celestial body will have an angular radius of 3.3 degrees. This is an arbitrary number, but must be kept constant
|
||
|
|
/// so the occlusion radius for direct lights is consistent regardless of near / far clip plane configuration.
|
||
|
|
private static float sCelestialAngularRadius = 3.3f * Mathf.PI / 180.0f;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// OcclusionRemapCurve allow the occlusion [from 0 to 1] to be remap with any desired shape.
|
||
|
|
/// </summary>
|
||
|
|
public TextureCurve occlusionRemapCurve = new TextureCurve(AnimationCurve.Linear(0.0f, 0.0f, 1.0f, 1.0f), 1.0f, false, new Vector2(0.0f, 1.0f));
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Light override, change the light which influences the flares including "modulate by light color" and "Attenuation By Light Shape" but not the position.
|
||
|
|
/// </summary>
|
||
|
|
public Light lightOverride = null;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Retrieves the projected occlusion radius from a particular celestial in the infinity plane with an angular radius.
|
||
|
|
/// This is used for directional lights which require to have consistent occlusion radius regardless of the near/farplane configuration.
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="mainCam">The camera utilized to calculate the occlusion radius</param>
|
||
|
|
/// <returns>The value, in world units, of the occlusion angular radius.</returns>
|
||
|
|
public float celestialProjectedOcclusionRadius(Camera mainCam)
|
||
|
|
{
|
||
|
|
float projectedRadius = (float)Math.Tan(sCelestialAngularRadius) * mainCam.farClipPlane;
|
||
|
|
return occlusionRadius * projectedRadius;
|
||
|
|
}
|
||
|
|
|
||
|
|
void Awake()
|
||
|
|
{
|
||
|
|
#if UNITY_EDITOR
|
||
|
|
if (!lensFlareData)
|
||
|
|
lensFlareData = AssetDatabase.LoadAssetAtPath<LensFlareDataSRP>("Packages/com.unity.render-pipelines.core/Runtime/RenderPipelineResources/Default Lens Flare (SRP).asset");
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Add or remove the lens flare to the queue of PostProcess
|
||
|
|
/// </summary>
|
||
|
|
void OnEnable()
|
||
|
|
{
|
||
|
|
if (lensFlareData)
|
||
|
|
LensFlareCommonSRP.Instance.AddData(this);
|
||
|
|
else
|
||
|
|
LensFlareCommonSRP.Instance.RemoveData(this);
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Remove the lens flare from the queue of PostProcess
|
||
|
|
/// </summary>
|
||
|
|
void OnDisable()
|
||
|
|
{
|
||
|
|
LensFlareCommonSRP.Instance.RemoveData(this);
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Add or remove the lens flare from the queue of PostProcess
|
||
|
|
/// </summary>
|
||
|
|
void OnValidate()
|
||
|
|
{
|
||
|
|
if (isActiveAndEnabled && lensFlareData != null)
|
||
|
|
{
|
||
|
|
LensFlareCommonSRP.Instance.AddData(this);
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
LensFlareCommonSRP.Instance.RemoveData(this);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
private void OnDestroy()
|
||
|
|
{
|
||
|
|
occlusionRemapCurve.Release();
|
||
|
|
}
|
||
|
|
|
||
|
|
#if UNITY_EDITOR
|
||
|
|
private float sDebugClippingSafePercentage = 0.9f; //for debug gizmo, only push 90% further so we avoid clipping of debug lines.
|
||
|
|
void OnDrawGizmosSelected()
|
||
|
|
{
|
||
|
|
Camera mainCam = Camera.current;
|
||
|
|
if (mainCam != null && useOcclusion)
|
||
|
|
{
|
||
|
|
Vector3 positionWS;
|
||
|
|
float adjustedOcclusionRadius = occlusionRadius;
|
||
|
|
Light light = GetComponent<Light>();
|
||
|
|
if (light != null && light.type == LightType.Directional)
|
||
|
|
{
|
||
|
|
positionWS = -transform.forward * (mainCam.farClipPlane * sDebugClippingSafePercentage) + mainCam.transform.position;
|
||
|
|
adjustedOcclusionRadius = celestialProjectedOcclusionRadius(mainCam);
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
positionWS = transform.position;
|
||
|
|
}
|
||
|
|
|
||
|
|
Color previousH = Handles.color;
|
||
|
|
Color previousG = Gizmos.color;
|
||
|
|
Handles.color = Color.red;
|
||
|
|
Gizmos.color = Color.red;
|
||
|
|
Vector3 dir = (mainCam.transform.position - positionWS).normalized;
|
||
|
|
Handles.DrawWireDisc(positionWS + dir * occlusionOffset, dir, adjustedOcclusionRadius, 1.0f);
|
||
|
|
Gizmos.DrawWireSphere(positionWS, occlusionOffset);
|
||
|
|
Gizmos.color = previousG;
|
||
|
|
Handles.color = previousH;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
}
|