From 7dcd59d9fb5484b136e68e555eeef8c7a36434fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20B=C3=A4hr?= Date: Sun, 5 Dec 2021 01:01:01 +0100 Subject: [PATCH] PD: Enhance the helix property docs Most strings are based on descriptions from the wiki [1]. Some have been extended where I saw need. Note that I'm not a native speaker, though. [1]: https://wiki.freecadweb.org/PartDesign_AdditiveHelix --- src/Mod/PartDesign/App/FeatureHelix.cpp | 46 ++++++++++++++++++------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/src/Mod/PartDesign/App/FeatureHelix.cpp b/src/Mod/PartDesign/App/FeatureHelix.cpp index 611409c2de..2a83db4f40 100644 --- a/src/Mod/PartDesign/App/FeatureHelix.cpp +++ b/src/Mod/PartDesign/App/FeatureHelix.cpp @@ -77,22 +77,42 @@ Helix::Helix() { addSubType = FeatureAddSub::Additive; - ADD_PROPERTY_TYPE(Base, (Base::Vector3d(0.0, 0.0, 0.0)), "Helix", App::Prop_ReadOnly, "Base"); - ADD_PROPERTY_TYPE(Axis, (Base::Vector3d(0.0, 1.0, 0.0)), "Helix", App::Prop_ReadOnly, "Axis"); - ADD_PROPERTY_TYPE(Pitch, (10.), "Helix", App::Prop_None, "Pitch"); - ADD_PROPERTY_TYPE(Height, (30.0), "Helix", App::Prop_None, "Height"); - ADD_PROPERTY_TYPE(Turns, (3.0), "Helix", App::Prop_None, "Turns"); + const char* group = "Helix"; + ADD_PROPERTY_TYPE(Base, (Base::Vector3d(0.0, 0.0, 0.0)), group, App::Prop_ReadOnly, + "The center point of the helix' start."); + ADD_PROPERTY_TYPE(Axis, (Base::Vector3d(0.0, 1.0, 0.0)), group, App::Prop_ReadOnly, + "The helix' direction."); + ADD_PROPERTY_TYPE(Pitch, (10.), group, App::Prop_None, + "The axial distance between two turns."); + ADD_PROPERTY_TYPE(Height, (30.0), group, App::Prop_None, + "The height of the helix' path, not accounting for the extent of the profile."); + ADD_PROPERTY_TYPE(Turns, (3.0), group, App::Prop_None, + "The number of turns in the helix."); Turns.setConstraints(&floatTurns); - ADD_PROPERTY_TYPE(LeftHanded, (long(0)), "Helix", App::Prop_None, "LeftHanded"); - ADD_PROPERTY_TYPE(Reversed, (long(0)), "Helix", App::Prop_None, "Reversed"); - ADD_PROPERTY_TYPE(Angle, (0.0), "Helix", App::Prop_None, "Angle"); - ADD_PROPERTY_TYPE(Growth, (0.0), "Helix", App::Prop_None, "Growth"); + ADD_PROPERTY_TYPE(LeftHanded, (long(0)), group, App::Prop_None, + "Sets the turning direction to left handed,\n" + "i.e. counter-clockwise when moving along its axis."); + ADD_PROPERTY_TYPE(Reversed, (long(0)), group, App::Prop_None, + "Determines whether the helix points in the opposite direction of the axis."); + ADD_PROPERTY_TYPE(Angle, (0.0), group, App::Prop_None, + "The angle of the cone that forms a hull around the helix.\n" + "Non-zero values turn the helix into a conical spiral.\n" + "Positive values make the radius grow, nevatige shrink."); Angle.setConstraints(&floatAngle); - ADD_PROPERTY_TYPE(ReferenceAxis, (0), "Helix", App::Prop_None, "Reference axis of revolution"); - ADD_PROPERTY_TYPE(Mode, (long(0)), "Helix", App::Prop_None, "Helix input mode"); - ADD_PROPERTY_TYPE(Outside, (long(0)), "Helix", App::Prop_None, "Outside"); - ADD_PROPERTY_TYPE(HasBeenEdited, (long(0)), "Helix", App::Prop_None, "HasBeenEdited"); + ADD_PROPERTY_TYPE(Growth, (0.0), group, App::Prop_None, + "The growth of the helix' radius per turn.\n" + "Non-zero values turn the helix into a conical spiral."); + ADD_PROPERTY_TYPE(ReferenceAxis, (0), group, App::Prop_None, + "The reference axis of the helix."); + ADD_PROPERTY_TYPE(Mode, (long(0)), group, App::Prop_None, + "The helix input mode specifies which properties are set by the user.\n" + "Dependent properties are then calculated."); Mode.setEnums(ModeEnums); + ADD_PROPERTY_TYPE(Outside, (long(0)), group, App::Prop_None, + "If set, the result will be the intersection of the profile and the preexisting body."); + ADD_PROPERTY_TYPE(HasBeenEdited, (long(0)), group, App::Prop_None, + "If false, the tool will propose an initial value for the pitch based on the profile bounding box,\n" + "so that self intersection is avoided."); } short Helix::mustExecute() const