sbox-public/engine/Sandbox.Engine/Scene/Components/Light/Light.cs

using NativeEngine;
using static Sandbox.Component;

namespace Sandbox;

[Expose]
public abstract class Light : Component, IColorProvider, ExecuteInEditor, ITintable
{
	SceneLight _sceneObject;

	internal SceneLight SceneObject => _sceneObject;

	/// <summary>
	/// Advanced settings imported from legacy map data that don't have public properties yet
	/// (baking, bounce, shadow texture size, raw attenuation). Applied to the native light when it's
	/// created. Internal for now - we may expose some of these as proper properties later.
	/// </summary>
	internal LegacyLightData? LegacyData { get; set; }

	/// <summary>
	/// Backend carrier for map light settings that aren't exposed as component properties yet.
	/// </summary>
	internal struct LegacyLightData
	{
		public int DirectLight;
		public int BakeLightIndex;
		public float BakeLightIndexScale;
		public bool BakedLightIndexing;
		public float FogContributionStrength;
		public bool RenderDiffuse;
		public bool RenderSpecular;
		public int FogLighting;

		// Only set by light types whose components don't expose these (falloff, point cookie).
		public float? LinearAttenuation;
		public float? QuadraticAttenuation;
		public Texture Cookie;

		public readonly void ApplyTo( CSceneLightObject light )
		{
			switch ( DirectLight )
			{
				case 3: // HAMMER_DIRECT_LIGHT_STATIONARY
					light.SetLightFlags( light.GetLightFlags() | 16 ); // LIGHTTYPE_FLAGS_MIXED_SHADOWS
					light.SetLightFlags( light.GetLightFlags() | 32 ); // LIGHTTYPE_FLAGS_BAKED
					break;
				case 1: // HAMMER_DIRECT_LIGHT_BAKED
					light.SetLightFlags( light.GetLightFlags() | 32 ); // LIGHTTYPE_FLAGS_BAKED
					break;
			}

			light.SetBakeLightIndex( BakeLightIndex );
			light.SetBakeLightIndexScale( BakeLightIndexScale );
			light.SetUsesIndexedBakedLighting( BakedLightIndexing );
			light.SetFogContributionStength( FogContributionStrength );
			light.SetRenderDiffuse( RenderDiffuse );
			light.SetRenderSpecular( RenderSpecular );
			light.SetFogLightingMode( FogLighting );

			if ( LinearAttenuation is { } linear ) light.SetLinearAttn( linear );
			if ( QuadraticAttenuation is { } quadratic ) light.SetQuadraticAttn( quadratic );
			if ( Cookie is not null ) light.SetLightCookie( Cookie.native );
		}
	}

	/// <summary>
	/// The main color of the light
	/// </summary>
	[Property]
	public Color LightColor
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			if ( _sceneObject.IsValid() )
				_sceneObject.LightColor = value;
		}
	} = "#E9FAFF";

	[Property, Category( "Fog Settings" )]
	public FogInfluence FogMode
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			if ( _sceneObject.IsValid() )
				_sceneObject.FogLighting = (SceneLight.FogLightingMode)value;
		}
	} = FogInfluence.Enabled;

	[Property, Range( 0, 1 ), Category( "Fog Settings" )]
	public float FogStrength
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			if ( _sceneObject.IsValid() )
				_sceneObject.FogStrength = value;
		}
	} = 1.0f;

	/// <summary>
	/// Should this light cast shadows?
	/// </summary>
	[Property, Category( "Shadows" ), Order( -10 )]
	public bool Shadows
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			if ( _sceneObject.IsValid() )
				_sceneObject.ShadowsEnabled = value;
		}
	} = true;

	[Property, Range( 0, 1 ), Category( "Shadows" ), Advanced]
	public float ShadowBias
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			if ( _sceneObject.IsValid() )
				_sceneObject.ShadowBias = value;
		}
	} = 0.0005f;

	[Property, Range( 0, 1 ), Category( "Shadows" )]
	public float ShadowHardness
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			if ( _sceneObject.IsValid() )
				_sceneObject.ShadowHardness = value;
		}
	} = 0.0f;

	/// <summary>
	/// Which lighting terms this light is allowed to contribute to. For example,
	/// turn off <see cref="LightContribution.Specular"/> to stop a light producing highlights.
	/// </summary>
	[Property, EnumButtonGroup, Title( "Contributes" )]
	public LightContribution Contribution
	{
		get;
		set
		{
			if ( field == value ) return;
			field = value;

			ApplyContribution();
		}
	} = LightContribution.Diffuse | LightContribution.Specular | LightContribution.Transmissive;

	void ApplyContribution()
	{
		if ( !_sceneObject.IsValid() )
			return;

		_sceneObject.RenderDiffuse = Contribution.HasFlag( LightContribution.Diffuse );
		_sceneObject.RenderSpecular = Contribution.HasFlag( LightContribution.Specular );
		_sceneObject.RenderTransmissive = Contribution.HasFlag( LightContribution.Transmissive );
	}

	Color IColorProvider.ComponentColor => LightColor;

	Color ITintable.Color { get => LightColor; set => LightColor = value; }

	public enum FogInfluence
	{
		[Icon( "blur_off" )]
		Disabled = SceneLight.FogLightingMode.None,
		[Icon( "blur_linear" )]
		Enabled = SceneLight.FogLightingMode.Dynamic,
		[Icon( "blur_on" )]
		WithoutShadows = SceneLight.FogLightingMode.DynamicNoShadows
	}

	/// <summary>
	/// Which lighting terms a light is allowed to contribute to.
	/// </summary>
	[Flags]
	public enum LightContribution
	{
		/// <summary>
		/// Soft, even shading across a surface.
		/// </summary>
		[Icon( "wb_sunny" )]
		Diffuse = 1,

		/// <summary>
		/// Glossy highlights and reflections.
		/// </summary>
		[Icon( "auto_awesome" )]
		Specular = 2,

		/// <summary>
		/// Light passing through surfaces (translucency / subsurface).
		/// </summary>
		[Icon( "opacity" )]
		Transmissive = 4
	}

	protected override void OnAwake()
	{
		Tags.Add( "light" );

		base.OnAwake();
	}

	protected override void OnEnabled()
	{
		Assert.True( !_sceneObject.IsValid(), "_sceneObject should be null" );
		Assert.NotNull( Scene, "Scene should not be null" );

		_sceneObject = CreateSceneObject();

		if ( _sceneObject.IsValid() )
		{
			_sceneObject.Component = this;
			_sceneObject.LightColor = LightColor;
			_sceneObject.ShadowsEnabled = Shadows;
			_sceneObject.FogLighting = (SceneLight.FogLightingMode)FogMode;
			_sceneObject.FogStrength = FogStrength;
			_sceneObject.ShadowBias = ShadowBias;
			_sceneObject.ShadowHardness = ShadowHardness;
			ApplyContribution();

			// Advanced map settings not covered by properties - overrides native state set above.
			if ( LegacyData is { } legacy )
				legacy.ApplyTo( _sceneObject.lightNative );

			OnTransformChanged();
			OnTagsChanged();

			Transform.OnTransformChanged += OnTransformChanged;
		}
	}

	protected override void OnDisabled()
	{
		Transform.OnTransformChanged -= OnTransformChanged;

		_sceneObject?.Delete();
		_sceneObject = null;
	}

	protected abstract SceneLight CreateSceneObject();

	void OnTransformChanged()
	{
		if ( !_sceneObject.IsValid() )
			return;

		_sceneObject.Transform = WorldTransform;
	}

	/// <summary>
	/// Tags have been updated - lets update our light's tags
	/// </summary>
	protected override void OnTagsChanged()
	{
		if ( !_sceneObject.IsValid() )
			return;

		_sceneObject?.Tags.SetFrom( Tags );
	}
}