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

Cleanup code #2213

Browse Source
This commit is contained in:
Wojtek Figat
2024-03-19 20:13:41 +01:00
parent bfbabbc395
commit 9e54827cb3
20 changed files with 150 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Source/Editor/CustomEditors/Editors/Vector3Editor.cs
View File

@@ -4,7 +4,6 @@ using System.Linq;
using FlaxEditor.CustomEditors.Elements; using FlaxEditor.CustomEditors.Elements;
using FlaxEngine; using FlaxEngine;
using FlaxEngine.GUI; using FlaxEngine.GUI;
using Utils = FlaxEngine.Utils;
namespace FlaxEditor.CustomEditors.Editors namespace FlaxEditor.CustomEditors.Editors
{ {

5
Source/Editor/CustomEditors/Elements/DoubleValueElement.cs
View File

@@ -5,7 +5,6 @@ using System.Reflection;
using FlaxEditor.GUI.Input; using FlaxEditor.GUI.Input;
using FlaxEngine; using FlaxEngine;
using FlaxEngine.GUI; using FlaxEngine.GUI;
using Utils = FlaxEngine.Utils;
namespace FlaxEditor.CustomEditors.Elements namespace FlaxEditor.CustomEditors.Elements
{ {
@@ -53,9 +52,9 @@ namespace FlaxEditor.CustomEditors.Elements
} }
/// <summary> /// <summary>
/// Set the value category of this float element /// Sets the editor value category.
/// </summary> /// </summary>
/// <param name="category"></param> /// <param name="category">The category.</param>
public void SetCategory(Utils.ValueCategory category) public void SetCategory(Utils.ValueCategory category)
{ {
ValueBox.Category = category; ValueBox.Category = category;

5
Source/Editor/CustomEditors/Elements/FloatValueElement.cs
View File

@@ -5,7 +5,6 @@ using System.Reflection;
using FlaxEditor.GUI.Input; using FlaxEditor.GUI.Input;
using FlaxEngine; using FlaxEngine;
using FlaxEngine.GUI; using FlaxEngine.GUI;
using Utils = FlaxEngine.Utils;
namespace FlaxEditor.CustomEditors.Elements namespace FlaxEditor.CustomEditors.Elements
{ {
@@ -53,9 +52,9 @@ namespace FlaxEditor.CustomEditors.Elements
} }
/// <summary> /// <summary>
/// Set the value category of this float element /// Sets the editor value category.
/// </summary> /// </summary>
/// <param name="category"></param> /// <param name="category">The category.</param>
public void SetCategory(Utils.ValueCategory category) public void SetCategory(Utils.ValueCategory category)
{ {
ValueBox.Category = category; ValueBox.Category = category;

16
Source/Editor/GUI/Input/DoubleValueBox.cs
View File

@@ -14,6 +14,8 @@ namespace FlaxEditor.GUI.Input
[HideInEditor] [HideInEditor]
public class DoubleValueBox : ValueBox<double> public class DoubleValueBox : ValueBox<double>
{ {
private Utils.ValueCategory _category = Utils.ValueCategory.None;
/// <inheritdoc /> /// <inheritdoc />
public override double Value public override double Value
{ {
@@ -131,9 +133,19 @@ namespace FlaxEditor.GUI.Input
} }
/// <summary> /// <summary>
/// Get or set the category of the value. This can either be none for just a number, a distance or an angle. /// Gets or sets the category of the value. This can be none for just a number or a more specific one like a distance.
/// </summary> /// </summary>
public Utils.ValueCategory Category = Utils.ValueCategory.None; public Utils.ValueCategory Category
{
get => _category;
set
{
if (_category == value)
return;
_category = value;
UpdateText();
}
}
/// <inheritdoc /> /// <inheritdoc />
protected sealed override void UpdateText() protected sealed override void UpdateText()

17
Source/Editor/GUI/Input/FloatValueBox.cs
View File

@@ -14,6 +14,8 @@ namespace FlaxEditor.GUI.Input
[HideInEditor] [HideInEditor]
public class FloatValueBox : ValueBox<float> public class FloatValueBox : ValueBox<float>
{ {
private Utils.ValueCategory _category = Utils.ValueCategory.None;
/// <inheritdoc /> /// <inheritdoc />
public override float Value public override float Value
{ {
@@ -137,14 +139,19 @@ namespace FlaxEditor.GUI.Input
Value = Value; Value = Value;
} }
private Utils.ValueCategory _category = Utils.ValueCategory.None;
/// <summary> /// <summary>
/// Get or set the category of the value. This can be none for just a number or a more specific one like a distance. /// Gets or sets the category of the value. This can be none for just a number or a more specific one like a distance.
/// </summary> /// </summary>
public Utils.ValueCategory Category { public Utils.ValueCategory Category
{
get => _category; get => _category;
set { _category = value; UpdateText(); } set
{
if (_category == value)
return;
_category = value;
UpdateText();
}
} }
/// <inheritdoc /> /// <inheritdoc />

14
Source/Editor/Options/InterfaceOptions.cs
View File

@@ -118,22 +118,24 @@ namespace FlaxEditor.Options
} }
/// <summary> /// <summary>
/// Options for formatting numerical values /// Options for formatting numerical values.
/// </summary> /// </summary>
public enum ValueFormattingType public enum ValueFormattingType
{ {
/// <summary> /// <summary>
/// No formatting /// No formatting.
/// </summary> /// </summary>
None, None,
/// <summary> /// <summary>
/// Format using the base SI unit /// Format using the base SI unit.
/// </summary> /// </summary>
BaseUnit, BaseUnit,
/// <summary> /// <summary>
/// Format using a unit that matches the value best /// Format using a unit that matches the value best.
/// </summary> /// </summary>
AutoUnit AutoUnit,
} }
/// <summary> /// <summary>
@@ -214,7 +216,7 @@ namespace FlaxEditor.Options
private bool _spaceNumberAndUnits = false; private bool _spaceNumberAndUnits = false;
/// <summary> /// <summary>
/// Gets or sets the option to put a space between numbers and units for unit formatting /// Gets or sets the option to put a space between numbers and units for unit formatting.
/// </summary> /// </summary>
[DefaultValue(false)] [DefaultValue(false)]
[EditorDisplay("Interface"), EditorOrder(310), Tooltip("Put a space between numbers and units.")] [EditorDisplay("Interface"), EditorOrder(310), Tooltip("Put a space between numbers and units.")]

12
Source/Editor/Utilities/ShuntingYardParser.cs
View File

@@ -141,19 +141,17 @@ namespace FlaxEditor.Utilities
}; };
/// <summary> /// <summary>
/// List known units which cannot be handled as a variable easily because they contain operator /// List known units which cannot be handled as a variable easily because they contain operator symbols (mostly a forward slash). The value is the factor to calculate game units.
/// symbols (mostly a forward slash). The value is the factor to calculate game units.
/// </summary> /// </summary>
// Nm is here because these values are compared case-sensitive and we don't want to confuse
// nanometers and Newtonmeters
private static readonly IDictionary<string, double> UnitSymbols = new Dictionary<string, double> private static readonly IDictionary<string, double> UnitSymbols = new Dictionary<string, double>
{ {
["cm/s"] = Units.Meters2Units / 100, ["cm/s"] = Units.Meters2Units / 100,
["cm/s²"] = Units.Meters2Units / 100, ["cm/s²"] = Units.Meters2Units / 100,
["m/s"] = Units.Meters2Units, ["m/s"] = Units.Meters2Units,
["m/s²"] = Units.Meters2Units, ["m/s²"] = Units.Meters2Units,
["km/h"] = 1/3.6 * Units.Meters2Units, ["km/h"] = 1 / 3.6 * Units.Meters2Units,
["Nm"] = Units.Meters2Units * Units.Meters2Units // Nm is here because these values are compared case-sensitive, and we don't want to confuse nanometers and Newtonmeters
["Nm"] = Units.Meters2Units * Units.Meters2Units,
}; };
/// <summary> /// <summary>
@@ -189,7 +187,7 @@ namespace FlaxEditor.Utilities
if (Operators.ContainsKey(str)) if (Operators.ContainsKey(str))
return TokenType.Operator; return TokenType.Operator;
if (char.IsLetter(c) || c=='²' || c=='³') if (char.IsLetter(c) || c == '²' || c == '³')
return TokenType.Variable; return TokenType.Variable;
throw new ParsingException("wrong character"); throw new ParsingException("wrong character");

11
Source/Editor/Utilities/Units.cs
View File

@@ -1,5 +1,10 @@
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
namespace FlaxEditor.Utilities; namespace FlaxEditor.Utilities;
/// <summary>
/// Units display utilities for Editor.
/// </summary>
public class Units public class Units
{ {
/// <summary> /// <summary>
@@ -8,7 +13,7 @@ public class Units
public static readonly float Meters2Units = 100f; public static readonly float Meters2Units = 100f;
/// <summary> /// <summary>
/// Set it to false to always show game units without any postfix. /// False to always show game units without any postfix.
/// </summary> /// </summary>
public static bool UseUnitsFormatting = true; public static bool UseUnitsFormatting = true;
@@ -25,8 +30,8 @@ public class Units
/// <summary> /// <summary>
/// Return the unit according to user settings. /// Return the unit according to user settings.
/// </summary> /// </summary>
/// <param name="unit"></param> /// <param name="unit">The unit name.</param>
/// <returns></returns> /// <returns>The formatted text.</returns>
public static string Unit(string unit) public static string Unit(string unit)
{ {
if (SpaceNumberAndUnits) if (SpaceNumberAndUnits)

59
Source/Editor/Utilities/Utils.cs
View File

@@ -1248,38 +1248,37 @@ namespace FlaxEditor.Utilities
{ {
switch (category) switch (category)
{ {
case FlaxEngine.Utils.ValueCategory.Distance: case FlaxEngine.Utils.ValueCategory.Distance:
if (!Units.AutomaticUnitsFormatting) if (!Units.AutomaticUnitsFormatting)
return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m"); return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m");
var absValue = Mathf.Abs(value); var absValue = Mathf.Abs(value);
// in case a unit != cm this would be (value / Meters2Units * 100) // in case a unit != cm this would be (value / Meters2Units * 100)
if (absValue < Units.Meters2Units) if (absValue < Units.Meters2Units)
return value.ToString(format, CultureInfo.InvariantCulture) + Units.Unit("cm"); return value.ToString(format, CultureInfo.InvariantCulture) + Units.Unit("cm");
if (absValue < Units.Meters2Units * 1000) if (absValue < Units.Meters2Units * 1000)
return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m"); return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m");
return (value / 1000 / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("km"); return (value / 1000 / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("km");
case FlaxEngine.Utils.ValueCategory.Angle: return value.ToString(format, CultureInfo.InvariantCulture) + "°"; case FlaxEngine.Utils.ValueCategory.Angle: return value.ToString(format, CultureInfo.InvariantCulture) + "°";
case FlaxEngine.Utils.ValueCategory.Time: return value.ToString(format, CultureInfo.InvariantCulture) + Units.Unit("s"); case FlaxEngine.Utils.ValueCategory.Time: return value.ToString(format, CultureInfo.InvariantCulture) + Units.Unit("s");
// some fonts have a symbol for that: "\u33A7" // some fonts have a symbol for that: "\u33A7"
case FlaxEngine.Utils.ValueCategory.Speed: return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m/s"); case FlaxEngine.Utils.ValueCategory.Speed: return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m/s");
case FlaxEngine.Utils.ValueCategory.Acceleration: return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m/s²"); case FlaxEngine.Utils.ValueCategory.Acceleration: return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m/s²");
case FlaxEngine.Utils.ValueCategory.Area: return (value / Units.Meters2Units / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m²"); case FlaxEngine.Utils.ValueCategory.Area: return (value / Units.Meters2Units / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m²");
case FlaxEngine.Utils.ValueCategory.Volume: return (value / Units.Meters2Units / Units.Meters2Units / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m³"); case FlaxEngine.Utils.ValueCategory.Volume: return (value / Units.Meters2Units / Units.Meters2Units / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("m³");
case FlaxEngine.Utils.ValueCategory.Mass: return value.ToString(format, CultureInfo.InvariantCulture) + Units.Unit("kg"); case FlaxEngine.Utils.ValueCategory.Mass: return value.ToString(format, CultureInfo.InvariantCulture) + Units.Unit("kg");
case FlaxEngine.Utils.ValueCategory.Force: return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("N"); case FlaxEngine.Utils.ValueCategory.Force: return (value / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("N");
case FlaxEngine.Utils.ValueCategory.Torque: return (value / Units.Meters2Units / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("Nm"); case FlaxEngine.Utils.ValueCategory.Torque: return (value / Units.Meters2Units / Units.Meters2Units).ToString(format, CultureInfo.InvariantCulture) + Units.Unit("Nm");
case FlaxEngine.Utils.ValueCategory.None: case FlaxEngine.Utils.ValueCategory.None:
default: default: return FormatFloat(value);
return FormatFloat(value);
} }
} }
/// <summary> /// <summary>
/// Format a float value either as-is, with a distance unit or with a degree sign /// Format a float value either as-is, with a distance unit or with a degree sign.
/// </summary> /// </summary>
/// <param name="value">the value to format</param> /// <param name="value">The value to format.</param>
/// <param name="category">the value type: none means just a number, distance will format in cm/m/km, angle with an appended degree sign</param> /// <param name="category">The value type: none means just a number, distance will format in cm/m/km, angle with an appended degree sign.</param>
/// <returns>the formatted string</returns> /// <returns>The formatted string.</returns>
public static string FormatFloat(float value, FlaxEngine.Utils.ValueCategory category) public static string FormatFloat(float value, FlaxEngine.Utils.ValueCategory category)
{ {
if (float.IsPositiveInfinity(value) || value == float.MaxValue) if (float.IsPositiveInfinity(value) || value == float.MaxValue)
@@ -1295,9 +1294,9 @@ namespace FlaxEditor.Utilities
/// <summary> /// <summary>
/// Format a double value either as-is, with a distance unit or with a degree sign /// Format a double value either as-is, with a distance unit or with a degree sign
/// </summary> /// </summary>
/// <param name="value">the value to format</param> /// <param name="value">The value to format.</param>
/// <param name="category">the value type: none means just a number, distance will format in cm/m/km, angle with an appended degree sign</param> /// <param name="category">The value type: none means just a number, distance will format in cm/m/km, angle with an appended degree sign.</param>
/// <returns>the formatted string</returns> /// <returns>The formatted string.</returns>
public static string FormatFloat(double value, FlaxEngine.Utils.ValueCategory category) public static string FormatFloat(double value, FlaxEngine.Utils.ValueCategory category)
{ {
if (double.IsPositiveInfinity(value) || value == double.MaxValue) if (double.IsPositiveInfinity(value) || value == double.MaxValue)

6
Source/Engine/Level/Actors/Camera.h
View File

@@ -77,7 +77,7 @@ public:
/// <summary> /// <summary>
/// Gets the camera's field of view (in degrees). /// Gets the camera's field of view (in degrees).
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(20), DefaultValue(60.0f), Limit(0, 179), EditorDisplay(\"Camera\", \"Field Of View\"), VisibleIf(nameof(UsePerspective))") API_PROPERTY(Attributes="EditorOrder(20), DefaultValue(60.0f), Limit(0, 179), EditorDisplay(\"Camera\", \"Field Of View\"), VisibleIf(nameof(UsePerspective)), ValueCategory(Utils.ValueCategory.Angle)")
float GetFieldOfView() const; float GetFieldOfView() const;
/// <summary> /// <summary>
@@ -99,7 +99,7 @@ public:
/// <summary> /// <summary>
/// Gets camera's near plane distance. /// Gets camera's near plane distance.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(30), DefaultValue(10.0f), Limit(0, 1000, 0.05f), EditorDisplay(\"Camera\")") API_PROPERTY(Attributes="EditorOrder(30), DefaultValue(10.0f), Limit(0, 1000, 0.05f), EditorDisplay(\"Camera\"), ValueCategory(Utils.ValueCategory.Distance)")
float GetNearPlane() const; float GetNearPlane() const;
/// <summary> /// <summary>
@@ -110,7 +110,7 @@ public:
/// <summary> /// <summary>
/// Gets camera's far plane distance. /// Gets camera's far plane distance.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(40), DefaultValue(40000.0f), Limit(0, float.MaxValue, 5), EditorDisplay(\"Camera\")") API_PROPERTY(Attributes="EditorOrder(40), DefaultValue(40000.0f), Limit(0, float.MaxValue, 5), EditorDisplay(\"Camera\"), ValueCategory(Utils.ValueCategory.Distance)")
float GetFarPlane() const; float GetFarPlane() const;
/// <summary> /// <summary>

2
Source/Engine/Physics/Actors/RigidBody.h
View File

@@ -181,7 +181,7 @@ public:
/// <summary> /// <summary>
/// Gets the mass value measured in kilograms (use override value only if OverrideMass is checked). /// Gets the mass value measured in kilograms (use override value only if OverrideMass is checked).
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(110), Limit(0), EditorDisplay(\"Rigid Body\"), NumberCategory(Utils.ValueCategory.Mass)") API_PROPERTY(Attributes="EditorOrder(110), Limit(0), EditorDisplay(\"Rigid Body\"), ValueCategory(Utils.ValueCategory.Mass)")
float GetMass() const; float GetMass() const;
/// <summary> /// <summary>

2
Source/Engine/Physics/Colliders/BoxCollider.h
View File

@@ -23,7 +23,7 @@ public:
/// Gets the size of the box, measured in the object's local space. /// Gets the size of the box, measured in the object's local space.
/// </summary> /// </summary>
/// <remarks>The box size will be scaled by the actor's world scale. </remarks> /// <remarks>The box size will be scaled by the actor's world scale. </remarks>
API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(typeof(Float3), \"100,100,100\"), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(typeof(Float3), \"100,100,100\"), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE Float3 GetSize() const FORCE_INLINE Float3 GetSize() const
{ {
return _size; return _size;

4
Source/Engine/Physics/Colliders/CapsuleCollider.h
View File

@@ -25,7 +25,7 @@ public:
/// Gets the radius of the sphere, measured in the object's local space. /// Gets the radius of the sphere, measured in the object's local space.
/// </summary> /// </summary>
/// <remarks>The sphere radius will be scaled by the actor's world scale.</remarks> /// <remarks>The sphere radius will be scaled by the actor's world scale.</remarks>
API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(20.0f), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(20.0f), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE float GetRadius() const FORCE_INLINE float GetRadius() const
{ {
return _radius; return _radius;
@@ -41,7 +41,7 @@ public:
/// Gets the height of the capsule, measured in the object's local space between the centers of the hemispherical ends. /// Gets the height of the capsule, measured in the object's local space between the centers of the hemispherical ends.
/// </summary> /// </summary>
/// <remarks>The capsule height will be scaled by the actor's world scale.</remarks> /// <remarks>The capsule height will be scaled by the actor's world scale.</remarks>
API_PROPERTY(Attributes="EditorOrder(110), DefaultValue(100.0f), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(110), DefaultValue(100.0f), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE float GetHeight() const FORCE_INLINE float GetHeight() const
{ {
return _height; return _height;

10
Source/Engine/Physics/Colliders/CharacterController.h
View File

@@ -73,7 +73,7 @@ public:
/// <summary> /// <summary>
/// Gets the radius of the sphere, measured in the object's local space. The sphere radius will be scaled by the actor's world scale. /// Gets the radius of the sphere, measured in the object's local space. The sphere radius will be scaled by the actor's world scale.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(50.0f), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(50.0f), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
float GetRadius() const; float GetRadius() const;
/// <summary> /// <summary>
@@ -84,7 +84,7 @@ public:
/// <summary> /// <summary>
/// Gets the height of the capsule, measured in the object's local space. The capsule height will be scaled by the actor's world scale. /// Gets the height of the capsule, measured in the object's local space. The capsule height will be scaled by the actor's world scale.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(110), DefaultValue(150.0f), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(110), DefaultValue(150.0f), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
float GetHeight() const; float GetHeight() const;
/// <summary> /// <summary>
@@ -95,7 +95,7 @@ public:
/// <summary> /// <summary>
/// Gets the slope limit (in degrees). Limits the collider to only climb slopes that are less steep (in degrees) than the indicated value. /// Gets the slope limit (in degrees). Limits the collider to only climb slopes that are less steep (in degrees) than the indicated value.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(210), DefaultValue(45.0f), Limit(0, 100), EditorDisplay(\"Character Controller\"), NumberCategory(Utils.ValueCategory.Angle)") API_PROPERTY(Attributes="EditorOrder(210), DefaultValue(45.0f), Limit(0, 100), EditorDisplay(\"Character Controller\"), ValueCategory(Utils.ValueCategory.Angle)")
float GetSlopeLimit() const; float GetSlopeLimit() const;
/// <summary> /// <summary>
@@ -117,7 +117,7 @@ public:
/// <summary> /// <summary>
/// Gets the step height. The character will step up a stair only if it is closer to the ground than the indicated value. This should not be greater than the Character Controller’s height or it will generate an error. /// Gets the step height. The character will step up a stair only if it is closer to the ground than the indicated value. This should not be greater than the Character Controller’s height or it will generate an error.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(220), DefaultValue(30.0f), Limit(0), EditorDisplay(\"Character Controller\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(220), DefaultValue(30.0f), Limit(0), EditorDisplay(\"Character Controller\"), ValueCategory(Utils.ValueCategory.Distance)")
float GetStepOffset() const; float GetStepOffset() const;
/// <summary> /// <summary>
@@ -139,7 +139,7 @@ public:
/// <summary> /// <summary>
/// Gets the minimum move distance of the character controller. The minimum traveled distance to consider. If traveled distance is smaller, the character doesn't move. This is used to stop the recursive motion algorithm when remaining distance to travel is small. /// Gets the minimum move distance of the character controller. The minimum traveled distance to consider. If traveled distance is smaller, the character doesn't move. This is used to stop the recursive motion algorithm when remaining distance to travel is small.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(230), DefaultValue(0.0f), Limit(0, 1000), EditorDisplay(\"Character Controller\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(230), DefaultValue(0.0f), Limit(0, 1000), EditorDisplay(\"Character Controller\"), ValueCategory(Utils.ValueCategory.Distance)")
float GetMinMoveDistance() const; float GetMinMoveDistance() const;
/// <summary> /// <summary>

4
Source/Engine/Physics/Colliders/Collider.h
View File

@@ -52,7 +52,7 @@ public:
/// <summary> /// <summary>
/// Gets the center of the collider, measured in the object's local space. /// Gets the center of the collider, measured in the object's local space.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(10), DefaultValue(typeof(Vector3), \"0,0,0\"), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(10), DefaultValue(typeof(Vector3), \"0,0,0\"), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE Vector3 GetCenter() const FORCE_INLINE Vector3 GetCenter() const
{ {
return _center; return _center;
@@ -66,7 +66,7 @@ public:
/// <summary> /// <summary>
/// Gets the contact offset. Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated. /// Gets the contact offset. Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(1), DefaultValue(2.0f), Limit(0, 100), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(1), DefaultValue(2.0f), Limit(0, 100), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE float GetContactOffset() const FORCE_INLINE float GetContactOffset() const
{ {
return _contactOffset; return _contactOffset;

2
Source/Engine/Physics/Colliders/SphereCollider.h
View File

@@ -21,7 +21,7 @@ public:
/// Gets the radius of the sphere, measured in the object's local space. /// Gets the radius of the sphere, measured in the object's local space.
/// </summary> /// </summary>
/// <remarks>The sphere radius will be scaled by the actor's world scale.</remarks> /// <remarks>The sphere radius will be scaled by the actor's world scale.</remarks>
API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(50.0f), EditorDisplay(\"Collider\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(100), DefaultValue(50.0f), EditorDisplay(\"Collider\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE float GetRadius() const FORCE_INLINE float GetRadius() const
{ {
return _radius; return _radius;

4
Source/Engine/Physics/Joints/DistanceJoint.h
View File

@@ -67,7 +67,7 @@ public:
/// Gets the allowed minimum distance for the joint. /// Gets the allowed minimum distance for the joint.
/// </summary> /// </summary>
/// <remarks>Used only when DistanceJointFlag.MinDistance flag is set. The minimum distance must be no more than the maximum distance. Default: 0, Range: [0, float.MaxValue].</remarks> /// <remarks>Used only when DistanceJointFlag.MinDistance flag is set. The minimum distance must be no more than the maximum distance. Default: 0, Range: [0, float.MaxValue].</remarks>
API_PROPERTY(Attributes="EditorOrder(110), DefaultValue(0.0f), Limit(0.0f), EditorDisplay(\"Joint\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(110), DefaultValue(0.0f), Limit(0.0f), EditorDisplay(\"Joint\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE float GetMinDistance() const FORCE_INLINE float GetMinDistance() const
{ {
return _minDistance; return _minDistance;
@@ -83,7 +83,7 @@ public:
/// Gets the allowed maximum distance for the joint. /// Gets the allowed maximum distance for the joint.
/// </summary> /// </summary>
/// <remarks>Used only when DistanceJointFlag.MaxDistance flag is set. The maximum distance must be no less than the minimum distance. Default: 0, Range: [0, float.MaxValue].</remarks> /// <remarks>Used only when DistanceJointFlag.MaxDistance flag is set. The maximum distance must be no less than the minimum distance. Default: 0, Range: [0, float.MaxValue].</remarks>
API_PROPERTY(Attributes="EditorOrder(120), DefaultValue(10.0f), Limit(0.0f), EditorDisplay(\"Joint\"), NumberCategory(Utils.ValueCategory.Distance)") API_PROPERTY(Attributes="EditorOrder(120), DefaultValue(10.0f), Limit(0.0f), EditorDisplay(\"Joint\"), ValueCategory(Utils.ValueCategory.Distance)")
FORCE_INLINE float GetMaxDistance() const FORCE_INLINE float GetMaxDistance() const
{ {
return _maxDistance; return _maxDistance;

4
Source/Engine/Physics/Joints/Joint.h
View File

@@ -38,7 +38,7 @@ public:
/// <summary> /// <summary>
/// Gets the break force. Determines the maximum force the joint can apply before breaking. Broken joints no longer participate in physics simulation. /// Gets the break force. Determines the maximum force the joint can apply before breaking. Broken joints no longer participate in physics simulation.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(10), DefaultValue(float.MaxValue), EditorDisplay(\"Joint\"), NumberCategory(Utils.ValueCategory.Force)") API_PROPERTY(Attributes="EditorOrder(10), DefaultValue(float.MaxValue), EditorDisplay(\"Joint\"), ValueCategory(Utils.ValueCategory.Force)")
FORCE_INLINE float GetBreakForce() const FORCE_INLINE float GetBreakForce() const
{ {
return _breakForce; return _breakForce;
@@ -52,7 +52,7 @@ public:
/// <summary> /// <summary>
/// Gets the break torque. Determines the maximum torque the joint can apply before breaking. Broken joints no longer participate in physics simulation. /// Gets the break torque. Determines the maximum torque the joint can apply before breaking. Broken joints no longer participate in physics simulation.
/// </summary> /// </summary>
API_PROPERTY(Attributes="EditorOrder(20), DefaultValue(float.MaxValue), EditorDisplay(\"Joint\"), NumberCategory(Utils.ValueCategory.Torque)") API_PROPERTY(Attributes="EditorOrder(20), DefaultValue(float.MaxValue), EditorDisplay(\"Joint\"), ValueCategory(Utils.ValueCategory.Torque)")
FORCE_INLINE float GetBreakTorque() const FORCE_INLINE float GetBreakTorque() const
{ {
return _breakTorque; return _breakTorque;

8
Source/Engine/Scripting/Attributes/Editor/ValueCategoryAttribute.cs
View File

@@ -1,13 +1,12 @@
// Copyright (c) 2012-2023 Wojciech Figat. All rights reserved. // Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
using System; using System;
namespace FlaxEngine namespace FlaxEngine
{ {
/// <summary> /// <summary>
/// Used to specify the value category of a numeric value as either as-is (a scalar), a distance (formatted as cm/m/km) or an angle (formatted with a degree sign). /// Specifies the value category of a numeric value as either as-is (a scalar), a distance (formatted as cm/m/km) or an angle (formatted with a degree sign).
/// </summary> /// </summary>
/// <seealso cref="System.Attribute" />
[Serializable] [Serializable]
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)] [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public sealed class ValueCategoryAttribute : Attribute public sealed class ValueCategoryAttribute : Attribute
@@ -17,6 +16,9 @@ namespace FlaxEngine
/// </summary> /// </summary>
public Utils.ValueCategory Category; public Utils.ValueCategory Category;
/// <summary>
/// Initializes a new instance of the <see cref="ValueCategoryAttribute"/> class.
/// </summary>
private ValueCategoryAttribute() private ValueCategoryAttribute()
{ {
Category = Utils.ValueCategory.None; Category = Utils.ValueCategory.None;

48
Source/Engine/Utilities/Utils.cs
View File

@@ -257,6 +257,7 @@ namespace FlaxEngine
{ {
public static FieldInfo itemsField; public static FieldInfo itemsField;
} }
internal static T[] ExtractArrayFromList<T>(List<T> list) internal static T[] ExtractArrayFromList<T>(List<T> list)
{ {
if (list == null) if (list == null)
@@ -1040,21 +1041,64 @@ namespace FlaxEngine
} }
/// <summary> /// <summary>
/// A category of number values used for formatting and input boxes /// A category of number values used for formatting and input fields.
/// </summary> /// </summary>
public enum ValueCategory public enum ValueCategory
{ {
/// <summary>
/// Nothing.
/// </summary>
None, None,
/// <summary>
/// Distance (eg. meters).
/// </summary>
Distance, Distance,
/// <summary>
/// Area (eg. m^2).
/// </summary>
Area, Area,
/// <summary>
/// Volume (eg. m^3).
/// </summary>
Volume, Volume,
/// <summary>
/// Mass (eg. kilograms).
/// </summary>
Mass, Mass,
/// <summary>
/// Angle (eg. degrees).
/// </summary>
Angle, Angle,
/// <summary>
/// Speed (distance / time).
/// </summary>
Speed, Speed,
/// <summary>
/// Acceleration (distance^2 / time).
/// </summary>
Acceleration, Acceleration,
/// <summary>
/// Time (eg. seconds).
/// </summary>
Time, Time,
/// <summary>
/// Force (mass * distance / time^2).
/// </summary>
Force, Force,
Torque
/// <summary>
/// Torque (mass * distance^2 / time^2).
/// </summary>
Torque,
} }
} }
} }