diff --git a/apps/OpenSpace/ext/sgct b/apps/OpenSpace/ext/sgct index ea1f8a110f..206307c1e3 160000 --- a/apps/OpenSpace/ext/sgct +++ b/apps/OpenSpace/ext/sgct @@ -1 +1 @@ -Subproject commit ea1f8a110fd151ad7fb925946b4be1aeacb58f41 +Subproject commit 206307c1e3282a2e09e01cd763af74d36311d23b diff --git a/ext/ghoul b/ext/ghoul index 689b1cec8b..0fc36769cf 160000 --- a/ext/ghoul +++ b/ext/ghoul @@ -1 +1 @@ -Subproject commit 689b1cec8ba22530b3401df06697388ef9e1e26e +Subproject commit 0fc36769cf20cea6e9c1b1157ec2e6c8d10cd421 diff --git a/modules/atmosphere/rendering/renderableatmosphere.cpp b/modules/atmosphere/rendering/renderableatmosphere.cpp index 9d93a18803..418ee4811c 100644 --- a/modules/atmosphere/rendering/renderableatmosphere.cpp +++ b/modules/atmosphere/rendering/renderableatmosphere.cpp @@ -43,7 +43,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo AtmosphereHeightInfo = { "AtmosphereHeight", "Atmosphere Height (KM)", - "The thickness of the atmosphere in km", + "The thickness of the atmosphere in kilometers.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -52,22 +52,22 @@ namespace { "AverageGroundReflectance", "Average Ground Reflectance (%)", "Average percentage of light reflected by the ground during the pre-calculation " - "phase", + "phase.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GroundRadianceEmissionInfo = { "GroundRadianceEmission", "Percentage of initial radiance emitted from ground", - "Multiplier of the ground radiance color during the rendering phase", + "Multiplier of the ground radiance color during the rendering phase.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RayleighHeightScaleInfo = { "RayleighHeightScale", "Rayleigh Scale Height (KM)", - "It is the vertical distance over which the density and pressure fall by a " - "constant factor", + "The vertical distance over which the density and pressure falls by a constant " + "factor.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -75,14 +75,14 @@ namespace { { "RayleighScatteringCoeff", "Rayleigh Scattering Coeff", - "Rayleigh sea-level scattering coefficients in meters", + "Rayleigh sea-level scattering coefficients in meters.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OzoneLayerInfo = { "Ozone", "Ozone Layer Enabled", - "Enables/Disable Ozone Layer during pre-calculation phase", + "Enables/Disable Ozone Layer during pre-calculation phase.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -90,14 +90,14 @@ namespace { "OzoneLayerHeightScale", "Ozone Scale Height (KM)", "It is the vertical distance over which the density and pressure fall by a " - "constant factor", + "constant factor.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OzoneLayerCoeffInfo = { "OzoneLayerCoeff", "Ozone Layer Extinction Coeff", - "Ozone scattering coefficients in meters", + "Ozone scattering coefficients in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -105,16 +105,14 @@ namespace { "MieHeightScale", "Mie Scale Height (KM)", "It is the vertical distance over which the density and pressure fall by a " - "constant factor", - // @VISIBILITY(3.2) + "constant factor.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MieScatteringCoeffInfo = { "MieScatteringCoeff", "Mie Scattering Coeff", - "Mie sea-level scattering coefficients in meters", - // @VISIBILITY(3.2) + "Mie sea-level scattering coefficients in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -123,24 +121,21 @@ namespace { { "MieScatteringExtinctionPropCoefficient", "Mie Scattering/Extinction Proportion Coefficient (%)", - "Mie Scattering/Extinction Proportion Coefficient (%)", - // @VISIBILITY(3.2) + "Mie Scattering/Extinction Proportion Coefficient.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MieAsymmetricFactorGInfo = { "MieAsymmetricFactorG", "Mie Asymmetric Factor G", - "Averaging of the scattering angle over a high number of scattering events", - // @VISIBILITY(3.2) + "Averaging of the scattering angle over a high number of scattering events.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SunIntensityInfo = { "SunIntensity", "Sun Intensity", - "Unitless for now", - // @VISIBILITY(2.6) + "Unitless for now.", openspace::properties::Property::Visibility::User }; @@ -149,7 +144,7 @@ namespace { { "SunFollowingCamera", "Enable Sun On Camera Position", - "When selected the Sun is artificially positioned behind the observer all times", + "When selected the Sun is artificially positioned behind the observer all times.", openspace::properties::Property::Visibility::User }; @@ -157,14 +152,13 @@ namespace { "EclipseHardShadowsInfo", "Enable Hard Shadows for Eclipses", "Enable/Disables hard shadows through the atmosphere", - // @VISIBILITY(2.8) openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo AtmosphereDimmingHeightInfo ={ "AtmosphereDimmingHeight", "Atmosphere Dimming Height", - "Percentage of the atmosphere where other objects, such as the stars, are faded", + "Percentage of the atmosphere where other objects, such as the stars, are faded.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -172,14 +166,14 @@ namespace { "AtmosphereDimmingSunsetAngle", "Atmosphere Dimming Sunset Angle", "The angle (degrees) between the Camera and the Sun where the sunset starts, and " - "the atmosphere starts to fade in objects such as the stars", + "the atmosphere starts to fade in objects such as the stars.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SunAngularSize = { "SunAngularSize", "Angular Size of the Sun", - "Specifies the angular size of the Sun in degrees", + "Specifies the angular size of the Sun in degrees.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -188,7 +182,7 @@ namespace { "Name of the light source", "This value is the name of a scene graph node that should be used as the source " "of illumination for the atmosphere. If this value is not specified, the solar " - "system's Sun is used instead", + "system's Sun is used instead.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/dashboard/dashboarditemangle.cpp b/modules/base/dashboard/dashboarditemangle.cpp index 4a59cbdd66..511e261bff 100644 --- a/modules/base/dashboard/dashboarditemangle.cpp +++ b/modules/base/dashboard/dashboarditemangle.cpp @@ -50,8 +50,7 @@ namespace { "SourceType", "Source Type", "The type of position that is used as the triangle apex used to calculate the " - "angle. The default value is 'Camera'", - // @VISIBILITY(2.67) + "angle. The default value is 'Camera'.", openspace::properties::Property::Visibility::User }; @@ -61,8 +60,7 @@ namespace { "If a scene graph node is selected as type, this value specifies the name of the " "node that is to be used as the apex of the triangle used to calculate the " "angle. The computed angle is the incident angle to Source in the triangle (" - "Source, Reference, Destination)", - // @VISIBILITY(2.67) + "Source, Reference, Destination).", openspace::properties::Property::Visibility::User }; @@ -71,8 +69,7 @@ namespace { "Reference Type", "The type of position that is used as the destination of the reference line used " "to calculate the angle. The computed angle is the incident angle to Source in " - "the triangle (Source, Reference, Destination)", - // @VISIBILITY(2.67) + "the triangle (Source, Reference, Destination).", openspace::properties::Property::Visibility::User }; @@ -80,8 +77,7 @@ namespace { "ReferenceNodeName", "Reference Node Name", "If a scene graph node is selected as type, this value specifies the name of the " - "node that is to be used as the reference direction to compute the angle", - // @VISIBILITY(2.67) + "node that is to be used as the reference direction to compute the angle.", openspace::properties::Property::Visibility::User }; @@ -90,8 +86,7 @@ namespace { "Destination Type", "The type of position that is used as the destination to calculate the angle. " "The computed angle is the incident angle to Source in the triangle (" - "Source, Reference, Destination). The default value for this is 'Focus'", - // @VISIBILITY(2.67) + "Source, Reference, Destination). The default value for this is 'Focus'.", openspace::properties::Property::Visibility::User }; @@ -99,8 +94,7 @@ namespace { "DestinationNodeName", "Destination Node Name", "If a scene graph node is selected as type, this value specifies the name of the " - "node that is to be used as the destination for computing the angle", - // @VISIBILITY(2.67) + "node that is to be used as the destination for computing the angle.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditemdate.cpp b/modules/base/dashboard/dashboarditemdate.cpp index f2fe23b3a3..5660386e00 100644 --- a/modules/base/dashboard/dashboarditemdate.cpp +++ b/modules/base/dashboard/dashboarditemdate.cpp @@ -40,7 +40,7 @@ namespace { "FormatString", "Format String", "The format text describing how this dashboard item renders its text. This text " - "must contain exactly one {} which is a placeholder that will contain the date", + "must contain exactly one {} which is a placeholder that will contain the date.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -50,8 +50,7 @@ namespace { "The format string used for formatting the date/time before being passed to the " "string in FormatString. See " "https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/timout_c.html for full " - "information about how to structure this format", - // @VISIBILITY(2.75) + "information about how to structure this format.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditemdistance.cpp b/modules/base/dashboard/dashboarditemdistance.cpp index b3dcf73d25..d30a9ece34 100644 --- a/modules/base/dashboard/dashboarditemdistance.cpp +++ b/modules/base/dashboard/dashboarditemdistance.cpp @@ -52,8 +52,7 @@ namespace { "SourceType", "Source Type", "The type of position that is used as the source to calculate the distance. The " - "default value is 'Camera'", - // @VISIBILITY(2.67) + "default value is 'Camera'.", openspace::properties::Property::Visibility::User }; @@ -61,8 +60,7 @@ namespace { "SourceNodeName", "Source Node Name", "If a scene graph node is selected as type, this value specifies the name of the " - "node that is to be used as the source for computing the distance", - // @VISIBILITY(2.67) + "node that is to be used as the source for computing the distance.", openspace::properties::Property::Visibility::User }; @@ -70,8 +68,7 @@ namespace { "DestinationType", "Destination Type", "The type of position that is used as the destination to calculate the distance. " - "The default value for this is 'Focus'", - // @VISIBILITY(2.67) + "The default value for this is 'Focus'.", openspace::properties::Property::Visibility::User }; @@ -79,8 +76,7 @@ namespace { "DestinationNodeName", "Destination Node Name", "If a scene graph node is selected as type, this value specifies the name of the " - "node that is to be used as the destination for computing the distance", - // @VISIBILITY(2.33) + "node that is to be used as the destination for computing the distance.", openspace::properties::Property::Visibility::User }; @@ -89,7 +85,7 @@ namespace { "Simplification", "If this value is enabled, the distance is displayed in nuanced units, such as " "km, AU, light years, parsecs, etc. If this value is disabled, the unit can be " - "explicitly requested", + "explicitly requested.", openspace::properties::Property::Visibility::User }; @@ -97,7 +93,7 @@ namespace { "RequestedUnit", "Requested Unit", "If the simplification is disabled, this distance unit is used as a destination " - "to convert the meters into" + "to convert the meters into." }; constexpr openspace::properties::Property::PropertyInfo FormatStringInfo = { @@ -105,7 +101,7 @@ namespace { "Format String", "The format string that is used for formatting the distance string. This format " "receives four parameters: The name of the source, the name of the destination " - "the value of the distance and the unit of the distance", + "the value of the distance and the unit of the distance.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/dashboard/dashboarditemelapsedtime.cpp b/modules/base/dashboard/dashboarditemelapsedtime.cpp index 9e231f8840..0ad562dda0 100644 --- a/modules/base/dashboard/dashboarditemelapsedtime.cpp +++ b/modules/base/dashboard/dashboarditemelapsedtime.cpp @@ -49,8 +49,7 @@ namespace { "ReferenceTime", "Reference Time", "The reference time relative to which the elapsed time is specified. The format " - "must be an ISO 8601-compliant date string", - // @VISIBILITY(2.75) + "must be an ISO 8601-compliant date string.", openspace::properties::Property::Visibility::User }; @@ -60,7 +59,6 @@ namespace { "If this value is enabled, the elapsed time will be simplified into seconds, " "minutes, hours, etc. If the value is disabled, the elapsed time is always " "presented in seconds. The default value for this is 'true'.", - // @VISIBILITY(2.25) openspace::properties::Property::Visibility::User }; @@ -69,7 +67,6 @@ namespace { "Lowest Time Unit when Simplifying", "If 'SimplifyTime' is enabled, this is the lowest time unit that will be shown. " "All finer grained timesteps will be ignored.", - // @VISIBILITY(2.75) openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditemframerate.cpp b/modules/base/dashboard/dashboarditemframerate.cpp index 279c9e200b..139645c464 100644 --- a/modules/base/dashboard/dashboarditemframerate.cpp +++ b/modules/base/dashboard/dashboarditemframerate.cpp @@ -48,8 +48,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo FrametimeInfo = { "FrametimeType", "Type of the frame time display", - "This value determines the units in which the frame time is displayed", - // @VISIBILITY(2.75) + "This value determines the units in which the frame time is displayed.", openspace::properties::Property::Visibility::User }; @@ -57,11 +56,11 @@ namespace { "ClearCache", "Clear Cache", "Clears the cache of this DashboardItemFramerate item. If the selected option " - "does not use any caching, this trigger does not do anything", + "does not use any caching, this trigger does not do anything.", openspace::properties::Property::Visibility::AdvancedUser }; - [[ nodiscard ]] char* formatDt(std::vector& buffer) { + [[nodiscard]] char* formatDt(std::vector& buffer) { return std::format_to( buffer.data(), "Avg. Frametime: {:.2f} ms\0", @@ -69,7 +68,7 @@ namespace { ); } - [[ nodiscard ]] char* formatDtExtremes(std::vector& buffer, + [[nodiscard]] char* formatDtExtremes(std::vector& buffer, double minFrametimeCache, double maxFrametimeCache) { @@ -84,7 +83,7 @@ namespace { ); } - [[ nodiscard ]] char* formatDtStandardDeviation(std::vector& buffer) { + [[nodiscard]] char* formatDtStandardDeviation(std::vector& buffer) { return std::format_to( buffer.data(), "Frametime standard deviation : {:.2f} ms\0", @@ -92,7 +91,7 @@ namespace { ); } - [[ nodiscard ]] char* formatDtCoefficientOfVariation(std::vector& buffer) { + [[nodiscard]] char* formatDtCoefficientOfVariation(std::vector& buffer) { return std::format_to( buffer.data(), "Frametime coefficient of variation : {:.2f} %\0", @@ -101,7 +100,7 @@ namespace { ); } - [[ nodiscard ]] char* formatFps(std::vector& buffer) { + [[nodiscard]] char* formatFps(std::vector& buffer) { return std::format_to( buffer.data(), "FPS: {:3.2f}\0", @@ -109,7 +108,7 @@ namespace { ); } - [[ nodiscard ]] char* formatAverageFps(std::vector& buffer) { + [[nodiscard]] char* formatAverageFps(std::vector& buffer) { return std::format_to( buffer.data(), "Avg. FPS: {:3.2f}\0", @@ -117,7 +116,7 @@ namespace { ); } - [[ nodiscard ]] char* format(std::vector& buffer, FrametimeType frametimeType, + [[nodiscard]] char* format(std::vector& buffer, FrametimeType frametimeType, double minFrametimeCache, double maxFrametimeCache) { using namespace openspace; diff --git a/modules/base/dashboard/dashboarditeminputstate.cpp b/modules/base/dashboard/dashboarditeminputstate.cpp index ed28511707..7463251f5b 100644 --- a/modules/base/dashboard/dashboarditeminputstate.cpp +++ b/modules/base/dashboard/dashboarditeminputstate.cpp @@ -37,40 +37,35 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ShowWhenEnabledInfo = { "ShowWhenEnabled", "Show when enabled", - "Show text when the input is enabled", - // @VISIBILITY(?) + "Show text when the input is enabled.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowWhenDisabledInfo = { "ShowWhenDisabled", "Show when disabled", - "Show text when the input is disabled", - // @VISIBILITY(?) + "Show text when the input is disabled.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowKeyboardInfo = { "ShowKeyboard", "Show Keyboard information", - "Display the state of the keyboard input", - // @VISIBILITY(?) + "Display the state of the keyboard input.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowMouseInfo = { "ShowMouse", "Show Mouse information", - "Display the state of the mouse input", - // @VISIBILITY(?) + "Display the state of the mouse input.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowJoystickInfo = { "ShowJoystick", "Show Joystick information", - "Display the state of the joystick input", - // @VISIBILITY(?) + "Display the state of the joystick input.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditempropertyvalue.cpp b/modules/base/dashboard/dashboarditempropertyvalue.cpp index 49f48920a5..10e8980339 100644 --- a/modules/base/dashboard/dashboarditempropertyvalue.cpp +++ b/modules/base/dashboard/dashboarditempropertyvalue.cpp @@ -56,8 +56,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo PropertyUriInfo = { "URI", "Property URI", - "The URI of the property that is displayed in this dashboarditem", - // @VISIBILITY(2.67) + "The URI of the property that is displayed in this dashboard item.", openspace::properties::Property::Visibility::User }; @@ -69,8 +68,7 @@ namespace { "instances of {}, which will be replaced with the value(s) of the property " "during rendering. For scalar types, there has to be exactly one instance of {}, " "for vector types, there need to be as many {} as there are compoents in the " - "vector, for example two {} for vec2 types, three for vec3 types, etc", - // @VISIBILITY(2.67) + "vector, for example two {} for vec2 types, three for vec3 types, etc.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditemsimulationincrement.cpp b/modules/base/dashboard/dashboarditemsimulationincrement.cpp index 3707c7ce08..0d0c5353ba 100644 --- a/modules/base/dashboard/dashboarditemsimulationincrement.cpp +++ b/modules/base/dashboard/dashboarditemsimulationincrement.cpp @@ -41,8 +41,7 @@ namespace { "Time Simplification", "If this value is enabled, the time is displayed in nuanced units, such as " "minutes, hours, days, years, etc. If this value is disabled, it is always " - "displayed in seconds", - // @VISIBILITY(2.33) + "displayed in seconds.", openspace::properties::Property::Visibility::User }; @@ -50,8 +49,7 @@ namespace { "RequestedUnit", "Requested Unit", "If the simplification is disabled, this time unit is used as a destination to " - "convert the seconds into", - // @VISIBILITY(2.33) + "convert the seconds into.", openspace::properties::Property::Visibility::User }; @@ -63,7 +61,7 @@ namespace { "delta time. This format gets five parameters in this order: The target delta " "time value, the target delta time unit, the string 'Paused' if the delta time " "is paused or the empty string otherwise, the current delta time value, and the " - "current delta time unit", + "current delta time unit.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -73,7 +71,7 @@ namespace { "The format string used to format the text if the target delta time is the same " "as the current delta time. This format gets three parameters in this order: " "The target delta value, the target delta unit, and the string 'Paused' if the " - "delta time is paused or the empty string otherwise", + "delta time is paused or the empty string otherwise.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/dashboard/dashboarditemspacing.cpp b/modules/base/dashboard/dashboarditemspacing.cpp index 482e849d0a..30a5ca9069 100644 --- a/modules/base/dashboard/dashboarditemspacing.cpp +++ b/modules/base/dashboard/dashboarditemspacing.cpp @@ -33,8 +33,7 @@ namespace { "Spacing", "Spacing", "This value determines the spacing (in pixels) that this item represents. The " - "default value is 15", - // @VISIBILITY(2.33) + "default value is 15.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditemtext.cpp b/modules/base/dashboard/dashboarditemtext.cpp index 10542723ab..149a478bd4 100644 --- a/modules/base/dashboard/dashboarditemtext.cpp +++ b/modules/base/dashboard/dashboarditemtext.cpp @@ -37,7 +37,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TextInfo = { "Text", "Text", - "The text to be displayed", + "The text to be displayed.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/dashboard/dashboarditemvelocity.cpp b/modules/base/dashboard/dashboarditemvelocity.cpp index bea74ca374..4fd8ac8d8c 100644 --- a/modules/base/dashboard/dashboarditemvelocity.cpp +++ b/modules/base/dashboard/dashboarditemvelocity.cpp @@ -45,7 +45,7 @@ namespace { "Simplification", "If this value is enabled, the velocity is displayed in nuanced units, such as " "m/s, AU/s, light years / s etc. If this value is disabled, the unit can be " - "explicitly requested", + "explicitly requested.", openspace::properties::Property::Visibility::User }; @@ -53,7 +53,7 @@ namespace { "RequestedUnit", "Requested Unit", "If the simplification is disabled, this distance unit is used for the velocity " - "display", + "display.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/lightsource/cameralightsource.cpp b/modules/base/lightsource/cameralightsource.cpp index df58467ac0..e5285d02e9 100644 --- a/modules/base/lightsource/cameralightsource.cpp +++ b/modules/base/lightsource/cameralightsource.cpp @@ -33,8 +33,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo IntensityInfo = { "Intensity", "Intensity", - "The intensity of this light source", - // @VISIBILITY(1.75) + "The intensity of this light source.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/base/lightsource/scenegraphlightsource.cpp b/modules/base/lightsource/scenegraphlightsource.cpp index bcd035bfbd..fdb33d58ad 100644 --- a/modules/base/lightsource/scenegraphlightsource.cpp +++ b/modules/base/lightsource/scenegraphlightsource.cpp @@ -37,15 +37,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo IntensityInfo = { "Intensity", "Intensity", - "The intensity of this light source", - // @VISIBILITY(1.75) + "The intensity of this light source.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo NodeCameraStateInfo = { "Node", "Node", - "The identifier of the scene graph node to follow", + "The identifier of the scene graph node to follow.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/grids/renderableboxgrid.cpp b/modules/base/rendering/grids/renderableboxgrid.cpp index d53632c94f..03028acddd 100644 --- a/modules/base/rendering/grids/renderableboxgrid.cpp +++ b/modules/base/rendering/grids/renderableboxgrid.cpp @@ -39,29 +39,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered", - // @VISIBILITY(1.17) + "This value determines the color of the grid lines that are rendered.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width of the spherical grid", + "This value specifies the line width of the spherical grid.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Grid Size", - "This value species the size of each dimensions of the box", + "This value species the size of each dimensions of the box.", openspace::properties::Property::Visibility::AdvancedUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { "Labels", "Labels", - "The labels for the grid" + "The labels for the grid." }; struct [[codegen::Dictionary(RenderableBoxGrid)]] Parameters { diff --git a/modules/base/rendering/grids/renderablegrid.cpp b/modules/base/rendering/grids/renderablegrid.cpp index ba03ab9f00..b530c843c6 100644 --- a/modules/base/rendering/grids/renderablegrid.cpp +++ b/modules/base/rendering/grids/renderablegrid.cpp @@ -39,16 +39,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered", - // @VISIBILITY(1.25) + "This value determines the color of the grid lines that are rendered.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo HighlightColorInfo = { "HighlightColor", "Highlight Color", - "This value determines the color of the highlighted lines in the grid", - // @VISIBILITY(1.25) + "This value determines the color of the highlighted lines in the grid.", openspace::properties::Property::Visibility::NoviceUser }; @@ -56,8 +54,7 @@ namespace { "Segments", "Number of Segments", "This value specifies the number of segments that are used to render the " - "grid in each direction", - // @VISIBILITY(2.75) + "grid in each direction.", openspace::properties::Property::Visibility::User }; @@ -73,29 +70,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width of the grid", - // @VISIBILITY(1.5) + "This value specifies the line width of the grid.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo HighlightLineWidthInfo = { "HighlightLineWidth", "Highlight Line Width", - "This value specifies the line width of the highlighted lines in the grid", + "This value specifies the line width of the highlighted lines in the grid.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Grid Size", - "This value species the size of each dimensions of the grid", + "This value species the size of each dimensions of the grid.", openspace::properties::Property::Visibility::User }; const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { "Labels", "Labels", - "The labels for the grid" + "The labels for the grid." }; struct [[codegen::Dictionary(RenderableGrid)]] Parameters { diff --git a/modules/base/rendering/grids/renderableradialgrid.cpp b/modules/base/rendering/grids/renderableradialgrid.cpp index 1449533ff7..4cc4dd3cdb 100644 --- a/modules/base/rendering/grids/renderableradialgrid.cpp +++ b/modules/base/rendering/grids/renderableradialgrid.cpp @@ -40,8 +40,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered", - // @VISIBILITY(1.25) + "This value determines the color of the grid lines that are rendered.", openspace::properties::Property::Visibility::NoviceUser }; @@ -49,8 +48,7 @@ namespace { "GridSegments", "Number of Grid Segments", "Specifies the number of segments for the grid, in the radial and angular " - "direction respectively", - // @VISIBILITY(2.5) + "direction respectively.", openspace::properties::Property::Visibility::User }; @@ -58,15 +56,14 @@ namespace { "CircleSegments", "Number of Circle Segments", "This value specifies the number of segments that is used to render each circle " - "in the grid", - // @VISIBILITY(2.5) + "in the grid.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width of the spherical grid", + "This value specifies the line width of the spherical grid.", openspace::properties::Property::Visibility::User }; @@ -75,15 +72,14 @@ namespace { "Inner and Outer Radius", "The radii values that determine the size of the circular grid. The first value " "is the radius of the inmost ring and the second is the radius of the outmost " - "ring", - // @VISIBILITY(2.67) + "ring.", openspace::properties::Property::Visibility::User }; const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { "Labels", "Labels", - "The labels for the grid" + "The labels for the grid." }; struct [[codegen::Dictionary(RenderableRadialGrid)]] Parameters { diff --git a/modules/base/rendering/grids/renderablesphericalgrid.cpp b/modules/base/rendering/grids/renderablesphericalgrid.cpp index 809bf737f9..f3d8aca5b2 100644 --- a/modules/base/rendering/grids/renderablesphericalgrid.cpp +++ b/modules/base/rendering/grids/renderablesphericalgrid.cpp @@ -39,8 +39,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered", - // @VISIBILITY(1.25) + "This value determines the color of the grid lines that are rendered.", openspace::properties::Property::Visibility::NoviceUser }; @@ -48,23 +47,21 @@ namespace { "Segments", "Number of Segments", "This value specifies the number of segments that are used to render the " - "surrounding sphere", - // @VISIBILITY(2.25) + "surrounding sphere.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width of the spherical grid", - // @VISIBILITY(1.67) + "This value specifies the line width of the spherical grid.", openspace::properties::Property::Visibility::NoviceUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { "Labels", "Labels", - "The labels for the grid" + "The labels for the grid." }; struct [[codegen::Dictionary(RenderableSphericalGrid)]] Parameters { diff --git a/modules/base/rendering/pointcloud/renderablepointcloud.cpp b/modules/base/rendering/pointcloud/renderablepointcloud.cpp index 96df080718..3b31642379 100644 --- a/modules/base/rendering/pointcloud/renderablepointcloud.cpp +++ b/modules/base/rendering/pointcloud/renderablepointcloud.cpp @@ -138,15 +138,14 @@ namespace { "FixedColor", "Fixed Color", "This value is used to define the color of the points when no color map is" - "used", + "used.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo DrawElementsInfo = { "DrawElements", "Draw Elements", - "Enables/Disables the drawing of the points", - // @VISIBILITY(1.25) + "Enables/Disables the drawing of the points.", openspace::properties::Property::Visibility::NoviceUser }; @@ -169,7 +168,6 @@ namespace { "camera is outside this range and fully invisible when inside the range. With " "inverted fading the situation is the opposite: the points are visible inside " "hen closer than the min value of the range and invisible when further away.", - // @VISIBILITY(3.25) openspace::properties::Property::Visibility::AdvancedUser }; @@ -235,7 +233,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo HasOrientationDataInfo = { "HasOrientationData", "Has Orientation Data", - "Set to true if orientation data was read from the dataset", + "Set to true if orientation data was read from the dataset.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderablecartesianaxes.cpp b/modules/base/rendering/renderablecartesianaxes.cpp index da67e3c4ce..792fc17adf 100644 --- a/modules/base/rendering/renderablecartesianaxes.cpp +++ b/modules/base/rendering/renderablecartesianaxes.cpp @@ -40,24 +40,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo XColorInfo = { "XColor", "X Color", - "This value determines the color of the x axis", - // @VISIBILITY(1.5) + "This value determines the color of the x axis.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo YColorInfo = { "YColor", "Y Color", - "This value determines the color of the y axis", - // @VISIBILITY(1.5) + "This value determines the color of the y axis.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ZColorInfo = { "ZColor", "Z Color", - "This value determines the color of the z axis", - // @VISIBILITY(1.5) + "This value determines the color of the z axis.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/base/rendering/renderabledisc.cpp b/modules/base/rendering/renderabledisc.cpp index a69435399c..dfbce826f2 100644 --- a/modules/base/rendering/renderabledisc.cpp +++ b/modules/base/rendering/renderabledisc.cpp @@ -47,16 +47,14 @@ namespace { "Texture", "Texture", "This value is the path to a texture on disk that contains a one-dimensional " - "texture to be used for the color", - // @VISIBILITY(2.75) + "texture to be used for the color.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value specifies the outer radius of the disc in meter", - // @VISIBILITY(2.75) + "This value specifies the outer radius of the disc in meters.", openspace::properties::Property::Visibility::User }; @@ -65,7 +63,7 @@ namespace { "Width", "This value is used to set the width of the disc. The actual width is set " "based on the given size and this value should be set between 0 and 1. A value " - "of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size", + "of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderablelabel.cpp b/modules/base/rendering/renderablelabel.cpp index a73fdf0611..8ec38316bb 100644 --- a/modules/base/rendering/renderablelabel.cpp +++ b/modules/base/rendering/renderablelabel.cpp @@ -92,70 +92,63 @@ namespace { constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = { "BlendMode", "Blending Mode", - "This determines the blending mode that is applied to the renderable", + "This determines the blending mode that is applied to the renderable.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "The label text color", - // @VISIBILITY(1.33) + "The label text color.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = { "FontSize", "Font Size", - "The font size (in points) for the label", - // @VISIBILITY(2.5) + "The font size (in points) for the label.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value affects the size scale of the label", - // @VISIBILITY(2.75) + "This value affects the size scale of the label.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TextInfo = { "Text", "Text", - "The text that will be displayed on screen", - // @VISIBILITY(1.8) + "The text that will be displayed on screen.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo MinMaxSizeInfo = { "MinMaxSize", "Min and Max Size", - "The minimum and maximum size (in pixels) of the label", + "The minimum and maximum size (in pixels) of the label.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TransformationMatrixInfo = { "TransformationMatrix", "Transformation Matrix", - "Transformation matrix to be applied to the label", - // @VISIBILITY(3.6) + "Transformation matrix to be applied to the label.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OrientationOptionInfo = { "OrientationOption", "Orientation Option", - "Label orientation rendering mode", - // @VISIBILITY(2.8) + "Label orientation rendering mode.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EnableFadingEffectInfo = { "EnableFading", "Enable/Disable Fade-in Effect", - "Enable/Disable the Fade-in effect", - // @VISIBILITY(?) + "Enable/Disable the Fade-in effect.", openspace::properties::Property::Visibility::User }; @@ -166,7 +159,7 @@ namespace { "The first value is the distance before the closest distance and the second " "the one after the furthest distance. For example, with the unit Parsec (pc), " "a value of {1, 2} will make the label being fully faded out 1 Parsec before " - "the closest distance and 2 Parsec away from the furthest distance", + "the closest distance and 2 Parsec away from the furthest distance.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -174,14 +167,14 @@ namespace { "FadeDistances", "Fade Distances", "The distance range in which the labels should be fully opaque, specified in " - "the chosen unit. The distance from the position of the label to the camera", + "the chosen unit. The distance from the position of the label to the camera.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FadeUnitOptionInfo = { "FadeUnit", "Fade Distance Unit", - "Distance unit for fade-in/-out distance calculations. Defaults to \"au\"", + "Distance unit for fade-in/-out distance calculations. Defaults to \"au\".", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderablemodel.cpp b/modules/base/rendering/renderablemodel.cpp index 7d303292ee..96a8d3452e 100644 --- a/modules/base/rendering/renderablemodel.cpp +++ b/modules/base/rendering/renderablemodel.cpp @@ -86,31 +86,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnableAnimationInfo = { "EnableAnimation", "Enable Animation", - "Enable or disable the animation for the model if it has any", + "Enable or disable the animation for the model if it has any.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = { "AmbientIntensity", "Ambient Intensity", - "A multiplier for ambient lighting", - // @VISIBILITY(2.4) + "A multiplier for ambient lighting.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DiffuseIntensityInfo = { "DiffuseIntensity", "Diffuse Intensity", - "A multiplier for diffuse lighting", - // @VISIBILITY(2.4) + "A multiplier for diffuse lighting.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SpecularIntensityInfo = { "SpecularIntensity", "Specular Intensity", - "A multiplier for specular lighting", - // @VISIBILITY(2.4) + "A multiplier for specular lighting.", openspace::properties::Property::Visibility::User }; @@ -118,14 +115,14 @@ namespace { "PerformShading", "Perform Shading", "This value determines whether this model should be shaded by using the position " - "of the Sun", + "of the Sun.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EnableFaceCullingInfo = { "EnableFaceCulling", "Enable Face Culling", - "Enable OpenGL automatic face culling optimization", + "Enable OpenGL automatic face culling optimization.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -133,14 +130,14 @@ namespace { "ModelTransform", "Model Transform", "This value specifies the model transform that is applied to the model before " - "all other transformations are applied", + "all other transformations are applied.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo PivotInfo = { "Pivot", "Pivot", - "A vector that moves the place of origin for the model", + "A vector that moves the place of origin for the model.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -151,29 +148,28 @@ namespace { "provided in the asset file, you can see and change it here. If instead a unit " "name was provided in the asset, this is the value that that name represents. " "For example 'Centimeter' becomes 0.01. For more information see " - "http://wiki.openspaceproject.com/docs/builders/models/model-scale.html", + "http://wiki.openspaceproject.com/docs/builders/models/model-scale.html.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RotationVecInfo = { "RotationVector", "Rotation Vector", - "Rotation Vector using degrees", - // @VISIBILITY(3.75) + "Rotation Vector using degrees.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LightSourcesInfo = { "LightSources", "Light Sources", - "A list of light sources that this model should accept light from", + "A list of light sources that this model should accept light from.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EnableDepthTestInfo = { "EnableDepthTest", "Enable Depth Test", - "Enable Depth Testing for the Model", + "Enable Depth Testing for the Model.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -181,7 +177,7 @@ namespace { "BlendingOption", "Blending Options", "Changes the blending function used to calculate the colors of the model with " - "respect to the opacity", + "respect to the opacity.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderablenodearrow.cpp b/modules/base/rendering/renderablenodearrow.cpp index 43a37c69fd..fa8e432a43 100644 --- a/modules/base/rendering/renderablenodearrow.cpp +++ b/modules/base/rendering/renderablenodearrow.cpp @@ -48,21 +48,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo StartNodeInfo = { "StartNode", "Start Node", - "The identifier of the node the arrow starts from", + "The identifier of the node the arrow starts from.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo EndNodeInfo = { "EndNode", "End Node", - "The identifier of the node the arrow should point towards", + "The identifier of the node the arrow should point towards.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the RGB color for the arrow", + "This value determines the RGB color for the arrow.", openspace::properties::Property::Visibility::NoviceUser }; @@ -70,7 +70,7 @@ namespace { "Segments", "Number of Segments", "This value specifies the number of segments that the shapes for the arrow are " - "separated in. A higher number leads to a higher resolution", + "separated in. A higher number leads to a higher resolution.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -87,7 +87,7 @@ namespace { "Arrow Head Size", "This size of the arrow head, given in relative value of the entire length of " "the arrow. For example, 0.1 makes the arrow head length be 10% of the full " - "arrow length", + "arrow length.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -95,7 +95,7 @@ namespace { "ArrowHeadWidthFactor", "Arrow Head Width Factor", "A factor that is multiplied with the width, or the arrow itself, to determine " - "the width of the base of the arrow head", + "the width of the base of the arrow head.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -105,7 +105,7 @@ namespace { "The distance from the center of the start node where the arrow starts. " "If 'UseRelativeOffset' is true, the value should be given as a factor to " "multiply with the bounding sphere of the node. Otherwise, the value is " - "specified in meters", + "specified in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -113,7 +113,7 @@ namespace { "UseRelativeOffset", "Use Relative Offset Distance", "Decide whether to use relative distances (in units of start node bounding " - "sphere) for the offset distance. If false, meters is used", + "sphere) for the offset distance. If false, meters is used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -122,7 +122,7 @@ namespace { "Length", "The length of the arrow, given either in meters or as a factor to be " "multiplied with the bounding sphere of the start node (if " - "'UseRelativeLength' is true)", + "'UseRelativeLength' is true).", openspace::properties::Property::Visibility::AdvancedUser }; @@ -130,42 +130,42 @@ namespace { "UseRelativeLength", "Use Relative Length", "Decide whether to use relative size (in units of start node bounding " - "sphere) for the length of the arrow. If false, meters is used", + "sphere) for the length of the arrow. If false, meters is used.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo WidthInfo = { "Width", "Width", - "This value specifies the width of the arrow shape", + "This value specifies the width of the arrow shape.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = { "AmbientIntensity", "Ambient Intensity", - "A multiplier for ambient lighting for the shading of the arrow", + "A multiplier for ambient lighting for the shading of the arrow.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DiffuseIntensityInfo = { "DiffuseIntensity", "Diffuse Intensity", - "A multiplier for diffuse lighting for the shading of the arrow", + "A multiplier for diffuse lighting for the shading of the arrow.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SpecularIntensityInfo = { "SpecularIntensity", "Specular Intensity", - "A multiplier for specular lighting for the shading of the arrow", + "A multiplier for specular lighting for the shading of the arrow.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShadingEnabledInfo = { "PerformShading", "Perform Shading", - "This value determines whether shading should be applied to the arrow model", + "This value determines whether shading should be applied to the arrow model.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderablenodeline.cpp b/modules/base/rendering/renderablenodeline.cpp index b48f8b04d1..91cabf5766 100644 --- a/modules/base/rendering/renderablenodeline.cpp +++ b/modules/base/rendering/renderablenodeline.cpp @@ -60,15 +60,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo LineColorInfo = { "Color", "Color", - "This value determines the RGB color for the line", + "This value determines the RGB color for the line.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width", - // @VISIBILITY(1.75) + "This value specifies the line width.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/base/rendering/renderableplane.cpp b/modules/base/rendering/renderableplane.cpp index 9baf51f932..e11bc64a24 100644 --- a/modules/base/rendering/renderableplane.cpp +++ b/modules/base/rendering/renderableplane.cpp @@ -56,7 +56,7 @@ namespace { "Billboard mode", "This value specifies whether the plane is a billboard, which means that it is " "always facing the camera. If this is false, it can be oriented using other " - "transformations", + "transformations.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -65,15 +65,14 @@ namespace { "Mirror backside of image plane", "If this value is set to false, the image plane will not be mirrored when " "looking from the backside. This is usually desirable when the image shows " - "data at a specific location, but not if it is displaying text for example", - // @VISIBILITY(2.67) + "data at a specific location, but not if it is displaying text for example.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size (in meters)", - "This value specifies the size of the plane in meters", + "This value specifies the size of the plane in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -87,7 +86,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = { "BlendMode", "Blending Mode", - "This determines the blending mode that is applied to this plane", + "This determines the blending mode that is applied to this plane.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -95,7 +94,7 @@ namespace { "MultiplyColor", "Multiply Color", "If set, the plane's texture is multiplied with this color. Useful for applying " - "a color grayscale images", + "a color grayscale images.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderableplaneimagelocal.cpp b/modules/base/rendering/renderableplaneimagelocal.cpp index 83787db5de..b0e49da674 100644 --- a/modules/base/rendering/renderableplaneimagelocal.cpp +++ b/modules/base/rendering/renderableplaneimagelocal.cpp @@ -42,8 +42,7 @@ namespace { "Texture", "Texture", "This value specifies an image that is loaded from disk and is used as a texture " - "that is applied to this plane. This image has to be square", - // @VISIBILITY(2.25) + "that is applied to this plane. This image has to be square.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderableplaneimageonline.cpp b/modules/base/rendering/renderableplaneimageonline.cpp index 142542c671..d9d0acb796 100644 --- a/modules/base/rendering/renderableplaneimageonline.cpp +++ b/modules/base/rendering/renderableplaneimageonline.cpp @@ -39,8 +39,7 @@ namespace { "Image URL", "Sets the URL of the texture that is displayed on this screen space plane. If " "this value is changed, the image at the new path will automatically be loaded " - "and displayed", - // @VISIBILITY(2.25) + "and displayed.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderableplanetimevaryingimage.cpp b/modules/base/rendering/renderableplanetimevaryingimage.cpp index 4e367ccf39..34303d828a 100644 --- a/modules/base/rendering/renderableplanetimevaryingimage.cpp +++ b/modules/base/rendering/renderableplanetimevaryingimage.cpp @@ -45,7 +45,7 @@ namespace { "SourceFolder", "Source Folder", "This value specifies the image directory that is loaded from disk and " - "is used as a texture that is applied to this plane", + "is used as a texture that is applied to this plane.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -53,8 +53,7 @@ namespace { "RenderType", "Render Type", "This value specifies if the plane should be rendered in the Background, " - "Opaque, Transparent, or Overlay rendering step", - // @VISIBILITY(3.67) + "Opaque, Transparent, or Overlay rendering step.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderableprism.cpp b/modules/base/rendering/renderableprism.cpp index 9bac9b2a3d..a03209fcc0 100644 --- a/modules/base/rendering/renderableprism.cpp +++ b/modules/base/rendering/renderableprism.cpp @@ -44,8 +44,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = { "Segments", "Segments", - "The number of segments the shape of the prism should have", - // @VISIBILITY(2.8) + "The number of segments the shape of the prism should have.", openspace::properties::Property::Visibility::User }; @@ -53,16 +52,14 @@ namespace { "NumLines", "Number of Lines", "The number of lines connecting the two shapes of the prism. They will be evenly " - "distributed around the bounding circle that makes up the shape of the prism", - // @VISIBILITY(2.8) + "distributed around the bounding circle that makes up the shape of the prism.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RadiusInfo = { "Radius", "Radius", - "The radius of the prism's shape in meters", - // @VISIBILITY(2.8) + "The radius of the prism's shape in meters.", openspace::properties::Property::Visibility::User }; @@ -70,32 +67,28 @@ namespace { "BaseRadius", "Base Radius", "The radius of the base of the prism's shape, in meters. By default it is given " - "the same radius as the outer shape", - // @VISIBILITY(2.8) + "the same radius as the outer shape.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width", - // @VISIBILITY(2.0) + "This value specifies the line width.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineColorInfo = { "Color", "Color", - "This value determines the RGB color for the line", - // @VISIBILITY(1.2) + "This value determines the RGB color for the line.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LengthInfo = { "Length", "Length", - "The length of the prism in meters", - // @VISIBILITY(2.8) + "The length of the prism in meters.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderablesphere.cpp b/modules/base/rendering/renderablesphere.cpp index c0b5070127..efd1678d9b 100644 --- a/modules/base/rendering/renderablesphere.cpp +++ b/modules/base/rendering/renderablesphere.cpp @@ -48,15 +48,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size (in meters)", - "This value specifies the radius of the sphere in meters", + "This value specifies the radius of the sphere in meters.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = { "Segments", "Number of Segments", - "This value specifies the number of segments that the sphere is separated in", - // @VISIBILITY(2.67) + "This value specifies the number of segments that the sphere is separated in.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -70,21 +69,21 @@ namespace { "Orientation", "Orientation", "Specifies whether the texture is applied to the inside of the sphere, the " - "outside of the sphere, or both", + "outside of the sphere, or both.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = { "MirrorTexture", "Mirror Texture", - "Mirror the texture along the x-axis", + "Mirror the texture along the x-axis.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = { "DisableFadeInOut", "Disable Fade-In/Fade-Out effects", - "Enables/Disables the fade in and out effects", + "Enables/Disables the fade in and out effects.", openspace::properties::Property::Visibility::User }; @@ -94,7 +93,7 @@ namespace { "This value determines the distance from center of MilkyWay from where the " "astronomical object starts to fade in, given as a percentage of the size of " "the object. A negative or zero value means no fading in will happen. This is " - "also the default", + "also the default.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -103,7 +102,7 @@ namespace { "Fade-Out Threshold", "This value determines percentage of the sphere that is visible before starting " "to fade it out. A negative or zero value means no fading out will happen. This " - "is also the default", + "is also the default.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderablesphereimagelocal.cpp b/modules/base/rendering/renderablesphereimagelocal.cpp index c82abf7788..2a80a598dd 100644 --- a/modules/base/rendering/renderablesphereimagelocal.cpp +++ b/modules/base/rendering/renderablesphereimagelocal.cpp @@ -38,8 +38,7 @@ namespace { "Texture", "This value specifies an image that is loaded from disk and is used as a texture " "that is applied to this sphere. This image is expected to be an equirectangular " - "projection", - // @VISIBILITY(2.33) + "projection.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderablesphereimageonline.cpp b/modules/base/rendering/renderablesphereimageonline.cpp index bf2757bdc1..df81368cbe 100644 --- a/modules/base/rendering/renderablesphereimageonline.cpp +++ b/modules/base/rendering/renderablesphereimageonline.cpp @@ -38,8 +38,7 @@ namespace { "Image URL", "Sets the URL of the texture that is displayed on this sphere. If " "this value is changed, the image at the new path will automatically be loaded " - "and displayed. This image is expected to be an equirectangular projection", - // @VISIBILITY(2.25) + "and displayed. This image is expected to be an equirectangular projection.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/renderabletimevaryingsphere.cpp b/modules/base/rendering/renderabletimevaryingsphere.cpp index 317a414155..d7747c7d95 100644 --- a/modules/base/rendering/renderabletimevaryingsphere.cpp +++ b/modules/base/rendering/renderabletimevaryingsphere.cpp @@ -55,7 +55,7 @@ namespace { "Texture Source", "This value specifies a directory of images that are loaded from disk and is " "used as a texture that is applied to this sphere. The images are expected to " - "be an equirectangular projection", + "be an equirectangular projection.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderabletrail.cpp b/modules/base/rendering/renderabletrail.cpp index 01a7c24159..3d0fe8551e 100644 --- a/modules/base/rendering/renderabletrail.cpp +++ b/modules/base/rendering/renderabletrail.cpp @@ -73,8 +73,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo LineColorInfo = { "Color", "Color", - "This value determines the RGB main color for the lines and points of the trail", - // @VISIBILITY(1.2) + "This value determines the RGB main color for the lines and points of the trail.", openspace::properties::Property::Visibility::NoviceUser }; @@ -83,8 +82,7 @@ namespace { "Enable line fading of old points", "Toggles whether the trail should fade older points out. If this value is " "'true', the 'Fade' parameter determines the speed of fading. If this value is " - "'false', the entire trail is rendered at full opacity and color", - // @VISIBILITY(1.25) + "'false', the entire trail is rendered at full opacity and color.", openspace::properties::Property::Visibility::NoviceUser }; @@ -95,7 +93,6 @@ namespace { "value of 1 will result in a trail that covers the entire extent. The setting " "only applies if 'EnableFade' is 'true'. If it is 'false', this setting has " "no effect.", - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -110,7 +107,6 @@ namespace { "will result in a trail that starts fading immediately, becoming fully " "transparent by the end of the trail. This setting only applies if the " "'EnableFade' value is 'true'. If it is 'false', this setting has no effect.", - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -119,8 +115,7 @@ namespace { "Line Width", "This value specifies the line width of the trail if the selected rendering " "method includes lines. If the rendering mode is set to Points, this value is " - "ignored", - // @VISIBILITY(2.4) + "ignored.", openspace::properties::Property::Visibility::User }; @@ -130,8 +125,7 @@ namespace { "This value specifies the base size of the points along the line if the selected " "rendering method includes points. If the rendering mode is set the Lines, this " "value is ignored. If a subsampling of the values is performed, the subsampled " - "values are half this size", - // @VISIBILITY(2.4) + "values are half this size.", openspace::properties::Property::Visibility::User }; @@ -140,12 +134,13 @@ namespace { "Rendering Mode", "Determines how the trail should be rendered. If 'Lines' is " "selected, only the line part is visible, if 'Points' is selected, only the " - "corresponding points (and subpoints) are shown. 'Lines+Points' shows both parts", + "corresponding points (and subpoints) are shown. 'Lines+Points' shows both " + "parts.", openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableTrail)]] Parameters { - // This object is used to compute locations along the path. Any Translation + // This object is used to compute locations along the path. Any Translation // object can be used here ghoul::Dictionary translation [[codegen::reference("core_transform_translation")]]; diff --git a/modules/base/rendering/renderabletrailorbit.cpp b/modules/base/rendering/renderabletrailorbit.cpp index 5f0a473af0..96ac84ad33 100644 --- a/modules/base/rendering/renderabletrailorbit.cpp +++ b/modules/base/rendering/renderabletrailorbit.cpp @@ -93,7 +93,7 @@ namespace { "The objects period, i.e. the length of its orbit around the parent object given " "in (Earth) days. In the case of Earth, this would be a sidereal year " "(=365.242 days). If this values is specified as multiples of the period, it is " - "possible to show the effects of precession", + "possible to show the effects of precession.", openspace::properties::Property::Visibility::User }; @@ -103,7 +103,7 @@ namespace { "The number of samples along the orbit. This determines the resolution of the " "trail; the tradeoff being that a higher resolution is able to resolve more " "detail, but will take more resources while rendering, too. The higher, the " - "smoother the trail, but also more memory will be used", + "smoother the trail, but also more memory will be used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -111,8 +111,7 @@ namespace { "RenderableType", "RenderableType", "This value specifies if the orbit should be rendered in the Background," - "Opaque, Transparent, or Overlay rendering step. Default is Transparent", - // @VISIBILITY(3.25) + "Opaque, Transparent, or Overlay rendering step. Default is Transparent.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/renderabletrailtrajectory.cpp b/modules/base/rendering/renderabletrailtrajectory.cpp index 8c9b6618d4..15016254d9 100644 --- a/modules/base/rendering/renderabletrailtrajectory.cpp +++ b/modules/base/rendering/renderabletrailtrajectory.cpp @@ -48,7 +48,7 @@ namespace { "StartTime", "Start Time", "The start time for the range of this trajectory. The date must be in ISO 8601 " - "format: YYYY MM DD HH:mm:ss.xxx", + "format: YYYY MM DD HH:mm:ss.xxx.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -56,7 +56,7 @@ namespace { "EndTime", "End Time", "The end time for the range of this trajectory. The date must be in ISO 8601 " - "format: YYYY MM DD HH:mm:ss.xxx", + "format: YYYY MM DD HH:mm:ss.xxx.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -66,7 +66,7 @@ namespace { "The interval between samples of the trajectory. This value (together with " "'TimeStampSubsampleFactor') determines how far apart (in time) the samples are " "spaced along the trajectory. The time interval between 'StartTime' and " - "'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments", + "'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -76,7 +76,7 @@ namespace { "The factor that is used to create subsamples along the trajectory. This value " "(together with 'SampleInterval') determines how far apart (in time) the samples " "are spaced along the trajectory. The time interval between 'StartTime' and " - "'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments", + "'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -84,8 +84,8 @@ namespace { "ShowFullTrail", "Render Full Trail", "If this value is set to 'true', the entire trail will be rendered; if it is " - "'false', only the trail until the current time in the application will be shown", - // @VISIBILITY(1.25) + "'false', only the trail until the current time in the application will be " + "shown.", openspace::properties::Property::Visibility::NoviceUser }; @@ -93,8 +93,8 @@ namespace { "SweepChunkSize", "Sweep Chunk Size", "The number of vertices that will be calculated each frame whenever the trail " - "needs to be recalculated. " - "A greater value will result in more calculations per frame.", + "needs to be recalculated. A greater value will result in more calculations per " + "frame.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -113,7 +113,8 @@ namespace { "AccurateTrailPositions", "Number of Accurate Trail Points", "The number of vertices, each side of the object, that will be recalculated " - "for greater accuracy. This also ensures that the object connects with the trail.", + "for greater accuracy. This also ensures that the object connects with the " + "trail.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rendering/screenspacedashboard.cpp b/modules/base/rendering/screenspacedashboard.cpp index 32ee38765b..7d2904a788 100644 --- a/modules/base/rendering/screenspacedashboard.cpp +++ b/modules/base/rendering/screenspacedashboard.cpp @@ -41,7 +41,7 @@ namespace { "UseMainDashboard", "Use main dashboard", "If this value is set to 'true', this ScreenSpaceDashboard will use the " - "main dashboard instead of creating an independent one", + "main dashboard instead of creating an independent one.", openspace::properties::Property::Visibility::Developer }; diff --git a/modules/base/rendering/screenspaceframebuffer.cpp b/modules/base/rendering/screenspaceframebuffer.cpp index 81380c5ede..6b8572578c 100644 --- a/modules/base/rendering/screenspaceframebuffer.cpp +++ b/modules/base/rendering/screenspaceframebuffer.cpp @@ -36,8 +36,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value explicitly specifies the size of the screen space plane", - // @VISIBILITY(3.75) + "This value explicitly specifies the size of the screen space plane.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/base/rendering/screenspaceimagelocal.cpp b/modules/base/rendering/screenspaceimagelocal.cpp index 188423fdde..b37666908c 100644 --- a/modules/base/rendering/screenspaceimagelocal.cpp +++ b/modules/base/rendering/screenspaceimagelocal.cpp @@ -42,8 +42,7 @@ namespace { "Sets the path of the texture that is displayed on this screen space plane. If " "this value is changed, the image at the new path will automatically be loaded " "and displayed. The size of the image will also automatically set the default " - "size of this plane", - // @VISIBILITY(2.4) + "size of this plane.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rendering/screenspaceimageonline.cpp b/modules/base/rendering/screenspaceimageonline.cpp index a7b6ac55dc..09c5261c0f 100644 --- a/modules/base/rendering/screenspaceimageonline.cpp +++ b/modules/base/rendering/screenspaceimageonline.cpp @@ -42,8 +42,7 @@ namespace { "Sets the URL of the texture that is displayed on this screen space plane. If " "this value is changed, the image at the new path will automatically be loaded " "and displayed. The size of the image will also automatically set the default " - "size of this plane", - // @VISIBILITY(2.4) + "size of this plane.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/rotation/constantrotation.cpp b/modules/base/rotation/constantrotation.cpp index fb965c088c..0a14cbd1f3 100644 --- a/modules/base/rotation/constantrotation.cpp +++ b/modules/base/rotation/constantrotation.cpp @@ -34,16 +34,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo RotationInfo = { "RotationAxis", "Rotation Axis", - "This value is the rotation axis around which the object will rotate", - // @VISIBILITY(3.33) + "This value is the rotation axis around which the object will rotate.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RotationRateInfo = { "RotationRate", "Rotation Rate", - "This value determines the number of revolutions per in-game second", - // @VISIBILITY(3.33) + "This value determines the number of revolutions per in-game second.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rotation/fixedrotation.cpp b/modules/base/rotation/fixedrotation.cpp index 2a03a54a02..df1c24b4cb 100644 --- a/modules/base/rotation/fixedrotation.cpp +++ b/modules/base/rotation/fixedrotation.cpp @@ -42,8 +42,7 @@ namespace { "Enabled", "If this value is 'true', all the machinery of this rotation is used, of it is " "'false', it provides the ability to change its attributes without risking some " - "undefined behavior", - // @VISIBILITY(2.75) + "undefined behavior.", openspace::properties::Property::Visibility::User }; @@ -53,7 +52,7 @@ namespace { "This value specifies how this axis is being specified, that is whether it is " "referencing another object, specifying an absolute vector, or whether it is " "using the right handed coordinate system completion based off the other two " - "vectors", + "vectors.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -63,7 +62,7 @@ namespace { "This value specifies how this axis is being specified, that is whether it is " "referencing another object, specifying an absolute vector, or whether it is " "using the right handed coordinate system completion based off the other two " - "vectors", + "vectors.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -73,7 +72,7 @@ namespace { "This value specifies how this axis is being specified, that is whether it is " "referencing another object, specifying an absolute vector, or whether it is " "using the right handed coordinate system completion based off the other two " - "vectors", + "vectors.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -82,7 +81,7 @@ namespace { "xAxis: Focus Object", "This is the object that the axis will focus on. This object must name an " "existing scene graph node in the currently loaded scene and the rotation will " - "stay fixed to the current position of that object", + "stay fixed to the current position of that object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -91,7 +90,7 @@ namespace { "yAxis: Focus Object", "This is the object that the axis will focus on. This object must name an " "existing scene graph node in the currently loaded scene and the rotation will " - "stay fixed to the current position of that object", + "stay fixed to the current position of that object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -100,7 +99,7 @@ namespace { "zAxis: Focus Object", "This is the object that the axis will focus on. This object must name an " "existing scene graph node in the currently loaded scene and the rotation will " - "stay fixed to the current position of that object", + "stay fixed to the current position of that object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -109,7 +108,7 @@ namespace { "xAxis: Invert Object Point Direction", "If this value is set to 'true', and the type is set to 'Object', the inverse of " "the pointing direction is used, causing the object to point away from the " - "referenced object", + "referenced object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -118,7 +117,7 @@ namespace { "yAxis: Invert Object Point Direction", "If this value is set to 'true', and the type is set to 'Object', the inverse of " "the pointing direction is used, causing the object to point away from the " - "referenced object", + "referenced object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -127,7 +126,7 @@ namespace { "zAxis: Invert Object Point Direction", "If this value is set to 'true', and the type is set to 'Object', the inverse of " "the pointing direction is used, causing the object to point away from the " - "referenced object", + "referenced object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -135,7 +134,7 @@ namespace { "xAxisVector", "xAxis: Direction vector", "This value specifies a static direction vector that is used for a fixed " - "rotation", + "rotation.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -143,7 +142,7 @@ namespace { "yAxisVector", "yAxis: Direction vector", "This value specifies a static direction vector that is used for a fixed " - "rotation", + "rotation.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -151,7 +150,7 @@ namespace { "zAxisVector", "zAxis: Direction vector", "This value specifies a static direction vector that is used for a fixed " - "rotation", + "rotation.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -160,7 +159,7 @@ namespace { "xAxis: Vector is orthogonal", "This value determines whether the vector specified is used directly, or whether " "it is used together with another non-coordinate system completion vector to " - "construct an orthogonal vector instead", + "construct an orthogonal vector instead.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -169,7 +168,7 @@ namespace { "yAxis: Vector is orthogonal", "This value determines whether the vector specified is used directly, or whether " "it is used together with another non-coordinate system completion vector to " - "construct an orthogonal vector instead", + "construct an orthogonal vector instead.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -178,7 +177,7 @@ namespace { "zAxis: Vector is orthogonal", "This value determines whether the vector specified is used directly, or whether " "it is used together with another non-coordinate system completion vector to " - "construct an orthogonal vector instead", + "construct an orthogonal vector instead.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -187,7 +186,7 @@ namespace { "Attached Node", "This is the name of the node that this rotation is attached to, this value is " "only needed if any of the three axis uses the Object type. In this case, the " - "location of the attached node is required to compute the relative direction", + "location of the attached node is required to compute the relative direction.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rotation/luarotation.cpp b/modules/base/rotation/luarotation.cpp index 183ba342b6..7608fb7664 100644 --- a/modules/base/rotation/luarotation.cpp +++ b/modules/base/rotation/luarotation.cpp @@ -43,8 +43,7 @@ namespace { "'rotation' that takes the current simulation time in seconds past the J2000 " "epoch as the first argument, the current wall time as milliseconds past the " "J2000 epoch as the second argument and computes the rotation returned as 9 " - "values", - // @VISIBILITY(3.25) + "values.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rotation/staticrotation.cpp b/modules/base/rotation/staticrotation.cpp index bf4ed3a55d..733456c96f 100644 --- a/modules/base/rotation/staticrotation.cpp +++ b/modules/base/rotation/staticrotation.cpp @@ -32,8 +32,7 @@ namespace { "Rotation", "Rotation", "This value is the used as a 3x3 rotation matrix that is applied to the scene " - "graph node that this transformation is attached to relative to its parent", - // @VISIBILITY(3.0) + "graph node that this transformation is attached to relative to its parent.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/rotation/timelinerotation.cpp b/modules/base/rotation/timelinerotation.cpp index de2709f163..d8a628e17d 100644 --- a/modules/base/rotation/timelinerotation.cpp +++ b/modules/base/rotation/timelinerotation.cpp @@ -35,8 +35,7 @@ namespace { "ShouldInterpolate", "Should Interpolate", "If this value is set to 'true', an interpolation is applied between the given " - "keyframes. If this value is set to 'false', the interpolation is not applied", - // @VISIBILITY(3.2) + "keyframes. If this value is set to 'false', the interpolation is not applied.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/scale/luascale.cpp b/modules/base/scale/luascale.cpp index 5a0e994fd6..23af817fd1 100644 --- a/modules/base/scale/luascale.cpp +++ b/modules/base/scale/luascale.cpp @@ -42,8 +42,7 @@ namespace { "scaling factor for this transformation. The script needs to define a function " "'scale' that takes the current simulation time in seconds past the J2000 epoch " "as the first argument, the current wall time as milliseconds past the J2000 " - "epoch the second argument and computes the three scaling factors", - // @VISIBILITY(3.25) + "epoch the second argument and computes the three scaling factors.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/scale/nonuniformstaticscale.cpp b/modules/base/scale/nonuniformstaticscale.cpp index b7ba2ade87..cef4a0003c 100644 --- a/modules/base/scale/nonuniformstaticscale.cpp +++ b/modules/base/scale/nonuniformstaticscale.cpp @@ -32,7 +32,7 @@ namespace { "Scale", "Scale", "These values are used as scaling factors for the scene graph node that this " - "transformation is attached to relative to its parent", + "transformation is attached to relative to its parent.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/base/scale/staticscale.cpp b/modules/base/scale/staticscale.cpp index 4f916424cc..e577f2a852 100644 --- a/modules/base/scale/staticscale.cpp +++ b/modules/base/scale/staticscale.cpp @@ -32,7 +32,7 @@ namespace { "Scale", "Scale", "This value is used as a scaling factor for the scene graph node that this " - "transformation is attached to relative to its parent", + "transformation is attached to relative to its parent.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/base/scale/timedependentscale.cpp b/modules/base/scale/timedependentscale.cpp index e70b077fa4..e71e0310b6 100644 --- a/modules/base/scale/timedependentscale.cpp +++ b/modules/base/scale/timedependentscale.cpp @@ -37,8 +37,7 @@ namespace { "The date at which this scale will be 0. The current value of the scale is " "computed by taking the difference between the current time and the reference " "date and multiplying it by the speed. This field must be formatted as: " - "YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds", - // @VISIBILITY(2.75) + "YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds.", openspace::properties::Property::Visibility::User }; @@ -46,8 +45,7 @@ namespace { "Speed", "Speed", "The speed at which the value grows or shrinks. The units for this are meters " - "per second. The default value is 1 m/s", - // @VISIBILITY(2.75) + "per second. The default value is 1 m/s.", openspace::properties::Property::Visibility::User }; @@ -57,7 +55,7 @@ namespace { "If this value is true, the velocity computation will be clamped to a positive " "value if the current simulation time is before the `ReferenceDate`. This is " "useful for instantaneous events that only propagate forwards in time. The " - "default value is 'true'", + "default value is 'true'.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/timeframe/timeframeinterval.cpp b/modules/base/timeframe/timeframeinterval.cpp index 7cf33cc43c..e7c76dbe5a 100644 --- a/modules/base/timeframe/timeframeinterval.cpp +++ b/modules/base/timeframe/timeframeinterval.cpp @@ -34,32 +34,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo HasStartInfo = { "HasStart", "Has Start", - "If enabled, this TimeFrame will be inactive before the Start", - // @VISIBILITY(2.75) + "If enabled, this TimeFrame will be inactive before the Start.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo StartInfo = { "Start", "Start", - "Specifies the time when this TimeFrame becomes active", - // @VISIBILITY(2.75) + "Specifies the time when this TimeFrame becomes active.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo HasEndInfo = { "HasEnd", "Has End", - "If enabled, this TimeFrame will be inactive after the End", - // @VISIBILITY(2.75) + "If enabled, this TimeFrame will be inactive after the End.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EndInfo = { "End", "End", - "Specifies the time when this TimeFrame becomes inactive", - // @VISIBILITY(2.75) + "Specifies the time when this TimeFrame becomes inactive.", openspace::properties::Property::Visibility::User }; diff --git a/modules/base/timeframe/timeframeunion.cpp b/modules/base/timeframe/timeframeunion.cpp index bee5206165..78d36641c5 100644 --- a/modules/base/timeframe/timeframeunion.cpp +++ b/modules/base/timeframe/timeframeunion.cpp @@ -35,8 +35,8 @@ namespace { "TimeFrames", "Time Frames", "A vector of time frames to combine into one. The time frame is active when any " - "of the contained time frames are, but not in gaps between contained time frames", - // @VISIBILITY(3.75) + "of the contained time frames are, but not in gaps between contained time " + "frames.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/translation/luatranslation.cpp b/modules/base/translation/luatranslation.cpp index e22857ff37..b5643108d2 100644 --- a/modules/base/translation/luatranslation.cpp +++ b/modules/base/translation/luatranslation.cpp @@ -43,8 +43,7 @@ namespace { "translation for this transformation. The script needs to define a function " "'translation' that takes the current simulation time in seconds past the J2000 " "epoch as the first argument, the current wall time as milliseconds past the " - "J2000 epoch as the second argument and computes the translation", - // @VISIBILITY(3.75) + "J2000 epoch as the second argument and computes the translation.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/base/translation/statictranslation.cpp b/modules/base/translation/statictranslation.cpp index 079604db64..894c0f68e7 100644 --- a/modules/base/translation/statictranslation.cpp +++ b/modules/base/translation/statictranslation.cpp @@ -32,7 +32,7 @@ namespace { "Position", "Position", "This value is used as a static offset (in meters) that is applied to the scene " - "graph node that this transformation is attached to relative to its parent", + "graph node that this transformation is attached to relative to its parent.", // @VISIBILITY(2.25) openspace::properties::Property::Visibility::User }; diff --git a/modules/base/translation/timelinetranslation.cpp b/modules/base/translation/timelinetranslation.cpp index e9a12adc0d..15c6c03fe3 100644 --- a/modules/base/translation/timelinetranslation.cpp +++ b/modules/base/translation/timelinetranslation.cpp @@ -35,7 +35,7 @@ namespace { "ShouldInterpolate", "Should Interpolate", "If this value is set to 'true', an interpolation is applied between the given " - "keyframes. If this value is set to 'false', the interpolation is not applied", + "keyframes. If this value is set to 'false', the interpolation is not applied.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/cefwebgui/cefwebguimodule.cpp b/modules/cefwebgui/cefwebguimodule.cpp index 818505ccc0..308aa07347 100644 --- a/modules/cefwebgui/cefwebguimodule.cpp +++ b/modules/cefwebgui/cefwebguimodule.cpp @@ -41,38 +41,35 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether the browser should be enabled or not", + "This setting determines whether the browser should be enabled or not.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ReloadInfo = { "Reload", "Reload", - "Trigger this property to reload the browser", - // @VISIBILITY(2.2) + "Trigger this property to reload the browser.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo VisibleInfo = { "Visible", "Is Visible", - "This setting determines whether the browser should be visible or not", - // @VISIBILITY(2.75) + "This setting determines whether the browser should be visible or not.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo GuiUrlInfo = { "GuiUrl", "GUI URL", - "The URL of the webpage that is used to load the WebGUI from", - // @VISIBILITY(3.5) + "The URL of the webpage that is used to load the WebGUI from.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GuiScaleInfo = { "GuiScale", "Gui Scale", - "GUI scale multiplier", + "GUI scale multiplier.", openspace::properties::Property::Visibility::Always }; } // namespace diff --git a/modules/debugging/rendering/renderabledebugplane.cpp b/modules/debugging/rendering/renderabledebugplane.cpp index 906d21f5bc..2509db87a2 100644 --- a/modules/debugging/rendering/renderabledebugplane.cpp +++ b/modules/debugging/rendering/renderabledebugplane.cpp @@ -51,8 +51,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TextureInfo = { "Texture", "Texture", - "The OpenGL name of the texture that is displayed on this plane", - // @VISIBILITY(3.75) + "The OpenGL name of the texture that is displayed on this plane.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -61,24 +60,21 @@ namespace { "Billboard mode", "This value specifies whether the plane is a billboard, which means that it is " "always facing the camera. If this is false, it can be oriented using other " - "transformations", - // @VISIBILITY(3.75) + "transformations.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size (in meters)", - "This value specifies the size of the plane in meters", - // @VISIBILITY(3.75) + "This value specifies the size of the plane in meters.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OriginInfo = { "Origin", "Texture Coordinate Origin", - "The origin of the texture coorinate system", - // @VISIBILITY(3.75) + "The origin of the texture coorinate system.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/digitaluniverse/rendering/renderabledumeshes.cpp b/modules/digitaluniverse/rendering/renderabledumeshes.cpp index aa17764658..a933ccb66e 100644 --- a/modules/digitaluniverse/rendering/renderabledumeshes.cpp +++ b/modules/digitaluniverse/rendering/renderabledumeshes.cpp @@ -62,7 +62,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TextColorInfo = { "TextColor", "Text Color", - "The text color for the astronomical object", + "The text color for the astronomical object.", openspace::properties::Property::Visibility::NoviceUser }; @@ -70,14 +70,14 @@ namespace { "TextOpacity", "Text Opacity", "Determines the transparency of the text label, where 1 is completely opaque " - "and 0 fully transparent", + "and 0 fully transparent.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo TextSizeInfo = { "TextSize", "Text Size", - "The text size for the astronomical object labels", + "The text size for the astronomical object labels.", openspace::properties::Property::Visibility::User }; @@ -85,7 +85,7 @@ namespace { "LabelFile", "Label File", "The path to the label file that contains information about the astronomical " - "objects being rendered", + "objects being rendered.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -93,44 +93,42 @@ namespace { "TextMinMaxSize", "Text Min/Max Size", "The minimum and maximum size (in pixels) of the text for the labels for the " - "astronomical objects being rendered", + "astronomical objects being rendered.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "If the DU mesh is of wire type, this value determines the width of the lines", - // @VISIBILITY(1.75) + "If the DU mesh is of wire type, this value determines the width of the lines.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo DrawElementsInfo = { "DrawElements", "Draw Elements", - "Enables/Disables the drawing of the astronomical objects", + "Enables/Disables the drawing of the astronomical objects.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo DrawLabelInfo = { "DrawLabels", "Draw Labels", - "Determines whether labels should be drawn or hidden", + "Determines whether labels should be drawn or hidden.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo MeshColorInfo = { "MeshColor", "Meshes colors", - "The defined colors for the meshes to be rendered", - // @VISIBILITY(1.25) + "The defined colors for the meshes to be rendered.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RenderOptionInfo = { "RenderOption", "Render Option", - "Debug option for rendering of billboards and texts", + "Debug option for rendering of billboards and texts.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/exoplanets/exoplanetsmodule.cpp b/modules/exoplanets/exoplanetsmodule.cpp index bfc6137b23..454b89fbcc 100644 --- a/modules/exoplanets/exoplanetsmodule.cpp +++ b/modules/exoplanets/exoplanetsmodule.cpp @@ -53,28 +53,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Decides if the GUI for this module should be enabled", + "Decides if the GUI for this module should be enabled.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DataFolderInfo = { "DataFolder", "Data Folder", - "The path to the folder containing the exoplanets data and lookup table", + "The path to the folder containing the exoplanets data and lookup table.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BvColorMapInfo = { "BvColormap", "B-V Colormap", - "The path to a cmap file that maps a B-V color index to an RGB color", + "The path to a cmap file that maps a B-V color index to an RGB color.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StarTextureInfo = { "StarTexture", "Star Texture", - "The path to a grayscale image that is used for the host star surfaces", + "The path to a grayscale image that is used for the host star surfaces.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -82,7 +82,7 @@ namespace { "StarGlareTexture", "Star Glare Texture", "The path to a grayscale image that is used for the glare effect of the " - "host stars", + "host stars.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -90,7 +90,7 @@ namespace { "NoDataTexture", "No Data Star Texture", "A path to a texture that is used to represent that there is missing data about " - "the star. For example no color information", + "the star. For example no color information.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -98,7 +98,7 @@ namespace { "OrbitDiscTexture", "Orbit Disc Texture", "A path to a 1-dimensional image used as a transfer function for the " - "exoplanets' orbit uncertainty disc", + "exoplanets' orbit uncertainty disc.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -106,7 +106,7 @@ namespace { "HabitableZoneTexture", "Habitable Zone Texture", "A path to a 1-dimensional image used as a transfer function for the " - "habitable zone disc", + "habitable zone disc.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -115,7 +115,7 @@ namespace { "Comparison Circle Color", "Decides the color of the 1 AU size comparison circles that are generated as " "part of an exoplanet system. Changing the color will not modify already " - "existing circles", + "existing circles.", openspace::properties::Property::Visibility::NoviceUser }; @@ -123,8 +123,7 @@ namespace { "ShowComparisonCircle", "Show Comparison Circle", "If true, the 1 AU size comparison circle is enabled per default when an " - "exoplanet system is created", - // @VISIBILITY(1.8) + "exoplanet system is created.", openspace::properties::Property::Visibility::NoviceUser }; @@ -132,7 +131,7 @@ namespace { "ShowOrbitUncertainty", "Show Orbit Uncertainty", "If true, a disc showing the uncertainty for each planetary orbit is enabled per " - "default when an exoplanet system is created", + "default when an exoplanet system is created.", openspace::properties::Property::Visibility::User }; @@ -140,7 +139,7 @@ namespace { "ShowHabitableZone", "Show Habitable Zone", "If true, the habitable zone disc is enabled per default when an exoplanet " - "system is created", + "system is created.", openspace::properties::Property::Visibility::User }; @@ -148,8 +147,7 @@ namespace { "UseOptimisticZone", "Use Optimistic Zone Boundaries", "If true, the habitable zone is computed with optimistic boundaries per default " - "when an exoplanet system is created", - // @VISIBILITY(2.8) + "when an exoplanet system is created.", openspace::properties::Property::Visibility::User }; @@ -157,8 +155,7 @@ namespace { "HabitableZoneOpacity", "Habitable Zone Opacity", "The opacity value used for the habitable zone renderable for a created " - "exoplanet system", - // @VISIBILITY(1.5) + "exoplanet system.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/exoplanets/rendering/renderableorbitdisc.cpp b/modules/exoplanets/rendering/renderableorbitdisc.cpp index edd8f9a81f..5e81661183 100644 --- a/modules/exoplanets/rendering/renderableorbitdisc.cpp +++ b/modules/exoplanets/rendering/renderableorbitdisc.cpp @@ -49,14 +49,14 @@ namespace { "Texture", "Texture", "This value is the path to a texture on disk that contains a one-dimensional " - "texture which is used for the color", + "texture which is used for the color.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value specifies the semi-major axis of the orbit, in meter", + "This value specifies the semi-major axis of the orbit, in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -64,7 +64,7 @@ namespace { "Eccentricity", "Eccentricity", "This value determines the eccentricity, that is the deviation from a perfect " - "sphere, for this orbit", + "sphere, for this orbit.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -74,7 +74,7 @@ namespace { "This property determines the width of the disc. The values specify the lower " "and upper deviation from the semi major axis, respectively. The values are " "relative to the size of the semi-major axis. That is, 0 means no deviation " - "from the semi-major axis and 1 is a whole semi-major axis's worth of deviation", + "from the semi-major axis and 1 is a whole semi-major axis's worth of deviation.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -82,8 +82,7 @@ namespace { "MultiplyColor", "Multiply Color", "If set, the disc's texture is multiplied with this color. Useful for applying a " - "color grayscale images", - // @VISIBILITY(1.5) + "color grayscale images.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/fieldlines/rendering/renderablefieldlines.cpp b/modules/fieldlines/rendering/renderablefieldlines.cpp index f382a7b532..c311b69dd1 100644 --- a/modules/fieldlines/rendering/renderablefieldlines.cpp +++ b/modules/fieldlines/rendering/renderablefieldlines.cpp @@ -71,10 +71,8 @@ namespace { constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = { "Stepsize", - //"StepSize", - "Fieldline Step Size", + "Fieldline Step Size.", "", // @TODO Missing documentation - // @VISIBILITY(2.75) openspace::properties::Property::Visibility::User }; diff --git a/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp b/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp index e68845d67c..e72436b3e9 100644 --- a/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp +++ b/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp @@ -53,110 +53,104 @@ namespace { "ColorMethod", "Color Method", "Color lines uniformly or using color tables based on extra quantities like, for " - "examples, temperature or particle density", + "examples, temperature or particle density.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorQuantityInfo = { "ColorQuantity", "Quantity to Color By", - "Quantity used to color lines if the 'By Quantity' color method is selected", - // @VISIBILITY(2.67) + "Quantity used to color lines if the 'By Quantity' color method is selected.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorMinMaxInfo = { "ColorQuantityMinMax", "ColorTable Min Value", - "Value to map to the lowest and highest end of the color table", + "Value to map to the lowest and highest end of the color table.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorTablePathInfo = { "ColorTablePath", "Path to Color Table", - "Color Table/Transfer Function to use for 'By Quantity' coloring", + "Color Table/Transfer Function to use for 'By Quantity' coloring.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorUniformInfo = { "Color", "Uniform Line Color", - "The uniform color of lines shown when 'Color Method' is set to 'Uniform'", - // @VISIBILITY(1.67) + "The uniform color of lines shown when 'Color Method' is set to 'Uniform'.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ColorUseABlendingInfo = { "ABlendingEnabled", "Additive Blending", - "Activate/deactivate additive blending", + "Activate/deactivate additive blending.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DomainEnabledInfo = { "DomainEnabled", "Domain Limits", - "Enable/Disable domain limits", + "Enable/Disable domain limits.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DomainXInfo = { "LimitsX", "X-limits", - "Valid range along the X-axis. [Min, Max]", + "Valid range along the X-axis. [Min, Max].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DomainYInfo = { "LimitsY", "Y-limits", - "Valid range along the Y-axis. [Min, Max]", + "Valid range along the Y-axis. [Min, Max].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DomainZInfo = { "LimitsZ", "Z-limits", - "Valid range along the Z-axis. [Min, Max]", + "Valid range along the Z-axis. [Min, Max].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DomainRInfo = { "LimitsR", "Radial limits", - "Valid radial range. [Min, Max]", + "Valid radial range. [Min, Max].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FlowColorInfo = { "FlowColor", "Flow Color", - "Color of particles flow direction indication", - // @VISIBILITY(1.33) + "Color of particles flow direction indication.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FlowEnabledInfo = { "FlowEnabled", "Flow Direction", "Toggles the rendering of moving particles along the lines. Can, for example, " - "illustrate magnetic flow", - // @VISIBILITY(1.67) + "illustrate magnetic flow.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FlowReversedInfo = { "Reversed", "Reversed Flow", - "Toggle to make the flow move in the opposite direction", + "Toggle to make the flow move in the opposite direction.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FlowParticleSizeInfo = { "ParticleSize", "Particle Size", - "Size of the particles", - // @VISIBILITY(2.33) + "Size of the particles.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FlowParticleSpacingInfo = { "ParticleSpacing", "Particle Spacing", - "Spacing inbetween particles", - // @VISIBILITY(2.33) + "Spacing inbetween particles.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FlowSpeedInfo = { "Speed", "Speed", - "Speed of the flow", + "Speed of the flow.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MaskingEnabledInfo = { @@ -165,32 +159,31 @@ namespace { "Enable/disable masking. Use masking to show lines where a given quantity is " "within a given range, for example, if you only want to see where the " "temperature is between 10 and 20 degrees. Also used for masking out line " - "topologies like solar wind & closed lines", + "topologies like solar wind & closed lines.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaskingMinMaxInfo = { "MaskingMinLimit", "Lower Limit", - "Lower and upper limit of the valid masking range", + "Lower and upper limit of the valid masking range.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaskingQuantityInfo = { "MaskingQuantity", "Quantity used for Masking", - "Quantity used for masking", + "Quantity used for masking.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width of the fieldlines", - // @VISIBILITY(1.33) + "This value specifies the line width of the fieldlines.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo TimeJumpButtonInfo = { "TimeJumpToStart", "Jump to Start Of Sequence", - "Performs a time jump to the start of the sequence", + "Performs a time jump to the start of the sequence.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/gaia/rendering/renderablegaiastars.cpp b/modules/gaia/rendering/renderablegaiastars.cpp index ee99034969..ecb71c2a30 100644 --- a/modules/gaia/rendering/renderablegaiastars.cpp +++ b/modules/gaia/rendering/renderablegaiastars.cpp @@ -57,7 +57,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo FilePathInfo = { "File", "File Path", - "The path to the file with data for the stars to be rendered", + "The path to the file with data for the stars to be rendered.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -71,8 +71,7 @@ namespace { "data, construct an Octree and render it. 'BinaryOctree' will read a constructed " "Octree from binary file and render full data. 'StreamOctree' will read an index " "file with full Octree structure and then stream nodes during runtime. (This " - "option is suited for bigger datasets)", - // @VISIBILITY(3.67) + "option is suited for bigger datasets).", openspace::properties::Property::Visibility::AdvancedUser }; @@ -81,7 +80,7 @@ namespace { "Render Mode", "This value determines which predefined columns to use in rendering. If " "'Static' only the position of the stars is used. 'Color' uses position + color " - "parameters and 'Motion' uses pos, color as well as velocity for the stars", + "parameters and 'Motion' uses pos, color as well as velocity for the stars.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -93,7 +92,7 @@ namespace { "filter. If 'Billboard_*' is chosen then the geometry shaders will generate " "screen-faced billboards for all stars. For '*_SSBO' the data will be stored in " "Shader Storage Buffer Objects while '*_VBO' uses Vertex Buffer Objects for the " - "streaming. OBS! SSBO won't work on Apple", + "streaming. OBS! SSBO won't work on Apple.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -101,7 +100,7 @@ namespace { "Texture", "Point Spread Function Texture", "The path to the texture that should be used as a point spread function for the " - "stars", + "stars.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -109,8 +108,7 @@ namespace { "LuminosityMultiplier", "Luminosity Multiplier", "Factor by which to multiply the luminosity with. [Works in Color and Motion " - "modes]", - // @VISIBILITY(2.33) + "modes].", openspace::properties::Property::Visibility::User }; @@ -118,8 +116,7 @@ namespace { "MagnitudeBoost", "Magnitude Boost", "Sets what percent of the star magnitude that will be used as boost to star " - "size. [Works only with billboards in Color and Motion modes]", - // @VISIBILITY(2.33) + "size. [Works only with billboards in Color and Motion modes].", openspace::properties::Property::Visibility::User }; @@ -128,24 +125,21 @@ namespace { "Cut Off Threshold", "Set threshold for when to cut off star rendering. Stars closer than this " "threshold are given full opacity. Farther away, stars dim proportionally to the " - "4-logarithm of their distance", - // @VISIBILITY(2.33) + "4-logarithm of their distance.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SharpnessInfo = { "Sharpness", "Sharpness", - "Adjust star sharpness. [Works only with billboards]", - // @VISIBILITY(?) + "Adjust star sharpness. [Works only with billboards].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BillboardSizeInfo = { "BillboardSize", "Billboard Size", - "Set the billboard size of all stars. [Works only with billboards]", - // @VISIBILITY(?) + "Set the billboard size of all stars. [Works only with billboards].", openspace::properties::Property::Visibility::AdvancedUser }; @@ -153,7 +147,7 @@ namespace { "CloseUpBoostDist", "Close-Up Boost Distance [pc]", "Set the distance where stars starts to increase in size. Unit is Parsec [Works " - "only with billboards]", + "only with billboards].", openspace::properties::Property::Visibility::AdvancedUser }; @@ -161,7 +155,7 @@ namespace { "FilterSize", "Filter Size [px]", "Set the filter size in pixels used in tonemapping for point splatting rendering" - "[Works only with points]", + "[Works only with points].", openspace::properties::Property::Visibility::AdvancedUser }; @@ -169,7 +163,7 @@ namespace { "Sigma", "Normal Distribution Sigma", "Set the normal distribution sigma used in tonemapping for point splatting " - "rendering. [Works only with points]", + "rendering. [Works only with points].", openspace::properties::Property::Visibility::AdvancedUser }; @@ -179,7 +173,7 @@ namespace { "Determines how many additional nodes around the camera that will be fetched " "from disk. The first value determines how many additional layers of parents " "that will be fetched. The second value determines how many layers of descendant " - "that will be fetched from the found parents", + "that will be fetched from the found parents.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -189,7 +183,7 @@ namespace { "Set the threshold for how big the elliptic weight of a pixel has to be to " "contribute to the final elliptic shape. A smaller value gives a more visually " "pleasing result while a bigger value will speed up the rendering on skewed " - "frustums (aka Domes)", + "frustums (aka Domes).", openspace::properties::Property::Visibility::AdvancedUser }; @@ -197,7 +191,7 @@ namespace { "ColorMap", "Color Texture", "The path to the texture that is used to convert from the magnitude of the star " - "to its color. The texture is used as a one dimensional lookup function", + "to its color. The texture is used as a one dimensional lookup function.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -206,7 +200,7 @@ namespace { "First Row to Read", "Defines the first row that will be read from the specified FITS file No need to " "define if data already has been processed. [Works only with " - "FileReaderOption::Fits]", + "FileReaderOption::Fits].", openspace::properties::Property::Visibility::AdvancedUser }; @@ -215,7 +209,7 @@ namespace { "Last Row to Read", "Defines the last row that will be read from the specified FITS file; has to be " "equal to or greater than FirstRow. No need to define if data already has been " - "processed. [Works only with FileReaderOption::Fits]", + "processed. [Works only with FileReaderOption::Fits].", openspace::properties::Property::Visibility::AdvancedUser }; @@ -224,16 +218,14 @@ namespace { "Column Names", "A list of strings with the names of all the columns that are to be read from " "the specified FITS file. No need to define if data already has been processed. " - "[Works only with FileReaderOption::Fits]", - // @VISIBILITY(3.67) + "[Works only with FileReaderOption::Fits].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo NumRenderedStarsInfo = { "NumRenderedStars", "Rendered Stars", - "The number of rendered stars in the current frame", - // @VISIBILITY(3.67) + "The number of rendered stars in the current frame.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -241,8 +233,7 @@ namespace { "CpuRamBudget", "CPU RAM Budget", "Current remaining budget (bytes) on the CPU RAM for loading more node data " - "files", - // @VISIBILITY(3.33) + "files.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -250,8 +241,7 @@ namespace { "GpuStreamBudget", "GPU Stream Budget", "Current remaining memory budget [in number of chunks] on the GPU for streaming " - "additional stars", - // @VISIBILITY(3.67) + "additional stars.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -259,15 +249,14 @@ namespace { "LodPixelThreshold", "LOD Pixel Threshold", "The number of total pixels a nodes AABB can have in clipping space before its " - "parent is fetched as LOD cache", + "parent is fetched as LOD cache.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaxGpuMemoryPercentInfo = { "MaxGpuMemoryPercent", "Max GPU Memory", - "Sets the max percent of existing GPU memory budget that the streaming will use", - // @VISIBILITY(3.33) + "Sets the max percent of existing GPU memory budget that the streaming will use.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -275,8 +264,7 @@ namespace { "MaxCpuMemoryPercent", "Max CPU Memory", "Sets the max percent of existing CPU memory budget that the streaming of files " - "will use", - // @VISIBILITY(3.33) + "will use.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -285,7 +273,7 @@ namespace { "PosX Threshold", "If defined then only stars with Position X values between [min, max] will be " "rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is " - "read as +Inf). Measured in kiloParsec", + "read as +Inf). Measured in kiloParsec.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -294,7 +282,7 @@ namespace { "PosY Threshold", "If defined then only stars with Position Y values between [min, max] will be " "rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is " - "read as +Inf). Measured in kiloParsec", + "read as +Inf). Measured in kiloParsec.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -303,7 +291,7 @@ namespace { "PosZ Threshold", "If defined then only stars with Position Z values between [min, max] will be " "rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is " - "read as +Inf). Measured in kiloParsec", + "read as +Inf). Measured in kiloParsec.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -313,7 +301,7 @@ namespace { "If defined then only stars with G mean magnitude values between [min, max] will " "be rendered (if min is set to 20.0 it is read as -Inf, if max is set to 20.0 it " "is read as +Inf). If min = max then all values equal min|max will be filtered " - "away", + "away.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -322,7 +310,8 @@ namespace { "Bp-Rp Threshold", "If defined then only stars with Bp-Rp color values between [min, max] will be " "rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is " - "read as +Inf). If min = max then all values equal min|max will be filtered away", + "read as +Inf). If min = max then all values equal min|max will be filtered " + "away.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -331,15 +320,14 @@ namespace { "Dist Threshold", "If defined then only stars with Distances values between [min, max] will be " "rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is " - "read as +Inf). Measured in kParsec", + "read as +Inf). Measured in kParsec.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ReportGlErrorsInfo = { "ReportGlErrors", "Report GL Errors", - "If set to true, any OpenGL errors will be reported if encountered", - // @VISIBILITY(3.67) + "If set to true, any OpenGL errors will be reported if encountered.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/galaxy/rendering/renderablegalaxy.cpp b/modules/galaxy/rendering/renderablegalaxy.cpp index ea11d39242..0e53203d10 100644 --- a/modules/galaxy/rendering/renderablegalaxy.cpp +++ b/modules/galaxy/rendering/renderablegalaxy.cpp @@ -78,7 +78,7 @@ namespace { "VolumeRenderingEnabled", "Volume Rendering", "If this value is enabled, the volume rendering component of the galaxy " - "rendering is turned on. Otherwise, the volume rendering is skipped", + "rendering is turned on. Otherwise, the volume rendering is skipped.", openspace::properties::Property::Visibility::User }; @@ -86,7 +86,7 @@ namespace { "StarRenderingEnabled", "Star Rendering", "If this value is enabled, the point-based star rendering component of the " - "galaxy rendering is turned on. Otherwise, the volume rendering is skipped", + "galaxy rendering is turned on. Otherwise, the volume rendering is skipped.", openspace::properties::Property::Visibility::User }; @@ -95,7 +95,7 @@ namespace { "Step Size", "Determines the distance between steps taken in the volume rendering. The lower " "the number is, the better the rendering looks, but also takes more " - "computational resources to render", + "computational resources to render.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -104,8 +104,7 @@ namespace { "Absorption Multiplier", "A unit-less scale factor for the probability of dust absorbing a light " "particle. The amount of absorption determines the spectrum of the light that is " - "emitted from the galaxy", - // @VISIBILITY(2.5) + "emitted from the galaxy.", openspace::properties::Property::Visibility::User }; @@ -113,15 +112,14 @@ namespace { "EmissionMultiply", "Emission Multiplier", "A unit-less scale factor for the amount of light being emitted by dust in the " - "galaxy", - // @VISIBILITY(2.5) + "galaxy.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RotationInfo = { "Rotation", "Euler rotation", - "The internal rotation of the volume rendering in Euler angles", + "The internal rotation of the volume rendering in Euler angles.", openspace::properties::Property::Visibility::Developer }; @@ -129,7 +127,7 @@ namespace { "StarRenderingMethod", "Star Rendering Method", "This value determines which rendering method is used for visualization of the " - "stars", + "stars.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -139,7 +137,7 @@ namespace { "The ratio of point-like stars that are rendered to produce the overall galaxy " "image. At a value of 0, no stars are rendered, at a value of 1 all points " "contained in the dataset are rendered. The specific value chosen is a " - "compromise between image fidelity and rendering performance", + "compromise between image fidelity and rendering performance.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -147,8 +145,7 @@ namespace { { "Downscale", "Downscale Factor Volume Rendering", - "This value sets the downscaling factor when rendering the current volume", - // @VISIBILITY(2.5) + "This value sets the downscaling factor when rendering the current volume.", openspace::properties::Property::Visibility::User }; @@ -156,7 +153,7 @@ namespace { { "Steps", "Number of RayCasting Steps", - "This value set the number of integration steps during the raycasting procedure", + "This value set the number of integration steps during the raycasting procedure.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/globebrowsingmodule.cpp b/modules/globebrowsing/globebrowsingmodule.cpp index 7688d89bda..027417c196 100644 --- a/modules/globebrowsing/globebrowsingmodule.cpp +++ b/modules/globebrowsing/globebrowsingmodule.cpp @@ -98,16 +98,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TileCacheSizeInfo = { "TileCacheSize", "Tile Cache Size", - "The maximum size of the MemoryAwareTileCache, on the CPU and GPU", + "The maximum size of the MemoryAwareTileCache, on the CPU and GPU.", openspace::properties::Property::Visibility::AdvancedUser }; - constexpr openspace::properties::Property::PropertyInfo - DefaultGeoPointTextureInfo = - { + constexpr openspace::properties::Property::PropertyInfo DefaultGeoPointTextureInfo = { "DefaultGeoPointTexture", "Default Geo Point Texture", - "A path to a texture to use as default for GeoJson points" + "A path to a texture to use as default for GeoJson points." }; constexpr openspace::properties::Property::PropertyInfo MRFCacheEnabledInfo = { diff --git a/modules/globebrowsing/src/dashboarditemglobelocation.cpp b/modules/globebrowsing/src/dashboarditemglobelocation.cpp index 740e15d10f..1a41a1deb6 100644 --- a/modules/globebrowsing/src/dashboarditemglobelocation.cpp +++ b/modules/globebrowsing/src/dashboarditemglobelocation.cpp @@ -45,15 +45,15 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DisplayFormatInfo = { "DisplayFormat", "Display Format", - "Choosing the format in which the camera location is displayed", + "Choosing the format in which the camera location is displayed.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SignificantDigitsInfo = { "SignificantDigits", "Significant Digits", - "Determines the number of significant digits that are shown in the location text", - // @VISIBILITY(3.25) + "Determines the number of significant digits that are shown in the location " + "text.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/gdalwrapper.cpp b/modules/globebrowsing/src/gdalwrapper.cpp index de23b519a7..66007bd043 100644 --- a/modules/globebrowsing/src/gdalwrapper.cpp +++ b/modules/globebrowsing/src/gdalwrapper.cpp @@ -42,7 +42,7 @@ namespace { "LogGdalErrors", "Log GDAL errors", "If this value is enabled, any error that is raised by GDAL will be logged using " - "the logmanager. If this value is disabled, any error will be ignored", + "the logmanager. If this value is disabled, any error will be ignored.", openspace::properties::Property::Visibility::Developer }; @@ -50,7 +50,7 @@ namespace { "GdalMaximumCacheSize", "GDAL maximum cache size", "This function sets the maximum amount of RAM memory in MB that GDAL is " - "permitted to use for caching", + "permitted to use for caching.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/geojson/geojsoncomponent.cpp b/modules/globebrowsing/src/geojson/geojsoncomponent.cpp index a296b70dc7..3b9d7ca869 100644 --- a/modules/globebrowsing/src/geojson/geojsoncomponent.cpp +++ b/modules/globebrowsing/src/geojson/geojsoncomponent.cpp @@ -61,14 +61,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether this object will be visible or not", + "This setting determines whether this object will be visible or not.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FileInfo = { "File", "File", - "Path to the GeoJSON file to base the rendering on", + "Path to the GeoJSON file to base the rendering on.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -76,7 +76,7 @@ namespace { "HeightOffset", "Height Offset", "A height offset value, in meters. Useful for moving a feature closer to or " - "farther away from the surface", + "farther away from the surface.", openspace::properties::Property::Visibility::NoviceUser }; @@ -86,7 +86,7 @@ namespace { "A latitude and longitude offset value, in decimal degrees. Can be used to " "move the object on the surface and correct potential mismatches with other " "renderings. Note that changing it during runtime leads to all positions being " - "recomputed", + "recomputed.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -94,7 +94,7 @@ namespace { "DrawWireframe", "Wireframe", "If true, draw the wire frame of the polygons. Used for testing and to " - "investigate tessellation results", + "investigate tessellation results.", openspace::properties::Property::Visibility::Developer }; @@ -103,7 +103,7 @@ namespace { "Prevent Update From Heightmap", "If true, the polygon mesh will not be automatically updated based on the " "heightmap, even if the 'RelativeToGround' altitude option is set and the " - "heightmap updates. The data can still be force updated", + "heightmap updates. The data can still be force updated.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -111,7 +111,7 @@ namespace { "ForceUpdateHeightData", "Force Update Height Data", "Triggering this leads to a recomputation of the heights based on the globe " - "height map value at the geometry's positions", + "height map value at the geometry's positions.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -120,7 +120,7 @@ namespace { "Points Aligned to", "Decides how the billboards for the points should be rendered in terms of up " "direction and whether the plane should face the camera. See details on the " - "different options in the wiki", + "different options in the wiki.", openspace::properties::Property::Visibility::User }; @@ -128,7 +128,7 @@ namespace { "FlyToFeature", "Fly To Feature", "Triggering this leads to the camera flying to a position that show the GeoJson " - "feature. The flight will account for any lat, long or height offset", + "feature. The flight will account for any lat, long or height offset.", openspace::properties::Property::Visibility::NoviceUser }; @@ -136,7 +136,7 @@ namespace { "CentroidCoordinate", "Centroid Coordinate", "The lat long coordinate of the centroid position of the read geometry. Note " - "that this value does not incude the offset", + "that this value does not incude the offset.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -144,7 +144,7 @@ namespace { "BoundingBox", "Bounding Box", "The lat long coordinates of the lower and upper corner of the bounding box of " - "the read geometry. Note that this value does not incude the offset", + "the read geometry. Note that this value does not incude the offset.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -152,7 +152,7 @@ namespace { "PointSizeScale", "Point Size Scale", "An extra scale value that can be used to increase or decrease the scale of any " - "rendered points in the component, even if a value is set from the GeoJson file", + "rendered points in the component, even if a value is set from the GeoJson file.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/globebrowsing/src/geojson/geojsonproperties.cpp b/modules/globebrowsing/src/geojson/geojsonproperties.cpp index 1dab4ec7e8..b4f358fee1 100644 --- a/modules/globebrowsing/src/geojson/geojsonproperties.cpp +++ b/modules/globebrowsing/src/geojson/geojsonproperties.cpp @@ -157,7 +157,7 @@ namespace { "Opacity", "Opacity", "This value determines the opacity of this object. A value of 0 means " - "completely transparent", + "completely transparent.", openspace::properties::Property::Visibility::NoviceUser }; @@ -165,7 +165,7 @@ namespace { "Color", "Color", "The color of the rendered geometry. For points it will be used as a multiply" - "color for any provided texture", + "color for any provided texture.", openspace::properties::Property::Visibility::NoviceUser }; @@ -173,7 +173,7 @@ namespace { "FillOpacity", "Fill Opacity", "This value determines the opacity of the filled portion of a polygon. Will " - "also be used for extruded features", + "also be used for extruded features.", openspace::properties::Property::Visibility::NoviceUser }; @@ -181,14 +181,14 @@ namespace { "FillColor", "Fill Color", "The color of the filled portion of a rendered polygon. Will also be used for " - "extruded features", + "extruded features.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "The width of any rendered lines", + "The width of any rendered lines.", openspace::properties::Property::Visibility::User }; @@ -196,7 +196,7 @@ namespace { "PointSize", "Point Size", "The size of any rendered points. The size will be scaled based on the " - "bounding sphere of the globe", + "bounding sphere of the globe.", openspace::properties::Property::Visibility::NoviceUser }; @@ -213,7 +213,7 @@ namespace { "Extrude", "Extrude", "If true, extrude the geometry to intersect the globe.Lines/polygons will be" - "extruded with polygons,and points with lines ", + "extruded with polygons,and points with lines.", openspace::properties::Property::Visibility::User }; @@ -222,7 +222,7 @@ namespace { "Perform Shading", "If true, perform shading on any create meshes, either from polygons or " "extruded lines. The shading will be computed based on any light sources of the " - "GeoJson component", + "GeoJson component.", openspace::properties::Property::Visibility::User }; @@ -233,7 +233,7 @@ namespace { "be interpreted. Absolute means that the height is interpreted as the height " "above the reference ellipsoid, while RelativeToGround takes the height map " "into account. For coordinates with only two values (latitude and longitude), " - "the height is considered to be equal to zero", + "the height is considered to be equal to zero.", openspace::properties::Property::Visibility::User }; @@ -241,7 +241,7 @@ namespace { "PointTextureAnchor", "Point Texture Anchor", "Decides the placement of the point texture in relation to the position. " - "Default is a the bottom of the texture, but it can also be put at the center", + "Default is a the bottom of the texture, but it can also be put at the center.", openspace::properties::Property::Visibility::User }; @@ -251,7 +251,7 @@ namespace { "If false, no tessellation to bend the geometry based on the curvature of the " "planet is performed. This leads to increased performance, but tessellation is " "neccessary for large geometry that spans a big portion of the globe. Otherwise " - "it may intersect the surface", + "it may intersect the surface.", openspace::properties::Property::Visibility::User }; @@ -261,7 +261,7 @@ namespace { "If true, use the 'Tessellation Level' to control the level of detail for the " "tessellation. The distance used will be the 'Tessellation Distance' divided by " "the 'Tessellation Level', so the higher the level value, the smaller each " - "segment in the geomoetry will be", + "segment in the geomoetry will be.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -282,7 +282,7 @@ namespace { "larger than this distance will be automatically subdivided into smaller pieces " "matching this distance, while anything smaller will not be subdivided. Per " "default this will be set to a distance corresponding to about 1 degree " - "longitude on the globe", + "longitude on the globe.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/globelabelscomponent.cpp b/modules/globebrowsing/src/globelabelscomponent.cpp index ce1253a0a6..0f885963c5 100644 --- a/modules/globebrowsing/src/globelabelscomponent.cpp +++ b/modules/globebrowsing/src/globelabelscomponent.cpp @@ -64,30 +64,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Enables and disables labels' rendering", + "Enables and disables labels' rendering.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = { "FontSize", "Font Size", - "Font size for the rendering labels. This is different fromt text size", - // @VISIBILITY(2.75) + "Font size for the rendering labels. This is different fromt text size.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MinMaxSizeInfo = { "MinMaxSize", "Min/Max Text Size", - "Minimum and maximum label size, in pixels", + "Minimum and maximum label size, in pixels.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "LabelsSize", "Labels Size", - "This value affects the size scale of the labels", - // @VISIBILITY(2.5) + "This value affects the size scale of the labels.", openspace::properties::Property::Visibility::User }; @@ -95,16 +93,14 @@ namespace { "HeightOffset", "Height Offset", "This value moves the label away from the globe surface by the specified " - "distance (in meters)", - // @VISIBILITY(2.75) + "distance (in meters).", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "The text color of the labels", - // @VISIBILITY(1.2) + "The text color of the labels.", openspace::properties::Property::Visibility::NoviceUser }; @@ -113,7 +109,7 @@ namespace { "Fade-In Distances", "The distances above the globe's surface at which the labels start fading in or " "out, given in meters. The final distances are also adjusted by the specified " - "height offset", + "height offset.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -121,7 +117,7 @@ namespace { "FadeInEnabled", "Fade In Enabled", "Sets whether the labels fade in when approaching the globe from a distance. If " - "false, no fading happens and the labels immediately has full opacity", + "false, no fading happens and the labels immediately has full opacity.", openspace::properties::Property::Visibility::User }; @@ -129,29 +125,28 @@ namespace { "FadeOutEnabled", "Fade Out Enabled", "Sets whether the labels fade out when approaching the surface of the globe. If " - "false, no fading happens and the labels stays in full opacity", + "false, no fading happens and the labels stays in full opacity.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DisableCullingInfo = { "DisableCulling", "Culling Disabled", - "Labels culling disabled", + "Labels culling disabled.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo DistanceEPSInfo = { "DistanceEPS", "Culling Distance", - "Labels culling distance from globe's center", + "Labels culling distance from globe's center.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo AlignmentOptionInfo = { "AlignmentOption", "Alignment Option", - "Labels are aligned horizontally or circularly related to the planet", - // @VISIBILITY(2.75) + "Labels are aligned horizontally or circularly related to the planet.", openspace::properties::Property::Visibility::User }; diff --git a/modules/globebrowsing/src/globerotation.cpp b/modules/globebrowsing/src/globerotation.cpp index 62dd959b4f..0dbe8ae0d4 100644 --- a/modules/globebrowsing/src/globerotation.cpp +++ b/modules/globebrowsing/src/globerotation.cpp @@ -40,8 +40,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo GlobeInfo = { "Globe", "Attached Globe", - "The globe on which the longitude/latitude is specified", - // @VISIBILITY(2.5) + "The globe on which the longitude/latitude is specified.", openspace::properties::Property::Visibility::User }; @@ -50,8 +49,7 @@ namespace { "Latitude", "The latitude of the location on the globe's surface. The value can range from " "-90 to 90, with negative values representing the southern hemisphere of the " - "globe. The default value is 0.0", - // @VISIBILITY(2.25) + "globe. The default value is 0.0.", openspace::properties::Property::Visibility::User }; @@ -60,8 +58,7 @@ namespace { "Longitude", "The longitude of the location on the globe's surface. The value can range from " "-180 to 180, with negative values representing the western hemisphere of the " - "globe. The default value is 0.0", - // @VISIBILITY(2.25) + "globe. The default value is 0.0.", openspace::properties::Property::Visibility::User }; @@ -69,7 +66,7 @@ namespace { "Angle", "Angle", "A rotation angle that can be used to rotate the object around its own y-axis, " - "which will be pointing out of the globe's surface", + "which will be pointing out of the globe's surface.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -78,16 +75,14 @@ namespace { "Use Heightmap", "If set to true, the heightmap will be used when computing the surface normal. " "This means that the object will be rotated to lay flat on the surface at the " - "given coordinate and follow the shape of the landscape", - // @VISIBILITY(2.5) + "given coordinate and follow the shape of the landscape.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo UseCameraInfo = { "UseCamera", "Use Camera", - "If this value is 'true', the lat and lon are updated to match the camera", - // @VISIBILITY(?) + "If this value is 'true', the lat and lon are updated to match the camera.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/globetranslation.cpp b/modules/globebrowsing/src/globetranslation.cpp index 2d997e1727..8766c99f60 100644 --- a/modules/globebrowsing/src/globetranslation.cpp +++ b/modules/globebrowsing/src/globetranslation.cpp @@ -39,8 +39,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo GlobeInfo = { "Globe", "Attached Globe", - "The globe on which the longitude/latitude is specified", - // @VISIBILITY(2.5) + "The globe on which the longitude/latitude is specified.", openspace::properties::Property::Visibility::User }; @@ -49,8 +48,7 @@ namespace { "Latitude", "The latitude of the location on the globe's surface. The value can range from " "-90 to 90, with negative values representing the southern hemisphere of the " - "globe. The default value is 0.0", - // @VISIBILITY(2.25) + "globe. The default value is 0.0.", openspace::properties::Property::Visibility::User }; @@ -59,8 +57,7 @@ namespace { "Longitude", "The longitude of the location on the globe's surface. The value can range from " "-180 to 180, with negative values representing the western hemisphere of the " - "globe. The default value is 0.0", - // @VISIBILITY(2.25) + "globe. The default value is 0.0.", openspace::properties::Property::Visibility::User }; @@ -69,8 +66,7 @@ namespace { "Altitude", "The altitude in meters. If the 'UseHeightmap' property is 'true', this is an " "offset from the actual surface of the globe. If not, this is an offset from the " - "reference ellipsoid. The default value is 0.0", - // @VISIBILITY(2.75) + "reference ellipsoid. The default value is 0.0.", openspace::properties::Property::Visibility::User }; @@ -79,24 +75,21 @@ namespace { "Use Heightmap", "If this value is 'true', the altitude specified in 'Altitude' will be treated " "as an offset from the heightmap. Otherwise, it will be an offset from the " - "globe's reference ellipsoid. The default value is 'false'", - // @VISIBILITY(2.5) + "globe's reference ellipsoid. The default value is 'false'.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo UseCameraInfo = { "UseCamera", "Use Camera", - "If this value is 'true', the lat and lon are updated to match the camera", - // @VISIBILITY(?) + "If this value is 'true', the lat and lon are updated to match the camera.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UseCameraAltitudeInfo = { "UseCameraAltitude", "Use Camera Altitude", - "If this value is 'true', the altitude is updated to match the camera", - // @VISIBILITY(?) + "If this value is 'true', the altitude is updated to match the camera.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/layer.cpp b/modules/globebrowsing/src/layer.cpp index b1ef0eb2a7..d9d3d92494 100644 --- a/modules/globebrowsing/src/layer.cpp +++ b/modules/globebrowsing/src/layer.cpp @@ -48,7 +48,7 @@ namespace { "Type", "Type", "The type of this Layer. This value is a read-only property and thus cannot be " - "changed", + "changed.", openspace::properties::Property::Visibility::Developer }; @@ -56,7 +56,7 @@ namespace { "BlendMode", "Blend Mode", "This value specifies the blend mode that is applied to this layer. The blend " - "mode determines how this layer is added to the underlying layers beneath", + "mode determines how this layer is added to the underlying layers beneath.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -65,8 +65,7 @@ namespace { "Enabled", "If this value is enabled, the layer will be used for the final composition of " "the planet. If this value is disabled, the layer will be ignored in the " - "composition", - // @VISIBILITY(1.17) + "composition.", openspace::properties::Property::Visibility::NoviceUser }; @@ -74,8 +73,7 @@ namespace { "Reset", "Reset", "If this value is triggered, this layer will be reset. This will delete the " - "local cache for this layer and will trigger a fresh load of all tiles", - // @VISIBILITY(2.5) + "local cache for this layer and will trigger a fresh load of all tiles.", openspace::properties::Property::Visibility::User }; @@ -83,8 +81,7 @@ namespace { "Remove", "Remove", "If this value is triggered, a script will be executed that will remove this " - "layer before the next frame", - // @VISIBILITY(2.75) + "layer before the next frame.", openspace::properties::Property::Visibility::User }; @@ -92,8 +89,7 @@ namespace { "Color", "Color", "If the 'Type' of this layer is a solid color, this value determines what this " - "solid color is", - // @VISIBILITY(2.5) + "solid color is.", openspace::properties::Property::Visibility::User }; @@ -101,7 +97,7 @@ namespace { "GuiDescription", "Gui Description", "This is the description for the scene graph node to be shown in the gui " - "example: Earth is a special place", + "example: Earth is a special place.", openspace::properties::Property::Visibility::Hidden }; diff --git a/modules/globebrowsing/src/layeradjustment.cpp b/modules/globebrowsing/src/layeradjustment.cpp index 8ddf55e323..d46d0eb495 100644 --- a/modules/globebrowsing/src/layeradjustment.cpp +++ b/modules/globebrowsing/src/layeradjustment.cpp @@ -32,7 +32,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ChromaKeyColorInfo = { "ChromaKeyColor", "Chroma Key Color", - "This color is used as the chroma key for the layer that is adjusted", + "This color is used as the chroma key for the layer that is adjusted.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -40,14 +40,14 @@ namespace { "ChromaKeyTolerance", "Chroma Key Tolerance", "This value determines the tolerance that is used to determine whether a color " - "is matching the selected Chroma key", + "is matching the selected Chroma key.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TypeInfo = { "Type", "Type", - "The type of layer adjustment that is applied to the underlying layer", + "The type of layer adjustment that is applied to the underlying layer.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/layergroup.cpp b/modules/globebrowsing/src/layergroup.cpp index c18b78bad2..598c217d1b 100644 --- a/modules/globebrowsing/src/layergroup.cpp +++ b/modules/globebrowsing/src/layergroup.cpp @@ -40,8 +40,7 @@ namespace { "Blend between levels", "If this value is enabled, images between different levels are interpolated, " "rather than switching between levels abruptly. This makes transitions smoother " - "and more visually pleasing", - // @VISIBILITY(2.75) + "and more visually pleasing.", openspace::properties::Property::Visibility::User }; } // namespace diff --git a/modules/globebrowsing/src/layerrendersettings.cpp b/modules/globebrowsing/src/layerrendersettings.cpp index 144289775a..5cdfb11116 100644 --- a/modules/globebrowsing/src/layerrendersettings.cpp +++ b/modules/globebrowsing/src/layerrendersettings.cpp @@ -29,16 +29,14 @@ namespace { "SetDefault", "Set Default", "If this value is triggered it will reset all of these values to their default " - "values", - // @VISIBILITY(1.67) + "values.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo GammaInfo = { "Gamma", "Gamma", - "This value is used as an exponent to adjust the color for each tile", - // @VISIBILITY(2.67) + "This value is used as an exponent to adjust the color for each tile.", openspace::properties::Property::Visibility::User }; @@ -46,8 +44,7 @@ namespace { "Multiplier", "Multiplier", "This value is used as a multiplier to adjust the color applied after taking the " - "gamma value as an exponent", - // @VISIBILITY(2.67) + "gamma value as an exponent.", openspace::properties::Property::Visibility::User }; @@ -55,7 +52,7 @@ namespace { "Offset", "Offset", "This value is used as an additive modifier to adjust the color applied after " - "the gamma exponent and the multiplier has been performed", + "the gamma exponent and the multiplier has been performed.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/globebrowsing/src/memoryawaretilecache.cpp b/modules/globebrowsing/src/memoryawaretilecache.cpp index e9d0a5d5c0..41a43872ce 100644 --- a/modules/globebrowsing/src/memoryawaretilecache.cpp +++ b/modules/globebrowsing/src/memoryawaretilecache.cpp @@ -39,7 +39,7 @@ namespace { "CpuAllocatedTileData", "CPU allocated tile data (MB)", "This value denotes the amount of RAM memory (in MB) that this tile cache is " - "utilizing", + "utilizing.", openspace::properties::Property::Visibility::Developer }; @@ -47,7 +47,7 @@ namespace { "GpuAllocatedTileData", "GPU allocated tile data (MB)", "This value denotes the amount of GPU memory (in MB) that this tile cache is " - "utilizing", + "utilizing.", openspace::properties::Property::Visibility::Developer }; @@ -478,7 +478,7 @@ void MemoryAwareTileCache::createTileAndPut(ProviderTileKey key, RawTile rawTile ); tex->setPixelData(rawTile.imageData.release(), Texture::TakeOwnership::Yes); rawTile.imageData = nullptr; - [[ maybe_unused ]] const size_t expectedSize = tex->expectedPixelDataSize(); + [[maybe_unused]] const size_t expectedSize = tex->expectedPixelDataSize(); const size_t numBytes = rawTile.textureInitData->totalNumBytes; ghoul_assert(expectedSize == numBytes, "Pixel data size is incorrect"); _numTextureBytesAllocatedOnCPU += numBytes - previousExpectedDataSize; diff --git a/modules/globebrowsing/src/rawtiledatareader.cpp b/modules/globebrowsing/src/rawtiledatareader.cpp index 0b0ff30478..23b6d5ced4 100644 --- a/modules/globebrowsing/src/rawtiledatareader.cpp +++ b/modules/globebrowsing/src/rawtiledatareader.cpp @@ -220,7 +220,7 @@ PixelRegion highestResPixelRegion(const GeodeticPatch& geodeticPatch, } RawTile::ReadError postProcessErrorCheck(const RawTile& rawTile, - [[ maybe_unused ]] size_t nRasters, + [[maybe_unused]] size_t nRasters, float noDataValue) { ghoul_assert(nRasters == rawTile.tileMetaData.nValues, "Wrong numbers of max values"); diff --git a/modules/globebrowsing/src/renderableglobe.cpp b/modules/globebrowsing/src/renderableglobe.cpp index 42127e1c38..2845affd15 100644 --- a/modules/globebrowsing/src/renderableglobe.cpp +++ b/modules/globebrowsing/src/renderableglobe.cpp @@ -112,7 +112,7 @@ namespace { "ShowChunkEdges", "Show chunk edges", "If this value is set to 'true', the borders between chunks are shown using a " - "red highlight", + "red highlight.", openspace::properties::Property::Visibility::Developer }; @@ -121,8 +121,7 @@ namespace { "Level by projected area (else distance)", "If this value is set to 'true', the tile level is determined by the area " "projected on screen. If it is 'false', the distance to the center of the tile " - "is used instead", - // @VISIBILITY(?) + "is used instead.", openspace::properties::Property::Visibility::Developer }; @@ -137,8 +136,7 @@ namespace { "ResetTileProviders", "Reset tile providers", "If this property is triggered, all tile provides for the globe are reset and " - "data is reloaded from scratch", - // @VISIBILITY(3.67) + "data is reloaded from scratch.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -148,7 +146,7 @@ namespace { "This value determines the tile level that is used as the cut off between " "rendering tiles using the globe model rendering vs the flat in-game rendering " "method. This value is a tradeoff between not having precision errors in the " - "rendering and represting a tile as flat or curved", + "rendering and represting a tile as flat or curved.", openspace::properties::Property::Visibility::Developer }; @@ -158,7 +156,7 @@ namespace { "Data availability checks before LOD factor impact", "The number of checks that have to fail/succeed in a row before the dynamic " "level-of-detail adjusts the actual level-of-detail up or down during a session " - "recording", + "recording.", openspace::properties::Property::Visibility::Developer }; @@ -167,7 +165,7 @@ namespace { "Perform shading", "This value determines whether there should be lighting applied to the surface " "of the globe. Note that if there is an atmosphere attached to the planet, there " - "is a separate setting to control the shadowing induced by the atmosphere part", + "is a separate setting to control the shadowing induced by the atmosphere part.", openspace::properties::Property::Visibility::NoviceUser }; @@ -176,8 +174,7 @@ namespace { "Use Accurate Normals", "This value determines whether higher-accuracy normals should be used in the " "rendering. These normals are calculated based on the height field information " - "and are thus only available if the planet has a height map", - // @VISIBILITY(3.5) + "and are thus only available if the planet has a height map.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -186,30 +183,28 @@ namespace { "Name of the light source", "This value is the name of a scene graph node that should be used as the source " "of illumination for the globe. If this value is not specified, the solar " - "system's Sun is used instead", + "system's Sun is used instead.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EclipseInfo = { "Eclipse", "Eclipse", - "Enables/Disable Eclipse shadows", + "Enables/Disable Eclipse shadows.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EclipseHardShadowsInfo = { "EclipseHardShadows", "Eclipse Hard Shadows", - "Enables the rendering of eclipse shadows using hard shadows", - // @VISIBILITY(2.67) + "Enables the rendering of eclipse shadows using hard shadows.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShadowMappingInfo = { "ShadowMapping", "Shadow Mapping", - "Enables shadow mapping algorithm. Used by renderable rings too", - // @VISIBILITY(3.5) + "Enables shadow mapping algorithm. Used by renderable rings, too.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -218,8 +213,7 @@ namespace { "Render at Distance", "Tells the rendering engine not to perform distance based performance culling " "for this globe. Turning this property on will let the globe to be seen at far " - "away distances when normally it would be hidden", - // @VISIBILITY(3.5) + "away distances when normally it would be hidden.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -227,7 +221,7 @@ namespace { "ZFightingPercentage", "Z-Fighting Percentage", "The percentage of the correct distance to the surface being shadowed. Possible " - "values: [0.0, 1.0]", + "values: [0.0, 1.0].", openspace::properties::Property::Visibility::Developer }; @@ -235,7 +229,7 @@ namespace { "NumberShadowSamples", "Number of Shadow Samples", "The number of samples used during shadow mapping calculation (Percentage Closer " - "Filtering)", + "Filtering).", openspace::properties::Property::Visibility::Developer }; @@ -244,7 +238,7 @@ namespace { "Target Level of Detail Scale Factor", "Determines the targeted level-of-detail of the tiles for this globe. A higher " "value means that the tiles rendered are a higher resolution for the same " - "distance of the camera to the planet", + "distance of the camera to the planet.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -252,21 +246,21 @@ namespace { "CurrentLodScaleFactor", "Current Level of Detail Scale Factor (Read Only)", "The currently used scale factor whose target value is deteremined by " - "'TargetLodScaleFactor'", + "'TargetLodScaleFactor'.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OrenNayarRoughnessInfo = { "OrenNayarRoughness", "orenNayarRoughness", - "The roughness factor that is used for the Oren-Nayar lighting mode", + "The roughness factor that is used for the Oren-Nayar lighting mode.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = { "AmbientIntensity", "Ambient Intensity", - "The intensity factor for the ambient light used for light shading", + "The intensity factor for the ambient light used for light shading.", openspace::properties::Property::Visibility::User }; @@ -274,8 +268,7 @@ namespace { "NActiveLayers", "Number of active layers", "This is the number of currently active layers, if this value reaches the " - "maximum, bad things will happen", - // @VISIBILITY(2.5) + "maximum, bad things will happen.", openspace::properties::Property::Visibility::User }; diff --git a/modules/globebrowsing/src/ringscomponent.cpp b/modules/globebrowsing/src/ringscomponent.cpp index 20bc7cd980..846f134121 100644 --- a/modules/globebrowsing/src/ringscomponent.cpp +++ b/modules/globebrowsing/src/ringscomponent.cpp @@ -74,8 +74,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Enable/Disable Rings", - // @VISIBILITY(?) + "Enable/Disable Rings.", openspace::properties::Property::Visibility::User }; @@ -83,7 +82,7 @@ namespace { "Texture", "Texture", "This value is the path to a texture on disk that contains a one-dimensional " - "texture which is used for these rings", + "texture which is used for these rings.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -91,7 +90,7 @@ namespace { "TextureFwrd", "TextureFwrd", "This value is the path to a texture on disk that contains a one-dimensional " - "texture which is used for forward scattering light in these rings", + "texture which is used for forward scattering light in these rings.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -99,7 +98,7 @@ namespace { "TextureBckwrd", "TextureBckwrd", "This value is the path to a texture on disk that contains a one-dimensional " - "texture which is used for backward scattering light in these rings", + "texture which is used for backward scattering light in these rings.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -107,7 +106,7 @@ namespace { "TextureUnlit", "TextureUnlit", "This value is the path to a texture on disk that contains a one-dimensional " - "texture which is used for unlit part in these rings", + "texture which is used for unlit part in these rings.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -115,7 +114,7 @@ namespace { "TextureColor", "TextureColor", "This value is the path to a texture on disk that contains a one-dimensional " - "texture color which is used for unlit part in these rings", + "texture color which is used for unlit part in these rings.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -123,14 +122,14 @@ namespace { "TextureTransparency", "TextureTransparency", "This value is the path to a texture on disk that contains a one-dimensional " - "texture transparency which is used for unlit part in these rings", + "texture transparency which is used for unlit part in these rings.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value specifies the radius of the rings in meter", + "This value specifies the radius of the rings in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -140,7 +139,7 @@ namespace { "This value is used to limit the width of the rings. Each of the two values is " "a value between 0 and 1, where 0 is the center of the ring and 1 is the " "maximum extent at the radius. For example, if the value is {0.5, 1.0}, the " - "ring is only shown between radius/2 and radius. It defaults to {0.0, 1.0}", + "ring is only shown between radius/2 and radius. It defaults to {0.0, 1.0}.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -149,7 +148,7 @@ namespace { "Night Factor", "This value is a multiplicative factor that is applied to the side of the rings " "that is facing away from the Sun. If this value is equal to '1', no darkening " - "of the night side occurs", + "of the night side occurs.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -157,7 +156,7 @@ namespace { "ColorFilter", "Color Filter", "This value affects the filtering out of part of the rings depending on the " - "color values of the texture. The higher value, the more rings are filtered out", + "color values of the texture. The higher value, the more rings are filtered out.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -165,7 +164,7 @@ namespace { "ZFightingPercentage", "Z-Fighting Percentage", "The percentage of the correct distance to the surface being shadowed. " - "Possible values: [0.0, 1.0]", + "Possible values: [0.0, 1.0].", openspace::properties::Property::Visibility::Developer }; @@ -173,7 +172,7 @@ namespace { "NumberShadowSamples", "Number of Shadow Samples", "The number of samples used during shadow mapping calculation " - "(Percentage Closer Filtering)", + "(Percentage Closer Filtering).", openspace::properties::Property::Visibility::Developer }; diff --git a/modules/globebrowsing/src/shadowcomponent.cpp b/modules/globebrowsing/src/shadowcomponent.cpp index 7d0034e24e..c43c4cc9f4 100644 --- a/modules/globebrowsing/src/shadowcomponent.cpp +++ b/modules/globebrowsing/src/shadowcomponent.cpp @@ -65,15 +65,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Enable/Disable Shadows", + "Enable/Disable Shadows.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SaveDepthTextureInfo = { "SaveDepthTextureInfo", "Save Depth Texture", - "Debug", - // @VISIBILITY(3.67) + "Debug.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -81,16 +80,14 @@ namespace { "DistanceFraction", "Distance Fraction", "Distance fraction of original distance from light source to the globe to be " - "considered as the new light source distance", - // @VISIBILITY(3.67) + "considered as the new light source distance.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DepthMapSizeInfo = { "DepthMapSize", "Depth Map Size", - "The depth map size in pixels. You must entry the width and height values", - // @VISIBILITY(3.67) + "The depth map size in pixels. You must entry the width and height values.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp b/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp index b791c499f0..4dc51a7e41 100644 --- a/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp @@ -36,7 +36,7 @@ namespace { "FilePath", "File Path", "The path of the GDAL file or the image file that is to be used in this tile " - "provider", + "provider.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -46,15 +46,14 @@ namespace { "This value is the preferred size (in pixels) for each tile. Choosing the right " "value is a tradeoff between more efficiency (larger images) and better quality " "(smaller images). The tile pixel size has to be smaller than the size of the " - "complete image if a single image is used", - // @VISIBILITY(3.33) + "complete image if a single image is used.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CompressionInfo = { "Compression", "Compression Algorithm", - "The compression algorithm to use for MRF cached tiles", + "The compression algorithm to use for MRF cached tiles.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp index fd2bbc2574..6bb9f3e997 100644 --- a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp @@ -33,8 +33,7 @@ namespace { "Index", "Index", "The index into the list of images that is used to pick the currently displayed " - "image", - // @VISIBILITY(2.33) + "image.", openspace::properties::Property::Visibility::User }; @@ -42,16 +41,14 @@ namespace { "NumberImages", "Number of Images", "The number of images that can be shown. The 'Index' value must be between 0 and " - "this value - 1", - // @VISIBILITY(?) + "this value - 1.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CurrentImageInfo = { "CurrentImage", "Current Image", - "The read-only value of the currently selected image", - // @VISIBILITY(2.33) + "The read-only value of the currently selected image.", openspace::properties::Property::Visibility::User }; @@ -59,7 +56,7 @@ namespace { "FolderPath", "Folder Path", "The path that is used to look for images for this image provider. The path must " - "point to an existing folder that contains images", + "point to an existing folder that contains images.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp index 0ddfef9fd0..1341eb5da3 100644 --- a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp @@ -32,7 +32,7 @@ namespace { "FilePath", "File Path", "The file path that is used for this image provider. The file must point to an " - "image that is then loaded and used for all tiles", + "image that is then loaded and used for all tiles.", openspace::properties::Property::Visibility::User }; diff --git a/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp b/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp index 1456f92ba4..82982310eb 100644 --- a/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp @@ -51,7 +51,7 @@ namespace { "Use Fixed Time", "If this value is enabled, the time-varying timevarying dataset will always use " "the time that is specified in the 'FixedTime' property, rather than using the " - "actual time from OpenSpace", + "actual time from OpenSpace.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -59,7 +59,7 @@ namespace { "FixedTime", "Fixed Time", "If the 'UseFixedTime' is enabled, this time will be used instead of the actual " - "time taken from OpenSpace for the displayed tiles", + "time taken from OpenSpace for the displayed tiles.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/globebrowsing/src/tileprovider/tileindextileprovider.cpp b/modules/globebrowsing/src/tileprovider/tileindextileprovider.cpp index a0b186a5db..018a227375 100644 --- a/modules/globebrowsing/src/tileprovider/tileindextileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/tileindextileprovider.cpp @@ -30,7 +30,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo UniqueBackgroundColors = { "UniqueBackgroundColor", "Unique Background Color", - "If 'true' each index tile will have a unique background color assigned to it", + "If 'true' each index tile will have a unique background color assigned to it.", openspace::properties::Property::Visibility::Developer }; diff --git a/modules/globebrowsing/src/timequantizer.cpp b/modules/globebrowsing/src/timequantizer.cpp index 22a9cc7840..2e02f941a3 100644 --- a/modules/globebrowsing/src/timequantizer.cpp +++ b/modules/globebrowsing/src/timequantizer.cpp @@ -204,24 +204,24 @@ void DateTime::incrementOnce(int value, char unit) { if (singleIncrement(_minute, value, 0, 59)) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'h': if (singleIncrement(_hour, value, 0, 23)) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'd': if (singleIncrement(_day, value, 1, monthSize(_month, _year))) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'M': inBounds = singleIncrement(_month, value, 1, 12); _day = std::clamp(_day, 1, monthSize(_month, _year)); if (inBounds) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'y': _year += value; break; @@ -251,26 +251,26 @@ void DateTime::decrementOnce(int value, char unit) { if (singleDecrement(_minute, value, 0, 59)) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'h': if (singleDecrement(_hour, value, 0, 23)) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'd': if (singleDecrement(_day, value, 1, monthSize(_month == 1 ? 12 : _month - 1, _year))) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'M': inBounds = singleDecrement(_month, value, 1, 12); _day = std::clamp(_day, 1, monthSize(_month, _year)); if (inBounds) { break; } - [[ fallthrough ]]; + [[fallthrough]]; case 'y': _year -= value; break; diff --git a/modules/imgui/imguimodule.cpp b/modules/imgui/imguimodule.cpp index 2521998b77..10073bb2ed 100644 --- a/modules/imgui/imguimodule.cpp +++ b/modules/imgui/imguimodule.cpp @@ -55,14 +55,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether this object will be visible or not", + "This setting determines whether this object will be visible or not.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo CollapsedInfo = { "Collapsed", "Is Collapsed", - "This setting determines whether this window is collapsed or not", + "This setting determines whether this window is collapsed or not.", openspace::properties::Property::Visibility::Developer }; @@ -70,14 +70,14 @@ namespace { "ShowHelpText", "Show tooltip help", "If this value is enabled these kinds of tooltips are shown for most properties " - "explaining what impact they have on the visuals", + "explaining what impact they have on the visuals.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo HelpTextDelayInfo = { "HelpTextDelay", "Tooltip Delay (in s)", - "This value determines the delay in seconds after which the tooltip is shown", + "This value determines the delay in seconds after which the tooltip is shown.", openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/modules/imgui/src/guicomponent.cpp b/modules/imgui/src/guicomponent.cpp index 8f915d23f0..4ad16a8ab0 100644 --- a/modules/imgui/src/guicomponent.cpp +++ b/modules/imgui/src/guicomponent.cpp @@ -28,16 +28,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether this object will be visible or not", - // @VISIBILITY(3.4) + "This setting determines whether this object will be visible or not.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CollapsedInfo = { "Collapsed", "Is Collapsed", - "This setting determines whether this window is collapsed or not", - // @VISIBILITY(3.4) + "This setting determines whether this window is collapsed or not.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/imgui/src/guipropertycomponent.cpp b/modules/imgui/src/guipropertycomponent.cpp index 6725f15668..b91884463d 100644 --- a/modules/imgui/src/guipropertycomponent.cpp +++ b/modules/imgui/src/guipropertycomponent.cpp @@ -42,8 +42,7 @@ namespace { "Use Tree Layout", "If this value is checked, this component will display the properties using a " "tree layout, rather than using a flat map. This value should only be set on " - "property windows that display SceneGraphNodes, or the application might crash", - // @VISIBILITY(3.67) + "property windows that display SceneGraphNodes, or the application might crash.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -52,8 +51,7 @@ namespace { "Tree Ordering", "This list determines the order of the first tree layer if it is used. Elements " "present in this list will be shown first, with an alphabetical ordering for " - "elements not listed", - // @VISIBILITY(3.67) + "elements not listed.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/server/src/serverinterface.cpp b/modules/server/src/serverinterface.cpp index c9bf5a08f5..f2f5272381 100644 --- a/modules/server/src/serverinterface.cpp +++ b/modules/server/src/serverinterface.cpp @@ -40,35 +40,35 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether this server interface is enabled or not", + "This setting determines whether this server interface is enabled or not.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TypeInfo = { "Type", "Type", - "Whether the interface is using a Socket or a WebSocket", + "Whether the interface is using a Socket or a WebSocket.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PortInfo = { "Port", "Port", - "The network port to use for this sevrer interface", + "The network port to use for this sevrer interface.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DefaultAccessInfo = { "DefaultAccess", "Default Access", - "Sets the default access policy: Allow, RequirePassword or Deny", + "Sets the default access policy: Allow, RequirePassword or Deny.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AllowAddressesInfo = { "AllowAddresses", "Allow Addresses", - "IP addresses or domains that should always be allowed access to this interface", + "IP addresses or domains that should always be allowed access to this interface.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -77,21 +77,21 @@ namespace { "RequirePasswordAddresses", "Require Password Addresses", "IP addresses or domains that should be allowed access if they provide a " - "password", + "password.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DenyAddressesInfo = { "DenyAddresses", "Deny Addresses", - "IP addresses or domains that should never be allowed access to this interface", + "IP addresses or domains that should never be allowed access to this interface.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PasswordInfo = { "Password", "Password", - "Password for connecting to this interface", + "Password for connecting to this interface.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/skybrowser/skybrowsermodule.cpp b/modules/skybrowser/skybrowsermodule.cpp index 693d9566ea..c0105f12e6 100644 --- a/modules/skybrowser/skybrowsermodule.cpp +++ b/modules/skybrowser/skybrowsermodule.cpp @@ -42,8 +42,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Decides if the GUI for this module should be enabled", - // @VISIBILITY(2.5) + "Decides if the GUI for this module should be enabled.", openspace::properties::Property::Visibility::User }; @@ -51,7 +50,7 @@ namespace { "ShowTitleInGuiBrowser", "Show Title in Gui Browser", "If true, the name of the currently selected sky browser is shown in the WebGUI " - "browser", + "browser.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -59,8 +58,7 @@ namespace { "AllowCameraRotation", "Allow Camera Rotation", "Toggles if the camera should rotate to look at the sky target if it is going " - "outside of the current field of view", - // @VISIBILITY(1.75) + "outside of the current field of view.", openspace::properties::Property::Visibility::NoviceUser }; @@ -68,21 +66,21 @@ namespace { "CameraRotationSpeed", "Camera Rotation Speed", "The speed of the rotation of the camera when the camera rotates to look at a " - "coordinate which is outside of the field of view", + "coordinate which is outside of the field of view.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TargetSpeedInfo = { "TargetAnimationSpeed", "Target Animation Speed", - "This determines the speed of the animation of the sky target", + "This determines the speed of the animation of the sky target.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo BrowserSpeedInfo = { "BrowserAnimationSpeed", "Field of View Animation Speed", - "This determines the speed of the animation of the field of view in the browser", + "This determines the speed of the animation of the field of view in the browser.", openspace::properties::Property::Visibility::User }; @@ -90,8 +88,7 @@ namespace { "HideTargetsBrowsersWithGui", "Hide Targets and Browsers with GUI", "If checked, the targets and browsers will be disabled when the sky browser " - "panel is minimized", - // @VISIBILITY(2.25) + "panel is minimized.", openspace::properties::Property::Visibility::User }; @@ -99,7 +96,7 @@ namespace { "InverseZoomDirection", "Inverse Zoom Direction", "If checked, the zoom direction of the scroll over the AAS WWT browser will be " - "inversed", + "inversed.", openspace::properties::Property::Visibility::NoviceUser }; @@ -107,7 +104,6 @@ namespace { "SynchronizeAim", "Synchronize Aim", "If checked, the target and the browser will have synchronized aim.", - // @VISIBILITY(3.25) openspace::properties::Property::Visibility::AdvancedUser }; @@ -115,16 +111,14 @@ namespace { "SpaceCraftAnimationTime", "Space Craft Animation Time", "Sets the duration (in seconds) of the animation of the space craft when it is " - "pointed to where the target is aiming", - // @VISIBILITY(2.5) + "pointed to where the target is aiming.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ImageCollectionInfo = { "WwtImageCollectionUrl", "AAS WorldWide Telescope Image Collection Url", - "The url of the image collection which is loaded into AAS WorldWide Telescope", - // @VISIBILITY(3.75) + "The url of the image collection which is loaded into AAS WorldWide Telescope.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/skybrowser/src/browser.cpp b/modules/skybrowser/src/browser.cpp index 333f840c50..7cd47925cc 100644 --- a/modules/skybrowser/src/browser.cpp +++ b/modules/skybrowser/src/browser.cpp @@ -39,23 +39,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DimensionsInfo = { "Dimensions", "Browser Dimensions", - "Set the dimensions of the web browser window", - // @VISIBILITY(3.75) + "Set the dimensions of the web browser window.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UrlInfo = { "Url", "URL", - "The URL to load", - // @VISIBILITY(3.25) + "The URL to load.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ReloadInfo = { "Reload", "Reload", - "Reload the web browser", + "Reload the web browser.", openspace::properties::Property::Visibility::User }; diff --git a/modules/skybrowser/src/renderableskytarget.cpp b/modules/skybrowser/src/renderableskytarget.cpp index 48d39e287e..d948ab1459 100644 --- a/modules/skybrowser/src/renderableskytarget.cpp +++ b/modules/skybrowser/src/renderableskytarget.cpp @@ -50,7 +50,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo crossHairSizeInfo = { "CrosshairSize", "Crosshair Size", - "Determines the size of the crosshair. The size is determined in fov (degrees)", + "Determines the size of the crosshair. The size is determined in fov (degrees).", openspace::properties::Property::Visibility::User }; @@ -58,16 +58,14 @@ namespace { "RectangleThreshold", "Rectangle Threshold", "When the field of view is larger than the rectangle threshold, a rectangle will " - "be rendered in the target", - // @VISIBILITY(2.33) + "be rendered in the target.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "The thickness of the line of the target. The larger number, the thicker line", - // @VISIBILITY(1.33) + "The thickness of the line of the target. The larger number, the thicker line.", openspace::properties::Property::Visibility::NoviceUser }; @@ -75,7 +73,6 @@ namespace { "VerticalFov", "Vertical Field Of View", "The vertical field of view of the target.", - // @VISIBILITY(2.33) openspace::properties::Property::Visibility::User }; @@ -83,7 +80,7 @@ namespace { "ApplyRoll", "Apply Roll", "Always rotate the target to have it's up direction aligned with the up direction " - "of the camera", + "of the camera.", openspace::properties::Property::Visibility::User }; diff --git a/modules/skybrowser/src/screenspaceskybrowser.cpp b/modules/skybrowser/src/screenspaceskybrowser.cpp index ebe5db7eb8..2a5f7f1d88 100644 --- a/modules/skybrowser/src/screenspaceskybrowser.cpp +++ b/modules/skybrowser/src/screenspaceskybrowser.cpp @@ -43,7 +43,7 @@ namespace { "Quality of Texture", "A parameter to set the resolution of the texture. 1 is full resolution and " "slower frame rate. Lower value means lower resolution of texture and faster " - "frame rate", + "frame rate.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -53,15 +53,14 @@ namespace { "Display a copy of this sky browser at an additional position. This copy will " "not be interactive. The position is in RAE (Radius, Azimuth, Elevation) " "coordinates or Cartesian, depending on if the browser uses RAE or Cartesian " - "coordinates", - // @VISIBILITY(2.67) + "coordinates.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DisplayCopyShowInfo = { "ShowDisplayCopy", "Show Display Copy", - "Show the display copy", + "Show the display copy.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -69,7 +68,7 @@ namespace { "IsHidden", "Is Hidden", "If checked, the browser will be not be displayed. If it is not checked, it will " - "be", + "be.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -78,7 +77,6 @@ namespace { "Point Spacecraft", "If checked, spacecrafts will point towards the coordinate of an image upon " "selection.", - // @VISIBILITY(?) openspace::properties::Property::Visibility::User }; diff --git a/modules/space/rendering/renderableconstellationbounds.cpp b/modules/space/rendering/renderableconstellationbounds.cpp index a2e0f3444f..d4fc73dae2 100644 --- a/modules/space/rendering/renderableconstellationbounds.cpp +++ b/modules/space/rendering/renderableconstellationbounds.cpp @@ -48,7 +48,7 @@ namespace { "File", "Vertex File Path", "The file pointed to with this value contains the vertex locations of the " - "constellations", + "constellations.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -56,7 +56,7 @@ namespace { "Color", "Color of constellation lines", "Specifies the color of the constellation lines. The lines are always drawn at " - "full opacity", + "full opacity.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/space/rendering/renderableconstellationlines.cpp b/modules/space/rendering/renderableconstellationlines.cpp index 727c9f7ba1..e0d2136eaa 100644 --- a/modules/space/rendering/renderableconstellationlines.cpp +++ b/modules/space/rendering/renderableconstellationlines.cpp @@ -50,21 +50,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SpeckInfo = { "File", "Constellation Data File Path", - "The file that contains the data for the constellation lines", + "The file that contains the data for the constellation lines.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DrawElementsInfo = { "DrawElements", "Draw Elements", - "Enables/Disables the drawing of the constellations", + "Enables/Disables the drawing of the constellations.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo UnitInfo = { "Unit", "Unit", - "The distance unit used for the constellation lines data", + "The distance unit used for the constellation lines data.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/rendering/renderableconstellationsbase.cpp b/modules/space/rendering/renderableconstellationsbase.cpp index 7de1232b4c..94e838c628 100644 --- a/modules/space/rendering/renderableconstellationsbase.cpp +++ b/modules/space/rendering/renderableconstellationsbase.cpp @@ -44,30 +44,28 @@ namespace { "Constellation Names File Path", "Specifies the file that contains the mapping between constellation " "abbreviations and full names of the constellations. If this value is empty, the " - "abbreviations are used as the full names", + "abbreviations are used as the full names.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "The line width of the constellation", - // @VISIBILITY(1.67) + "The line width of the constellation.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo SelectionInfo = { "ConstellationSelection", "Constellation Selection", - "The constellations that are selected are displayed on the celestial sphere", - // @VISIBILITY(1.33) + "The constellations that are selected are displayed on the celestial sphere.", openspace::properties::Property::Visibility::NoviceUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { "Labels", "Labels", - "The labels for the constellations" + "The labels for the constellations." }; struct [[codegen::Dictionary(RenderableConstellationsBase)]] Parameters { diff --git a/modules/space/rendering/renderableeclipsecone.cpp b/modules/space/rendering/renderableeclipsecone.cpp index e32464c884..a19b70e742 100644 --- a/modules/space/rendering/renderableeclipsecone.cpp +++ b/modules/space/rendering/renderableeclipsecone.cpp @@ -50,7 +50,7 @@ namespace { "This value determines the number of control points that is used to construct " "the shadow geometry. The higher this number, the more detailed the shadow is, " "but it will have a negative impact on the performance. Also note that rendering " - "errors will occur if this value is even", + "errors will occur if this value is even.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -59,14 +59,14 @@ namespace { "Shadow Length", "This value determines the length of the shadow that is cast by the target " "object. The total distance of the shadow is equal to the distance from the " - "target to the Sun multiplied with this value", + "target to the Sun multiplied with this value.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ShowUmbralShadowInfo = { "ShowUmbralShadow", "Show Umbral Shadow", - "If this is enabled, the umbral portioon of the shadow is shown", + "If this is enabled, the umbral portioon of the shadow is shown.", openspace::properties::Property::Visibility::User }; @@ -74,15 +74,14 @@ namespace { "UmbralShadowColor", "Umbral Shadow Color", "This value determines the color that is used for the shadow cylinder of the " - "umbral shadow", - // @VISIBILITY(2.5) + "umbral shadow.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowPenumbralShadowInfo = { "ShowPenumbralShadow", "Show Penumbral Shadow", - "If this is enabled, the penumbral portioon of the shadow is shown", + "If this is enabled, the penumbral portioon of the shadow is shown.", openspace::properties::Property::Visibility::User }; @@ -90,8 +89,7 @@ namespace { "PenumbralShadowColor", "Penumbral Shadow Color", "This value determines the color that is used for the shadow cylinder of the " - "penumbral shadow", - // @VISIBILITY(2.5) + "penumbral shadow.", openspace::properties::Property::Visibility::User }; @@ -99,7 +97,7 @@ namespace { "LightSource", "Light Source", "This value determines the SPICE name of the object that is used as the " - "illuminator for computing the shadow cylinder", + "illuminator for computing the shadow cylinder.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -107,7 +105,7 @@ namespace { "LightSourceFrame", "Light Source Frame", "This value is the SPICE name of the body-fixed reference frame for the light " - "source", + "source.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -115,14 +113,15 @@ namespace { "Shadower", "Shadower", "This value specifies the SPICE name of the object that is casting the shadow on " - "the shadowee", + "the shadowee.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ShadowerFrameInfo = { "ShadowerFrame", "Shadower Frame", - "This value is the SPICE name of the body-fixed reference frame for the shadower", + "This value is the SPICE name of the body-fixed reference frame for the " + "shadower.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -130,7 +129,7 @@ namespace { "Shadowee", "Shadowee", "This value is the SPICE name of object that is receiving the shadow from the " - "shadower", + "shadower.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/rendering/renderablefluxnodes.cpp b/modules/space/rendering/renderablefluxnodes.cpp index 2e7112a6fd..7d1fef1715 100644 --- a/modules/space/rendering/renderablefluxnodes.cpp +++ b/modules/space/rendering/renderablefluxnodes.cpp @@ -65,7 +65,7 @@ namespace { "GOES Energy", "Select which energy bin you want to show. GOES = Geostationary Operational " "Environmental Satellites. Emin01 is values > 10 MeV, Default is Emin03 where " - "values > 100 MeV", + "values > 100 MeV.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -73,87 +73,84 @@ namespace { "ColorMode", "Color Mode", "Color lines uniformly or using color tables based on specific values on nodes, " - "for examples flux values", - // @VISIBILITY(2.5) + "for examples flux values.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorTablePathInfo = { "ColorTablePath", "Path to Color Table", - "Color Table/Transfer Function to use for 'By Flux Value' coloring", + "Color Table/Transfer Function to use for 'By Flux Value' coloring.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StreamColorInfo = { "Color", "Color", - "Color of particles", - // @VISIBILITY(1.5) + "Color of particles.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo NodeSizeInfo = { "NodeSize", "Size of nodes", - "Change the size of the rendered points of the nodes", - // @VISIBILITY(2.5) + "Change the size of the rendered points of the nodes.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ThresholdFluxInfo = { "ThresholdFlux", "Threshold flux value", - "This value specifies the threshold that will be changed with the flux value", + "This value specifies the threshold that will be changed with the flux value.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FilteringInfo = { "FilterLower", "Filtering Lower Value in AU", - "Use filtering to show nodes within a given range", + "Use filtering to show nodes within a given range.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FilteringUpperInfo = { "FilterUpper", "Filtering Upper Value in AU", - "Use filtering to show nodes within a given range", + "Use filtering to show nodes within a given range.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AmountofNodesInfo = { "AmountOfNodes", "Every nth node to render in", - "Show only every nth node", + "Show only every nth node.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DefaultNodeSkipInfo = { "NodeSkip", "Every nth node to render default", - "Show only every nth node outside of skippingmethod", + "Show only every nth node outside of skippingmethod.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EarthNodeSkipInfo = { "NodeSkipEarth", "Every nth node to render close to Earth", - "Show only every nth node outside of skippingmethod", + "Show only every nth node outside of skippingmethod.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ScalingmethodInfo = { "ScalingFlux", "Scale the flux value with color table", - "Use scaling to color nodes with a given method", + "Use scaling to color nodes with a given method.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo NodeskipMethodInfo = { "SkippingNodes", "How to select nodes to skip", - "Methods to select nodes to skip", + "Methods to select nodes to skip.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -161,28 +158,28 @@ namespace { "ColorTableRange", "Color Table Range", "Valid range for the color table as the exponent, with base 10, of flux values. " - "[Min, Max]", + "[Min, Max].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DomainZInfo = { "ZLimit", "Z-limits", - "Valid range along the Z-axis. [Min, Max]", + "Valid range along the Z-axis. [Min, Max].", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FluxColorAlphaInfo = { "FluxColorAlpha", "Flux Color Alpha", - "The value of alpha for the flux color mode", + "The value of alpha for the flux color mode.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FluxNodeskipThresholdInfo = { "SkippingNodesByFlux", "Skipping Nodes By Flux", - "Select nodes to skip depending on flux value", + "Select nodes to skip depending on flux value.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -190,28 +187,28 @@ namespace { RadiusNodeSkipThresholdInfo = { "SkippingNodesByRadius", "Skipping Nodes By Radius", - "Select nodes to skip depending on Radius", + "Select nodes to skip depending on Radius.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DistanceThresholdInfo = { "DistancePlanetThreshold", "Threshold for distance between planet", - "Changes threshold distance for highlighting nodes close to earth", + "Changes threshold distance for highlighting nodes close to earth.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ProximityNodesSizeInfo = { "ProximityNodesSize", "Earths Proximity Nodes Size", - "Changes size of nodes only close to earth", + "Changes size of nodes only close to earth.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaxNodeDistanceSizeInfo = { "MaxNodeDistanceSize", "Max Node Distance Size", - "The maximum size of the nodes at a certin distance", + "The maximum size of the nodes at a certin distance.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -220,28 +217,28 @@ namespace { "CameraPerspectiveEnabled", "Use Camera perspective", "Camera perspective changes the size of the nodes dependent on the distance from " - "camera", + "camera.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DrawingCirclesInfo = { "RenderingCircles", "Render as circles", - "Using fragment shader to draw nodes as circles instead of squares", + "Using fragment shader to draw nodes as circles instead of squares.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DrawingHollowInfo = { "RenderingHollowCircles", "Render as hollow circles", - "Using fragment shader to draw nodes as hollow circles", + "Using fragment shader to draw nodes as hollow circles.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GaussiandAlphaFilterInfo = { "RenderingGaussianAlphaFilter", "Alpha by Gaussian", - "Using fragment shader to draw nodes with Gaussian filter for alpha value", + "Using fragment shader to draw nodes with Gaussian filter for alpha value.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -250,30 +247,28 @@ namespace { "PerspectiveDistanceFactor", "Perspective Distance factor", "This value decides how far away the camera must be to start impacting the node " - "size", + "size.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MinMaxNodeSizeInfo = { "MinMaxNodeSize", "Min & Max node size", - "The minimum and maximum node size", + "The minimum and maximum node size.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo pulseEnabledInfo = { "PulseEnabled", "Nodes close to Earth pulsate", - "Toggles the pulse for nodes close to Earth", - // @VISIBILITY(2.5) + "Toggles the pulse for nodes close to Earth.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo gaussianPulseEnabledInfo = { "GaussianPulseEnabled", "Nodes close to Earth pulsate with alpha by gaussian", - "Toggles the pulse with alpha by gaussian for nodes close to Earth", - // @VISIBILITY(2.5) + "Toggles the pulse with alpha by gaussian for nodes close to Earth.", openspace::properties::Property::Visibility::User }; diff --git a/modules/space/rendering/renderablehabitablezone.cpp b/modules/space/rendering/renderablehabitablezone.cpp index 276d8ea5a5..cc86a6cb19 100644 --- a/modules/space/rendering/renderablehabitablezone.cpp +++ b/modules/space/rendering/renderablehabitablezone.cpp @@ -49,8 +49,7 @@ namespace { "EffectiveTemperature", "Effective Temperature", "The effective temperature of the corresponding star, in Kelvin. " - "Used to compute the width and size of the disc", - // @VISIBILITY(2.5) + "Used to compute the width and size of the disc.", openspace::properties::Property::Visibility::User }; @@ -58,8 +57,7 @@ namespace { "Luminosity", "Luminosity", "The luminosity of the corresponding star, in units of solar luminosities. " - "Used to compute the width and size of the disc", - // @VISIBILITY(2.5) + "Used to compute the width and size of the disc.", openspace::properties::Property::Visibility::User }; @@ -67,8 +65,7 @@ namespace { "Optimistic", "Optimistic" , "If true, the habitable zone disc is rendered with the optimistic boundaries " - "rather than the conservative ones", - // @VISIBILITY(2.5) + "rather than the conservative ones.", openspace::properties::Property::Visibility::User }; @@ -78,8 +75,7 @@ namespace { "The effective temperature interval for which Kopparapu's formula is used for " "the habitable zone computation. For stars with temperatures outside the range, " "a simpler method by Tom E. Harris is used. This method only uses the star " - "luminosity and does not include computation of the optimistic boundaries", - // @VISIBILITY(2.5) + "luminosity and does not include computation of the optimistic boundaries.", openspace::properties::Property::Visibility::User }; diff --git a/modules/space/rendering/renderableorbitalkepler.cpp b/modules/space/rendering/renderableorbitalkepler.cpp index 2c67548be0..783eadbff7 100644 --- a/modules/space/rendering/renderableorbitalkepler.cpp +++ b/modules/space/rendering/renderableorbitalkepler.cpp @@ -56,7 +56,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo PathInfo = { "Path", "Path", - "The file path to the data file to read", + "The file path to the data file to read.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -66,8 +66,7 @@ namespace { "A segment quality value for the orbital trail. A value from 1 (lowest) to " "10 (highest) that controls the number of line segments in the rendering of the " "orbital trail. This does not control the direct number of segments because " - "these automatically increase according to the eccentricity of the orbit", - // @VISIBILITY(2.5) + "these automatically increase according to the eccentricity of the orbit.", openspace::properties::Property::Visibility::User }; @@ -76,7 +75,7 @@ namespace { "Trail Width", "This value specifies the line width of the trail if the selected rendering " "method includes lines. If the rendering mode is set to Points, this value is " - "ignored", + "ignored.", openspace::properties::Property::Visibility::NoviceUser }; @@ -85,7 +84,6 @@ namespace { "Point Size Exponent", "This value is used as in exponential scaling to set the absolute size of the " "point.", - // @VISIBILITY(2.4) openspace::properties::Property::Visibility::User }; @@ -129,7 +127,6 @@ namespace { "TrailFade", "Trail Fade Factor", "This value determines how fast the trail fades and is an appearance property.", - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -161,14 +158,14 @@ namespace { "StartRenderIdx", "Contiguous Starting Index of Render", "Index of object in renderable group to start rendering (all prior objects will " - "be ignored)", + "be ignored).", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RenderSizeInfo = { "RenderSize", "Contiguous Size of Render Block", - "Number of objects to render sequentially from StartRenderIdx", + "Number of objects to render sequentially from StartRenderIdx.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/rendering/renderablerings.cpp b/modules/space/rendering/renderablerings.cpp index d7241129c0..82d15f88fd 100644 --- a/modules/space/rendering/renderablerings.cpp +++ b/modules/space/rendering/renderablerings.cpp @@ -48,14 +48,14 @@ namespace { "Texture", "Texture", "This value is the path to a texture on disk that contains a one-dimensional " - "texture which is used for these rings", + "texture which is used for these rings.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value specifies the radius of the rings in meter", + "This value specifies the radius of the rings in meters.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -65,7 +65,7 @@ namespace { "This value is used to limit the width of the rings. Each of the two values is " "a value between 0 and 1, where 0 is the center of the ring and 1 is the " "maximum extent at the radius. For example, if the value is {0.5, 1.0}, the " - "ring is only shown between radius/2 and radius. It defaults to {0.0, 1.0}", + "ring is only shown between radius/2 and radius. It defaults to {0.0, 1.0}.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -74,7 +74,7 @@ namespace { "Night Factor", "This value is a multiplicative factor that is applied to the side of the rings " "that is facing away from the Sun. If this value is equal to '1', no darkening " - "of the night side occurs", + "of the night side occurs.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -82,7 +82,7 @@ namespace { "ColorFilter", "Color Filter", "This value affects the filtering out of part of the rings depending on the " - "color values of the texture. The higher value, the more rings are filtered out", + "color values of the texture. The higher value, the more rings are filtered out.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/rendering/renderablestars.cpp b/modules/space/rendering/renderablestars.cpp index 06ec9a135e..353aec081d 100644 --- a/modules/space/rendering/renderablestars.cpp +++ b/modules/space/rendering/renderablestars.cpp @@ -106,7 +106,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SpeckFileInfo = { "SpeckFile", "Speck File", - "The speck file that is loaded to get the data for rendering these stars", + "The speck file that is loaded to get the data for rendering these stars.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -114,7 +114,7 @@ namespace { "ColorMap", "ColorBV Texture", "The path to the texture that is used to convert from the B-V value of the star " - "to its color. The texture is used as a one dimensional lookup function", + "to its color. The texture is used as a one dimensional lookup function.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -122,7 +122,7 @@ namespace { "MappingBV", "Mapping (bv-color)", "The name of the variable in the speck file that is used as the b-v color " - "variable", + "variable.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -130,7 +130,7 @@ namespace { "MappingLuminance", "Mapping (luminance)", "The name of the variable in the speck file that is used as the luminance " - "variable", + "variable.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -138,7 +138,7 @@ namespace { "MappingAbsMagnitude", "Mapping (absolute magnitude)", "The name of the variable in the speck file that is used as the absolute " - "magnitude variable", + "magnitude variable.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -146,7 +146,7 @@ namespace { "MappingVx", "Mapping (vx)", "The name of the variable in the speck file that is used as the star velocity " - "along the x-axis", + "along the x-axis.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -154,7 +154,7 @@ namespace { "MappingVy", "Mapping (vy)", "The name of the variable in the speck file that is used as the star velocity " - "along the y-axis", + "along the y-axis.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -162,14 +162,14 @@ namespace { "MappingVz", "Mapping (vz)", "The name of the variable in the speck file that is used as the star velocity " - "along the z-axis", + "along the z-axis.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MappingSpeedInfo = { "MappingSpeed", "Mapping (speed)", - "The name of the variable in the speck file that is used as the speed", + "The name of the variable in the speck file that is used as the speed.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -177,14 +177,14 @@ namespace { "ColorOption", "Color Option", "This value determines which quantity is used for determining the color of the " - "stars", + "stars.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OtherDataOptionInfo = { "OtherData", "Other Data Column", - "The index of the speck file data column that is used as the color input", + "The index of the speck file data column that is used as the color input.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -192,21 +192,21 @@ namespace { "OtherDataValueRange", "Range of the other data values", "This value is the min/max value range that is used to normalize the other data " - "values so they can be used by the specified color map", + "values so they can be used by the specified color map.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FixedColorInfo = { "FixedColorValue", "Color used for fixed star colors", - "The color that should be used if the 'Fixed Color' value is used", + "The color that should be used if the 'Fixed Color' value is used.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OtherDataColorMapInfo = { "OtherDataColorMap", "Other Data Color Map", - "The color map that is used if the 'Other Data' rendering method is selected", + "The color map that is used if the 'Other Data' rendering method is selected.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -214,26 +214,26 @@ namespace { "FilterOutOfRange", "Filter Out of Range", "Determines whether other data values outside the value range should be visible " - "or filtered away", + "or filtered away.", openspace::properties::Property::Visibility::AdvancedUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo HaloOwnerInfo = { "Halo", "Halo", - "Settings for the halo portion of the star" + "Settings for the halo portion of the star." }; const openspace::properties::PropertyOwner::PropertyOwnerInfo GlareOwnerInfo = { "Glare", "Glare", - "Settings for the central glare portion of the star" + "Settings for the central glare portion of the star." }; constexpr openspace::properties::Property::PropertyInfo TextureInfo = { "Texture", "Texture Path", - "The path to the texture that should be used", + "The path to the texture that should be used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -243,7 +243,7 @@ namespace { "An individual multiplication factor for this texture component. Using the " "multiplier and gamma values for both components, it is possible to fine tune " "the look of the stars or disable the contributions altogether by setting it to " - "0", + "0.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -260,8 +260,7 @@ namespace { "Magnitude Exponent", "Adjust star magnitude by 10^MagnitudeExponent. Stars closer than this distance " "are given full opacity. Farther away, stars dim proportionally to the " - "logarithm of their distance", - // @VISIBILITY(2.5) + "logarithm of their distance.", openspace::properties::Property::Visibility::User }; @@ -283,21 +282,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SizeCompositionMethodInfo = { "Method", "Method", - "Method to determine the size for the stars", + "Method to determine the size for the stars.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LumPercentInfo = { "LumPercent", "Luminosity Contribution", - "Luminosity Contribution", + "Luminosity Contribution.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RadiusPercentInfo = { "RadiusPercent", "Radius Contribution", - "Radius Contribution", + "Radius Contribution.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -306,14 +305,14 @@ namespace { "Fade-In Start and End Distances", "These values determine the initial and final distances from the center of " "our galaxy from which the astronomical object will start and end " - "fading-in", + "fading-in.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EnableFadeInInfo = { "EnableFadeIn", "Enable Fade-in effect", - "Enables/Disables the Fade-in effect", + "Enables/Disables the Fade-in effect.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/rendering/renderabletravelspeed.cpp b/modules/space/rendering/renderabletravelspeed.cpp index 5b3ab4d252..14fd550176 100644 --- a/modules/space/rendering/renderabletravelspeed.cpp +++ b/modules/space/rendering/renderabletravelspeed.cpp @@ -42,38 +42,36 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SpeedInfo = { "TravelSpeed", "Speed of travel", - "The speed of light is the default value", - // @VISIBILITY(1.25) + "The speed of light is the default value.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo TargetInfo = { "TargetNode", "Target object", - "This value sets which scene graph node to target with the light speed indicator", + "This value sets which scene graph node to target with the light speed " + "indicator.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LineColorInfo = { "Color", "Color", - "This value determines the RGB color for the line", + "This value determines the RGB color for the line.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width", - // @VISIBILITY(1.33) + "This value specifies the line width.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo IndicatorLengthInfo = { "IndicatorLength", "Indicator Length", - "This value specifies the length of the light indicator set in light seconds", - // @VISIBILITY(2.33) + "This value specifies the length of the light indicator set in light seconds.", openspace::properties::Property::Visibility::User }; @@ -81,8 +79,7 @@ namespace { "FadeLength", "Fade Length", "This value specifies the length of the faded tail of the light indicator " - "set in light seconds", - // @VISIBILITY(2.33) + "set in light seconds.", openspace::properties::Property::Visibility::User }; diff --git a/modules/space/rotation/spicerotation.cpp b/modules/space/rotation/spicerotation.cpp index 53d4d42cde..bdba3390dc 100644 --- a/modules/space/rotation/spicerotation.cpp +++ b/modules/space/rotation/spicerotation.cpp @@ -36,7 +36,7 @@ namespace { "SourceFrame", "Source", "This value specifies the source frame that is used as the basis for the " - "coordinate transformation. This has to be a valid SPICE name", + "coordinate transformation. This has to be a valid SPICE name.", openspace::properties::Property::Visibility::Developer }; @@ -44,14 +44,14 @@ namespace { "DestinationFrame", "Destination", "This value specifies the destination frame that is used for the coordinate " - "transformation. This has to be a valid SPICE name", + "transformation. This has to be a valid SPICE name.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo TimeFrameInfo = { "TimeFrame", "Time Frame", - "The time frame in which the spice kernels are valid", + "The time frame in which the spice kernels are valid.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -59,7 +59,7 @@ namespace { "FixedDate", "Fixed Date", "A time to lock the rotation to. Setting this to an empty string will " - "unlock the time and return to rotation based on current simulation time", + "unlock the time and return to rotation based on current simulation time.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/spacemodule.cpp b/modules/space/spacemodule.cpp index 588fef8258..9c75829c99 100644 --- a/modules/space/spacemodule.cpp +++ b/modules/space/spacemodule.cpp @@ -56,7 +56,7 @@ namespace { "ShowExceptions", "Show Exceptions", "If enabled, errors from SPICE will be thrown and show up in the log. If " - "disabled, the errors will be ignored silently", + "disabled, the errors will be ignored silently.", openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/modules/space/translation/horizonstranslation.cpp b/modules/space/translation/horizonstranslation.cpp index 7895a4e2ee..0c985807e1 100644 --- a/modules/space/translation/horizonstranslation.cpp +++ b/modules/space/translation/horizonstranslation.cpp @@ -47,8 +47,7 @@ namespace { "HorizonsTextFile", "Horizons Text File", "This value is the path to the file or files generated by Horizons with " - "either a Vector table or an Observer table with the correct settings (see wiki)", - // @VISIBILITY(3.5) + "either a Vector table or an Observer table with the correct settings.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/translation/keplertranslation.cpp b/modules/space/translation/keplertranslation.cpp index 547a5b1efa..f87214e3fd 100644 --- a/modules/space/translation/keplertranslation.cpp +++ b/modules/space/translation/keplertranslation.cpp @@ -51,7 +51,7 @@ namespace { "Eccentricity", "This value determines the eccentricity, that is the deviation from a perfect " "sphere, for this orbit. Currently, hyperbolic orbits using Keplerian elements " - "are not supported", + "are not supported.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -60,7 +60,7 @@ namespace { "Semi-major axis", "This value determines the semi-major axis, that is the distance of the object " "from the central body in kilometers (semi-major axis = average of periapsis and " - "apoapsis)", + "apoapsis).", openspace::properties::Property::Visibility::AdvancedUser }; @@ -69,7 +69,7 @@ namespace { "Inclination", "This value determines the degrees of inclination, or the angle of the orbital " "plane, relative to the reference plane, on which the object orbits around the " - "central body", + "central body.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -78,7 +78,7 @@ namespace { "Right ascension of ascending Node", "This value determines the right ascension of the ascending node in degrees, " "that is the location of position along the orbit where the inclined plane and " - "the horizonal reference plane intersect", + "the horizonal reference plane intersect.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -86,7 +86,7 @@ namespace { "ArgumentOfPeriapsis", "Argument of Periapsis", "This value determines the argument of periapsis in degrees, that is the " - "position on the orbit that is closest to the orbiting body", + "position on the orbit that is closest to the orbiting body.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -94,7 +94,7 @@ namespace { "MeanAnomaly", "Mean anomaly at epoch", "This value determines the mean anomaly at the epoch in degrees, which " - "determines the initial location of the object along the orbit at epoch", + "determines the initial location of the object along the orbit at epoch.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -102,14 +102,14 @@ namespace { "Epoch", "Epoch", "This value determines the epoch for which the initial location is defined in " - "the form of YYYY MM DD HH:mm:ss", + "the form of YYYY MM DD HH:mm:ss.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PeriodInfo = { "Period", "Orbit period", - "Specifies the orbital period (in seconds)", + "Specifies the orbital period (in seconds).", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/space/translation/spicetranslation.cpp b/modules/space/translation/spicetranslation.cpp index 5d1b7a4a84..e8bddcc75f 100644 --- a/modules/space/translation/spicetranslation.cpp +++ b/modules/space/translation/spicetranslation.cpp @@ -43,8 +43,7 @@ namespace { "Target", "This is the SPICE NAIF name for the body whose translation is to be computed by " "the SpiceTranslation. It can either be a fully qualified name (such as 'EARTH') " - "or a NAIF integer id code (such as '399')", - // @VISIBILITY(3.5) + "or a NAIF integer id code (such as '399').", openspace::properties::Property::Visibility::AdvancedUser }; @@ -53,8 +52,7 @@ namespace { "Observer", "This is the SPICE NAIF name for the parent of the body whose translation is to " "be computed by the SpiceTranslation. It can either be a fully qualified name " - "(such as 'SOLAR SYSTEM BARYCENTER') or a NAIF integer id code (such as '0')", - // @VISIBILITY(3.5) + "(such as 'SOLAR SYSTEM BARYCENTER') or a NAIF integer id code (such as '0').", openspace::properties::Property::Visibility::AdvancedUser }; @@ -62,8 +60,7 @@ namespace { "Frame", "Reference Frame", "This is the SPICE NAIF name for the reference frame in which the position " - "should be retrieved. The default value is GALACTIC", - // @VISIBILITY(3.33) + "should be retrieved. The default value is GALACTIC.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -71,8 +68,7 @@ namespace { "FixedDate", "Fixed Date", "A time to lock the position to. Setting this to an empty string will " - "unlock the time and return to position based on current simulation time", - // @VISIBILITY(2.5) + "unlock the time and return to position based on current simulation time.", openspace::properties::Property::Visibility::User }; diff --git a/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp b/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp index 66409cab5a..f602bcf3d4 100644 --- a/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp +++ b/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp @@ -44,8 +44,7 @@ namespace { "Active Color", "This value determines the color that the active instrument is rendered in. " "Shortly after activation, the used color is mixture of this and the flash " - "color. The default value is (0.6, 1.0, 0.0)", - // @VISIBILITY(2.5) + "color. The default value is (0.6, 1.0, 0.0).", openspace::properties::Property::Visibility::User }; @@ -53,8 +52,7 @@ namespace { "FlashColor", "Flash Color", "This value determines the color that is used shortly after an instrument " - "activation. The default value is (0.9, 1.0, 0.75)", - // @VISIBILITY(2.5) + "activation. The default value is (0.9, 1.0, 0.75).", openspace::properties::Property::Visibility::User }; diff --git a/modules/spacecraftinstruments/rendering/renderablefov.cpp b/modules/spacecraftinstruments/rendering/renderablefov.cpp index 4af3d48cbb..2c3dd74c80 100644 --- a/modules/spacecraftinstruments/rendering/renderablefov.cpp +++ b/modules/spacecraftinstruments/rendering/renderablefov.cpp @@ -51,7 +51,7 @@ namespace { "LineWidth", "Line Width", "This value determines width of the lines connecting the instrument to the " - "corners of the field of view", + "corners of the field of view.", openspace::properties::Property::Visibility::User }; @@ -62,7 +62,7 @@ namespace { "distance of the plane to the focus object. If this value is '1', the field of " "view will be rendered exactly on the surface of, for example, a planet. With a " "value of smaller than 1, the field of view will hover of ther surface, thus " - "making it more visible", + "making it more visible.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -70,8 +70,7 @@ namespace { "AlwaysDrawFov", "Always Draw FOV", "If this value is enabled, the field of view will always be drawn, regardless of " - "whether image information has been loaded or not", - // @VISIBILITY(2.5) + "whether image information has been loaded or not.", openspace::properties::Property::Visibility::User }; @@ -80,7 +79,7 @@ namespace { "Start of default color", "This value determines the color of the field of view frustum close to the " "instrument. The final colors are interpolated between this value and the end " - "color", + "color.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -89,7 +88,7 @@ namespace { "End of default color", "This value determines the color of the field of view frustum close to the " "target. The final colors are interpolated between this value and the start " - "color", + "color.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -97,7 +96,7 @@ namespace { "Colors.Active", "Active Color", "This value determines the color that is used when the instrument's field of " - "view is active", + "view is active.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -105,7 +104,7 @@ namespace { "Colors.TargetInFieldOfView", "Target in field-of-view Color", "This value determines the color that is used if the target is inside the field " - "of view of the instrument but the instrument is not yet active", + "of view of the instrument but the instrument is not yet active.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -114,7 +113,7 @@ namespace { "Start of the intersection", "This value determines the color that is used close to the instrument if one of " "the field of view corners is intersecting the target object. The final color is " - "retrieved by interpolating between this color and the intersection end color", + "retrieved by interpolating between this color and the intersection end color.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -123,7 +122,7 @@ namespace { "End of the intersection", "This value determines the color that is used close to the target if one of the " "field of view corners is intersecting the target object. The final color is " - "retrieved by interpolating between this color and the intersection begin color", + "retrieved by interpolating between this color and the intersection begin color.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -132,7 +131,7 @@ namespace { "Orthogonal Square", "This value determines the color that is used for the field of view square in " "the case that there is no intersection and that the instrument is not currently " - "active", + "active.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp b/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp index 028aeac567..26ec899e96 100644 --- a/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp +++ b/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp @@ -58,8 +58,7 @@ namespace { "Perform Shading", "If this value is enabled, the model will be shaded based on the relative " "location to the Sun. If this value is disabled, shading is disabled and the " - "entire model is rendered brightly", - // @VISIBILITY(1.5) + "entire model is rendered brightly.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp b/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp index 5cd40e7710..4ad3070d35 100644 --- a/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp +++ b/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp @@ -58,7 +58,7 @@ namespace { "The texture path selected in this property is used as the base texture that is " "applied to the planet prior to any image projections. This menu always contains " "an empty option for not using a color map. If this value is specified in an " - "asset, the last texture is used", + "asset, the last texture is used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -66,7 +66,7 @@ namespace { "AddColorTexture", "Add Color Base Texture", "Adds a new base color texture to the list of selectable base maps used prior to " - "any image projection", + "any image projection.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -75,14 +75,14 @@ namespace { "Heightmap Texture", "The texture path selected in this property is used as the height map on the " "planet. This menu always contains an empty option for not using a heightmap. If " - "this value is specified in an asset, the last texture is used", + "this value is specified in an asset, the last texture is used.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AddHeightTextureInfo = { "AddHeightTexture", "Add Heightmap Texture", - "Adds a new height map texture to the list of selectable height maps used", + "Adds a new height map texture to the list of selectable height maps used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -91,7 +91,7 @@ namespace { "Height Exaggeration", "This value determines the level of height exaggeration that is applied to a " "potential height field. A value of '0' inhibits the height field, whereas a " - "value of '1' uses the measured height field", + "value of '1' uses the measured height field.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -101,50 +101,50 @@ namespace { "If this value is enabled, a shift of the meridian by 180 degrees is performed. " "This is a fix especially for Pluto height maps, where the definition of the " "meridian has changed through the New Horizons mission and this requires this " - "shift", + "shift.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AmbientBrightnessInfo = { "AmbientBrightness", "Ambient Brightness", - "This value determines the ambient brightness of the dark side of the planet", + "This value determines the ambient brightness of the dark side of the planet.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MaxProjectionsPerFrameInfo = { "MaxProjectionsPerFrame", "Max Projections Per Frame", - "The maximum number of image projections to perform per frame. " - "Useful to avoid freezing the system for large delta times", + "The maximum number of image projections to perform per frame. Useful to avoid " + "freezing the system for large delta times.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ProjectionsInBufferInfo = { "ProjectionsInBuffer", "Projections In Buffer", - "(Read only) The number of images that are currently waiting to be projected", + "(Read only) The number of images that are currently waiting to be projected.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ClearProjectionBufferInfo = { "ClearProjectionBuffer", "Clear Projection Buffer", - "Remove all pending projections from the buffer", + "Remove all pending projections from the buffer.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RadiusInfo = { "Radius", "Radius", - "This value specifies the radius of this sphere in meters", + "This value specifies the radius of this sphere in meters.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = { "Segments", "Segments", - "This value specifies the number of segments that this sphere is split into", + "This value specifies the number of segments that this sphere is split into.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp b/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp index f2d9bda2d8..9eefa880d6 100644 --- a/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp +++ b/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp @@ -43,7 +43,7 @@ namespace { "Points", "This value determines the number of control points that is used to construct " "the shadow geometry. The higher this number, the more detailed the shadow is, " - "but it will have a negative impact on the performance", + "but it will have a negative impact on the performance.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -52,15 +52,14 @@ namespace { "Shadow Length", "This value determines the length of the shadow that is cast by the target " "object. The total distance of the shadow is equal to the distance from the " - "target to the Sun multiplied with this value", + "target to the Sun multiplied with this value.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ShadowColorInfo = { "ShadowColor", "Shadow Color", - "This value determines the color that is used for the shadow cylinder", - // @VISIBILITY(2.5) + "This value determines the color that is used for the shadow cylinder.", openspace::properties::Property::Visibility::User }; @@ -68,7 +67,7 @@ namespace { "TerminatorType", "Terminator Type", "This value determines the type of the terminator that is used to calculate the " - "shadow eclipse", + "shadow eclipse.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -76,7 +75,7 @@ namespace { "LightSource", "Light Source", "This value determines the SPICE name of the object that is used as the " - "illuminator for computing the shadow cylinder", + "illuminator for computing the shadow cylinder.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -84,7 +83,7 @@ namespace { "Observer", "Observer", "This value specifies the SPICE name of the object that is the observer of the " - "shadow cylinder", + "shadow cylinder.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -92,7 +91,7 @@ namespace { "Body", "Target Body", "This value is the SPICE name of target body that is used as the shadow caster " - "for the shadow cylinder", + "for the shadow cylinder.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -100,7 +99,7 @@ namespace { "BodyFrame", "Body Frame", "This value is the SPICE name of the reference frame in which the shadow " - "cylinder is expressed", + "cylinder is expressed.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -108,8 +107,7 @@ namespace { "Aberration", "Aberration", "This value determines the aberration method that is used to compute the shadow " - "cylinder", - // @VISIBILITY(3.5) + "cylinder.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/spacecraftinstruments/util/projectioncomponent.cpp b/modules/spacecraftinstruments/util/projectioncomponent.cpp index 8f76694284..8dc0af50ee 100644 --- a/modules/spacecraftinstruments/util/projectioncomponent.cpp +++ b/modules/spacecraftinstruments/util/projectioncomponent.cpp @@ -50,8 +50,7 @@ namespace { "PerformProjection", "Perform Projections", "If this value is enabled, this ProjectionComponent will perform projections. If " - "it is disabled, projections will be ignored", - // @VISIBILITY(2.5) + "it is disabled, projections will be ignored.", openspace::properties::Property::Visibility::User }; @@ -59,8 +58,7 @@ namespace { "ClearAllProjections", "Clear Projections", "If this property is triggered, it will remove all the projections that have " - "already been applied", - // @VISIBILITY(2.5) + "already been applied.", openspace::properties::Property::Visibility::User }; @@ -69,8 +67,7 @@ namespace { "Projection Fading", "This value fades the previously performed projections in or out. If this value " "is equal to '1', the projections are fully visible, if the value is equal to " - "'0', the performed projections are completely invisible", - // @VISIBILITY(2.5) + "'0', the performed projections are completely invisible.", openspace::properties::Property::Visibility::User }; @@ -80,7 +77,7 @@ namespace { "This value determines the size of the texture into which the images are " "projected and thus provides the limit to the resolution of projections that can " "be applied. Changing this value will not cause the texture to be automatically " - "updated, but triggering the 'ApplyTextureSize' property is required", + "updated, but triggering the 'ApplyTextureSize' property is required.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -88,7 +85,7 @@ namespace { "ApplyTextureSize", "Apply Texture Size", "Triggering this property applies a new size to the underlying projection " - "texture. The old texture is resized and interpolated to fit the new size", + "texture. The old texture is resized and interpolated to fit the new size.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/spout/renderableplanespout.cpp b/modules/spout/renderableplanespout.cpp index 4a71596eb2..9bd83ea101 100644 --- a/modules/spout/renderableplanespout.cpp +++ b/modules/spout/renderableplanespout.cpp @@ -38,7 +38,7 @@ namespace { "SpoutName", "Spout Sender Name", "This value explicitly sets the Spout receiver to use a specific name. If this " - "is not a valid name, an empty image is used", + "is not a valid name, an empty image is used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -47,14 +47,14 @@ namespace { "Spout Selection", "This property displays all available Spout sender on the system. If one them is " "selected, its value is stored in the 'SpoutName' property, overwriting its " - "previous value", + "previous value.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UpdateInfo = { "UpdateSelection", "Update Selection", - "If this property is trigged, the 'SpoutSelection' options will be refreshed", + "If this property is trigged, the 'SpoutSelection' options will be refreshed.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/spout/screenspacespout.cpp b/modules/spout/screenspacespout.cpp index e72df828da..a587ef2fae 100644 --- a/modules/spout/screenspacespout.cpp +++ b/modules/spout/screenspacespout.cpp @@ -36,7 +36,7 @@ namespace { "SpoutName", "Spout Sender Name", "This value explicitly sets the Spout receiver to use a specific name. If this " - "is not a valid name, an empty image is used", + "is not a valid name, an empty image is used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -45,14 +45,14 @@ namespace { "Spout Selection", "This property displays all available Spout sender on the system. If one them is " "selected, its value is stored in the 'SpoutName' property, overwriting its " - "previous value", + "previous value.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UpdateInfo = { "UpdateSelection", "Update Selection", - "If this property is trigged, the 'SpoutSelection' options will be refreshed", + "If this property is trigged, the 'SpoutSelection' options will be refreshed.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/spout/spoutwrapper.cpp b/modules/spout/spoutwrapper.cpp index cc225a01f3..35218c3224 100644 --- a/modules/spout/spoutwrapper.cpp +++ b/modules/spout/spoutwrapper.cpp @@ -37,7 +37,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo NameSenderInfo = { "SpoutName", "Spout Sender Name", - "This value sets the Spout sender to use a specific name", + "This value sets the Spout sender to use a specific name.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -45,7 +45,7 @@ namespace { "SpoutName", "Spout Receiver Name", "This value explicitly sets the Spout receiver to use a specific name. If this " - "is not a valid name, an empty image is used", + "is not a valid name, an empty image is used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -54,14 +54,14 @@ namespace { "Spout Selection", "This property displays all available Spout sender on the system. If one them is " "selected, its value is stored in the 'SpoutName' property, overwriting its " - "previous value", + "previous value.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UpdateInfo = { "UpdateSelection", "Update Selection", - "If this property is trigged, the 'SpoutSelection' options will be refreshed", + "If this property is trigged, the 'SpoutSelection' options will be refreshed.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/touch/src/touchinteraction.cpp b/modules/touch/src/touchinteraction.cpp index a524919b17..23649c7b5e 100644 --- a/modules/touch/src/touchinteraction.cpp +++ b/modules/touch/src/touchinteraction.cpp @@ -67,7 +67,7 @@ namespace { "Take a unit test saving the LM data into file", "LM - least-squares minimization using Levenberg-Marquardt algorithm." "Used to find a new camera state from touch points when doing direct " - "manipulation", + "manipulation.", openspace::properties::Property::Visibility::Developer }; @@ -75,7 +75,6 @@ namespace { "DisableZoom", "Disable zoom navigation", "", // @TODO Missing documentation - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -83,7 +82,6 @@ namespace { "DisableRoll", "Disable roll navigation", "", // @TODO Missing documentation - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -105,7 +103,6 @@ namespace { "DeceleratesPerSecond", "Number of times velocity is decelerated per second", "", // @TODO Missing documentation - // @VISIBILITY(3.5) openspace::properties::Property::Visibility::AdvancedUser }; @@ -127,7 +124,7 @@ namespace { "PinchZoomFactor", "Scaling distance travelled on pinch", "This value is used to reduce the amount of pinching needed. A linear kind of " - "sensitivity that will alter the pinch-zoom speed", + "sensitivity that will alter the pinch-zoom speed.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -142,7 +139,6 @@ namespace { "ZoomSensitivityExp", "Sensitivity of exponential zooming in relation to distance from focus node", "", // @TODO Missing documentation - // @VISIBILITY(3.5) openspace::properties::Property::Visibility::AdvancedUser }; @@ -150,7 +146,6 @@ namespace { "ZoomSensitivityProp", "Sensitivity of zooming proportional to distance from focus node", "", // @TODO Missing documentation - // @VISIBILITY(3.5) openspace::properties::Property::Visibility::AdvancedUser }; @@ -161,7 +156,6 @@ namespace { "Threshold of distance to target node for whether or not to use exponential " "zooming", "", // @TODO Missing documentation - // @VISIBILITY(3.5) openspace::properties::Property::Visibility::AdvancedUser }; @@ -170,9 +164,8 @@ namespace { { "ZoomInBoundarySphereMultiplier", "Multiplies a node's boundary sphere by this in order to limit zoom in & prevent " - "surface collision", + "surface collision.", "", // @TODO Missing documentation - // @VISIBILITY(3.5) openspace::properties::Property::Visibility::AdvancedUser }; @@ -187,14 +180,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ConstantTimeDecaySecsInfo = { "ConstantTimeDecaySecs", "Time duration that a pitch/roll/zoom/pan should take to decay to zero (seconds)", - "", + "", // @TODO Missing documentation openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo InputSensitivityInfo = { "InputSensitivity", "Threshold for interpreting input as still", - "", + "", // @TODO Missing documentation openspace::properties::Property::Visibility::AdvancedUser }; @@ -223,7 +216,6 @@ namespace { "Friction", "Friction for different interactions (orbit, zoom, roll, pan)", "", // @TODO Missing documentation - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -232,8 +224,7 @@ namespace { "Zoom Out Limit", "The maximum distance you are allowed to navigate away from the anchor. " "This should always be larger than the zoom in value if you want to be able " - "to zoom. Defaults to maximum allowed double", - // @VISIBILITY(2.5) + "to zoom. Defaults to maximum allowed double.", openspace::properties::Property::Visibility::User }; @@ -243,7 +234,6 @@ namespace { "The minimum distance from the anchor that you are allowed to navigate to. " "Its purpose is to limit zooming in on a node. If this value is not set it " "defaults to the surface of the current anchor.", - // @VISIBILITY(2.5) openspace::properties::Property::Visibility::User }; @@ -263,7 +253,7 @@ namespace { "Direct manipulation threshold", "This threshold affects the distance from the interaction sphere at which the " "direct manipulation interaction mode starts being active. The value is given " - "as a factor times the interaction sphere", + "as a factor times the interaction sphere.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/touch/touchmodule.cpp b/modules/touch/touchmodule.cpp index 6330111fd7..5d8c043122 100644 --- a/modules/touch/touchmodule.cpp +++ b/modules/touch/touchmodule.cpp @@ -52,7 +52,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EventsInfo = { "DetectedTouchEvent", "Detected Touch Event", - "True when there is an active touch event", + "True when there is an active touch event.", openspace::properties::Property::Visibility::Hidden }; diff --git a/modules/toyvolume/rendering/renderabletoyvolume.cpp b/modules/toyvolume/rendering/renderabletoyvolume.cpp index f809341a63..f50f1d07c8 100644 --- a/modules/toyvolume/rendering/renderabletoyvolume.cpp +++ b/modules/toyvolume/rendering/renderabletoyvolume.cpp @@ -59,7 +59,6 @@ namespace { "Translation", "Translation", "", // @TODO Missing documentation - // @VISIBILITY(3.) openspace::properties::Property::Visibility::AdvancedUser }; @@ -67,7 +66,6 @@ namespace { "Rotation", "Euler rotation", "", // @TODO Missing documentation - // @VISIBILITY(3.) openspace::properties::Property::Visibility::AdvancedUser }; @@ -82,7 +80,7 @@ namespace { { "Downscale", "Downscale Factor Volume Rendering", - "This value set the downscaling factor when rendering the current volume", + "This value set the downscaling factor when rendering the current volume.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/video/src/videoplayer.cpp b/modules/video/src/videoplayer.cpp index 856a0a9850..54b5a5c6c5 100644 --- a/modules/video/src/videoplayer.cpp +++ b/modules/video/src/videoplayer.cpp @@ -50,13 +50,13 @@ namespace { constexpr openspace::properties::Property::PropertyInfo PlayInfo = { "Play", "Play", - "Play video" + "Play video." }; constexpr openspace::properties::Property::PropertyInfo PauseInfo = { "Pause", "Pause", - "Pause video" + "Pause video." }; constexpr openspace::properties::Property::PropertyInfo GoToStartInfo = { @@ -75,7 +75,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo AudioInfo = { "PlayAudio", "Play Audio", - "Play audio" + "Play audio." }; constexpr openspace::properties::Property::PropertyInfo StartTimeInfo = { diff --git a/modules/video/videomodule.cpp b/modules/video/videomodule.cpp index cb914478c2..13a5b97e2e 100644 --- a/modules/video/videomodule.cpp +++ b/modules/video/videomodule.cpp @@ -37,7 +37,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Decides if this module should be enabled" + "Decides if this module should be enabled." }; struct [[codegen::Dictionary(VideoModule)]] Parameters { diff --git a/modules/vislab/rendering/renderabledistancelabel.cpp b/modules/vislab/rendering/renderabledistancelabel.cpp index 3e03e64851..1372f70bd5 100644 --- a/modules/vislab/rendering/renderabledistancelabel.cpp +++ b/modules/vislab/rendering/renderabledistancelabel.cpp @@ -41,7 +41,7 @@ namespace { "NodeLine", "Node Line", "Property to track a nodeline. When tracking the label text will be updating the " - "distance from the nodeline start and end", + "distance from the nodeline start and end.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -49,8 +49,7 @@ namespace { "DistanceUnit", "Distance Unit", "Property to define the unit in which the distance should be displayed. " - "Defaults to 'km' if not specified", - // @VISIBILITY(2.5) + "Defaults to 'km' if not specified.", openspace::properties::Property::Visibility::User }; @@ -58,7 +57,7 @@ namespace { "CustomUnitDescriptor", "Custom Unit Descriptor", "Property to define a custom unit descriptor to use to describe the distance " - "value. Defaults to the units SI descriptor if not specified", + "value. Defaults to the units SI descriptor if not specified.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/volume/rendering/renderabletimevaryingvolume.cpp b/modules/volume/rendering/renderabletimevaryingvolume.cpp index 22ca620a4b..c9e97c2d57 100644 --- a/modules/volume/rendering/renderabletimevaryingvolume.cpp +++ b/modules/volume/rendering/renderabletimevaryingvolume.cpp @@ -55,16 +55,15 @@ namespace { constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = { "StepSize", "Step Size", - "Specifies how often to sample on the raycaster. Lower step -> higher resolution", - // @VISIBILITY(3.5) + "Specifies how often to sample on the raycaster. Lower step -> higher " + "resolution.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GridTypeInfo = { "GridType", "Grid Type", - "Spherical or Cartesian grid", - // @VISIBILITY(3.5) + "Spherical or Cartesian grid.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -72,7 +71,7 @@ namespace { "SecondsBefore", "Seconds before", "Specifies the number of seconds to show the first timestep before its " - "actual time. The default value is 0", + "actual time. The default value is 0.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -80,43 +79,42 @@ namespace { "SecondsAfter", "Seconds after", "Specifies the number of seconds to show the the last timestep after its " - "actual time", + "actual time.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SourceDirectoryInfo = { "SourceDirectory", "Source Directory", - "Specifies the path to load timesteps from", + "Specifies the path to load timesteps from.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TransferFunctionInfo = { "TransferFunctionPath", "Transfer Function Path", - "Specifies the transfer function file path", + "Specifies the transfer function file path.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TriggerTimeJumpInfo = { "TriggerTimeJump", "Jump", - "Sets the time to be the first time of the volume sequence", + "Sets the time to be the first time of the volume sequence.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo JumpToTimestepInfo = { "JumpToTimestep", "Jump to timestep", - "Lets you scrub through the sequence's time steps", + "Lets you scrub through the sequence's time steps.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo BrightnessInfo = { "Brightness", "Brightness", - "The volume renderer's general brightness", - // @VISIBILITY(2.5) + "The volume renderer's general brightness.", openspace::properties::Property::Visibility::User }; @@ -124,15 +122,13 @@ namespace { "RNormalization", "Radius normalization", "", // @TODO Missing documentation - // @VISIBILITY(3.5) openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo rUpperBoundInfo = { "RUpperBound", "Radius upper bound", - "Limit the volume's radius", - // @VISIBILITY(3.5) + "Limit the volume's radius.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/volume/transferfunctionhandler.cpp b/modules/volume/transferfunctionhandler.cpp index d8dec3f83d..c0a5329414 100644 --- a/modules/volume/transferfunctionhandler.cpp +++ b/modules/volume/transferfunctionhandler.cpp @@ -32,36 +32,35 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TransferFunctionInfo = { "TransferFunction", "TransferFunction", - "All the envelopes used in the transfer function", + "All the envelopes used in the transfer function.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DataUnitInfo = { "DataUnit", "DataUnit", - "Unit of the data", + "Unit of the data.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MinValueInfo = { "MinValue", "MinValue", - "Minimum value in the data", + "Minimum value in the data.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaxValueInfo = { "MaxValue", "MaxValue", - "Maximum value in the data", + "Maximum value in the data.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SaveTransferFunctionInfo = { "SaveTransferFunction", "Save Transfer Function", - "Save your transfer function", - // @VISIBILITY(3.5) + "Save your transfer function.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/webbrowser/src/defaultbrowserlauncher.cpp b/modules/webbrowser/src/defaultbrowserlauncher.cpp index c05f398b2d..7f5949662c 100644 --- a/modules/webbrowser/src/defaultbrowserlauncher.cpp +++ b/modules/webbrowser/src/defaultbrowserlauncher.cpp @@ -33,7 +33,7 @@ namespace openspace { bool DefaultBrowserLauncher::OnBeforePopup(CefRefPtr, CefRefPtr, - [[ maybe_unused ]] const CefString& targetUrl, + [[maybe_unused]] const CefString& targetUrl, const CefString&, CefLifeSpanHandler::WindowOpenDisposition, bool, const CefPopupFeatures&, CefWindowInfo&, diff --git a/modules/webbrowser/src/screenspacebrowser.cpp b/modules/webbrowser/src/screenspacebrowser.cpp index 5ca4bfbdb0..9bee28aa7f 100644 --- a/modules/webbrowser/src/screenspacebrowser.cpp +++ b/modules/webbrowser/src/screenspacebrowser.cpp @@ -41,22 +41,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DimensionsInfo = { "Dimensions", "Browser Dimensions", - "Set the dimensions of the web browser windows", - // @VISIBILITY(2.33) + "Set the dimensions of the web browser windows.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo UrlInfo = { "Url", "URL", - "The URL to load", + "The URL to load.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ReloadInfo = { "Reload", "Reload", - "Reload the web browser", + "Reload the web browser.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/modules/webbrowser/webbrowsermodule.cpp b/modules/webbrowser/webbrowsermodule.cpp index 61fd0e8360..1ce34570bb 100644 --- a/modules/webbrowser/webbrowsermodule.cpp +++ b/modules/webbrowser/webbrowsermodule.cpp @@ -58,7 +58,7 @@ namespace { "Update Browser Between Renderables", "Run the message loop of the browser between calls to render individual " "renderables. When disabled, the browser message loop only runs " - "once per frame", + "once per frame.", openspace::properties::Property::Visibility::Developer }; @@ -66,7 +66,7 @@ namespace { "BrowserUpdateInterval", "Browser Update Interval", "The time in microseconds between running the message loop of the browser. " - "Only used if UpdateBrowserBetweenRenderables is true", + "Only used if UpdateBrowserBetweenRenderables is true.", openspace::properties::Property::Visibility::Developer }; diff --git a/modules/webgui/webguimodule.cpp b/modules/webgui/webguimodule.cpp index 1cf99bd700..94edb9e439 100644 --- a/modules/webgui/webguimodule.cpp +++ b/modules/webgui/webguimodule.cpp @@ -44,29 +44,28 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ServerProcessEnabledInfo = { "ServerProcessEnabled", "Enable Server Process", - "Enable the node js based process used to serve the Web GUI", - // @VISIBILITY(3.5) + "Enable the node js based process used to serve the Web GUI.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AddressInfo = { "Address", "Address", - "The network address to use when connecting to OpenSpace from the Web GUI", + "The network address to use when connecting to OpenSpace from the Web GUI.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PortInfo = { "Port", "Port", - "The network port to use when serving the Web GUI over HTTP", + "The network port to use when serving the Web GUI over HTTP.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo WebSocketInterfaceInfo = { "WebSocketInterface", "WebSocket Interface", - "The identifier of the websocket interface to use when communicating", + "The identifier of the websocket interface to use when communicating.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -74,8 +73,7 @@ namespace { { "ServerProcessEntryPoint", "Server Process Entry Point", - "The node js command to invoke", - // @VISIBILITY(3.5) + "The node js command to invoke.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -84,8 +82,7 @@ namespace { "Directories", "Directories from which to to serve static content, as a string list " "with entries expressed as pairs, where every odd is the endpoint name and every " - "even is the directory", - // @VISIBILITY(3.5) + "even is the directory.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -93,8 +90,7 @@ namespace { "DefaultEndpoint", "Default Endpoint", "The 'default' endpoint. The server will redirect http requests from / to " - "/", - // @VISIBILITY(3.5) + "/.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -104,7 +100,7 @@ namespace { "Directories that are currently served. This value is set by the server process, " "as a verification of the actually served directories. For example, an onChange " "callback can be registered to this, to reload browsers when the server is " - "ready. Manual changes to this property have no effect", + "ready. Manual changes to this property have no effect.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/engine/moduleengine.cpp b/src/engine/moduleengine.cpp index e098301e56..0621df1589 100644 --- a/src/engine/moduleengine.cpp +++ b/src/engine/moduleengine.cpp @@ -42,8 +42,7 @@ namespace { "AllModules", "All Modules", "The list of all modules that were compiled for this version of OpenSpace in the " - "same order in which they were initialized", - // @VISIBILITY(3.5) + "same order in which they were initialized.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/engine/openspaceengine.cpp b/src/engine/openspaceengine.cpp index ec5161bff6..2e34ffdb05 100644 --- a/src/engine/openspaceengine.cpp +++ b/src/engine/openspaceengine.cpp @@ -120,7 +120,7 @@ namespace { "PrintEvents", "Print Events", "If this is enabled, all events that are propagated through the system are " - "printed to the log", + "printed to the log.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -128,7 +128,7 @@ namespace { "PropertyVisibility", "Property Visibility", "Hides or displays different settings in the GUI depending on how advanced they " - "are", + "are.", openspace::properties::Property::Visibility::Always }; @@ -146,8 +146,7 @@ namespace { "DisableMouseInputs", "Disable All Mouse Inputs", "Disables all mouse inputs. Useful when using touch interaction, to prevent " - "double inputs on touch (from both touch input and inserted mouse inputs)", - // @VISIBILITY(2.67) + "double inputs on touch (from both touch input and inserted mouse inputs).", openspace::properties::Property::Visibility::User }; diff --git a/src/events/event.cpp b/src/events/event.cpp index 8119c012bb..6e9a19bc22 100644 --- a/src/events/event.cpp +++ b/src/events/event.cpp @@ -67,7 +67,7 @@ void log(int i, const EventParallelConnection& e) { LINFO(std::format("[{}] ParallelConnection ({})", i, state)); } -void log(int i, [[ maybe_unused ]] const EventProfileLoadingFinished& e) { +void log(int i, [[maybe_unused]] const EventProfileLoadingFinished& e) { ghoul_assert(e.type == EventProfileLoadingFinished::Type, "Wrong type"); LINFO(std::format("[{}] ProfileLoadingFinished", i)); } @@ -126,7 +126,7 @@ void log(int i, const EventTimeOfInterestReached& e) { )); } -void log(int i, [[ maybe_unused ]] const EventMissionEventReached& e) { +void log(int i, [[maybe_unused]] const EventMissionEventReached& e) { ghoul_assert(e.type == EventMissionEventReached::Type, "Wrong type"); LINFO(std::format("[{}] MissionEventReached", i)); } @@ -136,7 +136,7 @@ void log(int i, const EventPlanetEclipsed& e) { LINFO(std::format("[{}] PlanetEclipsed: {} -> {}", i, e.eclipsee, e.eclipser)); } -void log(int i, [[ maybe_unused ]] const EventInterpolationFinished& e) { +void log(int i, [[maybe_unused]] const EventInterpolationFinished& e) { ghoul_assert(e.type == EventInterpolationFinished::Type, "Wrong type"); LINFO(std::format("[{}] InterpolationFinished", i)); } diff --git a/src/interaction/interactionmonitor.cpp b/src/interaction/interactionmonitor.cpp index fe83a4a684..49ea144fec 100644 --- a/src/interaction/interactionmonitor.cpp +++ b/src/interaction/interactionmonitor.cpp @@ -33,8 +33,7 @@ namespace { "IdleTime", "Idle Time", "Time in seconds that has passed from latest registered interaction until the " - "application goes idle", - // @VISIBILITY(3.5) + "application goes idle.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -42,8 +41,7 @@ namespace { "IsInActiveState", "Is State Active", "Keeps track whether the interaction session is in active state or not. False if " - "application is in idle state, true if it is in active state", - // @VISIBILITY(3.5) + "application is in idle state, true if it is in active state.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/interaction/sessionrecording.cpp b/src/interaction/sessionrecording.cpp index 68b8367427..4e355b548c 100644 --- a/src/interaction/sessionrecording.cpp +++ b/src/interaction/sessionrecording.cpp @@ -72,7 +72,7 @@ namespace { "RenderInfo", "Render Playback Information", "If enabled, information about a currently played back session recording is " - "rendering to screen", + "rendering to screen.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -80,7 +80,7 @@ namespace { "IgnoreRecordedScale", "Ignore Recorded Scale", "If this value is enabled, the scale value from a recording is ignored and the " - "computed values are used instead", + "computed values are used instead.", openspace::properties::Property::Visibility::Hidden }; @@ -89,7 +89,7 @@ namespace { "Add Model Matrix in ASCII recording", "If this is 'true', the model matrix is written into the ASCII recording format " "in the line before each camera keyframe. The model matrix is the full matrix " - "that converts the position into a J2000+Galactic reference frame", + "that converts the position into a J2000+Galactic reference frame.", openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/src/navigation/navigationhandler.cpp b/src/navigation/navigationhandler.cpp index c3e56d725e..bb7f994528 100644 --- a/src/navigation/navigationhandler.cpp +++ b/src/navigation/navigationhandler.cpp @@ -65,21 +65,21 @@ namespace { "DisableKeybindings", "Disable all Keybindings", "Disables all keybindings without removing them. Please note that this does not " - "apply to the key to open the console", + "apply to the key to open the console.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableMouseInputInfo = { "DisableMouseInputs", "Disable all mouse inputs", - "Disables all mouse inputs and prevents them from affecting the camera", + "Disables all mouse inputs and prevents them from affecting the camera.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableJoystickInputInfo = { "DisableJoystickInputs", "Disable all joystick inputs", - "Disables all joystick inputs and prevents them from affecting the camera", + "Disables all joystick inputs and prevents them from affecting the camera.", openspace::properties::Property::Visibility::User }; @@ -87,7 +87,7 @@ namespace { "UseKeyFrameInteraction", "Use keyframe interaction", "If this is set to 'true' the entire interaction is based off key frames rather " - "than using the mouse interaction", + "than using the mouse interaction.", openspace::properties::Property::Visibility::Developer }; @@ -96,7 +96,8 @@ namespace { "JumpTo Fade Duration", "The number of seconds the fading of the rendering should take per default when " "navigating through a 'jump' transition. This is when the rendering is first " - "faded to black, then the camera is moved, and then the rendering fades in again", + "faded to black, then the camera is moved, and then the rendering fades in " + "again.", openspace::properties::Property::Visibility::User }; } // namespace diff --git a/src/navigation/orbitalnavigator.cpp b/src/navigation/orbitalnavigator.cpp index 8aabc7398b..fb729b8485 100644 --- a/src/navigation/orbitalnavigator.cpp +++ b/src/navigation/orbitalnavigator.cpp @@ -57,8 +57,7 @@ namespace { "Anchor", "The name of the scene graph node that is the origin of the camera interaction. " "The camera follows, orbits and dollies towards this node. Any scene graph node " - "can be the anchor node", - // @VISIBILITY(1.33) + "can be the anchor node.", openspace::properties::Property::Visibility::NoviceUser }; @@ -66,8 +65,7 @@ namespace { "Aim", "Aim", "The name of the scene graph node that is the aim of the camera. The camera " - "direction is relative to the vector from the camera position to this node", - // @VISIBILITY(1.67) + "direction is relative to the vector from the camera position to this node.", openspace::properties::Property::Visibility::NoviceUser }; @@ -75,8 +73,7 @@ namespace { "RetargetAnchor", "Retarget Anchor", "When triggered, this property starts an interpolation to reset the " - "camera direction to the anchor node", - // @VISIBILITY(1.33) + "camera direction to the anchor node.", openspace::properties::Property::Visibility::NoviceUser }; @@ -84,8 +81,7 @@ namespace { "RetargetAim", "Retarget Aim", "When triggered, this property starts an interpolation to reset the " - "camera direction to the aim node", - // @VISIBILITY(1.67) + "camera direction to the aim node.", openspace::properties::Property::Visibility::NoviceUser }; @@ -94,8 +90,7 @@ namespace { "Roll Friction", "If this is enabled, a small friction is applied to the rolling part of the " "camera motion, thus slowing it down within a small time period. If this value " - "is disabled, the camera will roll forever", - // @VISIBILITY(1.33) + "is disabled, the camera will roll forever.", openspace::properties::Property::Visibility::NoviceUser }; @@ -104,8 +99,7 @@ namespace { "Rotational Friction", "If this is enabled, a small friction is applied to the rotational part of the " "camera motion, thus slowing it down within a small time period. If this value " - "is disabled, the camera will rotate forever", - // @VISIBILITY(1.33) + "is disabled, the camera will rotate forever.", openspace::properties::Property::Visibility::NoviceUser }; @@ -114,8 +108,7 @@ namespace { "Zoom Friction", "If this is enabled, a small friction is applied to the zoom part of the camera " "motion, thus slowing it down within a small time period. If this value is " - "disabled, the camera will zoom in or out forever", - // @VISIBILITY(1.33) + "disabled, the camera will zoom in or out forever.", openspace::properties::Property::Visibility::NoviceUser }; @@ -123,7 +116,7 @@ namespace { "MouseSensitivity", "Mouse Sensitivity", "Determines the sensitivity of the camera motion thorugh the mouse. The lower " - "the sensitivity is the less impact a mouse motion will have", + "the sensitivity is the less impact a mouse motion will have.", openspace::properties::Property::Visibility::NoviceUser }; @@ -131,7 +124,7 @@ namespace { "JoystickSensitivity", "Joystick Sensitivity", "Determines the sensitivity of the camera motion thorugh a joystick. The lower " - "the sensitivity is the less impact a joystick motion will have", + "the sensitivity is the less impact a joystick motion will have.", openspace::properties::Property::Visibility::NoviceUser }; @@ -139,7 +132,7 @@ namespace { "WebsocketSensitivity", "Websocket Sensitivity", "Determines the sensitivity of the camera motion thorugh a websocket. The lower " - "the sensitivity is the less impact a webstick motion will have", + "the sensitivity is the less impact a webstick motion will have.", openspace::properties::Property::Visibility::NoviceUser }; @@ -148,7 +141,7 @@ namespace { "Friction Factor", "Determines the factor that is applied if the 'Roll Friction', 'Rotational " "Friction', and 'Zoom Friction' values are enabled. The lower this value is, the " - "faster the camera movements will stop", + "faster the camera movements will stop.", openspace::properties::Property::Visibility::User }; @@ -158,7 +151,7 @@ namespace { "If true, the camera will rotate with the current achor node if within a " "certain distance from it. When this happens, the object will appear fixed in " "relation to the camera. The distance at which the change happens is controlled " - "through another property", + "through another property.", openspace::properties::Property::Visibility::User }; @@ -168,7 +161,7 @@ namespace { "Follow Anchor Node Rotation Distance", "A factor used to determine the distance at which the camera starts rotating " "with the anchor node. The actual distance will be computed by multiplying " - "this factor with the approximate radius of the node", + "this factor with the approximate radius of the node.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -177,7 +170,7 @@ namespace { "StereoInterpolationTime", "Stereo Interpolation Time", "The time to interpolate to a new stereoscopic depth when the anchor node is " - "changed, in seconds", + "changed, in seconds.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -187,7 +180,7 @@ namespace { "RetargetAnchorInterpolationTime", "Retarget Interpolation Time", "The time to interpolate the camera rotation when the anchor or aim node is " - "changed, in seconds", + "changed, in seconds.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -195,7 +188,7 @@ namespace { { "FollowRotationInterpolationTime", "Follow Rotation Interpolation Time", - "The interpolation time when toggling following focus node rotation", + "The interpolation time when toggling following focus node rotation.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -204,8 +197,7 @@ namespace { "Invert Left and Right Mouse Buttons", "If this value is 'false', the left mouse button causes the camera to rotate " "around the object and the right mouse button causes the zooming motion. If this " - "value is 'true', these two functionalities are reversed", - // @VISIBILITY(1.33) + "value is 'true', these two functionalities are reversed.", openspace::properties::Property::Visibility::NoviceUser }; @@ -216,8 +208,8 @@ namespace { "Adaptive Steroscopic Depth", "Dynamically adjust the view scaling based on the distance to the surface of " "the anchor and aim nodes. If enabled, view scale will be set to " - "StereoscopicDepthOfFocusSurface / min(anchorDistance, aimDistance). " - "If disabled, view scale will be set to 10^StaticViewScaleExponent", + "StereoscopicDepthOfFocusSurface / min(anchorDistance, aimDistance). If " + "disabled, view scale will be set to 10^StaticViewScaleExponent.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -226,7 +218,7 @@ namespace { "StaticViewScaleExponent", "Static View Scale Exponent", "Statically scale the world by 10^StaticViewScaleExponent. Only used if " - "UseAdaptiveStereoscopicDepthInfo is set to false", + "UseAdaptiveStereoscopicDepthInfo is set to false.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -237,8 +229,7 @@ namespace { "Stereoscopic Depth of the Surface in Focus", "Set the stereoscopically perceived distance (in meters) to the closest point " "out of the surface of the anchor and the center of the aim node. Only used if " - "UseAdaptiveStereoscopicDepthInfo is set to true", - // @VISIBILITY(2.5) + "UseAdaptiveStereoscopicDepthInfo is set to true.", openspace::properties::Property::Visibility::User }; @@ -247,8 +238,7 @@ namespace { "Constant Velocity Flight", "If this value is enabled, the camera motion will not be affected by the " "distance of the camera to the surface of a planet. When enabling this setting " - "consider adjusting the mouse sensitivity to a lower value", - // @VISIBILITY(2.5) + "consider adjusting the mouse sensitivity to a lower value.", openspace::properties::Property::Visibility::User }; @@ -256,8 +246,7 @@ namespace { "ApplyIdleBehavior", "Apply Idle Behavior", "When set to true, the chosen idle behavior will be applied to the camera, " - "moving the camera accordingly", - // @VISIBILITY(2.5) + "moving the camera accordingly.", openspace::properties::Property::Visibility::User }; @@ -265,7 +254,7 @@ namespace { "IdleBehavior", "Idle Behavior", "The chosen camera behavior that will be triggered when the idle behavior is " - "applied. Each option represents a predefined camera behavior", + "applied. Each option represents a predefined camera behavior.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -275,8 +264,7 @@ namespace { "ShouldTriggerWhenIdle", "Should Trigger When Idle", "If true, the chosen idle behavior will trigger automatically after a certain " - "time (see 'IdleWaitTime' property)", - // @VISIBILITY(?) + "time (see 'IdleWaitTime' property).", openspace::properties::Property::Visibility::User }; @@ -284,8 +272,7 @@ namespace { "IdleWaitTime", "Idle Wait Time", "The time (seconds) until idle behavior starts, if no camera interaction " - "has been performed. Note that friction counts as camera interaction", - // @VISIBILITY(?) + "has been performed. Note that friction counts as camera interaction.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -294,7 +281,7 @@ namespace { "Speed Factor", "A factor that can be used to increase or slow down the speed of an applied " "idle behavior. A negative value will invert the direction. Note that a speed " - "of exactly 0 leads to no movement at all", + "of exactly 0 leads to no movement at all.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -303,8 +290,7 @@ namespace { "Invert", "If true, the direction of the idle behavior motion will be inverted compared " "to the default. For example, the 'Orbit' option rotates to the right per " - "default, and will rotate to the left when inverted", - // @VISIBILITY(?) + "default, and will rotate to the left when inverted.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -315,8 +301,7 @@ namespace { "If set to true, the idle behavior is aborted on camera interaction. If false, " "the behavior will be reapplied after the interaction. Examples of camera " "interaction are: changing the anchor node, starting a camera path or session " - "recording playback, or navigating manually using an input device", - // @VISIBILITY(2.5) + "recording playback, or navigating manually using an input device.", openspace::properties::Property::Visibility::User }; @@ -326,8 +311,7 @@ namespace { "DampenInterpolationTime", "Start/End Dampen Interpolation Time", "The time to interpolate to/from full speed when an idle behavior is triggered " - "or canceled, in seconds", - // @VISIBILITY(3.5) + "or canceled, in seconds.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -335,7 +319,7 @@ namespace { "LimitZoom", "Limit Zoom", "Settings to limit the camera from going to close to or too far away from the " - "current focus" + "current focus." }; constexpr openspace::properties::Property::PropertyInfo @@ -344,7 +328,7 @@ namespace { "EnabledMinimumAllowedDistance", "Enable minimum allowed distance limit", "Enables or disables that the camera cannot go closer to an object than " - "the set minimum allowed distance", + "the set minimum allowed distance.", openspace::properties::Property::Visibility::User }; @@ -352,8 +336,7 @@ namespace { "MinimumAllowedDistance", "Minimum Allowed Distance", "The limit of how close the camera can get to an object. The distance is given " - "in meters above the surface", - // @VISIBILITY(2.5) + "in meters above the surface.", openspace::properties::Property::Visibility::User }; @@ -361,8 +344,7 @@ namespace { "EnableMaximumAllowedDistance", "Enable Maximum Allowed Distance limit", "Enables or disables that the camera cannot go further away from an object than " - "the set maximum allowed distance", - // @VISIBILITY(?) + "the set maximum allowed distance.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -370,8 +352,7 @@ namespace { "MaximumAllowedDistance", "Maximum Allowed Distance", "The limit of how far away the camera can get from an object. The distance is " - "given in meters above the surface", - // @VISIBILITY(?) + "given in meters above the surface.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -380,7 +361,7 @@ namespace { "Disable Zoom", "When set to true, disables all vertical navigation based on input. This means " "that the camera cannot be moved closer to or further away from the current " - "anchor node", + "anchor node.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -389,7 +370,7 @@ namespace { "Disable Roll", "When set to true, disables all rolling camera motions based on input. This " "means that the camera cannot be rotated to change the perceived up-direction " - "of the current anchor node, or rotate the horizon on a planet, for example", + "of the current anchor node, or rotate the horizon on a planet, for example.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -399,7 +380,7 @@ namespace { "When set to true, global rotation interactions in the X-direction will lead to " "a rotation around the specified up vector instead of just around the object. " "The up vector is the local coordinate axis, and can be set to either the X-, Y- " - "or Z-axis through the 'UpToUseForRotation' property", + "or Z-axis through the 'UpToUseForRotation' property.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -408,7 +389,7 @@ namespace { "Up To Use For Rotation", "Specifies the local coordinate axis of the anchor node to use as up direction " "when the camera is set to orbit around up. In general, the Z-axis is a good " - "choice for globes, and the Y-axis is a good choice for models", + "choice for globes, and the Y-axis is a good choice for models.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/navigation/pathnavigator.cpp b/src/navigation/pathnavigator.cpp index 6d23a11721..7f9b400ae9 100644 --- a/src/navigation/pathnavigator.cpp +++ b/src/navigation/pathnavigator.cpp @@ -58,14 +58,14 @@ namespace { "Default Path Type", "The default path type chosen when generating a path or flying to a target. " "See wiki for alternatives. The shape of the generated path will be different " - "depending on the path type", + "depending on the path type.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo IncludeRollInfo = { "IncludeRoll", "Include Roll", - "If disabled, roll is removed from the interpolation of camera orientation", + "If disabled, roll is removed from the interpolation of camera orientation.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -74,7 +74,7 @@ namespace { "Speed Scale", "Scale factor that the speed will be multiplied with during path traversal. " "Can be used to speed up or slow down the camera motion, depending on if the " - "value is larger than or smaller than one", + "value is larger than or smaller than one.", openspace::properties::Property::Visibility::User }; @@ -82,7 +82,7 @@ namespace { "ApplyIdleBehaviorOnFinish", "Apply Idle Behavior on Finish", "If set to true, the chosen IdleBehavior of the OrbitalNavigator will be " - "triggered once the path has reached its target", + "triggered once the path has reached its target.", openspace::properties::Property::Visibility::User }; @@ -92,7 +92,7 @@ namespace { "A factor used to compute the default distance from a target scene graph node " "when creating a camera path. The factor will be multipled with the node's " "bounding sphere to compute the target height from the bounding sphere of the " - "object", + "object.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -101,8 +101,7 @@ namespace { "Rotation Speed Factor (Linear Path)", "Affects how fast the camera rotates to the target rotation during a linear " "path. A value of 1 means that the camera will rotate 90 degrees in about 5 " - "seconds. A value of 2 means twice that time, i.e. 10 seconds, and so on", - // @VISIBILITY(2.5) + "seconds. A value of 2 means twice that time, i.e. 10 seconds, and so on.", openspace::properties::Property::Visibility::User }; @@ -111,7 +110,7 @@ namespace { "Minimal Valid Bounding Sphere", "The minimal allowed value for a bounding sphere, in meters. Used for " "computation of target positions and path generation, to avoid issues when " - "there is no bounding sphere", + "there is no bounding sphere.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -119,8 +118,7 @@ namespace { "RelevantNodeTags", "Relevant Node Tags", "List of tags for the nodes that are relevant for path creation, for example " - "when avoiding collisions", - // @VISIBILITY(3.5) + "when avoiding collisions.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/network/parallelpeer.cpp b/src/network/parallelpeer.cpp index 693e22efa2..bf7d1b6b93 100644 --- a/src/network/parallelpeer.cpp +++ b/src/network/parallelpeer.cpp @@ -50,7 +50,7 @@ namespace { "Password", "Password", "The general password that allows this OpenSpace instance access to the Wormhole " - "server", + "server.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -58,7 +58,7 @@ namespace { "HostPassword", "Host Password", "The password that is required to take control of the joint session and thus " - "send all commands to connected clients", + "send all commands to connected clients.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -66,14 +66,14 @@ namespace { "Port", "Port", "The port on which the Wormhole server is listening to connections from " - "OpenSpace", + "OpenSpace.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AddressInfo = { "Address", "Address", - "The address of the Wormhole server either as a DNS name or an IP address", + "The address of the Wormhole server either as a DNS name or an IP address.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -81,7 +81,7 @@ namespace { "Name", "Connection Name", "The name of this OpenSpace instance that will be potentially broadcast to other " - "connected instances", + "connected instances.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -91,8 +91,7 @@ namespace { "This is the number of seconds that received keyframes are buffered before they " "get applied to the rendering. A higher value leads to smoother rendering, " "particularly when the internet connection is unstable, but also leads to higher " - "delay", - // @VISIBILITY(3.5) + "delay.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -101,8 +100,7 @@ namespace { "Time keyframe interval", "Determines how often the information about the simulation time is sent (in " "seconds). Lower values mean more accurate representation of the time, but also " - "require higher internet bandwidth", - // @VISIBILITY(3.5) + "require higher internet bandwidth.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -111,8 +109,7 @@ namespace { "Camera Keyframe interval", "Determines how often the information about the camera position and orientation " "is sent (in seconds). Lower values mean more accurate representation of the " - "time, but also more internet traffic", - // @VISIBILITY(3.5) + "time, but also more internet traffic.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/rendering/colormappingcomponent.cpp b/src/rendering/colormappingcomponent.cpp index 79d5398158..e3bc535ac2 100644 --- a/src/rendering/colormappingcomponent.cpp +++ b/src/rendering/colormappingcomponent.cpp @@ -37,14 +37,14 @@ namespace { "Color Map Enabled", "If this value is set to 'true', the provided color map is used (if one was " "provided in the configuration). If no color map was provided, changing this " - "setting does not do anything", + "setting does not do anything.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FileInfo = { "File", "Color Map File", - "The path to the color map file to use for coloring the points", + "The path to the color map file to use for coloring the points.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -55,14 +55,14 @@ namespace { "on the color map. The property is set based on predefined options specified in " "the asset file. When changing the parameter, the value range to used for the" "mapping will also be changed. Per default, it is set to the last parameter in " - "the list of options", + "the list of options.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RangeInfo = { "ValueRange", "Value Range", - "This value changes the range of values to be mapped with the current color map", + "This value changes the range of values to be mapped with the current color map.", openspace::properties::Property::Visibility::User }; @@ -70,7 +70,7 @@ namespace { "SetRangeFromData", "Set Data Range from Data", "Set the data range for the color mapping based on the available data for the " - "curently selected data column", + "curently selected data column.", openspace::properties::Property::Visibility::User }; @@ -78,7 +78,7 @@ namespace { "HideValuesOutsideRange", "Hide Values Outside Range", "If true, points with values outside the provided range for the coloring will be " - "hidden, i.e. not rendered at all", + "hidden, i.e. not rendered at all.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -86,7 +86,7 @@ namespace { "ShowMissingData", "Show Missing Data", "If true, use a separate color (see NoDataColor) for items with values " - "corresponding to missing data values", + "corresponding to missing data values.", openspace::properties::Property::Visibility::User }; @@ -97,7 +97,7 @@ namespace { "if enabled. This color can also be read from the color map, but setting this " "value overrides any value in the color map. If a color value for the below " "range values is provided, the ShowMissingData property will automatically be " - "set to true", + "set to true.", openspace::properties::Property::Visibility::User }; @@ -107,7 +107,7 @@ namespace { "If true, use a separate color (see AboveRangeColor) for items with values " "larger than the one in the provided data range. Otherwise, the values will " "be clamped to use the color at the upper limit of the color map. If a color is " - "provided in the color map, this value will automatically be set to true", + "provided in the color map, this value will automatically be set to true.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -118,7 +118,7 @@ namespace { "data range, if enabled. This color can also be read from the color map, but " "setting this value overrides any value in the color map. If a color value for " "the above range values is provided, the UseAboveRangeColor property will " - "automatically be set to true", + "automatically be set to true.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -128,7 +128,7 @@ namespace { "If true, use a separate color (see BelowRangeColor) for items with values " "smaller than the one in the provided data range. Otherwise, the values will " "be clamped to use the color at the lower limit of the color map. If a color is " - "provided in the color map, this value will automatically be set to true", + "provided in the color map, this value will automatically be set to true.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -139,14 +139,14 @@ namespace { "data range, if enabled. This color can also be read from the color map, but " "setting this value overrides any value in the color map. If a color value for " "the below range values is provided, the UseBelowRangeColor property will " - "automatically be set to true", + "automatically be set to true.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo InvertColorMapInfo = { "Invert", "Invert Color Map", - "If true, the colors of the color map will be read in the inverse order", + "If true, the colors of the color map will be read in the inverse order.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/rendering/dashboard.cpp b/src/rendering/dashboard.cpp index 9e27eef04f..86c63e991a 100644 --- a/src/rendering/dashboard.cpp +++ b/src/rendering/dashboard.cpp @@ -38,7 +38,7 @@ namespace { "IsEnabled", "Enabled", "If this value is 'false', this dashboard will be invisible, regardless of the " - "state of the individual components", + "state of the individual components.", openspace::properties::Property::Visibility::NoviceUser }; @@ -46,8 +46,7 @@ namespace { "StartPositionOffset", "Start Position Offset", "A 2D vector controlling where the dashboard rendering starts. Adding an offset " - "in x and y-direction on screen", - // @VISIBILITY(2.75) + "in x and y-direction on screen.", openspace::properties::Property::Visibility::User }; } // namespace diff --git a/src/rendering/dashboarditem.cpp b/src/rendering/dashboarditem.cpp index 2d73518b8b..dab1d12cb8 100644 --- a/src/rendering/dashboarditem.cpp +++ b/src/rendering/dashboarditem.cpp @@ -37,8 +37,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "If this value is set to 'true' this dashboard item is shown in the dashboard", - // @VISIBILITY(1.75) + "If this value is set to 'true' this dashboard item is shown in the dashboard.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/rendering/dashboardtextitem.cpp b/src/rendering/dashboardtextitem.cpp index b9b0c12acb..0bd203e0e7 100644 --- a/src/rendering/dashboardtextitem.cpp +++ b/src/rendering/dashboardtextitem.cpp @@ -35,16 +35,14 @@ namespace { "FontName", "Font Name", "This value is the name of the font that is used. It can either refer to an " - "internal name registered previously, or it can refer to a path that is used", - // @VISIBILITY(2.33) + "internal name registered previously, or it can refer to a path that is used.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = { "FontSize", "Font Size", - "This value determines the size of the font that is used to render the distance", - // @VISIBILITY(2.33) + "This value determines the size of the font that is used to render the distance.", openspace::properties::Property::Visibility::User }; diff --git a/src/rendering/fadeable.cpp b/src/rendering/fadeable.cpp index 9dd00f3242..9c66e4a388 100644 --- a/src/rendering/fadeable.cpp +++ b/src/rendering/fadeable.cpp @@ -33,7 +33,7 @@ namespace { "Opacity", "Opacity", "This value determines the opacity of this object. A value of 0 means " - "completely transparent", + "completely transparent.", openspace::properties::Property::Visibility::NoviceUser }; @@ -43,9 +43,7 @@ namespace { "This value is used by the system to be able to fade out objects " "independently from the Opacity value selected by the user. This value should " "not be directly manipulated through a user interface, but instead used by other " - "components of the system programmatically", - // The Developer mode should be used once the properties in the UI listen to this - // openspace::properties::Property::Visibility::Developer + "components of the system programmatically.", openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/src/rendering/labelscomponent.cpp b/src/rendering/labelscomponent.cpp index 8222e4c663..3a1153ad32 100644 --- a/src/rendering/labelscomponent.cpp +++ b/src/rendering/labelscomponent.cpp @@ -43,44 +43,42 @@ namespace { "Enabled", "Enabled", "This setting determines whether the labels will be visible or not. They are " - "disabled per default", - // @VISIBILITY(?) + "disabled per default.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FileInfo = { "File", "File", - "The speck label file with the data for the labels", + "The speck label file with the data for the labels.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "The color of the labels", + "The color of the labels.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "The size of the labels in pixels", - // @VISIBILITY(2.5) + "The size of the labels in pixels.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = { "FontSize", "Font Size", - "Font size for the labels. This is different from the text size", + "Font size for the labels. This is different from the text size.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MinMaxInfo = { "MinMaxSize", "Min/Max Size", - "The minimum and maximum size (in pixels) of the labels", + "The minimum and maximum size (in pixels) of the labels.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -95,8 +93,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TransformationMatrixInfo = { "TransformationMatrix", "Transformation Matrix", - "Transformation matrix to be applied to the labels", - // @VISIBILITY(?) + "Transformation matrix to be applied to the labels.", openspace::properties::Property::Visibility::Developer }; diff --git a/src/rendering/luaconsole.cpp b/src/rendering/luaconsole.cpp index ac2a888ebe..decae4c8ef 100644 --- a/src/rendering/luaconsole.cpp +++ b/src/rendering/luaconsole.cpp @@ -73,7 +73,7 @@ namespace { "IsVisible", "Is Visible", "Determines whether the Lua console is shown on the screen or not. Toggling it " - "will fade the console in and out", + "will fade the console in and out.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -82,7 +82,7 @@ namespace { "Should Be Synchronized", "Determines whether the entered commands will only be executed locally (if this " "is disabled), or whether they will be send to other connected nodes, for " - "example in a cluster environment", + "example in a cluster environment.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -91,35 +91,35 @@ namespace { "Should Send To Remote", "Determines whether the entered commands will only be executed locally (if this " "is disabled), or whether they will be send to connected remote instances (other " - "peers through a parallel connection)", + "peers through a parallel connection).", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BackgroundColorInfo = { "BackgroundColor", "Background Color", - "Sets the background color of the console", + "Sets the background color of the console.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EntryTextColorInfo = { "EntryTextColor", "Entry Text Color", - "Sets the text color of the entry area of the console", + "Sets the text color of the entry area of the console.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo HistoryTextColorInfo = { "HistoryTextColor", "History Text Color", - "Sets the text color of the history area of the console", + "Sets the text color of the history area of the console.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo HistoryLengthInfo = { "HistoryLength", "History Length", - "Determines the length of the history in number of lines", + "Determines the length of the history in number of lines.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/rendering/renderable.cpp b/src/rendering/renderable.cpp index 2f76630659..073a84aa3a 100644 --- a/src/rendering/renderable.cpp +++ b/src/rendering/renderable.cpp @@ -45,16 +45,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether this object will be visible or not", - // @VISIBILITY(0.33) + "This setting determines whether this object will be visible or not.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RenderableTypeInfo = { "Type", "Renderable Type", - "This tells the type of the renderable", - // @VISIBILITY(3.4) + "This tells the type of the renderable.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -63,8 +61,7 @@ namespace { "RenderBinMode", "Render Bin Mode", "This value specifies if the renderable should be rendered in the Background," - "Opaque, Pre/PostDeferredTransparency, or Overlay rendering step", - // @VISIBILITY(3.2) + "Opaque, Pre/PostDeferredTransparency, or Overlay rendering step.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -72,7 +69,7 @@ namespace { "DimInAtmosphere", "Dim In Atmosphere", "Enables/Disables if the object should be dimmed when the camera is in the " - "sunny part of an atmosphere", + "sunny part of an atmosphere.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/rendering/renderengine.cpp b/src/rendering/renderengine.cpp index fe71de25d7..1dfe4f7e7e 100644 --- a/src/rendering/renderengine.cpp +++ b/src/rendering/renderengine.cpp @@ -83,7 +83,7 @@ namespace { "ShowOverlayOnClients", "Show Overlay Information on Clients", "If this value is enabled, the overlay information text is also automatically " - "rendered on client nodes. This values is disabled by default", + "rendered on client nodes. This values is disabled by default.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -92,7 +92,7 @@ namespace { "Show the on-screen log", "This value determines whether the on-screen log will be shown or hidden. Even " "if it is shown, all 'Debug' and 'Trace' level messages are omitted from this " - "log", + "log.", openspace::properties::Property::Visibility::User }; @@ -100,8 +100,7 @@ namespace { "VerticalLogOffset", "Vertical Log Offset", "The vertical offset for the on-screen log in [0,1] coordinates, a factor that " - "is scaled with the vertical resolution", - // @VISIBILITY(3.5) + "is scaled with the vertical resolution.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -109,7 +108,7 @@ namespace { "ShowVersion", "Shows the version on-screen information", "This value determines whether the Git version information (branch and commit) " - "hash are shown on the screen", + "hash are shown on the screen.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -117,8 +116,7 @@ namespace { "ShowCamera", "Shows information about the current camera state, such as friction", "This value determines whether the information about the current camera state is " - "shown on the screen", - // @VISIBILITY(2.5) + "shown on the screen.", openspace::properties::Property::Visibility::User }; @@ -127,7 +125,7 @@ namespace { "Screenshow Window Ids", "The list of window identifiers whose screenshot will be taken the next time " "anyone triggers a screenshot. If this list is empty (the default), all windows " - "will have their screenshot taken. Id's that do not exist are silently ignored", + "will have their screenshot taken. Id's that do not exist are silently ignored.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -137,15 +135,14 @@ namespace { "This value determines whether a warping should be applied before taking a " "screenshot. If it is enabled, all post processing is applied as well, which " "includes everything rendered on top of the rendering, such as the user " - "interface", + "interface.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ShowStatisticsInfo = { "ShowStatistics", "Show Statistics", - "Show updating, rendering, and network statistics on all rendering nodes", - // @VISIBILITY(3.5) + "Show updating, rendering, and network statistics on all rendering nodes.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -153,7 +150,7 @@ namespace { "ScreenshotUseDate", "Screenshot Folder uses Date", "If this value is set to 'true', screenshots will be saved to a folder that " - "contains the time at which this value was enabled", + "contains the time at which this value was enabled.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -161,7 +158,7 @@ namespace { "ShowFrameInformation", "Show Frame Information", "If this value is enabled, the current frame number and frame times are rendered " - "into the window", + "into the window.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -172,7 +169,7 @@ namespace { "Every other aspect of the application will be unaffected by this and it will " "still respond to user input. This setting is reasonably only useful in the case " "of multi-pipeline environments, such as planetariums, where the output of the " - "master node is not required and performance can be gained by disabling it", + "master node is not required and performance can be gained by disabling it.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -182,7 +179,7 @@ namespace { "Applies a global view rotation. Use this to rotate the position of the " "focus node away from the default location on the screen. This setting " "persists even when a new focus node is selected. Defined using pitch, yaw, " - "roll in radians", + "roll in radians.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -190,7 +187,7 @@ namespace { "ScreenSpaceRotation", "Screen Space Rotation", "Applies a rotation to all screen space renderables. Defined using pitch, yaw, " - "roll in radians", + "roll in radians.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -199,16 +196,16 @@ namespace { "Master Rotation", "Applies a view rotation for only the master node, defined using pitch, yaw, " "roll in radians.This can be used to compensate the master view direction for " - "tilted display systems in clustered immersive environments", + "tilted display systems in clustered immersive environments.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableHDRPipelineInfo = { - "DisableHDRPipeline", - "Disable HDR Rendering", - "If this value is enabled, the rendering will disable the HDR color handling and " - "the LDR color pipeline will be used. Be aware of possible over exposure in the " - "final colors", + "DisableHDRPipeline", + "Disable HDR Rendering", + "If this value is enabled, the rendering will disable the HDR color handling and " + "the LDR color pipeline will be used. Be aware of possible over exposure in the " + "final colors.", openspace::properties::Property::Visibility::Hidden }; @@ -216,8 +213,7 @@ namespace { "HDRExposure", "HDR Exposure", "This value determines the amount of light per unit area reaching the equivalent " - "of an electronic image sensor", - // @VISIBILITY(3.5) + "of an electronic image sensor.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -232,21 +228,21 @@ namespace { constexpr openspace::properties::Property::PropertyInfo HueInfo = { "Hue", "Hue", - "Hue", + "Hue.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SaturationInfo = { "Saturation", "Saturation", - "Saturation", + "Saturation.", openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ValueInfo = { "Value", "Value", - "Value", + "Value.", openspace::properties::Property::Visibility::User }; @@ -254,8 +250,7 @@ namespace { "FramerateLimit", "Framerate Limit", "If set to a value bigger than 0, the framerate will be limited to that many " - "frames per second without using V-Sync", - // @VISIBILITY(2.5) + "frames per second without using V-Sync.", openspace::properties::Property::Visibility::User }; @@ -264,7 +259,7 @@ namespace { "Horizontal Field of View", "Adjusts the degrees of the horizontal field of view. The vertical field of " "view will be automatically adjusted to match, according to the current " - "aspect ratio", + "aspect ratio.", openspace::properties::Property::Visibility::User }; @@ -272,8 +267,7 @@ namespace { "BlackoutFactor", "Blackout Factor", "The blackout factor of the rendering. This can be used for fading in or out the " - "rendering window", - // @VISIBILITY(2.5) + "rendering window.", openspace::properties::Property::Visibility::User }; @@ -281,29 +275,28 @@ namespace { "ApplyBlackoutToMaster", "Apply Blackout to Master", "If this value is 'true', the blackout factor is applied to the master node. " - "Regardless of this value, the clients will always adhere to the factor", + "Regardless of this value, the clients will always adhere to the factor.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FXAAInfo = { "FXAA", "Enable FXAA", - "Enable FXAA", - // @VISIBILITY(3.5) + "Enable FXAA.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EnabledFontColorInfo = { "EnabledFontColor", "Enabled Font Color", - "The font color used for enabled options", + "The font color used for enabled options.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisabledFontColorInfo = { "DisabledFontColor", "Disabled Font Color", - "The font color used for disabled options", + "The font color used for disabled options.", openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/rendering/screenspacerenderable.cpp b/src/rendering/screenspacerenderable.cpp index af8f29ea08..40b27847f5 100644 --- a/src/rendering/screenspacerenderable.cpp +++ b/src/rendering/screenspacerenderable.cpp @@ -51,7 +51,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "This setting determines whether this sceen space plane will be visible or not", + "This setting determines whether this sceen space plane will be visible or not.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -61,7 +61,7 @@ namespace { "If this value is 'true', this screenspace renderable is going to ignore the " "global blackout factor from the Render Engine and will always render at full " "opacity. If it is 'false', it will adhere to the factor and fade out like the " - "rest of the 3D rendering", + "rest of the 3D rendering.", openspace::properties::Property::Visibility::User }; @@ -75,7 +75,7 @@ namespace { "using cartesian coordinates. By switching this value, the correct property will " "be shown or hidden. The Cartesian coordinate system is useful if a regular " "rendering is applied, whereas the radius azimuth elevation are most useful in a " - "planetarium environment", + "planetarium environment.", openspace::properties::Property::Visibility::NoviceUser }; @@ -83,8 +83,7 @@ namespace { { "UsePerspectiveProjection", "Use Perspective Projection", - "Determines whetether the z/radius values affects the size of the plane or not", - // @VISIBILITY(3.25) + "Determines whetether the z/radius values affects the size of the plane or not.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -92,7 +91,7 @@ namespace { "CartesianPosition", "Cartesian Coordinates", "This value determines the position of this screen space plane in Cartesian " - "three-dimensional coordinates (meters)", + "three-dimensional coordinates (meters).", openspace::properties::Property::Visibility::NoviceUser }; @@ -101,7 +100,7 @@ namespace { "Radius Azimuth Elevation", "This value determines the position of this screen space plane in a " "coordinate system based on radius (meters), azimuth (radians) and elevation " - "(radians)", + "(radians).", openspace::properties::Property::Visibility::NoviceUser }; @@ -110,15 +109,14 @@ namespace { "Scale Value", "This value determines a scale factor for the plane. The default size of a plane " "is determined by the concrete instance and reflects, for example, the size of " - "the image being displayed", - // @VISIBILITY(1.6) + "the image being displayed.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LocalRotationInfo = { "Rotation", "Local Rotation", - "An euler rotation (x, y, z) to apply to the plane", + "An euler rotation (x, y, z) to apply to the plane.", openspace::properties::Property::Visibility::User }; @@ -126,7 +124,7 @@ namespace { "MultiplyColor", "Multiply Color", "If set, the plane's texture is multiplied with this color. Useful for applying " - "a color grayscale images", + "a color grayscale images.", openspace::properties::Property::Visibility::User }; @@ -135,7 +133,7 @@ namespace { "Background Color", "The fixed color that is combined with the screen space renderable to create the " "final color. The actual color of the screen space renderable is alpha-blended " - "with the background color to produce the final result", + "with the background color to produce the final result.", openspace::properties::Property::Visibility::User }; @@ -143,8 +141,7 @@ namespace { "Delete", "Delete", "If this property is triggered, this screen space plane is removed from the " - "scene", - // @VISIBILITY(2.25) + "scene.", openspace::properties::Property::Visibility::User }; @@ -152,29 +149,28 @@ namespace { "FaceCamera", "Face Camera", "If enabled, the local rotation is applied after the plane is rotated to face " - "the camera", - // @VISIBILITY(1.25) + "the camera.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo GammaInfo = { "Gamma", "Gamma Correction", - "Sets the gamma correction of the texture", + "Sets the gamma correction of the texture.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BorderWidthInfo = { "BorderWidth", "Border Width", - "The width of the border", + "The width of the border.", openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo BorderColorInfo = { "BorderColor", "Border Color", - "Sets the color of the border", + "Sets the color of the border.", openspace::properties::Property::Visibility::NoviceUser }; diff --git a/src/scene/lightsource.cpp b/src/scene/lightsource.cpp index eb6648a337..c16f227269 100644 --- a/src/scene/lightsource.cpp +++ b/src/scene/lightsource.cpp @@ -38,7 +38,7 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Whether the light source is enabled or not", + "Whether the light source is enabled or not.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/scene/scenegraphnode.cpp b/src/scene/scenegraphnode.cpp index a6ec5deab3..9c72936bb1 100644 --- a/src/scene/scenegraphnode.cpp +++ b/src/scene/scenegraphnode.cpp @@ -47,36 +47,35 @@ namespace { "ComputeScreenSpaceData", "Compute Screen Space Data", "If this value is set to 'true', the screenspace-based properties are calculated " - "at regular intervals. If these values are set to 'false', they are not updated", + "at regular intervals. If these values are set to 'false', they are not updated.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ScreenSpacePositionInfo = { "ScreenSpacePosition", "ScreenSpacePosition", - "The x,y position in screen space. Can be used for placing GUI elements", + "The x,y position in screen space. Can be used for placing GUI elements.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ScreenVisibilityInfo = { "ScreenVisibility", "ScreenVisibility", - "Determines if the node is currently visible on screen", + "Determines if the node is currently visible on screen.", openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DistanceFromCamToNodeInfo = { "DistanceFromCamToNode", "DistanceFromCamToNode", - "The distance from the camera to the node surface", + "The distance from the camera to the node surface.", openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ScreenSizeRadiusInfo = { "ScreenSizeRadius", "ScreenSizeRadius", - "The screen size of the radius of the node", - // @VISIBILITY(3.5) + "The screen size of the radius of the node.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -84,7 +83,7 @@ namespace { "VisibilityDistance", "VisibilityDistance", "The distace in world coordinates between node and camera at which the " - "screenspace object will become visible", + "screenspace object will become visible.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -95,7 +94,7 @@ namespace { "scene graph node renders must be contained within this sphere. This value is " "only used as an override to the bounding sphere calculated by the Renderable, " "if present. If this value is -1, the Renderable's computed bounding sphere is " - "used", + "used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -105,7 +104,7 @@ namespace { "The minimum radius that the camera is allowed to get close to this scene graph " "node. This value is only used as an override to the bounding sphere calculated " "by the Renderable, if present. If this value is -1, the Renderable's computed " - "interaction sphere is used", + "interaction sphere is used.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -115,7 +114,7 @@ namespace { "This read-only property contains the evaluated value for the bounding sphere. " "This is the actual value that is used internally within the software. If the " "BoundingSphere property is set to -1, it is the computed value, otherwise it " - "matches the one set in the property", + "matches the one set in the property.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -125,7 +124,7 @@ namespace { "This read-only property contains the evaluated value for the interaction " "sphere. This is the actual value that is used internally within the software. " "If the InteractionSphere property is set to -1, it is the computed value, " - "otherwise it matches the one set in the property", + "otherwise it matches the one set in the property.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -133,8 +132,7 @@ namespace { "ApproachFactor", "Approach Factor", "This value is a multiplication factor for the interaction sphere that " - "determines when the camera is 'approaching' the scene graph node", - // @VISIBILITY(3.5) + "determines when the camera is 'approaching' the scene graph node.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -142,8 +140,7 @@ namespace { "ReachFactor", "Reach Factor", "This value is a multiplication factor for the interaction sphere that " - "determines when the camera has 'reached' the scene graph node", - // @VISIBILITY(3.5) + "determines when the camera has 'reached' the scene graph node.", openspace::properties::Property::Visibility::AdvancedUser }; @@ -151,14 +148,14 @@ namespace { "GuiPath", "Gui Path", "This is the path for the scene graph node in the gui example: " - "/Solar System/Planets/Earth", + "/Solar System/Planets/Earth.", openspace::properties::Property::Visibility::Hidden }; constexpr openspace::properties::Property::PropertyInfo GuiNameInfo = { "GuiName", "Gui Name", - "This is the name for the scene graph node in the gui. Example: Earth", + "This is the name for the scene graph node in the gui. Example: Earth.", openspace::properties::Property::Visibility::Hidden }; @@ -166,7 +163,7 @@ namespace { "GuiDescription", "Gui Description", "This is the description for the scene graph node to be shown in the gui. " - "Example: Earth is a special place", + "Example: Earth is a special place.", openspace::properties::Property::Visibility::Hidden }; @@ -174,7 +171,7 @@ namespace { "GuiHidden", "Gui Hidden", "This represents if the scene graph node should be shown in the gui. " - "Example: false", + "Example: false.", openspace::properties::Property::Visibility::Hidden }; @@ -185,7 +182,6 @@ namespace { "method. The interaction sphere is rendered in cyan and the bounding sphere in " "purple. If only one is visible, this may be because the spheres have equal " "size and are overlapping.", - // @VISIBILITY(3.67) openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/scripting/scriptscheduler.cpp b/src/scripting/scriptscheduler.cpp index 5024fd1ba1..7bf4fb1956 100644 --- a/src/scripting/scriptscheduler.cpp +++ b/src/scripting/scriptscheduler.cpp @@ -39,8 +39,7 @@ namespace { "Enabled", "This enables or disables the ScriptScheduler. If disabled, no scheduled scripts " "will be executed. If enabled, scheduled scripts will be executed at their given " - "time as normal", - // @VISIBILITY(2.5) + "time as normal.", openspace::properties::Property::Visibility::User }; @@ -49,7 +48,7 @@ namespace { "Should Run All Time Jump", "If 'true': In a time jump, all scheduled scripts between the old time and the " "new time is executed. If 'false': In a time jump, no scripts scheduled between " - "the new time and the old time is executed", + "the new time and the old time is executed.", openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/src/util/timemanager.cpp b/src/util/timemanager.cpp index 52884a9927..3a5347971b 100644 --- a/src/util/timemanager.cpp +++ b/src/util/timemanager.cpp @@ -48,30 +48,30 @@ namespace { DefaultTimeInterpolationDurationInfo = { "DefaultTimeInterpolationDuration", "Default Time Interpolation Duration", - "The default duration taken to interpolate between times" + "The default duration taken to interpolate between times." }; constexpr openspace::properties::Property::PropertyInfo DefaultDeltaTimeInterpolationDurationInfo = { "DefaultDeltaTimeInterpolationDuration", "Default Delta Time Interpolation Duration", - "The default duration taken to interpolate between delta times" + "The default duration taken to interpolate between delta times." }; constexpr openspace::properties::Property::PropertyInfo DefaultPauseInterpolationDurationInfo = { "DefaultPauseInterpolationDuration", "Default Pause Interpolation Duration", - "The default duration taken to transition to the paused state, " - "when interpolating" + "The default duration taken to transition to the paused state, when " + "interpolating." }; constexpr openspace::properties::Property::PropertyInfo DefaultUnpauseInterpolationDurationInfo = { "DefaultUnpauseInterpolationDuration", "Default Unpause Interpolation Duration", - "The default duration taken to transition to the unpaused state, " - "when interpolating" + "The default duration taken to transition to the unpaused state, when " + "interpolating." }; constexpr std::string_view DeltaTimeStepsGuiPath = "/Time/Simulation Speed/Steps";