GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

Improve various doc comments to be more usable as tooltips in Editor

Browse Source
This commit is contained in:
Wojtek Figat
2023-11-07 00:57:18 +01:00
parent 87a9dedba4
commit 6648481d12
3 changed files with 28 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Source/Engine/Level/Actors/SpotLight.h
View File

@@ -24,7 +24,7 @@ private:
public:
/// <summary>
/// Light source bulb radius
/// Light source bulb radius.
/// </summary>
API_FIELD(Attributes="EditorOrder(2), DefaultValue(0.0f), EditorDisplay(\"Light\"), Limit(0, 1000, 0.01f)")
float SourceRadius = 0.0f;
@@ -42,54 +42,51 @@ public:
float FallOffExponent = 8.0f;
/// <summary>
/// IES texture (light profiles from real world measured data)
/// IES texture (light profiles from real world measured data).
/// </summary>
API_FIELD(Attributes="EditorOrder(211), DefaultValue(null), EditorDisplay(\"IES Profile\", \"IES Texture\")")
AssetReference<IESProfile> IESTexture;
/// <summary>
/// Enable/disable using light brightness from IES profile
/// Enable/disable using light brightness from IES profile.
/// </summary>
API_FIELD(Attributes="EditorOrder(212), DefaultValue(false), EditorDisplay(\"IES Profile\", \"Use IES Brightness\")")
bool UseIESBrightness = false;
/// <summary>
/// Global scale for IES brightness contribution
/// Global scale for IES brightness contribution.
/// </summary>
API_FIELD(Attributes="EditorOrder(213), DefaultValue(1.0f), Limit(0, 10000, 0.01f), EditorDisplay(\"IES Profile\", \"Brightness Scale\")")
float IESBrightnessScale = 1.0f;
public:
/// <summary>
/// Computes light brightness value
/// Computes light brightness value.
/// </summary>
/// <returns>Brightness</returns>
float ComputeBrightness() const;
/// <summary>
/// Gets scaled light radius
/// Gets scaled light radius.
/// </summary>
float GetScaledRadius() const;
/// <summary>
/// Gets light radius
/// Gets light radius.
/// </summary>
API_PROPERTY(Attributes="EditorOrder(1), DefaultValue(1000.0f), EditorDisplay(\"Light\"), Tooltip(\"Light radius\"), Limit(0, 10000, 0.1f)")
API_PROPERTY(Attributes="EditorOrder(1), DefaultValue(1000.0f), EditorDisplay(\"Light\"), Limit(0, 10000, 0.1f)")
FORCE_INLINE float GetRadius() const
{
return _radius;
}
/// <summary>
/// Sets light radius
/// Sets light radius.
/// </summary>
/// <param name="value">New radius</param>
API_PROPERTY() void SetRadius(float value);
/// <summary>
/// Gets the spot light's outer cone angle (in degrees)
/// Gets the spot light's outer cone angle (in degrees).
/// </summary>
/// <returns>Outer angle (in degrees)</returns>
API_PROPERTY(Attributes="EditorOrder(22), DefaultValue(43.0f), EditorDisplay(\"Light\"), Limit(1, 89, 0.1f)")
FORCE_INLINE float GetOuterConeAngle() const
{
@@ -97,15 +94,13 @@ public:
}
/// <summary>
/// Sets the spot light's outer cone angle (in degrees)
/// Sets the spot light's outer cone angle (in degrees).
/// </summary>
/// <param name="value">Value to assign</param>
API_PROPERTY() void SetOuterConeAngle(float value);
/// <summary>
/// Sets the spot light's inner cone angle (in degrees)
/// Sets the spot light's inner cone angle (in degrees).
/// </summary>
/// <returns>Inner angle (in degrees)</returns>
API_PROPERTY(Attributes="EditorOrder(21), DefaultValue(10.0f), EditorDisplay(\"Light\"), Limit(1, 89, 0.1f)")
FORCE_INLINE float GetInnerConeAngle() const
{
@@ -113,9 +108,8 @@ public:
}
/// <summary>
/// Sets the spot light's inner cone angle (in degrees)
/// Sets the spot light's inner cone angle (in degrees).
/// </summary>
/// <param name="value">Value to assign</param>
API_PROPERTY() void SetInnerConeAngle(float value);
private: