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

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

@@ -41,19 +41,8 @@ protected:
public:
/// <summary>
/// Enables kinematic mode for the rigidbody.
/// Enables kinematic mode for the rigidbody. Kinematic rigidbodies are special dynamic actors that are not influenced by forces(such as gravity), and have no momentum. They are considered to have infinite mass and can push regular dynamic actors out of the way. Kinematics will not collide with static or other kinematic objects but are great for moving platforms or characters, where direct motion control is desired.
/// </summary>
/// <remarks>
/// Kinematic rigidbodies are special dynamic actors that are not influenced by forces(such as gravity), and have no momentum.
/// They are considered to have infinite mass and can push regular dynamic actors out of the way.
/// Kinematics will not collide with static or other kinematic objects.
/// <para>
/// Kinematic rigidbodies are great for moving platforms or characters, where direct motion control is desired.
/// </para>
/// <para>
/// Kinematic rigidbodies are incompatible with CCD.
/// </para>
/// </remarks>
API_PROPERTY(Attributes="EditorOrder(10), DefaultValue(false), EditorDisplay(\"Rigid Body\")")
FORCE_INLINE bool GetIsKinematic() const
{
@@ -61,26 +50,13 @@ public:
}
/// <summary>
/// Enables kinematic mode for the rigidbody.
/// Enables kinematic mode for the rigidbody. Kinematic rigidbodies are special dynamic actors that are not influenced by forces(such as gravity), and have no momentum. They are considered to have infinite mass and can push regular dynamic actors out of the way. Kinematics will not collide with static or other kinematic objects but are great for moving platforms or characters, where direct motion control is desired.
/// </summary>
/// <remarks>
/// Kinematic rigidbodies are special dynamic actors that are not influenced by forces(such as gravity), and have no momentum.
/// They are considered to have infinite mass and can push regular dynamic actors out of the way.
/// Kinematics will not collide with static or other kinematic objects.
/// <para>
/// Kinematic rigidbodies are great for moving platforms or characters, where direct motion control is desired.
/// </para>
/// <para>
/// Kinematic rigidbodies are incompatible with CCD.
/// </para>
/// </remarks>
/// <param name="value">The value.</param>
API_PROPERTY() void SetIsKinematic(const bool value);
/// <summary>
/// Gets the 'drag' force added to reduce linear movement.
/// Gets the 'drag' force added to reduce linear movement. Linear damping can be used to slow down an object. The higher the drag the more the object slows down.
/// </summary>
/// <remarks>Linear damping can be used to slow down an object. The higher the drag the more the object slows down.</remarks>
API_PROPERTY(Attributes="EditorOrder(60), DefaultValue(0.01f), Limit(0), EditorDisplay(\"Rigid Body\")")
FORCE_INLINE float GetLinearDamping() const
{
@@ -88,16 +64,13 @@ public:
}
/// <summary>
/// Sets the 'drag' force added to reduce linear movement.
/// Sets the 'drag' force added to reduce linear movement. Linear damping can be used to slow down an object. The higher the drag the more the object slows down.
/// </summary>
/// <remarks>Linear damping can be used to slow down an object. The higher the drag the more the object slows down.</remarks>
/// <param name="value">The value.</param>
API_PROPERTY() void SetLinearDamping(float value);
/// <summary>
/// Gets the 'drag' force added to reduce angular movement.
/// Gets the 'drag' force added to reduce angular movement. Angular damping can be used to slow down the rotation of an object. The higher the drag the more the rotation slows down.
/// </summary>
/// <remarks>Angular damping can be used to slow down the rotation of an object. The higher the drag the more the rotation slows down.</remarks>
API_PROPERTY(Attributes="EditorOrder(70), DefaultValue(0.05f), Limit(0), EditorDisplay(\"Rigid Body\")")
FORCE_INLINE float GetAngularDamping() const
{
@@ -105,9 +78,8 @@ public:
}
/// <summary>
/// Sets the 'drag' force added to reduce angular movement.
/// Sets the 'drag' force added to reduce angular movement. Angular damping can be used to slow down the rotation of an object. The higher the drag the more the rotation slows down.
/// </summary>
/// <remarks>Angular damping can be used to slow down the rotation of an object. The higher the drag the more the rotation slows down.</remarks>
/// <param name="value">The value.</param>
API_PROPERTY() void SetAngularDamping(float value);
@@ -123,7 +95,6 @@ public:
/// <summary>
/// If true simulation and collisions detection will be enabled for the rigidbody.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetEnableSimulation(bool value);
/// <summary>
@@ -138,7 +109,6 @@ public:
/// <summary>
/// If true Continuous Collision Detection (CCD) will be used for this component.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetUseCCD(const bool value);
/// <summary>
@@ -153,7 +123,6 @@ public:
/// <summary>
/// If object should have the force of gravity applied.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetEnableGravity(bool value);
/// <summary>
@@ -168,7 +137,6 @@ public:
/// <summary>
/// If object should start awake, or if it should initially be sleeping.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetStartAwake(bool value);
/// <summary>
@@ -183,16 +151,11 @@ public:
/// <summary>
/// If true, it will update mass when actor scale changes.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetUpdateMassWhenScaleChanges(bool value);
/// <summary>
/// Gets the maximum angular velocity that a simulated object can achieve.
/// Gets the maximum angular velocity that a simulated object can achieve. The angular velocity of rigidbodies is clamped to MaxAngularVelocity to avoid numerical instability with fast rotating bodies. Because this may prevent intentional fast rotations on objects such as wheels, you can override this value per rigidbody.
/// </summary>
/// <remarks>
/// The angular velocity of rigidbodies is clamped to MaxAngularVelocity to avoid numerical instability with fast rotating bodies.
/// Because this may prevent intentional fast rotations on objects such as wheels, you can override this value per rigidbody.
/// </remarks>
API_PROPERTY(Attributes="EditorOrder(90), DefaultValue(7.0f), Limit(0), EditorDisplay(\"Rigid Body\")")
FORCE_INLINE float GetMaxAngularVelocity() const
{
@@ -200,13 +163,8 @@ public:
}
/// <summary>
/// Sets the maximum angular velocity that a simulated object can achieve.
/// Sets the maximum angular velocity that a simulated object can achieve. The angular velocity of rigidbodies is clamped to MaxAngularVelocity to avoid numerical instability with fast rotating bodies. Because this may prevent intentional fast rotations on objects such as wheels, you can override this value per rigidbody.
/// </summary>
/// <remarks>
/// The angular velocity of rigidbodies is clamped to MaxAngularVelocity to avoid numerical instability with fast rotating bodies.
/// Because this may prevent intentional fast rotations on objects such as wheels, you can override this value per rigidbody.
/// </remarks>
/// <param name="value">The value.</param>
API_PROPERTY() void SetMaxAngularVelocity(float value);
/// <summary>
@@ -218,7 +176,6 @@ public:
/// <summary>
/// Override the auto computed mass.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetOverrideMass(bool value);
/// <summary>
@@ -230,8 +187,6 @@ public:
/// <summary>
/// Sets the mass value measured in kilograms (use override value only if OverrideMass is checked).
/// </summary>
/// <remarks>If set auto enables mass override.</remarks>
/// <param name="value">The value.</param>
API_PROPERTY() void SetMass(float value);
/// <summary>
@@ -243,7 +198,6 @@ public:
/// <summary>
/// Sets the per-instance scaling of the mass.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetMassScale(float value);
/// <summary>
@@ -258,7 +212,6 @@ public:
/// <summary>
/// Sets the user specified offset for the center of mass of this object, from the calculated location.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetCenterOfMassOffset(const Float3& value);
/// <summary>
@@ -273,28 +226,27 @@ public:
/// <summary>
/// Sets the object movement constraint flags that define degrees of freedom are allowed for the simulation of object.
/// </summary>
/// <param name="value">The value.</param>
API_PROPERTY() void SetConstraints(const RigidbodyConstraints value);
public:
/// <summary>
/// Gets the linear velocity of the rigidbody.
/// </summary>
/// <remarks>It's used mostly to get the current velocity. Manual modifications may result in unrealistic behaviour. </remarks>
/// <remarks>It's used mostly to get the current velocity. Manual modifications may result in unrealistic behaviour.</remarks>
API_PROPERTY(Attributes="HideInEditor")
Vector3 GetLinearVelocity() const;
/// <summary>
/// Sets the linear velocity of the rigidbody.
/// </summary>
/// <remarks>It's used mostly to get the current velocity. Manual modifications may result in unrealistic behaviour. </remarks>
/// <remarks>It's used mostly to get the current velocity. Manual modifications may result in unrealistic behaviour.</remarks>
/// <param name="value">The value.</param>
API_PROPERTY() void SetLinearVelocity(const Vector3& value) const;
/// <summary>
/// Gets the angular velocity of the rigidbody measured in radians per second.
/// </summary>
/// <remarks>It's used mostly to get the current angular velocity. Manual modifications may result in unrealistic behaviour. </remarks>
/// <remarks>It's used mostly to get the current angular velocity. Manual modifications may result in unrealistic behaviour.</remarks>
API_PROPERTY(Attributes="HideInEditor")
Vector3 GetAngularVelocity() const;

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

@@ -35,11 +35,8 @@ public:
void* GetPhysicsShape() const;
/// <summary>
/// Gets the 'IsTrigger' flag.
/// Gets the 'IsTrigger' flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter and OnTriggerExit message when a rigidbody enters or exits the trigger volume.
/// </summary>
/// <remarks>
/// A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.
/// </remarks>
API_PROPERTY(Attributes="EditorOrder(0), DefaultValue(false), EditorDisplay(\"Collider\")")
FORCE_INLINE bool GetIsTrigger() const
{
@@ -47,11 +44,8 @@ public:
}
/// <summary>
/// Sets the `IsTrigger` flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.
/// Sets the `IsTrigger` flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter and OnTriggerExit message when a rigidbody enters or exits the trigger volume.
/// </summary>
/// <remarks>
/// A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.
/// </remarks>
API_PROPERTY() void SetIsTrigger(bool value);
/// <summary>
@@ -69,11 +63,8 @@ public:
API_PROPERTY() void SetCenter(const Vector3& value);
/// <summary>
/// Gets the contact offset.
/// 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>
/// <remarks>
/// 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.
/// </remarks>
API_PROPERTY(Attributes="EditorOrder(1), DefaultValue(2.0f), Limit(0, 100), EditorDisplay(\"Collider\")")
FORCE_INLINE float GetContactOffset() const
{
@@ -81,11 +72,8 @@ public:
}
/// <summary>
/// Sets the contact offset.
/// Sets 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>
/// <remarks>
/// 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.
/// </remarks>
API_PROPERTY() void SetContactOffset(float value);
/// <summary>