暫無描述
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

VolumeParameter.cs 75KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Collections.ObjectModel;
  4. using System.Diagnostics;
  5. using System.Linq;
  6. using System.Reflection;
  7. using System.Runtime.CompilerServices;
  8. namespace UnityEngine.Rendering
  9. {
  10. // We need this base class to be able to store a list of VolumeParameter in collections as we
  11. // can't store VolumeParameter<T> with variable T types in the same collection. As a result some
  12. // of the following is a bit hacky...
  13. /// <summary>
  14. /// The base class for all parameters types stored in a <see cref="VolumeComponent"/>.
  15. /// </summary>
  16. /// <seealso cref="VolumeParameter{T}"/>
  17. public abstract class VolumeParameter : ICloneable
  18. {
  19. /// <summary>
  20. /// A beautified string for debugger output. This is set on a <c>DebuggerDisplay</c> on every
  21. /// parameter types.
  22. /// </summary>
  23. public const string k_DebuggerDisplay = "{m_Value} ({m_OverrideState})";
  24. /// <summary>
  25. /// The current override state for this parameter. The Volume system considers overriden parameters
  26. /// for blending, and ignores non-overriden ones.
  27. /// </summary>
  28. /// <seealso cref="overrideState"/>
  29. [SerializeField]
  30. protected bool m_OverrideState;
  31. /// <summary>
  32. /// The current override state for this parameter. The Volume system considers overriden parameters
  33. /// for blending, and ignores non-overriden ones. It is also used in the VolumeStack to determine whether
  34. /// a given parameter has been overridden and thus needs to be reset to its default state in the next update.
  35. /// </summary>
  36. /// <remarks>
  37. /// You can override this property to define custom behaviors when the override state
  38. /// changes.
  39. /// </remarks>
  40. /// <seealso cref="m_OverrideState"/>
  41. public virtual bool overrideState
  42. {
  43. get => m_OverrideState;
  44. set => m_OverrideState = value;
  45. }
  46. internal abstract void Interp(VolumeParameter from, VolumeParameter to, float t);
  47. /// <summary>
  48. /// Casts and gets the typed value of this parameter.
  49. /// </summary>
  50. /// <typeparam name="T">The type of the value stored in this parameter</typeparam>
  51. /// <returns>A value of type <typeparamref name="T"/>.</returns>
  52. /// <remarks>
  53. /// This method is unsafe and does not do any type checking.
  54. /// </remarks>
  55. public T GetValue<T>()
  56. {
  57. return ((VolumeParameter<T>)this).value;
  58. }
  59. /// <summary>
  60. /// Sets the value of this parameter to the value in <paramref name="parameter"/>.
  61. /// </summary>
  62. /// <param name="parameter">The <see cref="VolumeParameter"/> to copy the value from.</param>
  63. public abstract void SetValue(VolumeParameter parameter);
  64. /// <summary>
  65. /// Unity calls this method when the parent <see cref="VolumeComponent"/> loads.
  66. /// </summary>
  67. /// <remarks>
  68. /// Use this if you need to access fields and properties that you can not access in
  69. /// the constructor of a <c>ScriptableObject</c>. (<see cref="VolumeParameter"/> are
  70. /// generally declared and initialized in a <see cref="VolumeComponent"/>, which is a
  71. /// <c>ScriptableObject</c>). Unity calls this right after it constructs the parent
  72. /// <see cref="VolumeComponent"/>, thus allowing access to previously
  73. /// inaccessible fields and properties.
  74. /// </remarks>
  75. protected internal virtual void OnEnable()
  76. {
  77. }
  78. /// <summary>
  79. /// Unity calls this method when the parent <see cref="VolumeComponent"/> goes out of scope.
  80. /// </summary>
  81. protected internal virtual void OnDisable()
  82. {
  83. }
  84. /// <summary>
  85. /// Checks if a given type is an <see cref="ObjectParameter{T}"/>.
  86. /// </summary>
  87. /// <param name="type">The type to check.</param>
  88. /// <returns><c>true</c> if <paramref name="type"/> is an <see cref="ObjectParameter{T}"/>,
  89. /// <c>false</c> otherwise.</returns>
  90. public static bool IsObjectParameter(Type type)
  91. {
  92. if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(ObjectParameter<>))
  93. return true;
  94. return type.BaseType != null
  95. && IsObjectParameter(type.BaseType);
  96. }
  97. /// <summary>
  98. /// Override this method to free all allocated resources
  99. /// </summary>
  100. public virtual void Release() { }
  101. /// <summary>
  102. /// Clones the current instance of the <see cref="VolumeParameter"/>
  103. /// </summary>
  104. /// <returns>A new created instance with the same values as the current instance of <see cref="VolumeParameter"/></returns>
  105. public abstract object Clone();
  106. }
  107. /// <summary>
  108. /// A generic implementation of <see cref="VolumeParameter"/>. Custom parameters should derive
  109. /// from this class and implement their own behavior.
  110. /// </summary>
  111. /// <typeparam name="T">The type of value to hold in this parameter.</typeparam>
  112. /// <remarks>
  113. /// <typeparamref name="T"/> should a serializable type.
  114. /// Due to limitations with the serialization system in Unity, you should not use this class
  115. /// directly to declare parameters in a <see cref="VolumeComponent"/>. Instead, use one of the
  116. /// pre-flatten types (like <see cref="FloatParameter"/>, or make your own by extending this
  117. /// class.
  118. /// </remarks>
  119. /// <example>
  120. /// <para>This sample code shows how to make a custom parameter holding a <c>float</c>:</para>
  121. /// <code>
  122. /// using UnityEngine.Rendering;
  123. ///
  124. /// [Serializable]
  125. /// public sealed class MyFloatParameter : VolumeParameter&lt;float&gt;
  126. /// {
  127. /// public MyFloatParameter(float value, bool overrideState = false)
  128. /// : base(value, overrideState) { }
  129. ///
  130. /// public sealed override void Interp(float from, float to, float t)
  131. /// {
  132. /// m_Value = from + (to - from) * t;
  133. /// }
  134. /// }
  135. /// </code>
  136. /// </example>
  137. /// <seealso cref="VolumeParameter"/>
  138. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  139. public class VolumeParameter<T> : VolumeParameter, IEquatable<VolumeParameter<T>>
  140. {
  141. /// <summary>
  142. /// The value stored and serialized by this parameter.
  143. /// </summary>
  144. [SerializeField]
  145. protected T m_Value;
  146. /// <summary>
  147. /// The value that this parameter stores.
  148. /// </summary>
  149. /// <remarks>
  150. /// You can override this property to define custom behaviors when the value is changed.
  151. /// </remarks>
  152. public virtual T value
  153. {
  154. get => m_Value;
  155. set => m_Value = value;
  156. }
  157. /// <summary>
  158. /// Creates a new <see cref="VolumeParameter{T}"/> instance.
  159. /// </summary>
  160. public VolumeParameter()
  161. : this(default, false)
  162. {
  163. }
  164. /// <summary>
  165. /// Creates a new <see cref="VolumeParameter{T}"/> instance.
  166. /// </summary>
  167. /// <param name="value">The initial value to store in the parameter.</param>
  168. /// <param name="overrideState">The initial override state for the parameter.</param>
  169. protected VolumeParameter(T value, bool overrideState = false)
  170. {
  171. m_Value = value;
  172. this.overrideState = overrideState;
  173. }
  174. internal override void Interp(VolumeParameter from, VolumeParameter to, float t)
  175. {
  176. // Note: this is relatively unsafe (assumes that from and to are both holding type T)
  177. Interp((from as VolumeParameter<T>).value, (to as VolumeParameter<T>).value, t);
  178. }
  179. /// <summary>
  180. /// Interpolates two values using a factor <paramref name="t"/>.
  181. /// </summary>
  182. /// <remarks>
  183. /// By default, this method does a "snap" interpolation, meaning it returns the value
  184. /// <paramref name="to"/> if <paramref name="t"/> is higher than 0, and <paramref name="from"/>
  185. /// otherwise.
  186. /// </remarks>
  187. /// <param name="from">The start value.</param>
  188. /// <param name="to">The end value.</param>
  189. /// <param name="t">The interpolation factor in range [0,1].</param>
  190. public virtual void Interp(T from, T to, float t)
  191. {
  192. // Default interpolation is naive
  193. m_Value = t > 0f ? to : from;
  194. }
  195. /// <summary>
  196. /// Sets the value for this parameter and sets its override state to <c>true</c>.
  197. /// </summary>
  198. /// <param name="x">The value to assign to this parameter.</param>
  199. public void Override(T x)
  200. {
  201. overrideState = true;
  202. m_Value = x;
  203. }
  204. /// <summary>
  205. /// Sets the value of this parameter to the value in <paramref name="parameter"/>.
  206. /// </summary>
  207. /// <param name="parameter">The <see cref="VolumeParameter"/> to copy the value from.</param>
  208. [MethodImpl(MethodImplOptions.AggressiveInlining)]
  209. public override void SetValue(VolumeParameter parameter)
  210. {
  211. m_Value = ((VolumeParameter<T>)parameter).m_Value;
  212. }
  213. /// <summary>
  214. /// Returns a hash code for the current object.
  215. /// </summary>
  216. /// <returns>A hash code for the current object.</returns>
  217. public override int GetHashCode()
  218. {
  219. unchecked
  220. {
  221. int hash = 17;
  222. hash = hash * 23 + overrideState.GetHashCode();
  223. if (!EqualityComparer<T>.Default.Equals(value, default)) // Catches null for references with boxing of value types
  224. hash = hash * 23 + value.GetHashCode();
  225. return hash;
  226. }
  227. }
  228. /// <summary>
  229. /// Returns a string that represents the current object.
  230. /// </summary>
  231. /// <returns>A string that represents the current object.</returns>
  232. public override string ToString() => $"{value} ({overrideState})";
  233. /// <summary>
  234. /// Compares the value in a parameter with another value of the same type.
  235. /// </summary>
  236. /// <param name="lhs">The first value in a <see cref="VolumeParameter"/>.</param>
  237. /// <param name="rhs">The second value.</param>
  238. /// <returns><c>true</c> if both values are equal, <c>false</c> otherwise.</returns>
  239. public static bool operator ==(VolumeParameter<T> lhs, T rhs) => lhs != null && !ReferenceEquals(lhs.value, null) && lhs.value.Equals(rhs);
  240. /// <summary>
  241. /// Compares the value store in a parameter with another value of the same type.
  242. /// </summary>
  243. /// <param name="lhs">The first value in a <see cref="VolumeParameter"/>.</param>
  244. /// <param name="rhs">The second value.</param>
  245. /// <returns><c>false</c> if both values are equal, <c>true</c> otherwise</returns>
  246. public static bool operator !=(VolumeParameter<T> lhs, T rhs) => !(lhs == rhs);
  247. /// <summary>
  248. /// Checks if this parameter is equal to another.
  249. /// </summary>
  250. /// <param name="other">The other parameter to check against.</param>
  251. /// <returns><c>true</c> if both parameters are equal, <c>false</c> otherwise</returns>
  252. public bool Equals(VolumeParameter<T> other)
  253. {
  254. if (ReferenceEquals(null, other))
  255. return false;
  256. if (ReferenceEquals(this, other))
  257. return true;
  258. return EqualityComparer<T>.Default.Equals(m_Value, other.m_Value);
  259. }
  260. /// <summary>
  261. /// Determines whether two object instances are equal.
  262. /// </summary>
  263. /// <param name="obj">The object to compare with the current object.</param>
  264. /// <returns><c>true</c> if the specified object is equal to the current object, <c>false</c> otherwise.</returns>
  265. public override bool Equals(object obj)
  266. {
  267. if (ReferenceEquals(null, obj))
  268. return false;
  269. if (ReferenceEquals(this, obj))
  270. return true;
  271. if (obj.GetType() != GetType())
  272. return false;
  273. return Equals((VolumeParameter<T>)obj);
  274. }
  275. /// <inheritdoc/>
  276. public override object Clone()
  277. {
  278. return new VolumeParameter<T>(GetValue<T>(), overrideState);
  279. }
  280. /// <summary>
  281. /// Explicitly downcast a <see cref="VolumeParameter{T}"/> to a value of type
  282. /// <typeparamref name="T"/>.
  283. /// </summary>
  284. /// <param name="prop">The parameter to downcast.</param>
  285. /// <returns>A value of type <typeparamref name="T"/>.</returns>
  286. public static explicit operator T(VolumeParameter<T> prop) => prop.m_Value;
  287. }
  288. /// <summary>
  289. /// Generic Enum volume parameter.
  290. /// </summary>
  291. /// <typeparam name="T">The type of value to hold in this parameter.</typeparam>
  292. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  293. public sealed class EnumParameter<T> : VolumeParameter<T>
  294. {
  295. /// <summary>
  296. /// Creates a new <see cref="EnumParameter"/> instance.
  297. /// </summary>
  298. /// <param name="value">The initial value to store in the parameter.</param>
  299. /// <param name="overrideState">The initial override state for the parameter.</param>
  300. public EnumParameter(T value, bool overrideState = false)
  301. : base(value, overrideState) { }
  302. }
  303. /// <summary>
  304. /// A <see cref="VolumeParameter"/> that holds a <c>bool</c> value.
  305. /// </summary>
  306. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  307. public class BoolParameter : VolumeParameter<bool>
  308. {
  309. /// <summary>
  310. /// Creates a new <see cref="BoolParameter"/> instance.
  311. /// </summary>
  312. /// <param name="value">The initial value to store in the parameter</param>
  313. /// <param name="overrideState">The initial override state for the parameter</param>
  314. public BoolParameter(bool value, bool overrideState = false)
  315. : base(value, overrideState)
  316. {
  317. }
  318. /// <summary>
  319. /// Creates a new <see cref="BoolParameter"/> instance.
  320. /// </summary>
  321. /// <param name="value">The initial value to store in the parameter</param>
  322. /// <param name="displayType">The display type to use for the parameter</param>
  323. /// <param name="overrideState">The initial override state for the parameter</param>
  324. public BoolParameter(bool value, DisplayType displayType, bool overrideState = false)
  325. : base(value, overrideState)
  326. {
  327. this.displayType = displayType;
  328. }
  329. /// <summary>
  330. /// Boolean widget type.
  331. /// </summary>
  332. public enum DisplayType
  333. {
  334. /// <summary> Display boolean parameter as checkbox. </summary>
  335. Checkbox,
  336. /// <summary> Display boolean parameter as enum popup with Disabled/Enabled options. </summary>
  337. EnumPopup
  338. }
  339. /// <summary>
  340. /// Type of widget used to display the <see cref="BoolParameter"/> in the UI.
  341. /// </summary>
  342. [NonSerialized]
  343. public DisplayType displayType = DisplayType.Checkbox;
  344. }
  345. /// <summary>
  346. /// A <see cref="VolumeParameter"/> that holds a <c>LayerMask</c> value.
  347. /// </summary>
  348. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  349. public class LayerMaskParameter : VolumeParameter<LayerMask>
  350. {
  351. /// <summary>
  352. /// Creates a new <see cref="LayerMaskParameter"/> instance.
  353. /// </summary>
  354. /// <param name="value">The initial value to store in the parameter.</param>
  355. /// <param name="overrideState">The initial override state for the parameter.</param>
  356. public LayerMaskParameter(LayerMask value, bool overrideState = false)
  357. : base(value, overrideState) { }
  358. }
  359. /// <summary>
  360. /// A <see cref="VolumeParameter"/> that holds a <c>LayerMask</c> value.
  361. /// </summary>
  362. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  363. public class RenderingLayerMaskParameter : VolumeParameter<RenderingLayerMask>
  364. {
  365. /// <summary>
  366. /// Creates a new <see cref="LayerMaskParameter"/> instance.
  367. /// </summary>
  368. /// <param name="value">The initial value to store in the parameter.</param>
  369. /// <param name="overrideState">The initial override state for the parameter.</param>
  370. public RenderingLayerMaskParameter(RenderingLayerMask value, bool overrideState = false)
  371. : base(value, overrideState) { }
  372. }
  373. /// <summary>
  374. /// A <see cref="VolumeParameter"/> that holds an <c>int</c> value.
  375. /// </summary>
  376. /// <seealso cref="MinIntParameter"/>
  377. /// <seealso cref="MaxIntParameter"/>
  378. /// <seealso cref="ClampedIntParameter"/>
  379. /// <seealso cref="NoInterpIntParameter"/>
  380. /// <seealso cref="NoInterpMinIntParameter"/>
  381. /// <seealso cref="NoInterpMaxIntParameter"/>
  382. /// <seealso cref="NoInterpClampedIntParameter"/>
  383. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  384. public class IntParameter : VolumeParameter<int>
  385. {
  386. /// <summary>
  387. /// Creates a new <see cref="IntParameter"/> instance.
  388. /// </summary>
  389. /// <param name="value">The initial value to store in the parameter.</param>
  390. /// <param name="overrideState">The initial override state for the parameter.</param>
  391. public IntParameter(int value, bool overrideState = false)
  392. : base(value, overrideState) { }
  393. /// <summary>
  394. /// Interpolates between two <c>int</c> values.
  395. /// </summary>
  396. /// <param name="from">The start value</param>
  397. /// <param name="to">The end value</param>
  398. /// <param name="t">The interpolation factor in range [0,1]</param>
  399. public sealed override void Interp(int from, int to, float t)
  400. {
  401. // Int snapping interpolation. Don't use this for enums as they don't necessarily have
  402. // contiguous values. Use the default interpolator instead (same as bool).
  403. m_Value = (int)(from + (to - from) * t);
  404. }
  405. }
  406. /// <summary>
  407. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>int</c> value.
  408. /// </summary>
  409. /// <seealso cref="IntParameter"/>
  410. /// <seealso cref="MinIntParameter"/>
  411. /// <seealso cref="MaxIntParameter"/>
  412. /// <seealso cref="ClampedIntParameter"/>
  413. /// <seealso cref="NoInterpMinIntParameter"/>
  414. /// <seealso cref="NoInterpMaxIntParameter"/>
  415. /// <seealso cref="NoInterpClampedIntParameter"/>
  416. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  417. public class NoInterpIntParameter : VolumeParameter<int>
  418. {
  419. /// <summary>
  420. /// Creates a new <see cref="NoInterpIntParameter"/> instance.
  421. /// </summary>
  422. /// <param name="value">The initial value to store in the parameter.</param>
  423. /// <param name="overrideState">The initial override state for the parameter.</param>
  424. public NoInterpIntParameter(int value, bool overrideState = false)
  425. : base(value, overrideState) { }
  426. }
  427. /// <summary>
  428. /// A <see cref="VolumeParameter"/> that holds an <c>int</c> value clamped to a
  429. /// minimum value.
  430. /// </summary>
  431. /// <seealso cref="IntParameter"/>
  432. /// <seealso cref="MaxIntParameter"/>
  433. /// <seealso cref="ClampedIntParameter"/>
  434. /// <seealso cref="NoInterpIntParameter"/>
  435. /// <seealso cref="NoInterpMinIntParameter"/>
  436. /// <seealso cref="NoInterpMaxIntParameter"/>
  437. /// <seealso cref="NoInterpClampedIntParameter"/>
  438. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  439. public class MinIntParameter : IntParameter
  440. {
  441. /// <summary>
  442. /// The minimum value to clamp this parameter to.
  443. /// </summary>
  444. [NonSerialized]
  445. public int min;
  446. /// <summary>
  447. /// The value that this parameter stores.
  448. /// </summary>
  449. /// <remarks>
  450. /// You can override this property to define custom behaviors when the value is changed.
  451. /// </remarks>
  452. public override int value
  453. {
  454. get => m_Value;
  455. set => m_Value = Mathf.Max(value, min);
  456. }
  457. /// <summary>
  458. /// Creates a new <see cref="MinIntParameter"/> instance.
  459. /// </summary>
  460. /// <param name="value">The initial value to store in the parameter.</param>
  461. /// <param name="min">The minimum value to clamp the parameter to.</param>
  462. /// <param name="overrideState">The initial override state for the parameter.</param>
  463. public MinIntParameter(int value, int min, bool overrideState = false)
  464. : base(value, overrideState)
  465. {
  466. this.min = min;
  467. }
  468. }
  469. /// <summary>
  470. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>int</c> value that
  471. /// clamped to a minimum value.
  472. /// </summary>
  473. /// <seealso cref="IntParameter"/>
  474. /// <seealso cref="MinIntParameter"/>
  475. /// <seealso cref="MaxIntParameter"/>
  476. /// <seealso cref="ClampedIntParameter"/>
  477. /// <seealso cref="NoInterpIntParameter"/>
  478. /// <seealso cref="NoInterpMaxIntParameter"/>
  479. /// <seealso cref="NoInterpClampedIntParameter"/>
  480. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  481. public class NoInterpMinIntParameter : VolumeParameter<int>
  482. {
  483. /// <summary>
  484. /// The minimum value to clamp this parameter to.
  485. /// </summary>
  486. [NonSerialized]
  487. public int min;
  488. /// <summary>
  489. /// The value that this parameter stores.
  490. /// </summary>
  491. /// <remarks>
  492. /// You can override this property to define custom behaviors when the value is changed.
  493. /// </remarks>
  494. public override int value
  495. {
  496. get => m_Value;
  497. set => m_Value = Mathf.Max(value, min);
  498. }
  499. /// <summary>
  500. /// Creates a new <see cref="NoInterpMinIntParameter"/> instance.
  501. /// </summary>
  502. /// <param name="value">The initial value to store in the parameter.</param>
  503. /// <param name="min">The minimum value to clamp the parameter to.</param>
  504. /// <param name="overrideState">The initial override state for the parameter.</param>
  505. public NoInterpMinIntParameter(int value, int min, bool overrideState = false)
  506. : base(value, overrideState)
  507. {
  508. this.min = min;
  509. }
  510. }
  511. /// <summary>
  512. /// A <see cref="VolumeParameter"/> that holds an <c>int</c> value clamped to a
  513. /// maximum value.
  514. /// </summary>
  515. /// <seealso cref="IntParameter"/>
  516. /// <seealso cref="MinIntParameter"/>
  517. /// <seealso cref="ClampedIntParameter"/>
  518. /// <seealso cref="NoInterpIntParameter"/>
  519. /// <seealso cref="NoInterpMinIntParameter"/>
  520. /// <seealso cref="NoInterpMaxIntParameter"/>
  521. /// <seealso cref="NoInterpClampedIntParameter"/>
  522. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  523. public class MaxIntParameter : IntParameter
  524. {
  525. /// <summary>
  526. /// The maximum value to clamp this parameter to.
  527. /// </summary>
  528. [NonSerialized]
  529. public int max;
  530. /// <summary>
  531. /// The value that this parameter stores.
  532. /// </summary>
  533. /// <remarks>
  534. /// You can override this property to define custom behaviors when the value is changed.
  535. /// </remarks>
  536. public override int value
  537. {
  538. get => m_Value;
  539. set => m_Value = Mathf.Min(value, max);
  540. }
  541. /// <summary>
  542. /// Creates a new <see cref="MaxIntParameter"/> instance.
  543. /// </summary>
  544. /// <param name="value">The initial value to store in the parameter.</param>
  545. /// <param name="max">The maximum value to clamp the parameter to.</param>
  546. /// <param name="overrideState">The initial override state for the parameter.</param>
  547. public MaxIntParameter(int value, int max, bool overrideState = false)
  548. : base(value, overrideState)
  549. {
  550. this.max = max;
  551. }
  552. }
  553. /// <summary>
  554. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>int</c> value that
  555. /// clamped to a maximum value.
  556. /// </summary>
  557. /// <seealso cref="IntParameter"/>
  558. /// <seealso cref="MinIntParameter"/>
  559. /// <seealso cref="MaxIntParameter"/>
  560. /// <seealso cref="ClampedIntParameter"/>
  561. /// <seealso cref="NoInterpIntParameter"/>
  562. /// <seealso cref="NoInterpMinIntParameter"/>
  563. /// <seealso cref="NoInterpClampedIntParameter"/>
  564. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  565. public class NoInterpMaxIntParameter : VolumeParameter<int>
  566. {
  567. /// <summary>
  568. /// The maximum value to clamp this parameter to.
  569. /// </summary>
  570. [NonSerialized]
  571. public int max;
  572. /// <summary>
  573. /// The value that this parameter stores.
  574. /// </summary>
  575. /// <remarks>
  576. /// You can override this property to define custom behaviors when the value is changed.
  577. /// </remarks>
  578. public override int value
  579. {
  580. get => m_Value;
  581. set => m_Value = Mathf.Min(value, max);
  582. }
  583. /// <summary>
  584. /// Creates a new <see cref="NoInterpMaxIntParameter"/> instance.
  585. /// </summary>
  586. /// <param name="value">The initial value to store in the parameter.</param>
  587. /// <param name="max">The maximum value to clamp the parameter to.</param>
  588. /// <param name="overrideState">The initial override state for the parameter.</param>
  589. public NoInterpMaxIntParameter(int value, int max, bool overrideState = false)
  590. : base(value, overrideState)
  591. {
  592. this.max = max;
  593. }
  594. }
  595. /// <summary>
  596. /// A <see cref="VolumeParameter"/> that holds an <c>int</c> value clamped between a
  597. /// minimum and a maximum value.
  598. /// </summary>
  599. /// <seealso cref="IntParameter"/>
  600. /// <seealso cref="MinIntParameter"/>
  601. /// <seealso cref="MaxIntParameter"/>
  602. /// <seealso cref="NoInterpIntParameter"/>
  603. /// <seealso cref="NoInterpMinIntParameter"/>
  604. /// <seealso cref="NoInterpMaxIntParameter"/>
  605. /// <seealso cref="NoInterpClampedIntParameter"/>
  606. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  607. public class ClampedIntParameter : IntParameter
  608. {
  609. /// <summary>
  610. /// The minimum value to clamp this parameter to.
  611. /// </summary>
  612. [NonSerialized]
  613. public int min;
  614. /// <summary>
  615. /// The maximum value to clamp this parameter to.
  616. /// </summary>
  617. [NonSerialized]
  618. public int max;
  619. /// <summary>
  620. /// The value that this parameter stores.
  621. /// </summary>
  622. /// <remarks>
  623. /// You can override this property to define custom behaviors when the value is changed.
  624. /// </remarks>
  625. public override int value
  626. {
  627. get => m_Value;
  628. set => m_Value = Mathf.Clamp(value, min, max);
  629. }
  630. /// <summary>
  631. /// Creates a new <see cref="ClampedIntParameter"/> instance.
  632. /// </summary>
  633. /// <param name="value">The initial value to store in the parameter.</param>
  634. /// <param name="min">The minimum value to clamp the parameter to</param>
  635. /// <param name="max">The maximum value to clamp the parameter to.</param>
  636. /// <param name="overrideState">The initial override state for the parameter.</param>
  637. public ClampedIntParameter(int value, int min, int max, bool overrideState = false)
  638. : base(value, overrideState)
  639. {
  640. this.min = min;
  641. this.max = max;
  642. }
  643. }
  644. /// <summary>
  645. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>int</c> value
  646. /// clamped between a minimum and a maximum value.
  647. /// </summary>
  648. /// <seealso cref="IntParameter"/>
  649. /// <seealso cref="MinIntParameter"/>
  650. /// <seealso cref="MaxIntParameter"/>
  651. /// <seealso cref="ClampedIntParameter"/>
  652. /// <seealso cref="NoInterpIntParameter"/>
  653. /// <seealso cref="NoInterpMinIntParameter"/>
  654. /// <seealso cref="NoInterpMaxIntParameter"/>
  655. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  656. public class NoInterpClampedIntParameter : VolumeParameter<int>
  657. {
  658. /// <summary>
  659. /// The minimum value to clamp this parameter to.
  660. /// </summary>
  661. [NonSerialized]
  662. public int min;
  663. /// <summary>
  664. /// The maximum value to clamp this parameter to.
  665. /// </summary>
  666. [NonSerialized]
  667. public int max;
  668. /// <summary>
  669. /// The value that this parameter stores.
  670. /// </summary>
  671. /// <remarks>
  672. /// You can override this property to define custom behaviors when the value is changed.
  673. /// </remarks>
  674. public override int value
  675. {
  676. get => m_Value;
  677. set => m_Value = Mathf.Clamp(value, min, max);
  678. }
  679. /// <summary>
  680. /// Creates a new <see cref="NoInterpClampedIntParameter"/> instance.
  681. /// </summary>
  682. /// <param name="value">The initial value to store in the parameter.</param>
  683. /// <param name="min">The minimum value to clamp the parameter to</param>
  684. /// <param name="max">The maximum value to clamp the parameter to.</param>
  685. /// <param name="overrideState">The initial override state for the parameter.</param>
  686. public NoInterpClampedIntParameter(int value, int min, int max, bool overrideState = false)
  687. : base(value, overrideState)
  688. {
  689. this.min = min;
  690. this.max = max;
  691. }
  692. }
  693. /// <summary>
  694. /// A <see cref="VolumeParameter"/> that holds a <c>float</c> value.
  695. /// </summary>
  696. /// <seealso cref="MinFloatParameter"/>
  697. /// <seealso cref="MaxFloatParameter"/>
  698. /// <seealso cref="ClampedFloatParameter"/>
  699. /// <seealso cref="FloatRangeParameter"/>
  700. /// <seealso cref="NoInterpFloatParameter"/>
  701. /// <seealso cref="NoInterpMinFloatParameter"/>
  702. /// <seealso cref="NoInterpMaxFloatParameter"/>
  703. /// <seealso cref="NoInterpClampedFloatParameter"/>
  704. /// <seealso cref="NoInterpFloatRangeParameter"/>
  705. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  706. public class FloatParameter : VolumeParameter<float>
  707. {
  708. /// <summary>
  709. /// Creates a new <see cref="FloatParameter"/> instance.
  710. /// </summary>
  711. /// <param name="value">The initial value to store in the parameter</param>
  712. /// <param name="overrideState">The initial override state for the parameter</param>
  713. public FloatParameter(float value, bool overrideState = false)
  714. : base(value, overrideState) { }
  715. /// <summary>
  716. /// Interpolates between two <c>float</c> values.
  717. /// </summary>
  718. /// <param name="from">The start value</param>
  719. /// <param name="to">The end value</param>
  720. /// <param name="t">The interpolation factor in range [0,1]</param>
  721. public sealed override void Interp(float from, float to, float t)
  722. {
  723. m_Value = from + (to - from) * t;
  724. }
  725. }
  726. /// <summary>
  727. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>float</c> value.
  728. /// </summary>
  729. /// <seealso cref="FloatParameter"/>
  730. /// <seealso cref="MinFloatParameter"/>
  731. /// <seealso cref="MaxFloatParameter"/>
  732. /// <seealso cref="ClampedFloatParameter"/>
  733. /// <seealso cref="FloatRangeParameter"/>
  734. /// <seealso cref="NoInterpMinFloatParameter"/>
  735. /// <seealso cref="NoInterpMaxFloatParameter"/>
  736. /// <seealso cref="NoInterpClampedFloatParameter"/>
  737. /// <seealso cref="NoInterpFloatRangeParameter"/>
  738. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  739. public class NoInterpFloatParameter : VolumeParameter<float>
  740. {
  741. /// <summary>
  742. /// Creates a new <see cref="NoInterpFloatParameter"/> instance.
  743. /// </summary>
  744. /// <param name="value">The initial value to store in the parameter</param>
  745. /// <param name="overrideState">The initial override state for the parameter.</param>
  746. public NoInterpFloatParameter(float value, bool overrideState = false)
  747. : base(value, overrideState) { }
  748. }
  749. /// <summary>
  750. /// A <see cref="VolumeParameter"/> that holds a <c>float</c> value clamped to a minimum value.
  751. /// </summary>
  752. /// <seealso cref="FloatParameter"/>
  753. /// <seealso cref="MaxFloatParameter"/>
  754. /// <seealso cref="ClampedFloatParameter"/>
  755. /// <seealso cref="FloatRangeParameter"/>
  756. /// <seealso cref="NoInterpFloatParameter"/>
  757. /// <seealso cref="NoInterpMinFloatParameter"/>
  758. /// <seealso cref="NoInterpMaxFloatParameter"/>
  759. /// <seealso cref="NoInterpClampedFloatParameter"/>
  760. /// <seealso cref="NoInterpFloatRangeParameter"/>
  761. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  762. public class MinFloatParameter : FloatParameter
  763. {
  764. /// <summary>
  765. /// The minimum value to clamp this parameter to.
  766. /// </summary>
  767. [NonSerialized]
  768. public float min;
  769. /// <summary>
  770. /// The value that this parameter stores.
  771. /// </summary>
  772. /// <remarks>
  773. /// You can override this property to define custom behaviors when the value is changed.
  774. /// </remarks>
  775. public override float value
  776. {
  777. get => m_Value;
  778. set => m_Value = Mathf.Max(value, min);
  779. }
  780. /// <summary>
  781. /// Creates a new <see cref="MinFloatParameter"/> instance.
  782. /// </summary>
  783. /// <param name="value">The initial value to store in the parameter.</param>
  784. /// <param name="min">The minimum value to clamp the parameter to.</param>
  785. /// <param name="overrideState">The initial override state for the parameter.</param>
  786. public MinFloatParameter(float value, float min, bool overrideState = false)
  787. : base(value, overrideState)
  788. {
  789. this.min = min;
  790. }
  791. }
  792. /// <summary>
  793. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>float</c> value clamped to
  794. /// a minimum value.
  795. /// </summary>
  796. /// <seealso cref="FloatParameter"/>
  797. /// <seealso cref="MinFloatParameter"/>
  798. /// <seealso cref="MaxFloatParameter"/>
  799. /// <seealso cref="ClampedFloatParameter"/>
  800. /// <seealso cref="FloatRangeParameter"/>
  801. /// <seealso cref="NoInterpFloatParameter"/>
  802. /// <seealso cref="NoInterpMaxFloatParameter"/>
  803. /// <seealso cref="NoInterpClampedFloatParameter"/>
  804. /// <seealso cref="NoInterpFloatRangeParameter"/>
  805. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  806. public class NoInterpMinFloatParameter : VolumeParameter<float>
  807. {
  808. /// <summary>
  809. /// The minimum value to clamp this parameter to.
  810. /// </summary>
  811. [NonSerialized]
  812. public float min;
  813. /// <summary>
  814. /// The value that this parameter stores.
  815. /// </summary>
  816. /// <remarks>
  817. /// You can override this property to define custom behaviors when the value is changed.
  818. /// </remarks>
  819. public override float value
  820. {
  821. get => m_Value;
  822. set => m_Value = Mathf.Max(value, min);
  823. }
  824. /// <summary>
  825. /// Creates a new <see cref="NoInterpMinFloatParameter"/> instance.
  826. /// </summary>
  827. /// <param name="value">The initial value to storedin the parameter.</param>
  828. /// <param name="min">The minimum value to clamp the parameter to.</param>
  829. /// <param name="overrideState">The initial override state for the parameter.</param>
  830. public NoInterpMinFloatParameter(float value, float min, bool overrideState = false)
  831. : base(value, overrideState)
  832. {
  833. this.min = min;
  834. }
  835. }
  836. /// <summary>
  837. /// A <see cref="VolumeParameter"/> that holds a <c>float</c> value clamped to a max value.
  838. /// </summary>
  839. /// <seealso cref="FloatParameter"/>
  840. /// <seealso cref="MinFloatParameter"/>
  841. /// <seealso cref="ClampedFloatParameter"/>
  842. /// <seealso cref="FloatRangeParameter"/>
  843. /// <seealso cref="NoInterpFloatParameter"/>
  844. /// <seealso cref="NoInterpMinFloatParameter"/>
  845. /// <seealso cref="NoInterpMaxFloatParameter"/>
  846. /// <seealso cref="NoInterpClampedFloatParameter"/>
  847. /// <seealso cref="NoInterpFloatRangeParameter"/>
  848. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  849. public class MaxFloatParameter : FloatParameter
  850. {
  851. /// <summary>
  852. /// The maximum value to clamp this parameter to.
  853. /// </summary>
  854. [NonSerialized]
  855. public float max;
  856. /// <summary>
  857. /// The value that this parameter stores.
  858. /// </summary>
  859. /// <remarks>
  860. /// You can override this property to define custom behaviors when the value is changed.
  861. /// </remarks>
  862. public override float value
  863. {
  864. get => m_Value;
  865. set => m_Value = Mathf.Min(value, max);
  866. }
  867. /// <summary>
  868. /// Creates a new <see cref="MaxFloatParameter"/> instance.
  869. /// </summary>
  870. /// <param name="value">The initial value to store in the parameter.</param>
  871. /// <param name="max">The maximum value to clamp the parameter to.</param>
  872. /// <param name="overrideState">The initial override state for the parameter.</param>
  873. public MaxFloatParameter(float value, float max, bool overrideState = false)
  874. : base(value, overrideState)
  875. {
  876. this.max = max;
  877. }
  878. }
  879. /// <summary>
  880. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>float</c> value clamped to
  881. /// a maximum value.
  882. /// </summary>
  883. /// <seealso cref="FloatParameter"/>
  884. /// <seealso cref="MinFloatParameter"/>
  885. /// <seealso cref="MaxFloatParameter"/>
  886. /// <seealso cref="ClampedFloatParameter"/>
  887. /// <seealso cref="FloatRangeParameter"/>
  888. /// <seealso cref="NoInterpFloatParameter"/>
  889. /// <seealso cref="NoInterpMinFloatParameter"/>
  890. /// <seealso cref="NoInterpClampedFloatParameter"/>
  891. /// <seealso cref="NoInterpFloatRangeParameter"/>
  892. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  893. public class NoInterpMaxFloatParameter : VolumeParameter<float>
  894. {
  895. /// <summary>
  896. /// The maximum value to clamp this parameter to.
  897. /// </summary>
  898. [NonSerialized]
  899. public float max;
  900. /// <summary>
  901. /// The value that this parameter stores.
  902. /// </summary>
  903. /// <remarks>
  904. /// You can override this property to define custom behaviors when the value is changed.
  905. /// </remarks>
  906. public override float value
  907. {
  908. get => m_Value;
  909. set => m_Value = Mathf.Min(value, max);
  910. }
  911. /// <summary>
  912. /// Creates a new <see cref="NoInterpMaxFloatParameter"/> instance.
  913. /// </summary>
  914. /// <param name="value">The initial value to store in the parameter.</param>
  915. /// <param name="max">The maximum value to clamp the parameter to.</param>
  916. /// <param name="overrideState">The initial override state for the parameter.</param>
  917. public NoInterpMaxFloatParameter(float value, float max, bool overrideState = false)
  918. : base(value, overrideState)
  919. {
  920. this.max = max;
  921. }
  922. }
  923. /// <summary>
  924. /// A <see cref="VolumeParameter"/> that holds a <c>float</c> value clamped between a minimum and a
  925. /// maximum value.
  926. /// </summary>
  927. /// <seealso cref="FloatParameter"/>
  928. /// <seealso cref="MinFloatParameter"/>
  929. /// <seealso cref="MaxFloatParameter"/>
  930. /// <seealso cref="FloatRangeParameter"/>
  931. /// <seealso cref="NoInterpFloatParameter"/>
  932. /// <seealso cref="NoInterpMinFloatParameter"/>
  933. /// <seealso cref="NoInterpMaxFloatParameter"/>
  934. /// <seealso cref="NoInterpClampedFloatParameter"/>
  935. /// <seealso cref="NoInterpFloatRangeParameter"/>
  936. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  937. public class ClampedFloatParameter : FloatParameter
  938. {
  939. /// <summary>
  940. /// The minimum value to clamp this parameter to.
  941. /// </summary>
  942. [NonSerialized]
  943. public float min;
  944. /// <summary>
  945. /// The maximum value to clamp this parameter to.
  946. /// </summary>
  947. [NonSerialized]
  948. public float max;
  949. /// <summary>
  950. /// The value that this parameter stores.
  951. /// </summary>
  952. /// <remarks>
  953. /// You can override this property to define custom behaviors when the value is changed.
  954. /// </remarks>
  955. public override float value
  956. {
  957. get => m_Value;
  958. set => m_Value = Mathf.Clamp(value, min, max);
  959. }
  960. /// <summary>
  961. /// Creates a new <see cref="ClampedFloatParameter"/> instance.
  962. /// </summary>
  963. /// <param name="value">The initial value to store in the parameter.</param>
  964. /// <param name="min">The minimum value to clamp the parameter to</param>
  965. /// <param name="max">The maximum value to clamp the parameter to.</param>
  966. /// <param name="overrideState">The initial override state for the parameter.</param>
  967. public ClampedFloatParameter(float value, float min, float max, bool overrideState = false)
  968. : base(value, overrideState)
  969. {
  970. this.min = min;
  971. this.max = max;
  972. }
  973. }
  974. /// <summary>
  975. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>float</c> value clamped between
  976. /// a minimum and a maximum value.
  977. /// </summary>
  978. /// <seealso cref="FloatParameter"/>
  979. /// <seealso cref="MinFloatParameter"/>
  980. /// <seealso cref="MaxFloatParameter"/>
  981. /// <seealso cref="ClampedFloatParameter"/>
  982. /// <seealso cref="FloatRangeParameter"/>
  983. /// <seealso cref="NoInterpFloatParameter"/>
  984. /// <seealso cref="NoInterpMinFloatParameter"/>
  985. /// <seealso cref="NoInterpMaxFloatParameter"/>
  986. /// <seealso cref="NoInterpFloatRangeParameter"/>
  987. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  988. public class NoInterpClampedFloatParameter : VolumeParameter<float>
  989. {
  990. /// <summary>
  991. /// The minimum value to clamp this parameter to.
  992. /// </summary>
  993. [NonSerialized]
  994. public float min;
  995. /// <summary>
  996. /// The maximum value to clamp this parameter to.
  997. /// </summary>
  998. [NonSerialized]
  999. public float max;
  1000. /// <summary>
  1001. /// The value that this parameter stores.
  1002. /// </summary>
  1003. /// <remarks>
  1004. /// You can override this property to define custom behaviors when the value is changed.
  1005. /// </remarks>
  1006. public override float value
  1007. {
  1008. get => m_Value;
  1009. set => m_Value = Mathf.Clamp(value, min, max);
  1010. }
  1011. /// <summary>
  1012. /// Creates a new <see cref="NoInterpClampedFloatParameter"/> instance.
  1013. /// </summary>
  1014. /// <param name="value">The initial value to store in the parameter.</param>
  1015. /// <param name="min">The minimum value to clamp the parameter to</param>
  1016. /// <param name="max">The maximum value to clamp the parameter to.</param>
  1017. /// <param name="overrideState">The initial override state for the parameter.</param>
  1018. public NoInterpClampedFloatParameter(float value, float min, float max, bool overrideState = false)
  1019. : base(value, overrideState)
  1020. {
  1021. this.min = min;
  1022. this.max = max;
  1023. }
  1024. }
  1025. /// <summary>
  1026. /// A <see cref="VolumeParameter"/> that holds a <c>Vector2</c> value holding a range of two
  1027. /// <c>float</c> values clamped between a minimum and a maximum value.
  1028. /// </summary>
  1029. /// <seealso cref="FloatParameter"/>
  1030. /// <seealso cref="MinFloatParameter"/>
  1031. /// <seealso cref="MaxFloatParameter"/>
  1032. /// <seealso cref="ClampedFloatParameter"/>
  1033. /// <seealso cref="NoInterpFloatParameter"/>
  1034. /// <seealso cref="NoInterpMinFloatParameter"/>
  1035. /// <seealso cref="NoInterpMaxFloatParameter"/>
  1036. /// <seealso cref="NoInterpClampedFloatParameter"/>
  1037. /// <seealso cref="NoInterpFloatRangeParameter"/>
  1038. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1039. public class FloatRangeParameter : VolumeParameter<Vector2>
  1040. {
  1041. /// <summary>
  1042. /// The minimum value to clamp this parameter to.
  1043. /// </summary>
  1044. [NonSerialized]
  1045. public float min;
  1046. /// <summary>
  1047. /// The maximum value to clamp this parameter to.
  1048. /// </summary>
  1049. [NonSerialized]
  1050. public float max;
  1051. /// <summary>
  1052. /// The value that this parameter stores.
  1053. /// </summary>
  1054. /// <remarks>
  1055. /// You can override this property to define custom behaviors when the value is changed.
  1056. /// </remarks>
  1057. public override Vector2 value
  1058. {
  1059. get => m_Value;
  1060. set
  1061. {
  1062. m_Value.x = Mathf.Max(value.x, min);
  1063. m_Value.y = Mathf.Min(value.y, max);
  1064. }
  1065. }
  1066. /// <summary>
  1067. /// Creates a new <see cref="FloatRangeParameter"/> instance.
  1068. /// </summary>
  1069. /// <param name="value">The initial value to store in the parameter.</param>
  1070. /// <param name="min">The minimum value to clamp the parameter to</param>
  1071. /// <param name="max">The maximum value to clamp the parameter to.</param>
  1072. /// <param name="overrideState">The initial override state for the parameter.</param>
  1073. public FloatRangeParameter(Vector2 value, float min, float max, bool overrideState = false)
  1074. : base(value, overrideState)
  1075. {
  1076. this.min = min;
  1077. this.max = max;
  1078. }
  1079. /// <summary>
  1080. /// Interpolates between two <c>Vector2</c> values.
  1081. /// </summary>
  1082. /// <param name="from">The start value</param>
  1083. /// <param name="to">The end value</param>
  1084. /// <param name="t">The interpolation factor in range [0,1]</param>
  1085. public override void Interp(Vector2 from, Vector2 to, float t)
  1086. {
  1087. m_Value.x = from.x + (to.x - from.x) * t;
  1088. m_Value.y = from.y + (to.y - from.y) * t;
  1089. }
  1090. }
  1091. /// <summary>
  1092. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Vector2</c> value holding
  1093. /// a range of two <c>float</c> values clamped between a minimum and a maximum value.
  1094. /// </summary>
  1095. /// <seealso cref="FloatParameter"/>
  1096. /// <seealso cref="MinFloatParameter"/>
  1097. /// <seealso cref="MaxFloatParameter"/>
  1098. /// <seealso cref="ClampedFloatParameter"/>
  1099. /// <seealso cref="FloatRangeParameter"/>
  1100. /// <seealso cref="NoInterpFloatParameter"/>
  1101. /// <seealso cref="NoInterpMinFloatParameter"/>
  1102. /// <seealso cref="NoInterpMaxFloatParameter"/>
  1103. /// <seealso cref="NoInterpClampedFloatParameter"/>
  1104. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1105. public class NoInterpFloatRangeParameter : VolumeParameter<Vector2>
  1106. {
  1107. /// <summary>
  1108. /// The minimum value to clamp this parameter to.
  1109. /// </summary>
  1110. [NonSerialized]
  1111. public float min;
  1112. /// <summary>
  1113. /// The maximum value to clamp this parameter to.
  1114. /// </summary>
  1115. [NonSerialized]
  1116. public float max;
  1117. /// <summary>
  1118. /// The value that this parameter stores.
  1119. /// </summary>
  1120. /// <remarks>
  1121. /// You can override this property to define custom behaviors when the value is changed.
  1122. /// </remarks>
  1123. public override Vector2 value
  1124. {
  1125. get => m_Value;
  1126. set
  1127. {
  1128. m_Value.x = Mathf.Max(value.x, min);
  1129. m_Value.y = Mathf.Min(value.y, max);
  1130. }
  1131. }
  1132. /// <summary>
  1133. /// Creates a new <see cref="NoInterpFloatRangeParameter"/> instance.
  1134. /// </summary>
  1135. /// <param name="value">The initial value to store in the parameter.</param>
  1136. /// <param name="min">The minimum value to clamp the parameter to</param>
  1137. /// <param name="max">The maximum value to clamp the parameter to.</param>
  1138. /// <param name="overrideState">The initial override state for the parameter.</param>
  1139. public NoInterpFloatRangeParameter(Vector2 value, float min, float max, bool overrideState = false)
  1140. : base(value, overrideState)
  1141. {
  1142. this.min = min;
  1143. this.max = max;
  1144. }
  1145. }
  1146. /// <summary>
  1147. /// A <see cref="VolumeParameter"/> that holds a <c>Color</c> value.
  1148. /// </summary>
  1149. /// <seealso cref="NoInterpColorParameter"/>
  1150. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1151. public class ColorParameter : VolumeParameter<Color>
  1152. {
  1153. /// <summary>
  1154. /// Is this color HDR?
  1155. /// </summary>
  1156. [NonSerialized]
  1157. public bool hdr = false;
  1158. /// <summary>
  1159. /// Should the alpha channel be editable in the editor?
  1160. /// </summary>
  1161. [NonSerialized]
  1162. public bool showAlpha = true;
  1163. /// <summary>
  1164. /// Should the eye dropper be visible in the editor?
  1165. /// </summary>
  1166. [NonSerialized]
  1167. public bool showEyeDropper = true;
  1168. /// <summary>
  1169. /// Creates a new <see cref="ColorParameter"/> instance.
  1170. /// </summary>
  1171. /// <param name="value">The initial value to store in the parameter.</param>
  1172. /// <param name="overrideState">The initial override state for the parameter.</param>
  1173. public ColorParameter(Color value, bool overrideState = false)
  1174. : base(value, overrideState) { }
  1175. /// <summary>
  1176. /// Creates a new <see cref="ColorParameter"/> instance.
  1177. /// </summary>
  1178. /// <param name="value">The initial value to store in the parameter.</param>
  1179. /// <param name="hdr">Specifies whether the color is HDR or not.</param>
  1180. /// <param name="showAlpha">Specifies whether you can edit the alpha channel in the Inspector or not.</param>
  1181. /// <param name="showEyeDropper">Specifies whether the eye dropper is visible in the editor or not.</param>
  1182. /// <param name="overrideState">The initial override state for the parameter.</param>
  1183. public ColorParameter(Color value, bool hdr, bool showAlpha, bool showEyeDropper, bool overrideState = false)
  1184. : base(value, overrideState)
  1185. {
  1186. this.hdr = hdr;
  1187. this.showAlpha = showAlpha;
  1188. this.showEyeDropper = showEyeDropper;
  1189. this.overrideState = overrideState;
  1190. }
  1191. /// <summary>
  1192. /// Interpolates between two <c>Color</c> values.
  1193. /// </summary>
  1194. /// <remarks>
  1195. /// For performance reasons, this function interpolates the RGBA channels directly.
  1196. /// </remarks>
  1197. /// <param name="from">The start value.</param>
  1198. /// <param name="to">The end value.</param>
  1199. /// <param name="t">The interpolation factor in range [0,1].</param>
  1200. public override void Interp(Color from, Color to, float t)
  1201. {
  1202. // Lerping color values is a sensitive subject... We looked into lerping colors using
  1203. // HSV and LCH but they have some downsides that make them not work correctly in all
  1204. // situations, so we stick with RGB lerping for now, at least its behavior is
  1205. // predictable despite looking desaturated when `t ~= 0.5` and it's faster anyway.
  1206. m_Value.r = from.r + (to.r - from.r) * t;
  1207. m_Value.g = from.g + (to.g - from.g) * t;
  1208. m_Value.b = from.b + (to.b - from.b) * t;
  1209. m_Value.a = from.a + (to.a - from.a) * t;
  1210. }
  1211. }
  1212. /// <summary>
  1213. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Color</c> value.
  1214. /// </summary>
  1215. /// <seealso cref="ColorParameter"/>
  1216. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1217. public class NoInterpColorParameter : VolumeParameter<Color>
  1218. {
  1219. /// <summary>
  1220. /// Specifies whether the color is HDR or not.
  1221. /// </summary>
  1222. public bool hdr = false;
  1223. /// <summary>
  1224. /// Specifies whether you can edit the alpha channel in the Inspector or not.
  1225. /// </summary>
  1226. [NonSerialized]
  1227. public bool showAlpha = true;
  1228. /// <summary>
  1229. /// Specifies whether the eye dropper is visible in the editor or not.
  1230. /// </summary>
  1231. [NonSerialized]
  1232. public bool showEyeDropper = true;
  1233. /// <summary>
  1234. /// Creates a new <see cref="NoInterpColorParameter"/> instance.
  1235. /// </summary>
  1236. /// <param name="value">The initial value to store in the parameter.</param>
  1237. /// <param name="overrideState">The initial override state for the parameter.</param>
  1238. public NoInterpColorParameter(Color value, bool overrideState = false)
  1239. : base(value, overrideState) { }
  1240. /// <summary>
  1241. /// Creates a new <see cref="NoInterpColorParameter"/> instance.
  1242. /// </summary>
  1243. /// <param name="value">The initial value to store in the parameter.</param>
  1244. /// <param name="hdr">Specifies whether the color is HDR or not.</param>
  1245. /// <param name="showAlpha">Specifies whether you can edit the alpha channel in the Inspector or not.</param>
  1246. /// <param name="showEyeDropper">Specifies whether the eye dropper is visible in the editor or not.</param>
  1247. /// <param name="overrideState">The initial override state for the parameter.</param>
  1248. public NoInterpColorParameter(Color value, bool hdr, bool showAlpha, bool showEyeDropper, bool overrideState = false)
  1249. : base(value, overrideState)
  1250. {
  1251. this.hdr = hdr;
  1252. this.showAlpha = showAlpha;
  1253. this.showEyeDropper = showEyeDropper;
  1254. this.overrideState = overrideState;
  1255. }
  1256. }
  1257. /// <summary>
  1258. /// A <see cref="VolumeParameter"/> that holds a <c>Vector2</c> value.
  1259. /// </summary>
  1260. /// <seealso cref="NoInterpVector2Parameter"/>
  1261. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1262. public class Vector2Parameter : VolumeParameter<Vector2>
  1263. {
  1264. /// <summary>
  1265. /// Creates a new <see cref="Vector2Parameter"/> instance.
  1266. /// </summary>
  1267. /// <param name="value">The initial value to store in the parameter.</param>
  1268. /// <param name="overrideState">The initial override state for the parameter.</param>
  1269. public Vector2Parameter(Vector2 value, bool overrideState = false)
  1270. : base(value, overrideState) { }
  1271. /// <summary>
  1272. /// Interpolates between two <c>Vector2</c> values.
  1273. /// </summary>
  1274. /// <param name="from">The start value.</param>
  1275. /// <param name="to">The end value.</param>
  1276. /// <param name="t">The interpolation factor in range [0,1].</param>
  1277. public override void Interp(Vector2 from, Vector2 to, float t)
  1278. {
  1279. m_Value.x = from.x + (to.x - from.x) * t;
  1280. m_Value.y = from.y + (to.y - from.y) * t;
  1281. }
  1282. }
  1283. /// <summary>
  1284. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Vector2</c> value.
  1285. /// </summary>
  1286. /// <seealso cref="Vector2Parameter"/>
  1287. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1288. public class NoInterpVector2Parameter : VolumeParameter<Vector2>
  1289. {
  1290. /// <summary>
  1291. /// Creates a new <see cref="NoInterpVector2Parameter"/> instance.
  1292. /// </summary>
  1293. /// <param name="value">The initial value to store in the parameter.</param>
  1294. /// <param name="overrideState">The initial override state for the parameter.</param>
  1295. public NoInterpVector2Parameter(Vector2 value, bool overrideState = false)
  1296. : base(value, overrideState) { }
  1297. }
  1298. /// <summary>
  1299. /// A <see cref="VolumeParameter"/> that holds a <c>Vector3</c> value.
  1300. /// </summary>
  1301. /// <seealso cref="NoInterpVector3Parameter"/>
  1302. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1303. public class Vector3Parameter : VolumeParameter<Vector3>
  1304. {
  1305. /// <summary>
  1306. /// Creates a new <see cref="Vector3Parameter"/> instance.
  1307. /// </summary>
  1308. /// <param name="value">The initial value to store in the parameter.</param>
  1309. /// <param name="overrideState">The initial override state for the parameter.</param>
  1310. public Vector3Parameter(Vector3 value, bool overrideState = false)
  1311. : base(value, overrideState) { }
  1312. /// <summary>
  1313. /// Interpolates between two <c>Vector3</c> values.
  1314. /// </summary>
  1315. /// <param name="from">The start value.</param>
  1316. /// <param name="to">The end value.</param>
  1317. /// <param name="t">The interpolation factor in range [0,1].</param>
  1318. public override void Interp(Vector3 from, Vector3 to, float t)
  1319. {
  1320. m_Value.x = from.x + (to.x - from.x) * t;
  1321. m_Value.y = from.y + (to.y - from.y) * t;
  1322. m_Value.z = from.z + (to.z - from.z) * t;
  1323. }
  1324. }
  1325. /// <summary>
  1326. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Vector3</c> value.
  1327. /// </summary>
  1328. /// <seealso cref="Vector3Parameter"/>
  1329. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1330. public class NoInterpVector3Parameter : VolumeParameter<Vector3>
  1331. {
  1332. /// <summary>
  1333. /// Creates a new <see cref="Vector3Parameter"/> instance.
  1334. /// </summary>
  1335. /// <param name="value">The initial value to store in the parameter.</param>
  1336. /// <param name="overrideState">The initial override state for the parameter.</param>
  1337. public NoInterpVector3Parameter(Vector3 value, bool overrideState = false)
  1338. : base(value, overrideState) { }
  1339. }
  1340. /// <summary>
  1341. /// A <see cref="VolumeParameter"/> that holds a <c>Vector4</c> value.
  1342. /// </summary>
  1343. /// <seealso cref="NoInterpVector4Parameter"/>
  1344. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1345. public class Vector4Parameter : VolumeParameter<Vector4>
  1346. {
  1347. /// <summary>
  1348. /// Creates a new <see cref="Vector4Parameter"/> instance.
  1349. /// </summary>
  1350. /// <param name="value">The initial value to store in the parameter.</param>
  1351. /// <param name="overrideState">The initial override state for the parameter.</param>
  1352. public Vector4Parameter(Vector4 value, bool overrideState = false)
  1353. : base(value, overrideState) { }
  1354. /// <summary>
  1355. /// Interpolates between two <c>Vector4</c> values.
  1356. /// </summary>
  1357. /// <param name="from">The start value.</param>
  1358. /// <param name="to">The end value.</param>
  1359. /// <param name="t">The interpolation factor in range [0,1].</param>
  1360. public override void Interp(Vector4 from, Vector4 to, float t)
  1361. {
  1362. m_Value.x = from.x + (to.x - from.x) * t;
  1363. m_Value.y = from.y + (to.y - from.y) * t;
  1364. m_Value.z = from.z + (to.z - from.z) * t;
  1365. m_Value.w = from.w + (to.w - from.w) * t;
  1366. }
  1367. }
  1368. /// <summary>
  1369. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Vector4</c> value.
  1370. /// </summary>
  1371. /// <seealso cref="Vector4Parameter"/>
  1372. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1373. public class NoInterpVector4Parameter : VolumeParameter<Vector4>
  1374. {
  1375. /// <summary>
  1376. /// Creates a new <see cref="Vector4Parameter"/> instance.
  1377. /// </summary>
  1378. /// <param name="value">The initial value to store in the parameter.</param>
  1379. /// <param name="overrideState">The initial override state for the parameter.</param>
  1380. public NoInterpVector4Parameter(Vector4 value, bool overrideState = false)
  1381. : base(value, overrideState) { }
  1382. }
  1383. /// <summary>
  1384. /// A <see cref="VolumeParameter"/> that holds a <c>Texture</c> value.
  1385. /// </summary>
  1386. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1387. public class TextureParameter : VolumeParameter<Texture>
  1388. {
  1389. /// <summary>
  1390. /// The accepted dimension of textures.
  1391. /// </summary>
  1392. public TextureDimension dimension;
  1393. /// <summary>
  1394. /// Creates a new <see cref="TextureParameter"/> instance.
  1395. /// </summary>
  1396. /// <param name="value">The initial value to store in the parameter.</param>
  1397. /// <param name="overrideState">The initial override state for the parameter.</param>
  1398. public TextureParameter(Texture value, bool overrideState = false)
  1399. : this(value, TextureDimension.Any, overrideState) { }
  1400. /// <summary>
  1401. /// Creates a new <see cref="TextureParameter"/> instance.
  1402. /// </summary>
  1403. /// <param name="value">The initial value to store in the parameter.</param>
  1404. /// <param name="dimension">The accepted dimension of textures.</param>
  1405. /// <param name="overrideState">The initial override state for the parameter.</param>
  1406. public TextureParameter(Texture value, TextureDimension dimension, bool overrideState = false)
  1407. : base(value, overrideState)
  1408. {
  1409. this.dimension = dimension;
  1410. }
  1411. // TODO: Texture interpolation
  1412. /// <summary>
  1413. /// Returns a hash code for the current object.
  1414. /// </summary>
  1415. /// <returns>A hash code for the current object.</returns>
  1416. public override int GetHashCode()
  1417. {
  1418. int hash = base.GetHashCode();
  1419. unchecked
  1420. {
  1421. if (value != null)
  1422. hash = 23 * CoreUtils.GetTextureHash(value);
  1423. }
  1424. return hash;
  1425. }
  1426. }
  1427. /// <summary>
  1428. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Texture</c> value.
  1429. /// </summary>
  1430. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1431. public class NoInterpTextureParameter : VolumeParameter<Texture>
  1432. {
  1433. /// <summary>
  1434. /// Creates a new <see cref="NoInterpTextureParameter"/> instance.
  1435. /// </summary>
  1436. /// <param name="value">The initial value to store in the parameter.</param>
  1437. /// <param name="overrideState">The initial override state for the parameter.</param>
  1438. public NoInterpTextureParameter(Texture value, bool overrideState = false)
  1439. : base(value, overrideState) { }
  1440. /// <summary>
  1441. /// Returns a hash code for the current object.
  1442. /// </summary>
  1443. /// <returns>A hash code for the current object.</returns>
  1444. public override int GetHashCode()
  1445. {
  1446. int hash = base.GetHashCode();
  1447. unchecked
  1448. {
  1449. if (value != null)
  1450. hash = 23 * CoreUtils.GetTextureHash(value);
  1451. }
  1452. return hash;
  1453. }
  1454. }
  1455. /// <summary>
  1456. /// A <see cref="VolumeParameter"/> that holds a 2D <c>Texture</c> value.
  1457. /// </summary>
  1458. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1459. public class Texture2DParameter : VolumeParameter<Texture>
  1460. {
  1461. /// <summary>
  1462. /// Creates a new <see cref="Texture2DParameter"/> instance.
  1463. /// </summary>
  1464. /// <param name="value">The initial value to store in the parameter.</param>
  1465. /// <param name="overrideState">The initial override state for the parameter.</param>
  1466. public Texture2DParameter(Texture value, bool overrideState = false)
  1467. : base(value, overrideState) { }
  1468. /// <summary>
  1469. /// Returns a hash code for the current object.
  1470. /// </summary>
  1471. /// <returns>A hash code for the current object.</returns>
  1472. public override int GetHashCode()
  1473. {
  1474. int hash = base.GetHashCode();
  1475. unchecked
  1476. {
  1477. if (value != null)
  1478. hash = 23 * CoreUtils.GetTextureHash(value);
  1479. }
  1480. return hash;
  1481. }
  1482. }
  1483. /// <summary>
  1484. /// A <see cref="VolumeParameter"/> that holds a 3D <c>Texture</c> value.
  1485. /// </summary>
  1486. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1487. public class Texture3DParameter : VolumeParameter<Texture>
  1488. {
  1489. /// <summary>
  1490. /// Creates a new <see cref="Texture3DParameter"/> instance.
  1491. /// </summary>
  1492. /// <param name="value">The initial value to store in the parameter.</param>
  1493. /// <param name="overrideState">The initial override state for the parameter.</param>
  1494. public Texture3DParameter(Texture value, bool overrideState = false)
  1495. : base(value, overrideState) { }
  1496. /// <summary>
  1497. /// Returns a hash code for the current object.
  1498. /// </summary>
  1499. /// <returns>A hash code for the current object.</returns>
  1500. public override int GetHashCode()
  1501. {
  1502. int hash = base.GetHashCode();
  1503. unchecked
  1504. {
  1505. if (value != null)
  1506. hash = 23 * CoreUtils.GetTextureHash(value);
  1507. }
  1508. return hash;
  1509. }
  1510. }
  1511. /// <summary>
  1512. /// A <see cref="VolumeParameter"/> that holds a <c>RenderTexture</c> value.
  1513. /// </summary>
  1514. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1515. public class RenderTextureParameter : VolumeParameter<RenderTexture>
  1516. {
  1517. /// <summary>
  1518. /// Creates a new <see cref="RenderTextureParameter"/> instance.
  1519. /// </summary>
  1520. /// <param name="value">The initial value to store in the parameter.</param>
  1521. /// <param name="overrideState">The initial override state for the parameter.</param>
  1522. public RenderTextureParameter(RenderTexture value, bool overrideState = false)
  1523. : base(value, overrideState) { }
  1524. // TODO: RenderTexture interpolation
  1525. /// <summary>
  1526. /// Returns a hash code for the current object.
  1527. /// </summary>
  1528. /// <returns>A hash code for the current object.</returns>
  1529. public override int GetHashCode()
  1530. {
  1531. int hash = base.GetHashCode();
  1532. unchecked
  1533. {
  1534. if (value != null)
  1535. hash = 23 * CoreUtils.GetTextureHash(value);
  1536. }
  1537. return hash;
  1538. }
  1539. }
  1540. /// <summary>
  1541. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>RenderTexture</c> value.
  1542. /// </summary>
  1543. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1544. public class NoInterpRenderTextureParameter : VolumeParameter<RenderTexture>
  1545. {
  1546. /// <summary>
  1547. /// Creates a new <see cref="NoInterpRenderTextureParameter"/> instance.
  1548. /// </summary>
  1549. /// <param name="value">The initial value to store in the parameter.</param>
  1550. /// <param name="overrideState">The initial override state for the parameter.</param>
  1551. public NoInterpRenderTextureParameter(RenderTexture value, bool overrideState = false)
  1552. : base(value, overrideState) { }
  1553. /// <summary>
  1554. /// Returns a hash code for the current object.
  1555. /// </summary>
  1556. /// <returns>A hash code for the current object.</returns>
  1557. public override int GetHashCode()
  1558. {
  1559. int hash = base.GetHashCode();
  1560. unchecked
  1561. {
  1562. if (value != null)
  1563. hash = 23 * CoreUtils.GetTextureHash(value);
  1564. }
  1565. return hash;
  1566. }
  1567. }
  1568. /// <summary>
  1569. /// A <see cref="VolumeParameter"/> that holds a <c>Cubemap</c> value.
  1570. /// </summary>
  1571. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1572. public class CubemapParameter : VolumeParameter<Texture>
  1573. {
  1574. /// <summary>
  1575. /// Creates a new <see cref="CubemapParameter"/> instance.
  1576. /// </summary>
  1577. /// <param name="value">The initial value to store in the parameter.</param>
  1578. /// <param name="overrideState">The initial override state for the parameter.</param>
  1579. public CubemapParameter(Texture value, bool overrideState = false)
  1580. : base(value, overrideState) { }
  1581. // TODO: Cubemap interpolation
  1582. /// <summary>
  1583. /// Returns a hash code for the current object.
  1584. /// </summary>
  1585. /// <returns>A hash code for the current object.</returns>
  1586. public override int GetHashCode()
  1587. {
  1588. int hash = base.GetHashCode();
  1589. unchecked
  1590. {
  1591. if (value != null)
  1592. hash = 23 * CoreUtils.GetTextureHash(value);
  1593. }
  1594. return hash;
  1595. }
  1596. }
  1597. /// <summary>
  1598. /// A <see cref="VolumeParameter"/> that holds a non-interpolating <c>Cubemap</c> value.
  1599. /// </summary>
  1600. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1601. public class NoInterpCubemapParameter : VolumeParameter<Cubemap>
  1602. {
  1603. /// <summary>
  1604. /// Creates a new <see cref="NoInterpCubemapParameter"/> instance.
  1605. /// </summary>
  1606. /// <param name="value">The initial value to store in the parameter.</param>
  1607. /// <param name="overrideState">The initial override state for the parameter.</param>
  1608. public NoInterpCubemapParameter(Cubemap value, bool overrideState = false)
  1609. : base(value, overrideState) { }
  1610. /// <summary>
  1611. /// Returns a hash code for the current object.
  1612. /// </summary>
  1613. /// <returns>A hash code for the current object.</returns>
  1614. public override int GetHashCode()
  1615. {
  1616. int hash = base.GetHashCode();
  1617. unchecked
  1618. {
  1619. if (value != null)
  1620. hash = 23 * CoreUtils.GetTextureHash(value);
  1621. }
  1622. return hash;
  1623. }
  1624. }
  1625. /// <summary>
  1626. /// A <see cref="VolumeParameter"/> that holds a serializable class or struct.
  1627. /// </summary>
  1628. /// <typeparam name="T">The type of serializable object or struct to hold in this parameter.
  1629. /// </typeparam>
  1630. // TODO: ObjectParameter<T> doesn't seem to be working as expect, debug me
  1631. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1632. public class ObjectParameter<T> : VolumeParameter<T>
  1633. {
  1634. internal ReadOnlyCollection<VolumeParameter> parameters { get; private set; }
  1635. /// <summary>
  1636. /// The current override state for this parameter. Note that this is always forced enabled
  1637. /// on <see cref="ObjectParameter{T}"/>.
  1638. /// </summary>
  1639. public sealed override bool overrideState
  1640. {
  1641. get => true;
  1642. set => m_OverrideState = true;
  1643. }
  1644. /// <summary>
  1645. /// The value stored by this parameter.
  1646. /// </summary>
  1647. public sealed override T value
  1648. {
  1649. get => m_Value;
  1650. set
  1651. {
  1652. m_Value = value;
  1653. if (m_Value == null)
  1654. {
  1655. parameters = null;
  1656. return;
  1657. }
  1658. // Automatically grab all fields of type VolumeParameter contained in this instance
  1659. parameters = m_Value.GetType()
  1660. .GetFields(BindingFlags.Public | BindingFlags.Instance)
  1661. .Where(t => t.FieldType.IsSubclassOf(typeof(VolumeParameter)))
  1662. .OrderBy(t => t.MetadataToken) // Guaranteed order
  1663. .Select(t => (VolumeParameter)t.GetValue(m_Value))
  1664. .ToList()
  1665. .AsReadOnly();
  1666. }
  1667. }
  1668. /// <summary>
  1669. /// Creates a new <see cref="ObjectParameter{T}"/> instance.
  1670. /// </summary>
  1671. /// <param name="value">The initial value to store in the parameter.</param>
  1672. public ObjectParameter(T value)
  1673. {
  1674. m_OverrideState = true;
  1675. this.value = value;
  1676. }
  1677. internal override void Interp(VolumeParameter from, VolumeParameter to, float t)
  1678. {
  1679. if (m_Value == null)
  1680. return;
  1681. var paramOrigin = parameters;
  1682. var paramFrom = ((ObjectParameter<T>)from).parameters;
  1683. var paramTo = ((ObjectParameter<T>)to).parameters;
  1684. for (int i = 0; i < paramFrom.Count; i++)
  1685. {
  1686. // Keep track of the override state for debugging purpose
  1687. paramOrigin[i].overrideState = paramTo[i].overrideState;
  1688. if (paramTo[i].overrideState)
  1689. paramOrigin[i].Interp(paramFrom[i], paramTo[i], t);
  1690. }
  1691. }
  1692. }
  1693. /// <summary>
  1694. /// A <see cref="VolumeParameter"/> that holds an <c>AnimationCurve</c> value.
  1695. /// </summary>
  1696. [Serializable]
  1697. public class AnimationCurveParameter : VolumeParameter<AnimationCurve>
  1698. {
  1699. /// <summary>
  1700. /// Creates a new <see cref="AnimationCurveParameter"/> instance.
  1701. /// </summary>
  1702. /// <param name="value">The initial value to be stored in the parameter</param>
  1703. /// <param name="overrideState">The initial override state for the parameter</param>
  1704. public AnimationCurveParameter(AnimationCurve value, bool overrideState = false)
  1705. : base(value, overrideState) { }
  1706. /// <summary>
  1707. /// Interpolates between two AnimationCurve values. Note that it will overwrite the values in lhsCurve,
  1708. /// whereas rhsCurve data will be unchanged. Thus, it is legal to call it as:
  1709. /// stateParam.Interp(stateParam, toParam, interpFactor);
  1710. /// However, It should NOT be called when the lhsCurve parameter needs to be preserved. But the current
  1711. /// framework modifies it anyway in VolumeComponent.Override for all types of VolumeParameters
  1712. /// </summary>
  1713. /// <param name="lhsCurve">The start value.</param>
  1714. /// <param name="rhsCurve">The end value.</param>
  1715. /// <param name="t">The interpolation factor in range [0,1].</param>
  1716. public override void Interp(AnimationCurve lhsCurve, AnimationCurve rhsCurve, float t)
  1717. {
  1718. m_Value = lhsCurve;
  1719. KeyframeUtility.InterpAnimationCurve(ref m_Value, rhsCurve, t);
  1720. }
  1721. /// <inheritdoc/>
  1722. public override void SetValue(VolumeParameter parameter)
  1723. {
  1724. m_Value.CopyFrom(((AnimationCurveParameter)parameter).m_Value);
  1725. }
  1726. /// <inheritdoc/>
  1727. public override object Clone()
  1728. {
  1729. return new AnimationCurveParameter(new AnimationCurve(GetValue<AnimationCurve>().keys), overrideState);
  1730. }
  1731. /// <summary>
  1732. /// Returns a hash code for the animationCurve.
  1733. /// </summary>
  1734. /// <returns>A hash code for the animationCurve.</returns>
  1735. public override int GetHashCode()
  1736. {
  1737. unchecked
  1738. {
  1739. var hash = overrideState.GetHashCode();
  1740. return hash * 23 + value.GetHashCode();
  1741. }
  1742. }
  1743. }
  1744. /// <summary>
  1745. /// A <see cref="VolumeParameter"/> that holds a <see cref="Material"/> value.
  1746. /// </summary>
  1747. [Serializable, DebuggerDisplay(k_DebuggerDisplay)]
  1748. public class MaterialParameter : VolumeParameter<Material>
  1749. {
  1750. /// <summary>
  1751. /// Creates a new <see cref="MaterialParameter"/> instance.
  1752. /// </summary>
  1753. /// <param name="value">The initial value to store in the parameter</param>
  1754. /// <param name="overrideState">The initial override state for the parameter</param>
  1755. public MaterialParameter(Material value, bool overrideState = false)
  1756. : base(value, overrideState) { }
  1757. }
  1758. }