improve wording for all PhysX gem tooltips apart from pipeline, fixes 3898

Signed-off-by: greerdv <greerdv@amazon.com>
This commit is contained in:
greerdv
2021-10-14 16:06:13 +01:00
parent 922a991443
commit ec10bb078e
21 changed files with 174 additions and 147 deletions
@@ -51,23 +51,27 @@ namespace PhysX
if (auto* editContext = serializeContext->GetEditContext())
{
editContext->Class<PhysX::EditorJointLimitConfig>(
"Editor Joint Limit Config Base", "Base joint limit parameters")
"Editor Joint Limit Config Base", "Base joint limit parameters.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::Category, "PhysX")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->Attribute(AZ::Edit::Attributes::Visibility, AZ::Edit::PropertyVisibility::ShowChildrenOnly)
->DataElement(0, &PhysX::EditorJointLimitConfig::m_isLimited, "Limit", "True if the motion about the unconstrained axes of this joint are limited")
->DataElement(0, &PhysX::EditorJointLimitConfig::m_isLimited, "Limit",
"When active, the joint's degrees of freedom are limited.")
->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::EntireTree)
->Attribute(AZ::Edit::Attributes::ReadOnly, &EditorJointLimitConfig::IsInComponentMode)
->DataElement(0, &PhysX::EditorJointLimitConfig::m_isSoftLimit, "Soft limit", "True if the joint is allowed to rotate beyond limits and spring back")
->DataElement(0, &PhysX::EditorJointLimitConfig::m_isSoftLimit, "Soft limit",
"When active, motion beyond the joint limit with a spring-like return is allowed.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitConfig::m_isLimited)
->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::EntireTree)
->Attribute(AZ::Edit::Attributes::ReadOnly, &EditorJointLimitConfig::IsInComponentMode)
->DataElement(0, &PhysX::EditorJointLimitConfig::m_damping, "Damping", "The damping strength of the drive, the force proportional to the velocity error")
->DataElement(0, &PhysX::EditorJointLimitConfig::m_damping, "Damping",
"Dissipation of energy and reduction in spring oscillations when outside the joint limit.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitConfig::IsSoftLimited)
->Attribute(AZ::Edit::Attributes::Max, s_springMax)
->Attribute(AZ::Edit::Attributes::Min, s_springMin)
->DataElement(0, &PhysX::EditorJointLimitConfig::m_stiffness, "Stiffness", "The spring strength of the drive, the force proportional to the position error")
->DataElement(0, &PhysX::EditorJointLimitConfig::m_stiffness, "Stiffness",
"The spring's drive relative to the position of the follower when outside the rotation limit.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitConfig::IsSoftLimited)
->Attribute(AZ::Edit::Attributes::Max, s_springMax)
->Attribute(AZ::Edit::Attributes::Min, s_springMin)
@@ -115,18 +119,20 @@ namespace PhysX
if (auto* editContext = serializeContext->GetEditContext())
{
editContext->Class<PhysX::EditorJointLimitPairConfig>(
"Angular Limit", "Rotation limitation")
"Angular Limit", "Rotation limitation.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::Category, "PhysX")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(0, &PhysX::EditorJointLimitPairConfig::m_standardLimitConfig
, "Standard limit configuration"
, "Common limit parameters to all joint types")
->DataElement(0, &PhysX::EditorJointLimitPairConfig::m_limitPositive, "Positive angular limit", "Positive rotation angle")
, "Common limit parameters to all joint types.")
->DataElement(0, &PhysX::EditorJointLimitPairConfig::m_limitPositive, "Positive angular limit",
"Positive rotation angle.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitPairConfig::IsLimited)
->Attribute(AZ::Edit::Attributes::Max, s_angleMax)
->Attribute(AZ::Edit::Attributes::Min, s_angleMin)
->DataElement(0, &PhysX::EditorJointLimitPairConfig::m_limitNegative, "Negative angular limit", "Negative rotation angle")
->DataElement(0, &PhysX::EditorJointLimitPairConfig::m_limitNegative, "Negative angular limit",
"Negative rotation angle.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitPairConfig::IsLimited)
->Attribute(AZ::Edit::Attributes::Max, s_angleMin)
->Attribute(AZ::Edit::Attributes::Min, -s_angleMax)
@@ -164,18 +170,20 @@ namespace PhysX
if (auto* editContext = serializeContext->GetEditContext())
{
editContext->Class<PhysX::EditorJointLimitConeConfig>(
"Angular Limit", "Rotation limitation")
"Angular Limit", "Rotation limitation.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::Category, "PhysX")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(0, &PhysX::EditorJointLimitConeConfig::m_standardLimitConfig
, "Standard limit configuration"
, "Common limit parameters to all joint types")
->DataElement(0, &PhysX::EditorJointLimitConeConfig::m_limitY, "Y axis angular limit", "Limit for swing angle about Y axis")
, "Common limit parameters to all joint types.")
->DataElement(0, &PhysX::EditorJointLimitConeConfig::m_limitY, "Y axis angular limit",
"Limit for swing angle about Y axis.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitConeConfig::IsLimited)
->Attribute(AZ::Edit::Attributes::Max, s_angleMax)
->Attribute(AZ::Edit::Attributes::Min, s_angleMin)
->DataElement(0, &PhysX::EditorJointLimitConeConfig::m_limitZ, "Z axis angular limit", "Limit for swing angle about Z axis")
->DataElement(0, &PhysX::EditorJointLimitConeConfig::m_limitZ, "Z axis angular limit",
"Limit for swing angle about Z axis.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointLimitConeConfig::IsLimited)
->Attribute(AZ::Edit::Attributes::Max, s_angleMax)
->Attribute(AZ::Edit::Attributes::Min, s_angleMin)
@@ -226,33 +234,33 @@ namespace PhysX
->Attribute(AZ::Edit::Attributes::Category, "PhysX")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(0, &PhysX::EditorJointConfig::m_localPosition, "Local Position"
, "Local Position of joint, relative to its entity")
, "Local Position of joint, relative to its entity.")
->DataElement(0, &PhysX::EditorJointConfig::m_localRotation, "Local Rotation"
, "Local Rotation of joint, relative to its entity")
, "Local Rotation of joint, relative to its entity.")
->Attribute(AZ::Edit::Attributes::Min, LocalRotationMin)
->Attribute(AZ::Edit::Attributes::Max, LocalRotationMax)
->DataElement(0, &PhysX::EditorJointConfig::m_leadEntity, "Lead Entity"
, "Parent entity associated with joint")
, "Parent entity associated with joint.")
->Attribute(AZ::Edit::Attributes::ChangeNotify, &EditorJointConfig::ValidateLeadEntityId)
->DataElement(0, &PhysX::EditorJointConfig::m_selfCollide, "Lead-Follower Collide"
, "Lead and follower pair will collide with each other")
, "When active, the lead and follower pair will collide with each other.")
->DataElement(0, &PhysX::EditorJointConfig::m_displayJointSetup, "Display Setup in Viewport"
, "Display joint setup in the viewport")
, "Display joint setup in the viewport.")
->Attribute(AZ::Edit::Attributes::ReadOnly, &EditorJointConfig::IsInComponentMode)
->DataElement(0, &PhysX::EditorJointConfig::m_selectLeadOnSnap, "Select Lead on Snap"
, "Select lead entity on snap to position in component mode")
, "Select lead entity on snap to position in component mode.")
->DataElement(0, &PhysX::EditorJointConfig::m_breakable
, "Breakable"
, "Joint is breakable when force or torque exceeds limit")
, "Joint is breakable when force or torque exceeds limit.")
->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::EntireTree)
->Attribute(AZ::Edit::Attributes::ReadOnly, &EditorJointConfig::IsInComponentMode)
->DataElement(0, &PhysX::EditorJointConfig::m_forceMax,
"Maximum Force", "Amount of force joint can withstand before breakage")
"Maximum Force", "Amount of force joint can withstand before breakage.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointConfig::m_breakable)
->Attribute(AZ::Edit::Attributes::Max, s_breakageMax)
->Attribute(AZ::Edit::Attributes::Min, s_breakageMin)
->DataElement(0, &PhysX::EditorJointConfig::m_torqueMax,
"Maximum Torque", "Amount of torque joint can withstand before breakage")
"Maximum Torque", "Amount of torque joint can withstand before breakage.")
->Attribute(AZ::Edit::Attributes::Visibility, &EditorJointConfig::m_breakable)
->Attribute(AZ::Edit::Attributes::Max, s_breakageMax)
->Attribute(AZ::Edit::Attributes::Min, s_breakageMin)