diff --git a/include/openspace/properties/property.h b/include/openspace/properties/property.h index 4dbe290e07..4a5fc2a18c 100644 --- a/include/openspace/properties/property.h +++ b/include/openspace/properties/property.h @@ -72,6 +72,8 @@ public: User = 2, ///< Visible in User mode NoviceUser = 1, ///< Visible in Novice User mode Always = 0, ///< Visible for all types, no matter what + + Default = Always ///< The default visibility for properties }; /** @@ -102,7 +104,7 @@ public: /// The user facing description of this Property const char* description; /// Determines the visibility of this Property in the user interface - Visibility visibility = Visibility::Always; + Visibility visibility = Visibility::Default; }; /// An OnChangeHandle is returned by the onChange method to uniquely identify an diff --git a/modules/atmosphere/rendering/renderableatmosphere.cpp b/modules/atmosphere/rendering/renderableatmosphere.cpp index e6bd488770..e46c6e2956 100644 --- a/modules/atmosphere/rendering/renderableatmosphere.cpp +++ b/modules/atmosphere/rendering/renderableatmosphere.cpp @@ -41,7 +41,8 @@ namespace { constexpr openspace::properties::Property::PropertyInfo AtmosphereHeightInfo = { "AtmosphereHeight", "Atmosphere Height (KM)", - "The thickness of the atmosphere in km" + "The thickness of the atmosphere in km", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AverageGroundReflectanceInfo = @@ -49,59 +50,70 @@ 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" + "constant factor", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RayleighScatteringCoeffInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo OzoneHeightScaleInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MieHeightScaleInfo = { "MieHeightScale", "Mie Scale Height (KM)", "It is the vertical distance over which the density and pressure fall by a " - "constant factor" + "constant factor", + // @VISIBILITY(3.2) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MieScatteringCoeffInfo = { "MieScatteringCoeff", "Mie Scattering Coeff", - "Mie sea-level scattering coefficients in meters" + "Mie sea-level scattering coefficients in meters", + // @VISIBILITY(3.2) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -109,19 +121,25 @@ namespace { { "MieScatteringExtinctionPropCoefficient", "Mie Scattering/Extinction Proportion Coefficient (%)", - "Mie Scattering/Extinction Proportion Coefficient (%)" + "Mie Scattering/Extinction Proportion Coefficient (%)", + // @VISIBILITY(3.2) + 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" + "Averaging of the scattering angle over a high number of scattering events", + // @VISIBILITY(3.2) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SunIntensityInfo = { "SunIntensity", "Sun Intensity", - "Unitless for now" + "Unitless for now", + // @VISIBILITY(2.6) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo @@ -129,26 +147,31 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo EclipseHardShadowsInfo = { "EclipseHardShadowsInfo", "Enable Hard Shadows for Eclipses", - "Enable/Disables hard shadows through the atmosphere" + "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 }; constexpr openspace::properties::Property::PropertyInfo SunsetAngleInfo = { "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 }; struct [[codegen::Dictionary(RenderableAtmosphere)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemangle.cpp b/modules/base/dashboard/dashboarditemangle.cpp index 9557f92524..12217ef19d 100644 --- a/modules/base/dashboard/dashboarditemangle.cpp +++ b/modules/base/dashboard/dashboarditemangle.cpp @@ -50,7 +50,9 @@ 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'" + "angle. The default value is 'Camera'", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SourceNodeNameInfo = { @@ -59,7 +61,9 @@ 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)" + "Source, Reference, Destination)", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ReferenceTypeInfo = { @@ -67,14 +71,18 @@ 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)" + "the triangle (Source, Reference, Destination)", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ReferenceNodeNameInfo = { "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" + "node that is to be used as the reference direction to compute the angle", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DestinationTypeInfo = { @@ -82,14 +90,18 @@ 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'" + "Source, Reference, Destination). The default value for this is 'Focus'", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DestinationNodeNameInfo = { "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" + "node that is to be used as the destination for computing the angle", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemAngle)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemdate.cpp b/modules/base/dashboard/dashboarditemdate.cpp index f5fc9d29ee..cca8844985 100644 --- a/modules/base/dashboard/dashboarditemdate.cpp +++ b/modules/base/dashboard/dashboarditemdate.cpp @@ -40,7 +40,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo TimeFormatInfo = { @@ -49,7 +50,9 @@ 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" + "information about how to structure this format", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemDate)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemdistance.cpp b/modules/base/dashboard/dashboarditemdistance.cpp index fd99b8814e..895c6dbf4a 100644 --- a/modules/base/dashboard/dashboarditemdistance.cpp +++ b/modules/base/dashboard/dashboarditemdistance.cpp @@ -52,28 +52,36 @@ namespace { "SourceType", "Source Type", "The type of position that is used as the source to calculate the distance. The " - "default value is 'Camera'" + "default value is 'Camera'", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SourceNodeNameInfo = { "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" + "node that is to be used as the source for computing the distance", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DestinationTypeInfo = { "DestinationType", "Destination Type", "The type of position that is used as the destination to calculate the distance. " - "The default value for this is 'Focus'" + "The default value for this is 'Focus'", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DestinationNodeNameInfo = { "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" + "node that is to be used as the destination for computing the distance", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SimplificationInfo = { @@ -81,7 +89,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RequestedUnitInfo = { @@ -96,7 +105,8 @@ 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 }; std::vector unitList() { diff --git a/modules/base/dashboard/dashboarditemelapsedtime.cpp b/modules/base/dashboard/dashboarditemelapsedtime.cpp index 6406bf97e8..295ad646f5 100644 --- a/modules/base/dashboard/dashboarditemelapsedtime.cpp +++ b/modules/base/dashboard/dashboarditemelapsedtime.cpp @@ -41,14 +41,17 @@ namespace { "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 value " - "of the elapsed time." + "of the elapsed time.", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ReferenceTimeInfo = { "ReferenceTime", "Reference Time", "The reference time relative to which the elapsed time is specified. The format " - "must be an ISO 8601-compliant date string" + "must be an ISO 8601-compliant date string", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SimplifyTimeInfo = { @@ -56,14 +59,18 @@ namespace { "Simplify Time", "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'." + "presented in seconds. The default value for this is 'true'.", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LowestTimeUnitInfo = { "LowestTimeUnit", "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." + "All finer grained timesteps will be ignored.", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemElapsedTime)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemframerate.cpp b/modules/base/dashboard/dashboarditemframerate.cpp index 6380dbfa9b..1ef866c87b 100644 --- a/modules/base/dashboard/dashboarditemframerate.cpp +++ b/modules/base/dashboard/dashboarditemframerate.cpp @@ -48,14 +48,17 @@ 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" + "This value determines the units in which the frame time is displayed", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ClearCacheInfo = { "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) { diff --git a/modules/base/dashboard/dashboarditeminputstate.cpp b/modules/base/dashboard/dashboarditeminputstate.cpp index d3b0210e17..ea0758154e 100644 --- a/modules/base/dashboard/dashboarditeminputstate.cpp +++ b/modules/base/dashboard/dashboarditeminputstate.cpp @@ -37,31 +37,41 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ShowWhenEnabledInfo = { "ShowWhenEnabled", "Show when enabled", - "Show text when the input is enabled" + "Show text when the input is enabled", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowWhenDisabledInfo = { "ShowWhenDisabled", "Show when disabled", - "Show text when the input is disabled" + "Show text when the input is disabled", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowKeyboardInfo = { "ShowKeyboard", "Show Keyboard information", - "Display the state of the keyboard input" + "Display the state of the keyboard input", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowMouseInfo = { "ShowMouse", "Show Mouse information", - "Display the state of the mouse input" + "Display the state of the mouse input", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowJoystickInfo = { "ShowJoystick", "Show Joystick information", - "Display the state of the joystick input" + "Display the state of the joystick input", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemPropertyValue)]] Parameters { diff --git a/modules/base/dashboard/dashboarditempropertyvalue.cpp b/modules/base/dashboard/dashboarditempropertyvalue.cpp index cd8706bf63..2d24893547 100644 --- a/modules/base/dashboard/dashboarditempropertyvalue.cpp +++ b/modules/base/dashboard/dashboarditempropertyvalue.cpp @@ -38,7 +38,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo PropertyUriInfo = { "URI", "Property URI", - "The URI of the property that is displayed in this dashboarditem" + "The URI of the property that is displayed in this dashboarditem", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DisplayStringInfo = { @@ -46,7 +48,9 @@ namespace { "Display String", "The String that is being displayed. It must either be empty (in which case only " "the value itself will be displayed), or it must contain extact one instance of " - "{}, which will be replaced with the value of the property during rendering" + "{}, which will be replaced with the value of the property during rendering", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemPropertyValue)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemsimulationincrement.cpp b/modules/base/dashboard/dashboarditemsimulationincrement.cpp index 69f38c65c8..6e007cd93d 100644 --- a/modules/base/dashboard/dashboarditemsimulationincrement.cpp +++ b/modules/base/dashboard/dashboarditemsimulationincrement.cpp @@ -41,14 +41,18 @@ 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" + "displayed in seconds", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RequestedUnitInfo = { "RequestedUnit", "Requested Unit", "If the simplification is disabled, this time unit is used as a destination to " - "convert the seconds into" + "convert the seconds into", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TransitionFormatInfo = { @@ -59,7 +63,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RegularFormatInfo = { @@ -68,7 +73,8 @@ 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 }; std::vector unitList() { diff --git a/modules/base/dashboard/dashboarditemspacing.cpp b/modules/base/dashboard/dashboarditemspacing.cpp index 75f9a4a346..806fb95c71 100644 --- a/modules/base/dashboard/dashboarditemspacing.cpp +++ b/modules/base/dashboard/dashboarditemspacing.cpp @@ -33,7 +33,9 @@ namespace { "Spacing", "Spacing", "This value determines the spacing (in pixels) that this item represents. The " - "default value is 15" + "default value is 15", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemSpacing)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemtext.cpp b/modules/base/dashboard/dashboarditemtext.cpp index 7dea51bd91..6b7b3cbead 100644 --- a/modules/base/dashboard/dashboarditemtext.cpp +++ b/modules/base/dashboard/dashboarditemtext.cpp @@ -37,7 +37,8 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TextInfo = { "Text", "Text", - "The text to be displayed" + "The text to be displayed", + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardItemText)]] Parameters { diff --git a/modules/base/dashboard/dashboarditemvelocity.cpp b/modules/base/dashboard/dashboarditemvelocity.cpp index 599e67b837..b1911c1e7b 100644 --- a/modules/base/dashboard/dashboarditemvelocity.cpp +++ b/modules/base/dashboard/dashboarditemvelocity.cpp @@ -45,14 +45,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RequestedUnitInfo = { "RequestedUnit", "Requested Unit", "If the simplification is disabled, this distance unit is used for the velocity " - "display" + "display", + openspace::properties::Property::Visibility::User }; std::vector unitList() { diff --git a/modules/base/lightsource/cameralightsource.cpp b/modules/base/lightsource/cameralightsource.cpp index 65e2a59531..f20751a951 100644 --- a/modules/base/lightsource/cameralightsource.cpp +++ b/modules/base/lightsource/cameralightsource.cpp @@ -33,7 +33,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo IntensityInfo = { "Intensity", "Intensity", - "The intensity of this light source" + "The intensity of this light source", + // @VISIBILITY(1.75) + openspace::properties::Property::Visibility::NoviceUser }; struct [[codegen::Dictionary(CameraLightSource)]] Parameters { diff --git a/modules/base/lightsource/scenegraphlightsource.cpp b/modules/base/lightsource/scenegraphlightsource.cpp index 1844919d23..29bdb62cda 100644 --- a/modules/base/lightsource/scenegraphlightsource.cpp +++ b/modules/base/lightsource/scenegraphlightsource.cpp @@ -37,13 +37,16 @@ namespace { constexpr openspace::properties::Property::PropertyInfo IntensityInfo = { "Intensity", "Intensity", - "The intensity of this light source" + "The intensity of this light source", + // @VISIBILITY(1.75) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo NodeInfo = { "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 }; struct [[codegen::Dictionary(SceneGraphLightSource)]] Parameters { diff --git a/modules/base/rendering/grids/renderableboxgrid.cpp b/modules/base/rendering/grids/renderableboxgrid.cpp index 4bb4b6e182..2a54b6d064 100644 --- a/modules/base/rendering/grids/renderableboxgrid.cpp +++ b/modules/base/rendering/grids/renderableboxgrid.cpp @@ -39,19 +39,23 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered" + "This value determines the color of the grid lines that are rendered", + // @VISIBILITY(1.17) + 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 }; static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { diff --git a/modules/base/rendering/grids/renderablegrid.cpp b/modules/base/rendering/grids/renderablegrid.cpp index 018436726b..a855a2b441 100644 --- a/modules/base/rendering/grids/renderablegrid.cpp +++ b/modules/base/rendering/grids/renderablegrid.cpp @@ -39,20 +39,26 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered" + "This value determines the color of the grid lines that are rendered", + // @VISIBILITY(1.25) + 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" + "This value determines the color of the highlighted lines in the grid", + // @VISIBILITY(1.25) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = { "Segments", "Number of Segments", "This value specifies the number of segments that are used to render the " - "grid in each direction" + "grid in each direction", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo HighlightRateInfo = { @@ -60,25 +66,30 @@ namespace { "Highlight Rate", "The rate that the columns and rows are highlighted, counted with respect to the " "center of the grid. If the number of segments in the grid is odd, the " - "highlighting might be offset from the center." + "highlighting might be offset from the center.", + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width of the grid" + "This value specifies the line width of the grid", + // @VISIBILITY(1.5) + 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 }; static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { diff --git a/modules/base/rendering/grids/renderableradialgrid.cpp b/modules/base/rendering/grids/renderableradialgrid.cpp index ccd3a83f74..fa1f2c4d5e 100644 --- a/modules/base/rendering/grids/renderableradialgrid.cpp +++ b/modules/base/rendering/grids/renderableradialgrid.cpp @@ -40,27 +40,34 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered" + "This value determines the color of the grid lines that are rendered", + // @VISIBILITY(1.25) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo GridSegmentsInfo = { "GridSegments", "Number of Grid Segments", "Specifies the number of segments for the grid, in the radial and angular " - "direction respectively" + "direction respectively", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo CircleSegmentsInfo = { "CircleSegments", "Number of Circle Segments", "This value specifies the number of segments that is used to render each circle " - "in the grid" + "in the grid", + // @VISIBILITY(2.5) + 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 }; constexpr openspace::properties::Property::PropertyInfo RadiiInfo = { @@ -68,7 +75,9 @@ 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" + "ring", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { diff --git a/modules/base/rendering/grids/renderablesphericalgrid.cpp b/modules/base/rendering/grids/renderablesphericalgrid.cpp index 4c520cad00..bc261d6078 100644 --- a/modules/base/rendering/grids/renderablesphericalgrid.cpp +++ b/modules/base/rendering/grids/renderablesphericalgrid.cpp @@ -39,20 +39,26 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value determines the color of the grid lines that are rendered" + "This value determines the color of the grid lines that are rendered", + // @VISIBILITY(1.25) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = { "Segments", "Number of Segments", "This value specifies the number of segments that are used to render the " - "surrounding sphere" + "surrounding sphere", + // @VISIBILITY(2.25) + 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", + // @VISIBILITY(1.67) + openspace::properties::Property::Visibility::NoviceUser }; static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { diff --git a/modules/base/rendering/renderablecartesianaxes.cpp b/modules/base/rendering/renderablecartesianaxes.cpp index 9d0b53e7d6..e93e18d107 100644 --- a/modules/base/rendering/renderablecartesianaxes.cpp +++ b/modules/base/rendering/renderablecartesianaxes.cpp @@ -40,19 +40,25 @@ namespace { constexpr openspace::properties::Property::PropertyInfo XColorInfo = { "XColor", "X Color", - "This value determines the color of the x axis" + "This value determines the color of the x axis", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo YColorInfo = { "YColor", "Y Color", - "This value determines the color of the y axis" + "This value determines the color of the y axis", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ZColorInfo = { "ZColor", "Z Color", - "This value determines the color of the z axis" + "This value determines the color of the z axis", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; struct [[codegen::Dictionary(RenderableCartesianAxes)]] Parameters { diff --git a/modules/base/rendering/renderabledisc.cpp b/modules/base/rendering/renderabledisc.cpp index 3e40f356c1..f09ae1dbfd 100644 --- a/modules/base/rendering/renderabledisc.cpp +++ b/modules/base/rendering/renderabledisc.cpp @@ -47,13 +47,17 @@ 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" + "texture to be used for the color", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value specifies the outer radius of the disc in meter" + "This value specifies the outer radius of the disc in meter", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo WidthInfo = { @@ -61,7 +65,8 @@ 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 }; struct [[codegen::Dictionary(RenderableDisc)]] Parameters { diff --git a/modules/base/rendering/renderablelabel.cpp b/modules/base/rendering/renderablelabel.cpp index b0d8cfd437..f11f5bd89f 100644 --- a/modules/base/rendering/renderablelabel.cpp +++ b/modules/base/rendering/renderablelabel.cpp @@ -92,55 +92,71 @@ 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" + "The label text color", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = { "FontSize", "Font Size", - "The font size (in points) for the label" + "The font size (in points) for the label", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value affects the size scale of the label" + "This value affects the size scale of the label", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TextInfo = { "Text", "Text", - "The text that will be displayed on screen" + "The text that will be displayed on screen", + // @VISIBILITY(1.8) + 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" + "Transformation matrix to be applied to the label", + // @VISIBILITY(3.6) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OrientationOptionInfo = { "OrientationOption", "Orientation Option", - "Label orientation rendering mode" + "Label orientation rendering mode", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EnableFadingEffectInfo = { "EnableFading", "Enable/Disable Fade-in Effect", - "Enable/Disable the Fade-in effect" + "Enable/Disable the Fade-in effect", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FadeWidthsInfo = { @@ -150,20 +166,23 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FadeDistancesInfo = { "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 }; struct [[codegen::Dictionary(RenderableLabel)]] Parameters { diff --git a/modules/base/rendering/renderablemodel.cpp b/modules/base/rendering/renderablemodel.cpp index c90f7ffbaf..707089cf9d 100644 --- a/modules/base/rendering/renderablemodel.cpp +++ b/modules/base/rendering/renderablemodel.cpp @@ -88,70 +88,85 @@ 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" + "A multiplier for ambient lighting", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DiffuseIntensityInfo = { "DiffuseIntensity", "Diffuse Intensity", - "A multiplier for diffuse lighting" + "A multiplier for diffuse lighting", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SpecularIntensityInfo = { "SpecularIntensity", "Specular Intensity", - "A multiplier for specular lighting" + "A multiplier for specular lighting", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShadingInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ModelTransformInfo = { "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 RotationVecInfo = { "RotationVector", "Rotation Vector", - "Rotation Vector using degrees" + "Rotation Vector using degrees", + // @VISIBILITY(3.75) + 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 }; constexpr openspace::properties::Property::PropertyInfo BlendingOptionInfo = { "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 }; struct [[codegen::Dictionary(RenderableModel)]] Parameters { diff --git a/modules/base/rendering/renderablenodeline.cpp b/modules/base/rendering/renderablenodeline.cpp index 5d6944bfdb..6f61e2b3cc 100644 --- a/modules/base/rendering/renderablenodeline.cpp +++ b/modules/base/rendering/renderablenodeline.cpp @@ -45,26 +45,31 @@ namespace { "StartNode", "Start Node", "The identifier of the node the line starts from. Defaults to 'Root' if not " - "specified." + "specified.", + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EndNodeInfo = { "EndNode", "End Node", "The identifier of the node the line ends at. Defaults to 'Root' if not " - "specified." + "specified.", + openspace::properties::Property::Visibility::User }; 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" + "This value specifies the line width", + // @VISIBILITY(1.75) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo StartOffsetInfo = { diff --git a/modules/base/rendering/renderableplane.cpp b/modules/base/rendering/renderableplane.cpp index ab0d2dc5d1..67c8d1326c 100644 --- a/modules/base/rendering/renderableplane.cpp +++ b/modules/base/rendering/renderableplane.cpp @@ -54,7 +54,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo MirrorBacksideInfo = { @@ -62,13 +63,16 @@ 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" + "data at a specific location, but not if it is displaying text for example", + // @VISIBILITY(2.67) + 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 }; constexpr openspace::properties::Property::PropertyInfo AutoScaleInfo = { @@ -81,14 +85,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo MultiplyColorInfo = { "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 }; struct [[codegen::Dictionary(RenderablePlane)]] Parameters { diff --git a/modules/base/rendering/renderableplaneimagelocal.cpp b/modules/base/rendering/renderableplaneimagelocal.cpp index 401aa60c0f..8280dfcee0 100644 --- a/modules/base/rendering/renderableplaneimagelocal.cpp +++ b/modules/base/rendering/renderableplaneimagelocal.cpp @@ -42,7 +42,9 @@ 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" + "that is applied to this plane. This image has to be square", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderablePlaneImageLocal)]] Parameters { diff --git a/modules/base/rendering/renderableplaneimageonline.cpp b/modules/base/rendering/renderableplaneimageonline.cpp index bd127bef94..65c9f4ffb1 100644 --- a/modules/base/rendering/renderableplaneimageonline.cpp +++ b/modules/base/rendering/renderableplaneimageonline.cpp @@ -39,7 +39,9 @@ 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" + "and displayed", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderablePlaneImageOnline)]] Parameters { diff --git a/modules/base/rendering/renderableplanetimevaryingimage.cpp b/modules/base/rendering/renderableplanetimevaryingimage.cpp index c63add8148..27c93f371a 100644 --- a/modules/base/rendering/renderableplanetimevaryingimage.cpp +++ b/modules/base/rendering/renderableplanetimevaryingimage.cpp @@ -45,14 +45,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RenderTypeInfo = { "RenderType", "Render Type", "This value specifies if the plane should be rendered in the Background, " - "Opaque, Transparent, or Overlay rendering step" + "Opaque, Transparent, or Overlay rendering step", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderablePlaneTimeVaryingImage)]] Parameters { diff --git a/modules/base/rendering/renderableprism.cpp b/modules/base/rendering/renderableprism.cpp index a6d357de10..308391b9c3 100644 --- a/modules/base/rendering/renderableprism.cpp +++ b/modules/base/rendering/renderableprism.cpp @@ -43,45 +43,59 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = { "Segments", "Segments", - "The number of segments the shape of the prism should have" + "The number of segments the shape of the prism should have", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LinesInfo = { "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" + "distributed around the bounding circle that makes up the shape of the prism", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RadiusInfo = { "Radius", "Radius", - "The radius of the prism's shape in meters" + "The radius of the prism's shape in meters", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo BaseRadiusInfo = { "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" + "the same radius as the outer shape", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { "LineWidth", "Line Width", - "This value specifies the line width" + "This value specifies the line width", + // @VISIBILITY(2.0) + openspace::properties::Property::Visibility::User }; 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", + // @VISIBILITY(1.2) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LengthInfo = { "Length", "Length", - "The length of the prism in meters" + "The length of the prism in meters", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; // Generate vertices around the unit circle on the XY-plane diff --git a/modules/base/rendering/renderablesphere.cpp b/modules/base/rendering/renderablesphere.cpp index 743c436bcd..90896dd370 100644 --- a/modules/base/rendering/renderablesphere.cpp +++ b/modules/base/rendering/renderablesphere.cpp @@ -57,32 +57,39 @@ 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" + "projection", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; 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::User }; constexpr openspace::properties::Property::PropertyInfo OrientationInfo = { "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 SegmentsInfo = { "Segments", "Number of Segments", - "This value specifies the number of segments that the sphere is separated in" + "This value specifies the number of segments that the sphere is separated in", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; 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 FadeOutThresholdInfo = { @@ -90,7 +97,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FadeInThresholdInfo = { @@ -99,13 +107,15 @@ 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 }; 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 }; struct [[codegen::Dictionary(RenderableSphere)]] Parameters { diff --git a/modules/base/rendering/renderabletimevaryingsphere.cpp b/modules/base/rendering/renderabletimevaryingsphere.cpp index fdb33a8e7a..634db73cc8 100644 --- a/modules/base/rendering/renderabletimevaryingsphere.cpp +++ b/modules/base/rendering/renderabletimevaryingsphere.cpp @@ -59,52 +59,62 @@ 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 }; 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::User }; constexpr openspace::properties::Property::PropertyInfo OrientationInfo = { "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 SegmentsInfo = { "Segments", "Number of Segments", - "This value specifies the number of segments that the sphere is separated in" + "This value specifies the number of segments that the sphere is separated in", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; 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 FadeOutThresholdInfo = { "FadeOutThreshold", "Fade-Out Threshold", "This value determines percentage of the sphere is visible before starting " - "fading-out it" + "fading-out it", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FadeInThresholdInfo = { "FadeInThreshold", "Fade-In Threshold", "Distance from center of MilkyWay from where the astronomical object starts to " - "fade in" + "fade in", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = { "DisableFadeInOut", "Disable Fade-In/Fade-Out effects", - "Enables/Disables the Fade-In/Out effects" + "Enables/Disables the Fade-In/Out effects", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableTimeVaryingSphere)]] Parameters { diff --git a/modules/base/rendering/renderabletrail.cpp b/modules/base/rendering/renderabletrail.cpp index 66c391b146..873b8d17c6 100644 --- a/modules/base/rendering/renderabletrail.cpp +++ b/modules/base/rendering/renderabletrail.cpp @@ -71,7 +71,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo LineColorInfo = { "Color", "Color", - "This value determines the RGB main color for the lines and points of the trail" + "This value determines the RGB main color for the lines and points of the trail", + // @VISIBILITY(1.2) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo EnableFadeInfo = { @@ -79,7 +81,9 @@ 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" + "'false', the entire trail is rendered at full opacity and color", + // @VISIBILITY(1.25) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FadeInfo = { @@ -87,7 +91,9 @@ namespace { "Line fade", "The fading factor that is applied to the trail if the 'EnableFade' value is " "'true'. If it is 'false', this setting has no effect. The higher the number, " - "the less fading is applied" + "the less fading is applied", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { @@ -95,7 +101,9 @@ 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" + "ignored", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo PointSizeInfo = { @@ -104,7 +112,9 @@ 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" + "values are half this size", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RenderingModeInfo = { @@ -112,7 +122,8 @@ namespace { "Rendering Mode", "Determines how the trail should be rendered to the screen. 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 { diff --git a/modules/base/rendering/renderabletrailorbit.cpp b/modules/base/rendering/renderabletrailorbit.cpp index 4444122868..722859556d 100644 --- a/modules/base/rendering/renderabletrailorbit.cpp +++ b/modules/base/rendering/renderabletrailorbit.cpp @@ -93,7 +93,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ResolutionInfo = { @@ -102,14 +103,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RenderableTypeInfo = { "RenderableType", "RenderableType", "This value specifies if the orbit should be rendered in the Background," - "Opaque, Transparent, or Overlay rendering step. Default is Transparent" + "Opaque, Transparent, or Overlay rendering step. Default is Transparent", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableTrailOrbit)]] Parameters { diff --git a/modules/base/rendering/renderabletrailtrajectory.cpp b/modules/base/rendering/renderabletrailtrajectory.cpp index d6141007b9..f67cb04f2d 100644 --- a/modules/base/rendering/renderabletrailtrajectory.cpp +++ b/modules/base/rendering/renderabletrailtrajectory.cpp @@ -48,14 +48,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo EndTimeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo SampleIntervalInfo = { @@ -64,7 +66,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo TimeSubSampleInfo = { @@ -73,14 +76,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RenderFullPathInfo = { "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" + "'false', only the trail until the current time in the application will be shown", + // @VISIBILITY(1.25) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo SweepChunkSizeInfo = { @@ -88,7 +94,9 @@ namespace { "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." + "A greater value will result in more calculations per frame.", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableTrailTrajectory)]] Parameters { diff --git a/modules/base/rendering/screenspacedashboard.cpp b/modules/base/rendering/screenspacedashboard.cpp index 35a5bdc657..8bbc2f2f9b 100644 --- a/modules/base/rendering/screenspacedashboard.cpp +++ b/modules/base/rendering/screenspacedashboard.cpp @@ -41,7 +41,8 @@ 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 }; struct [[codegen::Dictionary(ScreenSpaceDashboard)]] Parameters { diff --git a/modules/base/rendering/screenspaceframebuffer.cpp b/modules/base/rendering/screenspaceframebuffer.cpp index 42da3e2383..b6cf74bf62 100644 --- a/modules/base/rendering/screenspaceframebuffer.cpp +++ b/modules/base/rendering/screenspaceframebuffer.cpp @@ -36,7 +36,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "This value explicitly specifies the size of the screen space plane" + "This value explicitly specifies the size of the screen space plane", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/base/rendering/screenspaceimagelocal.cpp b/modules/base/rendering/screenspaceimagelocal.cpp index 7b302a9068..d84cf9b011 100644 --- a/modules/base/rendering/screenspaceimagelocal.cpp +++ b/modules/base/rendering/screenspaceimagelocal.cpp @@ -42,7 +42,9 @@ 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" + "size of this plane", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(ScreenSpaceImageLocal)]] Parameters { diff --git a/modules/base/rendering/screenspaceimageonline.cpp b/modules/base/rendering/screenspaceimageonline.cpp index c5cb15a5e1..71160a3eb2 100644 --- a/modules/base/rendering/screenspaceimageonline.cpp +++ b/modules/base/rendering/screenspaceimageonline.cpp @@ -42,7 +42,9 @@ 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" + "size of this plane", + // @VISIBILITY(2.4) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(ScreenSpaceImageOnline)]] Parameters { diff --git a/modules/base/rotation/constantrotation.cpp b/modules/base/rotation/constantrotation.cpp index 2b5481057d..71949103e2 100644 --- a/modules/base/rotation/constantrotation.cpp +++ b/modules/base/rotation/constantrotation.cpp @@ -34,13 +34,17 @@ namespace { constexpr openspace::properties::Property::PropertyInfo RotationInfo = { "RotationAxis", "Rotation Axis", - "This value is the rotation axis around which the object will rotate" + "This value is the rotation axis around which the object will rotate", + // @VISIBILITY(3.33) + 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" + "This value determines the number of revolutions per in-game second", + // @VISIBILITY(3.33) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(ConstantRotation)]] Parameters { diff --git a/modules/base/rotation/fixedrotation.cpp b/modules/base/rotation/fixedrotation.cpp index b480b5c60e..ab69accaf7 100644 --- a/modules/base/rotation/fixedrotation.cpp +++ b/modules/base/rotation/fixedrotation.cpp @@ -42,7 +42,9 @@ 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" + "undefined behavior", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo XAxisTypeInfo = { @@ -51,7 +53,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo YAxisTypeInfo = { @@ -60,7 +63,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ZAxisTypeInfo = { @@ -69,7 +73,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo XAxisObjectInfo = { @@ -77,7 +82,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo YAxisObjectInfo = { @@ -85,7 +91,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ZAxisObjectInfo = { @@ -93,7 +100,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo XAxisInvertObjectInfo = { @@ -101,7 +109,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo YAxisInvertObjectInfo = { @@ -109,7 +118,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ZAxisInvertObjectInfo = { @@ -117,25 +127,32 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo XAxisVectorInfo = { "xAxisVector", "xAxis: Direction vector", - "This value specifies a static direction vector that is used for a fixed rotation" + "This value specifies a static direction vector that is used for a fixed " + "rotation", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo YAxisVectorInfo = { "yAxisVector", "yAxis: Direction vector", - "This value specifies a static direction vector that is used for a fixed rotation" + "This value specifies a static direction vector that is used for a fixed " + "rotation", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ZAxisVectorInfo = { "zAxisVector", "zAxis: Direction vector", - "This value specifies a static direction vector that is used for a fixed rotation" + "This value specifies a static direction vector that is used for a fixed " + "rotation", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo XAxisOrthogonalVectorInfo = { @@ -143,7 +160,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo YAxisOrthogonalVectorInfo = { @@ -151,7 +169,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ZAxisOrthogonalVectorInfo = { @@ -159,7 +178,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo AttachedInfo = { @@ -167,7 +187,8 @@ 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 }; struct [[codegen::Dictionary(FixedRotation)]] Parameters { diff --git a/modules/base/rotation/luarotation.cpp b/modules/base/rotation/luarotation.cpp index 3e1e7c8e96..83dc48fa7a 100644 --- a/modules/base/rotation/luarotation.cpp +++ b/modules/base/rotation/luarotation.cpp @@ -43,7 +43,9 @@ 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" + "values", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(LuaRotation)]] Parameters { diff --git a/modules/base/rotation/staticrotation.cpp b/modules/base/rotation/staticrotation.cpp index cb0ef831f3..3b4acc4208 100644 --- a/modules/base/rotation/staticrotation.cpp +++ b/modules/base/rotation/staticrotation.cpp @@ -32,7 +32,9 @@ 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" + "graph node that this transformation is attached to relative to its parent", + // @VISIBILITY(3.0) + openspace::properties::Property::Visibility::AdvancedUser }; // Conversion from rotation matrix to euler angles, given that the rotation is a pure diff --git a/modules/base/rotation/timelinerotation.cpp b/modules/base/rotation/timelinerotation.cpp index ac40c6e750..ce881f6a5d 100644 --- a/modules/base/rotation/timelinerotation.cpp +++ b/modules/base/rotation/timelinerotation.cpp @@ -35,7 +35,9 @@ 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", + // @VISIBILITY(3.2) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(TimelineRotation)]] Parameters { diff --git a/modules/base/scale/luascale.cpp b/modules/base/scale/luascale.cpp index 215daeecf6..92450a067e 100644 --- a/modules/base/scale/luascale.cpp +++ b/modules/base/scale/luascale.cpp @@ -42,7 +42,9 @@ 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" + "epoch the second argument and computes the three scaling factors", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(LuaScale)]] Parameters { diff --git a/modules/base/scale/nonuniformstaticscale.cpp b/modules/base/scale/nonuniformstaticscale.cpp index 5e393a0ba3..d6c4148b2d 100644 --- a/modules/base/scale/nonuniformstaticscale.cpp +++ b/modules/base/scale/nonuniformstaticscale.cpp @@ -32,7 +32,8 @@ 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 }; struct [[codegen::Dictionary(NonUniformStaticScale)]] Parameters { diff --git a/modules/base/scale/staticscale.cpp b/modules/base/scale/staticscale.cpp index c951c9068b..0317709275 100644 --- a/modules/base/scale/staticscale.cpp +++ b/modules/base/scale/staticscale.cpp @@ -32,7 +32,8 @@ 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 }; struct [[codegen::Dictionary(StaticScale)]] Parameters { diff --git a/modules/base/scale/timedependentscale.cpp b/modules/base/scale/timedependentscale.cpp index 02c6d4eae8..3511658936 100644 --- a/modules/base/scale/timedependentscale.cpp +++ b/modules/base/scale/timedependentscale.cpp @@ -37,14 +37,18 @@ 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" + "YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SpeedInfo = { "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" + "per second. The default value is 1 m/s", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ClampToPositiveInfo = { @@ -52,7 +56,8 @@ namespace { "Clamp to Positive", "If this value is true, the velocity computation will never result in any " "negative values. This is useful for instantaneous events that only propagate " - "forwards. The default value is 'true'" + "forwards. The default value is 'true'", + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(TimeDependentScale)]] Parameters { diff --git a/modules/base/timeframe/timeframeinterval.cpp b/modules/base/timeframe/timeframeinterval.cpp index 204aee2d9b..36a16eee2c 100644 --- a/modules/base/timeframe/timeframeinterval.cpp +++ b/modules/base/timeframe/timeframeinterval.cpp @@ -34,25 +34,33 @@ namespace { constexpr openspace::properties::Property::PropertyInfo HasStartInfo = { "HasStart", "Has Start", - "If enabled, this TimeFrame will be inactive before the Start" + "If enabled, this TimeFrame will be inactive before the Start", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo StartInfo = { "Start", "Start", - "Specifies the time when this TimeFrame becomes active" + "Specifies the time when this TimeFrame becomes active", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo HasEndInfo = { "HasEnd", "Has End", - "If enabled, this TimeFrame will be inactive after the End" + "If enabled, this TimeFrame will be inactive after the End", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EndInfo = { "End", "End", - "Specifies the time when this TimeFrame becomes inactive" + "Specifies the time when this TimeFrame becomes inactive", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(TimeFrameInterval)]] Parameters { diff --git a/modules/base/timeframe/timeframeunion.cpp b/modules/base/timeframe/timeframeunion.cpp index 1e7c12b301..656a0d0daf 100644 --- a/modules/base/timeframe/timeframeunion.cpp +++ b/modules/base/timeframe/timeframeunion.cpp @@ -35,7 +35,9 @@ 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" + "of the contained time frames are, but not in gaps between contained time frames", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(TimeFrameUnion)]] Parameters { diff --git a/modules/base/translation/luatranslation.cpp b/modules/base/translation/luatranslation.cpp index 26bb77a690..4bdda55028 100644 --- a/modules/base/translation/luatranslation.cpp +++ b/modules/base/translation/luatranslation.cpp @@ -43,7 +43,9 @@ namespace { "translation for this transformation. The script needs to define a function " "'translate' 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" + "J2000 epoch as the second argument and computes the translation", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(LuaTranslation)]] Parameters { diff --git a/modules/base/translation/statictranslation.cpp b/modules/base/translation/statictranslation.cpp index 16a2007a82..80bad2af5a 100644 --- a/modules/base/translation/statictranslation.cpp +++ b/modules/base/translation/statictranslation.cpp @@ -32,7 +32,9 @@ 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 }; struct [[codegen::Dictionary(StaticTranslation)]] Parameters { diff --git a/modules/base/translation/timelinetranslation.cpp b/modules/base/translation/timelinetranslation.cpp index 5347d60a3d..d64bebe79a 100644 --- a/modules/base/translation/timelinetranslation.cpp +++ b/modules/base/translation/timelinetranslation.cpp @@ -35,7 +35,8 @@ 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 }; struct [[codegen::Dictionary(TimelineTranslation)]] Parameters { diff --git a/modules/cefwebgui/cefwebguimodule.cpp b/modules/cefwebgui/cefwebguimodule.cpp index ef6372f448..d6a0c8fa73 100644 --- a/modules/cefwebgui/cefwebguimodule.cpp +++ b/modules/cefwebgui/cefwebguimodule.cpp @@ -41,31 +41,39 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is 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" + "Trigger this property to reload the browser", + // @VISIBILITY(2.2) + 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" + "This setting determines whether the browser should be visible or not", + // @VISIBILITY(2.75) + 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" + "The URL of the webpage that is used to load the WebGUI from", + // @VISIBILITY(3.5) + 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 b57a2741b4..97f780de47 100644 --- a/modules/debugging/rendering/renderabledebugplane.cpp +++ b/modules/debugging/rendering/renderabledebugplane.cpp @@ -51,7 +51,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo TextureInfo = { "Texture", "Texture", - "The OpenGL name of the texture that is displayed on this plane" + "The OpenGL name of the texture that is displayed on this plane", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BillboardInfo = { @@ -59,19 +61,25 @@ 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", + // @VISIBILITY(3.75) + 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" + "This value specifies the size of the plane in meters", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OriginInfo = { "Origin", "Texture Coordinate Origin", - "The origin of the texture coorinate system" + "The origin of the texture coorinate system", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableDebugPlane)]] Parameters { diff --git a/modules/digitaluniverse/rendering/renderablebillboardscloud.cpp b/modules/digitaluniverse/rendering/renderablebillboardscloud.cpp index 1946ca5183..2414994f05 100644 --- a/modules/digitaluniverse/rendering/renderablebillboardscloud.cpp +++ b/modules/digitaluniverse/rendering/renderablebillboardscloud.cpp @@ -70,14 +70,17 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SpriteTextureInfo = { "Texture", "Point Sprite Texture", - "The path to the texture that should be used as the point sprite" + "The path to the texture that should be used as the point sprite", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ScaleFactorInfo = { "ScaleFactor", "Scale Factor", "This value is used as a multiplicative factor that is applied to the apparent " - "size of each point" + "size of each point", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo UseColorMapInfo = { @@ -85,25 +88,32 @@ namespace { "Use Color Map", "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", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value is used to define the color of the astronomical object" + "This value is used to define the color of the astronomical object", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ColorMapInfo = { "ColorMap", "Color Map File", - "The path to the color map file of the astronomical object" + "The path to the color map file of the astronomical object", + openspace::properties::Property::Visibility::AdvancedUser }; 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", + // @VISIBILITY(1.25) + openspace::properties::Property::Visibility::NoviceUser }; static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { @@ -116,27 +126,31 @@ namespace { "ColorOption", "Color Option", "This value determines which paramenter is used for default color of the " - "astronomical objects" + "astronomical objects", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OptionColorRangeInfo = { "OptionColorRange", "Option Color 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::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeOptionInfo = { "SizeOption", "Size Option Variable", "This value determines which paramenter (datavar) is used for scaling of the " - "astronomical objects" + "astronomical objects", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RenderOptionInfo = { "RenderOption", "Render Option", "Option wether the billboards should face the camera or not. Used for non-linear " - "display envierments such as fisheye." + "display environments such as fisheye.", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FadeInDistancesInfo = { @@ -144,27 +158,32 @@ 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", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableFadeInInfo = { "DisableFadeIn", "Disable Fade-in Effect", - "Enables/Disables the Fade-in effect" + "Enables/Disables the Fade-in effect", + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo PixelSizeControlInfo = { "EnablePixelSizeControl", "Enable Pixel Size Control", "Enable pixel size control for rectangular projections. If set to true, the " - "billboard size is restricted by the min/max size in pixels property" + "billboard size is restricted by the min/max size in pixels property", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BillboardMinMaxSizeInfo = { "BillboardMinMaxSize", "Billboard Min/Max Size in Pixels", "The minimum and maximum size (in pixels) for the billboard representing the " - "astronomical object" + "astronomical object", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -172,26 +191,31 @@ namespace { { "CorrectionSizeEndDistance", "Distance in 10^X meters where correction size stops acting", - "Distance in 10^X meters where correction size stops acting" + "Distance in 10^X meters where correction size stops acting", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CorrectionSizeFactorInfo = { "CorrectionSizeFactor", "Control variable for distance size", - "" + "", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UseLinearFiltering = { "UseLinearFiltering", "Use Linear Filtering", "Determines whether the provided color map should be sampled nearest neighbor " - "(=off) or linearly (=on)" + "(=off) or linearly (=on)", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SetRangeFromData = { "SetRangeFromData", "Set Data Range from Data", - "Set the data range based on the available data" + "Set the data range based on the available data", + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableBillboardsCloud)]] Parameters { diff --git a/modules/digitaluniverse/rendering/renderabledumeshes.cpp b/modules/digitaluniverse/rendering/renderabledumeshes.cpp index f3442c998a..96b4f4fd39 100644 --- a/modules/digitaluniverse/rendering/renderabledumeshes.cpp +++ b/modules/digitaluniverse/rendering/renderabledumeshes.cpp @@ -61,64 +61,76 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo TextOpacityInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo LabelFileInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo LabelMinMaxSizeInfo = { "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" + "If the DU mesh is of wire type, this value determines the width of the lines", + // @VISIBILITY(1.75) + 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" + "The defined colors for the meshes to be rendered", + // @VISIBILITY(1.25) + 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 }; struct [[codegen::Dictionary(RenderableDUMeshes)]] Parameters { diff --git a/modules/digitaluniverse/rendering/renderableplanescloud.cpp b/modules/digitaluniverse/rendering/renderableplanescloud.cpp index 05820844c2..060023baf9 100644 --- a/modules/digitaluniverse/rendering/renderableplanescloud.cpp +++ b/modules/digitaluniverse/rendering/renderableplanescloud.cpp @@ -62,11 +62,12 @@ namespace { "ScaleFactor", "Scale Factor", "This value is used as a multiplicative factor that is applied to the apparent " - "size of each point" + "size of each point", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; - static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = - { + static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { "Labels", "Labels", "The labels for the astronomical objects" @@ -75,62 +76,74 @@ namespace { 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 TransformationMatrixInfo = { "TransformationMatrix", "Transformation Matrix", - "Transformation matrix to be applied to each astronomical object" + "Transformation matrix to be applied to each astronomical object", + openspace::properties::Property::Visibility::Developer }; 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 }; constexpr openspace::properties::Property::PropertyInfo TexturePathInfo = { "TexturePath", "Texture Path", - "This value specifies the path for the textures in disk" + "This value specifies the path for the textures in disk", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LuminosityInfo = { "Luminosity", "Luminosity variable", - "Datavar variable to control the luminosity/size of the astronomical objects" + "Datavar variable to control the luminosity/size of the astronomical objects", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ScaleLuminosityInfo = { "ScaleLuminosity", "ScaleLuminosity variable", - "Scaling control for the luminosity/size of the astronomical objects" + "Scaling control for the luminosity/size of the astronomical objects", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; 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 }; constexpr openspace::properties::Property::PropertyInfo FadeInDistancesInfo = { "FadeInDistances", "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" + "our galaxy from which the astronomical object will start and end fading-in", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableFadeInInfo = { "DisableFadeIn", "Disable Fade-in effect", - "Enables/Disables the Fade-in effect" + "Enables/Disables the Fade-in effect", + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo PlaneMinSizeInfo = { "PlaneMinSize", "Plane Min Size in Pixels", - "The min size (in pixels) for the plane representing the astronomical object" + "The min size (in pixels) for the plane representing the astronomical object", + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderablePlanesCloud)]] Parameters { @@ -196,7 +209,7 @@ documentation::Documentation RenderablePlanesCloud::Documentation() { RenderablePlanesCloud::RenderablePlanesCloud(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _scaleFactor(ScaleFactorInfo, 1.f, 0.f, 300000.f) + , _scaleFactor(ScaleFactorInfo, 1.f, 0.f, 1000.f) , _drawElements(DrawElementsInfo, true) , _blendMode(BlendModeInfo, properties::OptionProperty::DisplayType::Dropdown) , _fadeInDistances( diff --git a/modules/digitaluniverse/rendering/renderablepoints.cpp b/modules/digitaluniverse/rendering/renderablepoints.cpp index 650539d36b..1a7d76acd5 100644 --- a/modules/digitaluniverse/rendering/renderablepoints.cpp +++ b/modules/digitaluniverse/rendering/renderablepoints.cpp @@ -57,26 +57,30 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SpriteTextureInfo = { "Texture", "Point Sprite Texture", - "The path to the texture that should be used as the point sprite" + "The path to the texture that should be used as the point sprite", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ScaleFactorInfo = { "ScaleFactor", "Scale Factor", "This value is used as a multiplicative factor that is applied to the apparent " - "size of each point" + "size of each point", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "This value is used to define the color of the astronomical object" + "This value is used to define the color of the astronomical object", + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ColorMapInfo = { "ColorMap", "Color Map File", - "The path to the color map file of the astronomical object" + "The path to the color map file of the astronomical object", + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderablePoints)]] Parameters { diff --git a/modules/exoplanets/exoplanetsmodule.cpp b/modules/exoplanets/exoplanetsmodule.cpp index 68c78ca25f..8747c43a26 100644 --- a/modules/exoplanets/exoplanetsmodule.cpp +++ b/modules/exoplanets/exoplanetsmodule.cpp @@ -53,81 +53,96 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo StarGlareTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo NoDataTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo OrbitDiscTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo HabitableZoneTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ShowComparisonCircleInfo = { "ShowComparisonCircle", "Show Comparison Circle", "If true, the 1 AU size comparison circle is enabled per default when an " - "exoplanet system is created" + "exoplanet system is created", + // @VISIBILITY(1.8) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ShowHabitableZoneInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo UseOptimisticZoneInfo = { "UseOptimisticZone", "Use Optimistic Zone Boundaries", "If true, the habitable zone is computed with optimistic boundaries per default " - "when an exoplanet system is created" + "when an exoplanet system is created", + // @VISIBILITY(2.8) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo HabitableZoneOpacityInfo = { "HabitableZoneOpacity", "Habitable Zone Opacity", "The opacity value used for the habitable zone renderable for a created " - "exoplanet system" + "exoplanet system", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; constexpr std::string_view ExoplanetsDataFileName = "exoplanets_data.bin"; diff --git a/modules/exoplanets/rendering/renderableorbitdisc.cpp b/modules/exoplanets/rendering/renderableorbitdisc.cpp index ff817e548f..dddb81f391 100644 --- a/modules/exoplanets/rendering/renderableorbitdisc.cpp +++ b/modules/exoplanets/rendering/renderableorbitdisc.cpp @@ -49,20 +49,23 @@ 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 meter", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EccentricityInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo OffsetInfo = { @@ -71,14 +74,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo MultiplyColorInfo = { "MultiplyColor", "Multiply Color", "If set, the disc's texture is multiplied with this color. Useful for applying a " - "color grayscale images" + "color grayscale images", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; struct [[codegen::Dictionary(RenderableOrbitDisc)]] Parameters { diff --git a/modules/fieldlines/rendering/renderablefieldlines.cpp b/modules/fieldlines/rendering/renderablefieldlines.cpp index be47d6cc4a..220a68a6b8 100644 --- a/modules/fieldlines/rendering/renderablefieldlines.cpp +++ b/modules/fieldlines/rendering/renderablefieldlines.cpp @@ -72,31 +72,37 @@ namespace { "Stepsize", //"StepSize", "Fieldline Step Size", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo Classification = { "Classification", "Fieldline Classification", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FieldlineColorInfo = { "FieldlineColor", "Fieldline Color", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SeedPointSourceInfo = { "Source", "SeedPoint Source", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SeedPointFileInfo = { "SourceFile", "SeedPoint File", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp b/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp index 990feb5693..37405e993b 100644 --- a/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp +++ b/modules/fieldlinessequence/rendering/renderablefieldlinessequence.cpp @@ -52,88 +52,111 @@ 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" + "Quantity used to color lines if the 'By Quantity' color method is selected", + // @VISIBILITY(2.67) + 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'" + "The uniform color of lines shown when 'Color Method' is set to 'Uniform'", + // @VISIBILITY(1.67) + 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" + "Color of particles flow direction indication", + // @VISIBILITY(1.33) + 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" + "illustrate magnetic flow", + // @VISIBILITY(1.67) + 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" + "Size of the particles", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FlowParticleSpacingInfo = { "ParticleSpacing", "Particle Spacing", - "Spacing inbetween particles" + "Spacing inbetween particles", + // @VISIBILITY(2.33) + 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 = { "MaskingEnabled", @@ -141,27 +164,33 @@ 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" + "This value specifies the line width of the fieldlines", + // @VISIBILITY(1.33) + 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 }; struct [[codegen::Dictionary(RenderableFieldlinesSequence)]] Parameters { diff --git a/modules/gaia/rendering/renderablegaiastars.cpp b/modules/gaia/rendering/renderablegaiastars.cpp index ff15d62bae..2b83ce82c0 100644 --- a/modules/gaia/rendering/renderablegaiastars.cpp +++ b/modules/gaia/rendering/renderablegaiastars.cpp @@ -57,7 +57,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FileReaderOptionInfo = { @@ -70,7 +71,9 @@ 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)" + "option is suited for bigger datasets)", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RenderModeInfo = { @@ -78,7 +81,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ShaderOptionInfo = { @@ -89,28 +93,34 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo PsfTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo LuminosityMultiplierInfo = { "LuminosityMultiplier", "Luminosity Multiplier", "Factor by which to multiply the luminosity with. [Works in Color and Motion " - "modes]" + "modes]", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MagnitudeBoostInfo = { "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]" + "size. [Works only with billboards in Color and Motion modes]", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo CutOffThresholdInfo = { @@ -118,40 +128,49 @@ 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" + "4-logarithm of their distance", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SharpnessInfo = { "Sharpness", "Sharpness", - "Adjust star sharpness. [Works only with billboards]" + "Adjust star sharpness. [Works only with billboards]", + // @VISIBILITY(?) + 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]" + "Set the billboard size of all stars. [Works only with billboards]", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CloseUpBoostDistInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TmPointFilterSizeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TmPointSigmaInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo AdditionalNodesInfo = { @@ -160,7 +179,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo TmPointPxThresholdInfo = { @@ -169,14 +189,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo FirstRowInfo = { @@ -184,7 +206,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo LastRowInfo = { @@ -192,7 +215,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColumnNamesInfo = { @@ -200,46 +224,60 @@ 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]" + "[Works only with FileReaderOption::Fits]", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo NumRenderedStarsInfo = { "NumRenderedStars", "Rendered Stars", - "The number of rendered stars in the current frame" + "The number of rendered stars in the current frame", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CpuRamBudgetInfo = { "CpuRamBudget", "CPU RAM Budget", - "Current remaining budget (bytes) on the CPU RAM for loading more node data files" + "Current remaining budget (bytes) on the CPU RAM for loading more node data " + "files", + // @VISIBILITY(3.33) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GpuStreamBudgetInfo = { "GpuStreamBudget", "GPU Stream Budget", "Current remaining memory budget [in number of chunks] on the GPU for streaming " - "additional stars" + "additional stars", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo LodPixelThresholdInfo = { "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" + "Sets the max percent of existing GPU memory budget that the streaming will use", + // @VISIBILITY(3.33) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaxCpuMemoryPercentInfo = { "MaxCpuMemoryPercent", "Max CPU Memory", "Sets the max percent of existing CPU memory budget that the streaming of files " - "will use" + "will use", + // @VISIBILITY(3.33) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FilterPosXInfo = { @@ -247,7 +285,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FilterPosYInfo = { @@ -255,7 +294,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FilterPosZInfo = { @@ -263,7 +303,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FilterGMagInfo = { @@ -272,7 +313,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FilterBpRpInfo = { @@ -280,7 +322,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 }; constexpr openspace::properties::Property::PropertyInfo FilterDistInfo = { @@ -288,13 +331,16 @@ 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" + "If set to true, any OpenGL errors will be reported if encountered", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableGaiaStars)]] Parameters { @@ -418,7 +464,7 @@ RenderableGaiaStars::RenderableGaiaStars(const ghoul::Dictionary& dictionary) , _filePath(FilePathInfo) , _pointSpreadFunctionTexturePath(PsfTextureInfo) , _colorTexturePath(ColorTextureInfo) - , _luminosityMultiplier(LuminosityMultiplierInfo, 35.f, 1.f, 1000.f) + , _luminosityMultiplier(LuminosityMultiplierInfo, 35.f, 1.f, 250.f) , _magnitudeBoost(MagnitudeBoostInfo, 25.f, 0.f, 100.f) , _cutOffThreshold(CutOffThresholdInfo, 38.f, 0.f, 50.f) , _sharpness(SharpnessInfo, 1.45f, 0.f, 5.f) diff --git a/modules/galaxy/rendering/renderablegalaxy.cpp b/modules/galaxy/rendering/renderablegalaxy.cpp index 45ebc77f92..164ff7f11c 100644 --- a/modules/galaxy/rendering/renderablegalaxy.cpp +++ b/modules/galaxy/rendering/renderablegalaxy.cpp @@ -77,14 +77,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo StarRenderingEnabledInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = { @@ -92,7 +94,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo AbsorptionMultiplyInfo = { @@ -100,14 +103,18 @@ 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" + "emitted from the galaxy", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EmissionMultiplyInfo = { "EmissionMultiply", "Emission Multiplier", "A unit-less scale factor for the amount of light being emitted by dust in the " - "galaxy" + "galaxy", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RotationInfo = { @@ -121,7 +128,8 @@ namespace { "StarRenderingMethod", "Star Rendering Method", "This value determines which rendering method is used for visualization of the " - "stars" + "stars", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo EnabledPointsRatioInfo = { @@ -130,21 +138,25 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DownscaleVolumeRenderingInfo = { "Downscale", "Downscale Factor Volume Rendering", - "This value sets the downscaling factor when rendering the current volume" + "This value sets the downscaling factor when rendering the current volume", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo NumberOfRayCastingStepsInfo = { "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 }; struct [[codegen::Dictionary(RenderableGalaxy)]] Parameters { diff --git a/modules/globebrowsing/globebrowsingmodule.cpp b/modules/globebrowsing/globebrowsingmodule.cpp index bbc90b60bf..bc80c63ab8 100644 --- a/modules/globebrowsing/globebrowsingmodule.cpp +++ b/modules/globebrowsing/globebrowsingmodule.cpp @@ -94,19 +94,22 @@ 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 MRFCacheEnabledInfo = { "MRFCacheEnabled", "MRF Cache Enabled", - "Determines whether automatic caching of globe browsing data is enabled." + "Determines whether automatic caching of globe browsing data is enabled.", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MRFCacheLocationInfo = { "MRFCacheLocation", "MRF Cache Location", - "The location of the root folder for the MRF cache of globe browsing data." + "The location of the root folder for the MRF cache of globe browsing data.", + openspace::properties::Property::Visibility::AdvancedUser }; openspace::GlobeBrowsingModule::Capabilities diff --git a/modules/globebrowsing/src/dashboarditemglobelocation.cpp b/modules/globebrowsing/src/dashboarditemglobelocation.cpp index cbbfaff0dc..e6b49d161e 100644 --- a/modules/globebrowsing/src/dashboarditemglobelocation.cpp +++ b/modules/globebrowsing/src/dashboarditemglobelocation.cpp @@ -45,13 +45,16 @@ 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" + "Determines the number of significant digits that are shown in the location text", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(DashboardItemGlobeLocation)]] Parameters { diff --git a/modules/globebrowsing/src/gdalwrapper.cpp b/modules/globebrowsing/src/gdalwrapper.cpp index 5e2019342d..980bddbcb3 100644 --- a/modules/globebrowsing/src/gdalwrapper.cpp +++ b/modules/globebrowsing/src/gdalwrapper.cpp @@ -41,14 +41,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo GdalMaximumCacheInfo = { "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 }; void gdalErrorHandler(CPLErr eErrClass, int, const char* msg) { diff --git a/modules/globebrowsing/src/globelabelscomponent.cpp b/modules/globebrowsing/src/globelabelscomponent.cpp index 47d82ea24d..88c1a8a787 100644 --- a/modules/globebrowsing/src/globelabelscomponent.cpp +++ b/modules/globebrowsing/src/globelabelscomponent.cpp @@ -63,38 +63,48 @@ 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" + "Font size for the rendering labels. This is different fromt text size", + // @VISIBILITY(2.75) + 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" + "This value affects the size scale of the labels", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo HeightOffsetInfo = { "HeightOffset", "Height Offset", "This value moves the label away from the globe surface by the specified " - "distance (in meters)" + "distance (in meters)", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "The text color of the labels" + "The text color of the labels", + // @VISIBILITY(1.2) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo FadeDistancesInfo = { @@ -102,39 +112,46 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FadeInEnabledInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo FadeOutEnabledInfo = { "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" + "Labels are aligned horizontally or circularly related to the planet", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(GlobeLabelsComponent)]] Parameters { diff --git a/modules/globebrowsing/src/globerotation.cpp b/modules/globebrowsing/src/globerotation.cpp index be621a2642..b97975a8a1 100644 --- a/modules/globebrowsing/src/globerotation.cpp +++ b/modules/globebrowsing/src/globerotation.cpp @@ -40,7 +40,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo GlobeInfo = { "Globe", "Attached Globe", - "The globe on which the longitude/latitude is specified" + "The globe on which the longitude/latitude is specified", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LatitudeInfo = { @@ -48,7 +50,9 @@ 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" + "globe. The default value is 0.0", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LongitudeInfo = { @@ -56,14 +60,17 @@ 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" + "globe. The default value is 0.0", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo AngleInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo UseHeightmapInfo = { @@ -71,7 +78,9 @@ 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" + "given coordinate and follow the shape of the landscape", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(GlobeRotation)]] Parameters { diff --git a/modules/globebrowsing/src/globetranslation.cpp b/modules/globebrowsing/src/globetranslation.cpp index ded1ec46aa..3d57f6a59a 100644 --- a/modules/globebrowsing/src/globetranslation.cpp +++ b/modules/globebrowsing/src/globetranslation.cpp @@ -39,7 +39,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo GlobeInfo = { "Globe", "Attached Globe", - "The globe on which the longitude/latitude is specified" + "The globe on which the longitude/latitude is specified", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LatitudeInfo = { @@ -47,7 +49,9 @@ 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" + "globe. The default value is 0.0", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LongitudeInfo = { @@ -55,7 +59,9 @@ 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" + "globe. The default value is 0.0", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo AltitudeInfo = { @@ -63,7 +69,9 @@ 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" + "reference ellipsoid. The default value is 0.0", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo UseHeightmapInfo = { @@ -71,7 +79,9 @@ 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'" + "globe's reference ellipsoid. The default value is 'false'", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(GlobeTranslation)]] Parameters { diff --git a/modules/globebrowsing/src/layer.cpp b/modules/globebrowsing/src/layer.cpp index 787278036c..1f159638a9 100644 --- a/modules/globebrowsing/src/layer.cpp +++ b/modules/globebrowsing/src/layer.cpp @@ -48,14 +48,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { @@ -63,28 +65,36 @@ 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" + "composition", + // @VISIBILITY(1.17) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ResetInfo = { "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" + "local cache for this layer and will trigger a fresh load of all tiles", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RemoveInfo = { "Remove", "Remove", "If this value is triggered, a script will be executed that will remove this " - "layer before the next frame" + "layer before the next frame", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", "If the 'Type' of this layer is a solid color, this value determines what this " - "solid color is" + "solid color is", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo GuiDescriptionInfo = { diff --git a/modules/globebrowsing/src/layeradjustment.cpp b/modules/globebrowsing/src/layeradjustment.cpp index 29ce43100d..74d4f5e66e 100644 --- a/modules/globebrowsing/src/layeradjustment.cpp +++ b/modules/globebrowsing/src/layeradjustment.cpp @@ -32,20 +32,23 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ChromaKeyToleranceInfo = { "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 }; struct [[codegen::Dictionary(LayerAdjustment)]] Parameters { diff --git a/modules/globebrowsing/src/layergroup.cpp b/modules/globebrowsing/src/layergroup.cpp index 22dbea9ac8..e63d0a8ab5 100644 --- a/modules/globebrowsing/src/layergroup.cpp +++ b/modules/globebrowsing/src/layergroup.cpp @@ -41,7 +41,8 @@ namespace { "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", - openspace::properties::Property::Visibility::Hidden + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; } // namespace diff --git a/modules/globebrowsing/src/layerrendersettings.cpp b/modules/globebrowsing/src/layerrendersettings.cpp index f50f5a0ee2..acf8eaf763 100644 --- a/modules/globebrowsing/src/layerrendersettings.cpp +++ b/modules/globebrowsing/src/layerrendersettings.cpp @@ -29,27 +29,34 @@ namespace { "SetDefault", "Set Default", "If this value is triggered it will reset all of these values to their default " - "values" + "values", + // @VISIBILITY(1.67) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo GammaInfo = { "Gamma", "Gamma", - "This value is used as an exponent to adjust the color for each tile" + "This value is used as an exponent to adjust the color for each tile", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MultiplierInfo = { "Multiplier", "Multiplier", "This value is used as a multiplier to adjust the color applied after taking the " - "gamma value as an exponent" + "gamma value as an exponent", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo OffsetInfo = { "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 c2bd44296c..1a6287ee12 100644 --- a/modules/globebrowsing/src/memoryawaretilecache.cpp +++ b/modules/globebrowsing/src/memoryawaretilecache.cpp @@ -38,32 +38,37 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo GpuAllocatedDataInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TileCacheSizeInfo = { "TileCacheSize", "Tile cache size", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ApplyTileCacheInfo = { "ApplyTileCacheSize", "Apply tile cache size", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ClearTileCacheInfo = { "ClearTileCache", "Clear tile cache", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; GLenum toGlTextureFormat(GLenum glType, ghoul::opengl::Texture::Format format) { diff --git a/modules/globebrowsing/src/renderableglobe.cpp b/modules/globebrowsing/src/renderableglobe.cpp index 1c36d8d4f9..689b93089b 100644 --- a/modules/globebrowsing/src/renderableglobe.cpp +++ b/modules/globebrowsing/src/renderableglobe.cpp @@ -112,7 +112,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo LevelProjectedAreaInfo = { @@ -120,14 +121,18 @@ 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" + "is used instead", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ResetTileProviderInfo = { "ResetTileProviders", "Reset tile providers", "If this property is triggered, all tile provides for the globe are reset and " - "data is reloaded from scratch" + "data is reloaded from scratch", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ModelSpaceRenderingInfo = { @@ -136,7 +141,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DynamicLodIterationCountInfo = @@ -145,7 +151,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo PerformShadingInfo = { @@ -153,7 +160,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo AccurateNormalsInfo = { @@ -161,25 +169,32 @@ 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" + "and are thus only available if the planet has a height map", + // @VISIBILITY(3.5) + 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" + "Enables the rendering of eclipse shadows using hard shadows", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShadowMappingInfo = { "ShadowMapping", "Shadow Mapping", - "Enables shadow mapping algorithm. Used by renderable rings too" + "Enables shadow mapping algorithm. Used by renderable rings too", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RenderAtDistanceInfo = { @@ -187,21 +202,25 @@ 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" + "away distances when normally it would be hidden", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ZFightingPercentageInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo NumberShadowSamplesInfo = { "NumberShadowSamples", "Number of Shadow Samples", "The number of samples used during shadow mapping calculation (Percentage Closer " - "Filtering)" + "Filtering)", + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo TargetLodScaleFactorInfo = { @@ -209,33 +228,39 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo CurrentLodScaleFactorInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo NActiveLayersInfo = { "NActiveLayers", "Number of active layers", "This is the number of currently active layers, if this value reaches the " - "maximum, bad things will happen" + "maximum, bad things will happen", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableGlobe)]] Parameters { diff --git a/modules/globebrowsing/src/ringscomponent.cpp b/modules/globebrowsing/src/ringscomponent.cpp index baf9bbe1e3..6e8a3af766 100644 --- a/modules/globebrowsing/src/ringscomponent.cpp +++ b/modules/globebrowsing/src/ringscomponent.cpp @@ -74,55 +74,64 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "Enable/Disable Rings" + "Enable/Disable Rings", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TextureInfo = { "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 TextureFwrdInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TextureBckwrdInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TextureUnlitInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TextureColorInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TextureTransparencyInfo = { "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 meter", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OffsetInfo = { @@ -131,7 +140,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo NightFactorInfo = { @@ -139,28 +149,32 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorFilterInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ZFightingPercentageInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo NumberShadowSamplesInfo = { "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 }; struct [[codegen::Dictionary(RingsComponent)]] Parameters { diff --git a/modules/globebrowsing/src/shadowcomponent.cpp b/modules/globebrowsing/src/shadowcomponent.cpp index cdb0067249..b3988b3afe 100644 --- a/modules/globebrowsing/src/shadowcomponent.cpp +++ b/modules/globebrowsing/src/shadowcomponent.cpp @@ -54,23 +54,36 @@ namespace { constexpr std::string_view _loggerCat = "ShadowComponent"; + constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { + "Enabled", + "Enabled", + "Enable/Disable Shadows", + openspace::properties::Property::Visibility::User + }; + constexpr openspace::properties::Property::PropertyInfo SaveDepthTextureInfo = { "SaveDepthTextureInfo", "Save Depth Texture", - "Debug" + "Debug", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DistanceFractionInfo = { "DistanceFraction", "Distance Fraction", "Distance fraction of original distance from light source to the globe to be " - "considered as the new light source distance" + "considered as the new light source distance", + // @VISIBILITY(3.67) + 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" + "The depth map size in pixels. You must entry the width and height values", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr GLfloat ShadowBorder[] = { 1.f, 1.f, 1.f, 1.f }; @@ -158,7 +171,7 @@ ShadowComponent::ShadowComponent(const ghoul::Dictionary& dictionary) : properties::PropertyOwner({ "ShadowsComponent" }) , _saveDepthTexture(SaveDepthTextureInfo) , _distanceFraction(DistanceFractionInfo, 20, 1, 10000) - , _enabled({ "Enabled", "Enabled", "Enable/Disable Shadows" }, true) + , _enabled(EnabledInfo, true) { using ghoul::filesystem::File; diff --git a/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp b/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp index 4dd907a078..501dd2489a 100644 --- a/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp @@ -36,7 +36,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo TilePixelSizeInfo = { @@ -45,13 +46,16 @@ 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" + "complete image if a single image is used", + // @VISIBILITY(3.33) + 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 }; enum class [[codegen::stringify()]] Compression { diff --git a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp index 02bce73b58..9d01f0c0c4 100644 --- a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp @@ -33,20 +33,25 @@ namespace { "Index", "Index", "The index into the list of images that is used to pick the currently displayed " - "image" + "image", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo CurrentImageInfo = { "CurrentImage", "Current Image", - "The read-only value of the currently selected image" + "The read-only value of the currently selected image", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FolderPathInfo = { "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 }; struct [[codegen::Dictionary(ImageSequenceTileProvider)]] Parameters { diff --git a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp index bbb31b053b..ec98651a06 100644 --- a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp @@ -32,7 +32,8 @@ 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 }; struct [[codegen::Dictionary(SingleImageProvider)]] Parameters { diff --git a/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp b/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp index 1b7752e987..81ebabe395 100644 --- a/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp @@ -51,14 +51,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FixedTimeInfo = { "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 }; struct [[codegen::Dictionary(TemporalTileProvider)]] Parameters { diff --git a/modules/imgui/imguimodule.cpp b/modules/imgui/imguimodule.cpp index 266ee60910..95492d3efb 100644 --- a/modules/imgui/imguimodule.cpp +++ b/modules/imgui/imguimodule.cpp @@ -55,26 +55,30 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is 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 }; constexpr openspace::properties::Property::PropertyInfo ShowHelpInfo = { "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 9e71cd01d2..09cad8b2ce 100644 --- a/modules/imgui/src/guicomponent.cpp +++ b/modules/imgui/src/guicomponent.cpp @@ -28,13 +28,17 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is Enabled", - "This setting determines whether this object will be visible or not" + "This setting determines whether this object will be visible or not", + // @VISIBILITY(3.4) + openspace::properties::Property::Visibility::AdvancedUser }; 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", + // @VISIBILITY(3.4) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/imgui/src/guipropertycomponent.cpp b/modules/imgui/src/guipropertycomponent.cpp index 8967d0b464..8f38f0dda8 100644 --- a/modules/imgui/src/guipropertycomponent.cpp +++ b/modules/imgui/src/guipropertycomponent.cpp @@ -42,7 +42,9 @@ 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" + "property windows that display SceneGraphNodes, or the application might crash", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OrderingInfo = { @@ -50,7 +52,9 @@ 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" + "elements not listed", + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; int nVisibleProperties(const std::vector& props) diff --git a/modules/iswa/rendering/datacygnet.cpp b/modules/iswa/rendering/datacygnet.cpp index 237ba3832a..4c70799064 100644 --- a/modules/iswa/rendering/datacygnet.cpp +++ b/modules/iswa/rendering/datacygnet.cpp @@ -42,43 +42,50 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DataOptionsInfo = { "DataOptions", "Data Options", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo UseLogInfo = { "UseLog", "Use Logarithm", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UseHistogramInfo = { "UseHistogram", "Auto Contrast", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AutoFilterInfo = { "AutoFilter", "Auto Filter", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo NormalizeValuesInfo = { "NormValues", "Normalize Values", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo BackgroundInfo = { "BackgroundValues", "Background Values", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo TransferFunctionsFile = { "Transferfunctions", "Transfer Functions", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/modules/iswa/rendering/iswabasegroup.cpp b/modules/iswa/rendering/iswabasegroup.cpp index 7897a4edc7..a498bd7dc8 100644 --- a/modules/iswa/rendering/iswabasegroup.cpp +++ b/modules/iswa/rendering/iswabasegroup.cpp @@ -34,19 +34,22 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Enabled", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo AlphaInfo = { "Alpha", "Alpha", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DeleteInfo = { "Delete", "Delete", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/modules/iswa/rendering/iswacygnet.cpp b/modules/iswa/rendering/iswacygnet.cpp index 847ca053b0..b8e0f12120 100644 --- a/modules/iswa/rendering/iswacygnet.cpp +++ b/modules/iswa/rendering/iswacygnet.cpp @@ -45,12 +45,14 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DeleteInfo = { "Delete", "Delete", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo AlphaInfo = { "Alpha", "Alpha", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; } // namespace diff --git a/modules/iswa/rendering/iswadatagroup.cpp b/modules/iswa/rendering/iswadatagroup.cpp index 3d87cf7f98..1c44609a11 100644 --- a/modules/iswa/rendering/iswadatagroup.cpp +++ b/modules/iswa/rendering/iswadatagroup.cpp @@ -41,43 +41,50 @@ namespace { constexpr openspace::properties::Property::PropertyInfo UseLogInfo = { "UseLog", "Use Logarithm", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UseHistogramInfo = { "UseHistogram", "Auto Contrast", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AutoFilterInfo = { "AutoFilter", "Auto Filter", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo NormalizeValues = { "NormValues", "Normalize Values", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo BackgroundInfo = { "BackgroundValues", "Background Values", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo TransferFunctionInfo = { "Transferfunctions", "Transfer Functions", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo DataOptionsInfo = { "DataOptions", "Data Options", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/iswa/rendering/iswakameleongroup.cpp b/modules/iswa/rendering/iswakameleongroup.cpp index 3177a01e41..5eb84733fb 100644 --- a/modules/iswa/rendering/iswakameleongroup.cpp +++ b/modules/iswa/rendering/iswakameleongroup.cpp @@ -38,15 +38,16 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ResolutionInfo = { "Resolution", "Resolution", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FieldlineSeedInfo = { "FieldlineSeedsIndexFile", "Fieldline Seedpoints", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; - } // namespace namespace openspace{ diff --git a/modules/iswa/rendering/kameleonplane.cpp b/modules/iswa/rendering/kameleonplane.cpp index 057bf89f87..51cbf6286f 100644 --- a/modules/iswa/rendering/kameleonplane.cpp +++ b/modules/iswa/rendering/kameleonplane.cpp @@ -46,19 +46,22 @@ namespace { constexpr openspace::properties::Property::PropertyInfo FieldLineSeedsInfo = { "FieldlineSeedsIndexFile", "Fieldline Seedpoints", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ResolutionInfo = { "Resolution", "Resolution%", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SliceInfo = { "Slice", "Slice", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; } // namespace diff --git a/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp b/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp index f875dcd88d..a4a45dd2f4 100644 --- a/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp +++ b/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp @@ -68,73 +68,87 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DimensionsInfo = { "Dimensions", "Dimensions", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo VariableInfo = { "Variable", "Variable", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LowerDomainBoundInfo = { "LowerDomainBound", "Lower Domain Bound", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UpperDomainBoundInfo = { "UpperDomainBound", "Upper Domain Bound", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DomainScaleInfo = { "DomainScale", "Domain scale", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LowerValueBoundInfo = { "LowerValueBound", "Lower Value Bound", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UpperValueBoundInfo = { "UpperValueBound", "Upper Value Bound", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GridTypeInfo = { "GridType", "Grid Type", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = { "StepSize", "Step Size", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SourcePathInfo = { "SourcePath", "Source Path", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TransferFunctionInfo = { "TransferFunctionPath", "Transfer Function Path", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CacheInfo = { "Cache", "Cache", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/modules/multiresvolume/rendering/renderablemultiresvolume.cpp b/modules/multiresvolume/rendering/renderablemultiresvolume.cpp index 1065013bfb..75acfd8237 100644 --- a/modules/multiresvolume/rendering/renderablemultiresvolume.cpp +++ b/modules/multiresvolume/rendering/renderablemultiresvolume.cpp @@ -71,79 +71,97 @@ namespace { constexpr openspace::properties::Property::PropertyInfo StepSizeCoefficientInfo = { "StepSizeCoefficient", "Stepsize Coefficient", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CurrentTimeInfo = { "CurrentTime", "Current Time", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MemoryBudgetInfo = { "MemoryBudget", "Memory Budget", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StreamingBudgetInfo = { "StreamingBudget", "Streaming Budget", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UseGlobalTimeInfo = { "UseGlobalTime", "Global Time", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LoopInfo = { "Loop", "Loop", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SelectorNameInfo = { "Selector", "Brick Selector", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StatsToFileInfo = { "PrintStats", "Print Stats", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo StatsToFileNameInfo = { "PrintStatsFileName", "Stats Filename", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ScalingExponentInfo = { "ScalingExponent", "Scaling Exponent", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ScalingInfo = { "Scaling", "Scaling", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TranslationInfo = { "Translation", "Translation", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo RotationInfo = { "Rotation", "Euler rotation", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/modules/server/src/serverinterface.cpp b/modules/server/src/serverinterface.cpp index 7e6db61faa..b236c0e596 100644 --- a/modules/server/src/serverinterface.cpp +++ b/modules/server/src/serverinterface.cpp @@ -40,50 +40,59 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is 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 }; constexpr openspace::properties::Property::PropertyInfo RequirePasswordAddressesInfo = { "RequirePasswordAddresses", "Require Password Addresses", - "IP addresses or domains that should be allowed access if they provide a password" + "IP addresses or domains that should be allowed access if they provide a " + "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 c8abcfa5de..b1b661246b 100644 --- a/modules/skybrowser/skybrowsermodule.cpp +++ b/modules/skybrowser/skybrowsermodule.cpp @@ -42,73 +42,90 @@ 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", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShowTitleInGuiBrowserInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo AllowRotationInfo = { "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" + "outside of the current field of view", + // @VISIBILITY(1.75) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo CameraRotSpeedInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo HideWithGuiInfo = { "HideTargetsBrowsersWithGui", "Hide Targets and Browsers with GUI", "If checked, the targets and browsers will be disabled when the sky browser " - "panel is minimized" + "panel is minimized", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo InverseZoomInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo SynchronizeAimInfo = { "SynchronizeAim", "Synchronize Aim", - "If checked, the target and the browser will have synchronized aim." + "If checked, the target and the browser will have synchronized aim.", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SpaceCraftTimeInfo = { "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" + "pointed to where the target is aiming", + // @VISIBILITY(2.5) + 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" + "The url of the image collection which is loaded into AAS WorldWide Telescope", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; diff --git a/modules/skybrowser/src/browser.cpp b/modules/skybrowser/src/browser.cpp index e9e6671277..2250c609cc 100644 --- a/modules/skybrowser/src/browser.cpp +++ b/modules/skybrowser/src/browser.cpp @@ -39,19 +39,24 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DimensionsInfo = { "Dimensions", "Browser Dimensions", - "Set the dimensions of the web browser window" + "Set the dimensions of the web browser window", + // @VISIBILITY(3.75) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo UrlInfo = { "Url", "URL", - "The URL to load" + "The URL to load", + // @VISIBILITY(3.25) + 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 }; struct [[codegen::Dictionary(Browser)]] Parameters { diff --git a/modules/skybrowser/src/renderableskytarget.cpp b/modules/skybrowser/src/renderableskytarget.cpp index d4bd41ea79..d9cea82983 100644 --- a/modules/skybrowser/src/renderableskytarget.cpp +++ b/modules/skybrowser/src/renderableskytarget.cpp @@ -52,33 +52,41 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RectangleThresholdInfo = { "RectangleThreshold", "Rectangle Threshold", "When the field of view is larger than the rectangle threshold, a rectangle will " - "be rendered in the target" + "be rendered in the target", + // @VISIBILITY(2.33) + 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" + "The thickness of the line of the target. The larger number, the thicker line", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo VerticalFovInfo = { "VerticalFov", "Vertical Field Of View", - "The vertical field of view of the target." + "The vertical field of view of the target.", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ApplyRollInfo = { "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 }; struct [[codegen::Dictionary(RenderableSkyTarget)]] Parameters { diff --git a/modules/skybrowser/src/screenspaceskybrowser.cpp b/modules/skybrowser/src/screenspaceskybrowser.cpp index 0eb7bee4e4..150dd19ca2 100644 --- a/modules/skybrowser/src/screenspaceskybrowser.cpp +++ b/modules/skybrowser/src/screenspaceskybrowser.cpp @@ -45,7 +45,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DisplayCopyInfo = { @@ -54,27 +55,33 @@ 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" + "coordinates", + // @VISIBILITY(2.67) + 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 }; constexpr openspace::properties::Property::PropertyInfo IsHiddenInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo PointSpacecraftInfo = { "PointSpacecraft", "Point Spacecraft", "If checked, spacecrafts will point towards the coordinate of an image upon " - "selection." + "selection.", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(ScreenSpaceSkyBrowser)]] Parameters { diff --git a/modules/skybrowser/src/wwtcommunicator.cpp b/modules/skybrowser/src/wwtcommunicator.cpp index 66f7cb41d1..82dbac1a2d 100644 --- a/modules/skybrowser/src/wwtcommunicator.cpp +++ b/modules/skybrowser/src/wwtcommunicator.cpp @@ -121,7 +121,8 @@ namespace { constexpr openspace::properties::Property::PropertyInfo VerticalFovInfo = { "VerticalFov", "Vertical Field Of View", - "The vertical field of view of the target." + "The vertical field of view of the target.", + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(WwtCommunicator)]] Parameters { diff --git a/modules/space/labelscomponent.cpp b/modules/space/labelscomponent.cpp index 0cced7f14e..9bbf8ee35e 100644 --- a/modules/space/labelscomponent.cpp +++ b/modules/space/labelscomponent.cpp @@ -43,50 +43,61 @@ namespace { "Enabled", "Is Enabled", "This setting determines whether the labels will be visible or not. They are " - "disabled per default" + "disabled per default", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::NoviceUser }; 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" + "The size of the labels in pixels", + // @VISIBILITY(2.5) + 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 }; constexpr openspace::properties::Property::PropertyInfo FaceCameraInfo = { "FaceCamera", "Face Camera", "If enabled, the labels will be rotated to face the camera. For non-linear " - "display rendering (for example fisheye) this should be set to false." + "display rendering (for example fisheye) this should be set to false.", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TransformationMatrixInfo = { "TransformationMatrix", "Transformation Matrix", - "Transformation matrix to be applied to the labels" + "Transformation matrix to be applied to the labels", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::Developer }; struct [[codegen::Dictionary(LabelsComponent)]] Parameters { diff --git a/modules/space/rendering/renderableconstellationbounds.cpp b/modules/space/rendering/renderableconstellationbounds.cpp index 4e9e0181d0..2aa9a6fd81 100644 --- a/modules/space/rendering/renderableconstellationbounds.cpp +++ b/modules/space/rendering/renderableconstellationbounds.cpp @@ -47,14 +47,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "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 }; struct [[codegen::Dictionary(RenderableConstellationBounds)]] Parameters { diff --git a/modules/space/rendering/renderableconstellationlines.cpp b/modules/space/rendering/renderableconstellationlines.cpp index 977af886c8..cb4f55cfec 100644 --- a/modules/space/rendering/renderableconstellationlines.cpp +++ b/modules/space/rendering/renderableconstellationlines.cpp @@ -50,26 +50,30 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorsInfo = { "Colors", "Constellation Colors", "The defined colors for the constellations to be rendered. There can be several " - "groups of constellaitons that can have distinct colors." + "groups of constellaitons that can have distinct colors.", + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableConstellationLines)]] Parameters { diff --git a/modules/space/rendering/renderableconstellationsbase.cpp b/modules/space/rendering/renderableconstellationsbase.cpp index d5a45e86ee..ad73cffcf9 100644 --- a/modules/space/rendering/renderableconstellationsbase.cpp +++ b/modules/space/rendering/renderableconstellationsbase.cpp @@ -44,19 +44,24 @@ 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" + "The line width of the constellation", + // @VISIBILITY(1.67) + 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" + "The constellations that are selected are displayed on the celestial sphere", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; const static openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = { diff --git a/modules/space/rendering/renderablefluxnodes.cpp b/modules/space/rendering/renderablefluxnodes.cpp index e63f5c4dd4..7a547ae1b1 100644 --- a/modules/space/rendering/renderablefluxnodes.cpp +++ b/modules/space/rendering/renderablefluxnodes.cpp @@ -64,130 +64,154 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorModeInfo = { "ColorMode", "Color Mode", "Color lines uniformly or using color tables based on specific values on nodes, " - "for examples flux values" + "for examples flux values", + // @VISIBILITY(2.5) + 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" + "Color of particles", + // @VISIBILITY(1.5) + 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" + "Change the size of the rendered points of the nodes", + // @VISIBILITY(2.5) + 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 }; constexpr openspace::properties::Property::PropertyInfo colorTableRangeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo 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 }; constexpr openspace::properties::Property::PropertyInfo @@ -195,25 +219,29 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo @@ -221,25 +249,31 @@ 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" + "Toggles the pulse for nodes close to Earth", + // @VISIBILITY(2.5) + 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" + "Toggles the pulse with alpha by gaussian for nodes close to Earth", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableFluxNodes)]] Parameters { diff --git a/modules/space/rendering/renderablehabitablezone.cpp b/modules/space/rendering/renderablehabitablezone.cpp index 62f4e5046a..03b946631c 100644 --- a/modules/space/rendering/renderablehabitablezone.cpp +++ b/modules/space/rendering/renderablehabitablezone.cpp @@ -49,21 +49,27 @@ namespace { "EffectiveTemperature", "Effective Temperature", "The effective temperature of the corresponding star, in Kelvin. " - "Used to compute the width and size of the disc" + "Used to compute the width and size of the disc", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LuminosityInfo = { "Luminosity", "Luminosity", "The luminosity of the corresponding star, in units of solar luminosities. " - "Used to compute the width and size of the disc" + "Used to compute the width and size of the disc", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo OptimisticInfo = { "Optimistic", "Optimistic" , "If true, the habitable zone disc is rendered with the optimistic boundaries " - "rather than the conservative ones" + "rather than the conservative ones", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo KopparapuTeffIntervalInfo = { @@ -72,7 +78,9 @@ 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" + "luminosity and does not include computation of the optimistic boundaries", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableHabitableZone)]] Parameters { diff --git a/modules/space/rendering/renderableorbitalkepler.cpp b/modules/space/rendering/renderableorbitalkepler.cpp index f381070669..3ccbba24ac 100644 --- a/modules/space/rendering/renderableorbitalkepler.cpp +++ b/modules/space/rendering/renderableorbitalkepler.cpp @@ -48,7 +48,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo SegmentQualityInfo = { @@ -57,7 +58,9 @@ 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" + "these automatically increase according to the eccentricity of the orbit", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = { @@ -65,32 +68,38 @@ 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" + "ignored", + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo LineColorInfo = { "Color", "Color", - "This value determines the RGB main color for the lines and points of the trail" + "This value determines the RGB main color for the lines and points of the trail", + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo TrailFadeInfo = { "TrailFade", "Trail Fade", - "This value determines how fast the trail fades and is an appearance property." + "This value determines how fast the trail fades and is an appearance property.", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo StartRenderIdxInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ContiguousModeInfo = { @@ -99,7 +108,8 @@ namespace { "If enabled, then the contiguous set of objects starting from StartRenderIdx " "of size RenderSize will be rendered. If disabled, then the number of objects " "defined by UpperLimit will rendered from an evenly dispersed sample of the " - "full length of the data file." + "full length of the data file.", + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableOrbitalKepler)]] Parameters { diff --git a/modules/space/rendering/renderablerings.cpp b/modules/space/rendering/renderablerings.cpp index 7a8e397b03..b2e618dd6b 100644 --- a/modules/space/rendering/renderablerings.cpp +++ b/modules/space/rendering/renderablerings.cpp @@ -48,13 +48,15 @@ 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 meter", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo OffsetInfo = { @@ -63,7 +65,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo NightFactorInfo = { @@ -71,14 +74,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorFilterInfo = { "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 }; struct [[codegen::Dictionary(RenderableRings)]] Parameters { diff --git a/modules/space/rendering/renderablestars.cpp b/modules/space/rendering/renderablestars.cpp index b79d2a56f9..87d8ca7d6b 100644 --- a/modules/space/rendering/renderablestars.cpp +++ b/modules/space/rendering/renderablestars.cpp @@ -120,108 +120,124 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ColorTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MappingBvInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MappingLuminanceInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MappingAbsMagnitudeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MappingAppMagnitudeInfo = { "MappingAppMagnitude", "Mapping (apparent magnitude)", "The name of the variable in the speck file that is used as the apparent " - "magnitude variable" + "magnitude variable", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MappingVxInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MappingVyInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MappingVzInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ColorOptionInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo OtherDataValueRangeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo FilterOutOfRangeInfo = { "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 }; // Old Method @@ -229,7 +245,8 @@ 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 }; //constexpr openspace::properties::Property::PropertyInfo ShapeTextureInfo = { @@ -244,13 +261,16 @@ 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" + "logarithm of their distance", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo RenderMethodOptionInfo = { "RenderMethod", "Render Method", - "Render method for the stars" + "Render method for the stars", + openspace::properties::Property::Visibility::AdvancedUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo @@ -279,31 +299,36 @@ namespace { constexpr openspace::properties::Property::PropertyInfo PSFMethodOptionInfo = { "PSFMethodOptionInfo", "PSF Method Option", - "Debug option for PSF main function: Spencer or Moffat" + "Debug option for PSF main function: Spencer or Moffat", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SizeCompositionOptionInfo = { "SizeComposition", "Size Composition Option", - "Base multiplyer for the final stars' sizes" + "Base multiplyer for the final stars' sizes", + 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 }; constexpr openspace::properties::Property::PropertyInfo BrightnessPercentInfo = { "BrightnessPercent", "App Brightness Contribution", - "App Brightness Contribution" + "App Brightness Contribution", + openspace::properties::Property::Visibility::AdvancedUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo @@ -317,25 +342,29 @@ namespace { constexpr openspace::properties::Property::PropertyInfo P0ParamInfo = { "P0Param", "P0", - "P0 parameter contribution" + "P0 parameter contribution", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo P1ParamInfo = { "P1Param", "P1", - "P1 parameter contribution" + "P1 parameter contribution", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo P2ParamInfo = { "P2Param", "P2", - "P2 parameter contribution" + "P2 parameter contribution", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AlphaConstInfo = { "AlphaConst", "Alpha", - "Empirical Alpha Constant" + "Empirical Alpha Constant", + openspace::properties::Property::Visibility::AdvancedUser }; const openspace::properties::PropertyOwner::PropertyOwnerInfo @@ -349,13 +378,15 @@ namespace { constexpr openspace::properties::Property::PropertyInfo FWHMInfo = { "FWHM", "FWHM", - "Moffat's FWHM" + "Moffat's FWHM", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BetaInfo = { "Beta", "Beta", - "Moffat's Beta Constant" + "Moffat's Beta Constant", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FadeInDistancesInfo = { @@ -363,13 +394,15 @@ 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 DisableFadeInInfo = { "DisableFadeIn", "Disable Fade-in effect", - "Enables/Disables the Fade-in effect" + "Enables/Disables the Fade-in effect", + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableStars)]] Parameters { @@ -512,7 +545,7 @@ RenderableStars::RenderableStars(const ghoul::Dictionary& dictionary) , _lumCent(LumPercentInfo, 0.5f, 0.f, 3.f) , _radiusCent(RadiusPercentInfo, 0.5f, 0.f, 3.f) , _brightnessCent(BrightnessPercentInfo, 0.5f, 0.f, 3.f) - , _magnitudeExponent(MagnitudeExponentInfo, 4.f, 0.f, 8.f) + , _magnitudeExponent(MagnitudeExponentInfo, 6.2f, 5.f, 8.f) , _spencerPSFParamOwner(SpencerPSFParamOwnerInfo) , _p0Param(P0ParamInfo, 0.384f, 0.f, 1.f) , _p1Param(P1ParamInfo, 0.478f, 0.f, 1.f) diff --git a/modules/space/rendering/renderabletravelspeed.cpp b/modules/space/rendering/renderabletravelspeed.cpp index de00b849aa..b495961e39 100644 --- a/modules/space/rendering/renderabletravelspeed.cpp +++ b/modules/space/rendering/renderabletravelspeed.cpp @@ -42,38 +42,48 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SpeedInfo = { "TravelSpeed", "Speed of travel", - "The speed of light is the default value" + "The speed of light is the default value", + // @VISIBILITY(1.25) + 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" + "This value specifies the line width", + // @VISIBILITY(1.33) + 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" + "This value specifies the length of the light indicator set in light seconds", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FadeLengthInfo = { "FadeLength", "Fade Length", "This value specifies the length of the faded tail of the light indicator " - "set in light seconds" + "set in light seconds", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(RenderableLightTravel)]] Parameters { diff --git a/modules/space/rotation/spicerotation.cpp b/modules/space/rotation/spicerotation.cpp index b755ff4b04..ae9958bddf 100644 --- a/modules/space/rotation/spicerotation.cpp +++ b/modules/space/rotation/spicerotation.cpp @@ -36,27 +36,31 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DestinationInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo FixedDateInfo = { "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 }; struct [[codegen::Dictionary(SpiceRotation)]] Parameters { diff --git a/modules/space/spacemodule.cpp b/modules/space/spacemodule.cpp index b56af70f35..cd975b4eed 100644 --- a/modules/space/spacemodule.cpp +++ b/modules/space/spacemodule.cpp @@ -55,7 +55,8 @@ 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 aa673960a9..8065361403 100644 --- a/modules/space/translation/horizonstranslation.cpp +++ b/modules/space/translation/horizonstranslation.cpp @@ -47,7 +47,9 @@ 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)" + "either a Vector table or an Observer table with the correct settings (see wiki)", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(HorizonsTranslation)]] Parameters { diff --git a/modules/space/translation/keplertranslation.cpp b/modules/space/translation/keplertranslation.cpp index c6d7e1c94f..b6c722bdad 100644 --- a/modules/space/translation/keplertranslation.cpp +++ b/modules/space/translation/keplertranslation.cpp @@ -51,7 +51,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo SemiMajorAxisInfo = { @@ -59,7 +60,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo InclinationInfo = { @@ -67,7 +69,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo AscendingNodeInfo = { @@ -75,34 +78,39 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ArgumentOfPeriapsisInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MeanAnomalyAtEpochInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo EpochInfo = { "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 }; struct [[codegen::Dictionary(KeplerTranslation)]] Parameters { diff --git a/modules/space/translation/spicetranslation.cpp b/modules/space/translation/spicetranslation.cpp index b920300b9f..fb08e91c76 100644 --- a/modules/space/translation/spicetranslation.cpp +++ b/modules/space/translation/spicetranslation.cpp @@ -43,7 +43,9 @@ 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')" + "or a NAIF integer id code (such as '399')", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ObserverInfo = { @@ -51,21 +53,27 @@ 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')" + "(such as 'SOLAR SYSTEM BARYCENTER') or a NAIF integer id code (such as '0')", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FrameInfo = { "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" + "should be retrieved. The default value is GALACTIC", + // @VISIBILITY(3.33) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FixedDateInfo = { "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" + "unlock the time and return to position based on current simulation time", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(SpiceTranslation)]] Parameters { diff --git a/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp b/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp index bdb34c7444..9db867a435 100644 --- a/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp +++ b/modules/spacecraftinstruments/dashboard/dashboarditeminstruments.cpp @@ -44,14 +44,18 @@ 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)" + "color. The default value is (0.6, 1.0, 0.0)", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FlashColorInfo = { "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)" + "activation. The default value is (0.9, 1.0, 0.75)", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; std::string progressToStr(int size, double t) { diff --git a/modules/spacecraftinstruments/rendering/renderablefov.cpp b/modules/spacecraftinstruments/rendering/renderablefov.cpp index 3d20967e73..e29610b013 100644 --- a/modules/spacecraftinstruments/rendering/renderablefov.cpp +++ b/modules/spacecraftinstruments/rendering/renderablefov.cpp @@ -51,7 +51,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo StandoffDistanceInfo = { @@ -61,14 +62,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo AlwaysDrawFovInfo = { "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" + "whether image information has been loaded or not", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DefaultStartColorInfo = { @@ -76,7 +80,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DefaultEndColorInfo = { @@ -84,21 +89,24 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ActiveColorInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo TargetInFovInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo IntersectionStartInfo = { @@ -106,7 +114,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo IntersectionEndInfo = { @@ -114,7 +123,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo SquareColorInfo = { @@ -122,7 +132,8 @@ 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 }; template diff --git a/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp b/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp index b80cfc36c0..3852feda2e 100644 --- a/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp +++ b/modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp @@ -58,7 +58,9 @@ 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" + "entire model is rendered brightly", + // @VISIBILITY(1.5) + openspace::properties::Property::Visibility::NoviceUser }; struct [[codegen::Dictionary(RenderableModelProjection)]] Parameters { diff --git a/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp b/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp index 79bb113699..818c2e0a7d 100644 --- a/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp +++ b/modules/spacecraftinstruments/rendering/renderableplanetprojection.cpp @@ -58,14 +58,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo AddColorTextureInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo HeightTexturePathsInfo = { @@ -73,13 +75,15 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo HeightExaggerationInfo = { @@ -87,7 +91,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo MeridianShiftInfo = { @@ -96,44 +101,51 @@ 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" + "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 }; struct [[codegen::Dictionary(RenderablePlanetProjection)]] Parameters { diff --git a/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp b/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp index 4cd745e98a..be1f8efef7 100644 --- a/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp +++ b/modules/spacecraftinstruments/rendering/renderableshadowcylinder.cpp @@ -43,7 +43,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ShadowLengthInfo = { @@ -51,55 +52,65 @@ 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" + "This value determines the color that is used for the shadow cylinder", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TerminatorTypeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo LightSourceInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ObserverInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo BodyInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo BodyFrameInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo AberrationInfo = { "Aberration", "Aberration", "This value determines the aberration method that is used to compute the shadow " - "cylinder" + "cylinder", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableShadowCylinder)]] Parameters { diff --git a/modules/spacecraftinstruments/util/projectioncomponent.cpp b/modules/spacecraftinstruments/util/projectioncomponent.cpp index d12e1d9aac..aa03fa8db9 100644 --- a/modules/spacecraftinstruments/util/projectioncomponent.cpp +++ b/modules/spacecraftinstruments/util/projectioncomponent.cpp @@ -50,14 +50,18 @@ namespace { "PerformProjection", "Perform Projections", "If this value is enabled, this ProjectionComponent will perform projections. If " - "it is disabled, projections will be ignored" + "it is disabled, projections will be ignored", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ClearProjectionInfo = { "ClearAllProjections", "Clear Projections", "If this property is triggered, it will remove all the projections that have " - "already been applied" + "already been applied", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FadingInfo = { @@ -65,7 +69,9 @@ 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" + "'0', the performed projections are completely invisible", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo TextureSizeInfo = { @@ -74,14 +80,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ApplyTextureSizeInfo = { "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 }; struct [[codegen::Dictionary(ProjectionComponent)]] Parameters { diff --git a/modules/spout/renderableplanespout.cpp b/modules/spout/renderableplanespout.cpp index 0f747e2b46..2e3bea2bc9 100644 --- a/modules/spout/renderableplanespout.cpp +++ b/modules/spout/renderableplanespout.cpp @@ -38,7 +38,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo SelectionInfo = { @@ -46,13 +47,15 @@ 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 }; struct [[codegen::Dictionary(RenderablePlaneSpout)]] Parameters { diff --git a/modules/spout/screenspacespout.cpp b/modules/spout/screenspacespout.cpp index 83f6993a1b..7ba25f1ede 100644 --- a/modules/spout/screenspacespout.cpp +++ b/modules/spout/screenspacespout.cpp @@ -36,7 +36,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo SelectionInfo = { @@ -44,13 +45,15 @@ 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 }; struct [[codegen::Dictionary(ScreenSpaceSpout)]] Parameters { diff --git a/modules/spout/spoutwrapper.cpp b/modules/spout/spoutwrapper.cpp index e45a1efbf8..543a339fd0 100644 --- a/modules/spout/spoutwrapper.cpp +++ b/modules/spout/spoutwrapper.cpp @@ -37,14 +37,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo NameReceiverInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo SelectionInfo = { @@ -52,13 +54,15 @@ 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 f5c3ba7ab6..ce4d7438ae 100644 --- a/modules/touch/src/touchinteraction.cpp +++ b/modules/touch/src/touchinteraction.cpp @@ -74,68 +74,84 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DisableZoomInfo = { "DisableZoom", "Disable zoom navigation", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DisableRollInfo = { "DisableRoll", "Disable roll navigation", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo SetDefaultInfo = { "SetDefault", "Reset all properties to default", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaxTapTimeInfo = { "MaxTapTime", "Max tap delay (in ms) for double tap", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DecelatesPerSecondInfo = { "DeceleratesPerSecond", "Number of times velocity is decelerated per second", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TouchScreenSizeInfo = { "TouchScreenSize", "Touch Screen size in inches", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TapZoomFactorInfo = { "TapZoomFactor", "Scaling distance travelled on tap", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PinchZoomFactorInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo RollThresholdInfo = { "RollThreshold", "Threshold for min angle for roll interpret", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ZoomSensitivityExpInfo = { "ZoomSensitivityExp", "Sensitivity of exponential zooming in relation to distance from focus node", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ZoomSensitivityPropInfo = { "ZoomSensitivityProp", "Sensitivity of zooming proportional to distance from focus node", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -144,7 +160,9 @@ namespace { "ZoomSensitivityDistanceThreshold", "Threshold of distance to target node for whether or not to use exponential " "zooming", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -153,7 +171,9 @@ namespace { "ZoomInBoundarySphereMultiplier", "Multiplies a node's boundary sphere by this in order to limit zoom in & prevent " "surface collision", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -167,37 +187,44 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ConstantTimeDecaySecsInfo = { "ConstantTimeDecaySecs", "Time duration that a pitch/roll/zoom/pan should take to decay to zero (seconds)", - "" + "", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo InputSensitivityInfo = { "InputSensitivity", "Threshold for interpreting input as still", - "" + "", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StationaryCentroidInfo = { "CentroidStationary", "Threshold for stationary centroid", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PanModeInfo = { "PanMode", "Allow panning gesture", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo PanDeltaDistanceInfo = { "PanDeltaDistance", "Delta distance between fingers allowed for interpreting pan interaction", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FrictionInfo = { "Friction", "Friction for different interactions (orbit, zoom, roll, pan)", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ZoomOutLimitInfo = { @@ -205,7 +232,9 @@ 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" + "to zoom. Defaults to maximum allowed double", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ZoomInLimitInfo = { @@ -213,7 +242,9 @@ namespace { "Zoom In Limit", "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." + "defaults to the surface of the current anchor.", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo @@ -221,7 +252,8 @@ namespace { { "EnableDirectManipulation", "Enable direct manipulation", - "Decides whether the direct manipulation mode should be enabled or not. " + "Decides whether the direct manipulation mode should be enabled or not.", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -231,7 +263,8 @@ 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 }; // Compute coefficient of decay based on current frametime; if frametime has been diff --git a/modules/touch/src/touchmarker.cpp b/modules/touch/src/touchmarker.cpp index cde53a73ad..b746ca2547 100644 --- a/modules/touch/src/touchmarker.cpp +++ b/modules/touch/src/touchmarker.cpp @@ -38,29 +38,36 @@ namespace { constexpr openspace::properties::Property::PropertyInfo VisibilityInfo = { "Visibility", "Toggle visibility of markers", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RadiusInfo = { "Size", "Marker radius", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo OpacityInfo = { "Opacity", "Marker opacity", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ThicknessInfo = { "Thickness", "Marker thickness", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { - "MarkerColor", "Marker color", "" // @TODO Missing documentation + "MarkerColor", + "Marker color", + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; } // namespace diff --git a/modules/touch/touchmodule.cpp b/modules/touch/touchmodule.cpp index 02b8c68386..98e61911c0 100644 --- a/modules/touch/touchmodule.cpp +++ b/modules/touch/touchmodule.cpp @@ -45,7 +45,8 @@ namespace { "EnableTouchInteraction", "Enable Touch Interaction", "Use this property to turn on/off touch input navigation in the 3D scene. " - "Disabling will reset all current touch inputs to the navigation." + "Disabling will reset all current touch inputs to the navigation.", + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EventsInfo = { @@ -66,7 +67,8 @@ namespace { "relatively spherical objects.", openspace::properties::Property::Visibility::AdvancedUser }; -} +} // namespace openspace + namespace openspace { TouchModule::TouchModule() diff --git a/modules/toyvolume/rendering/renderabletoyvolume.cpp b/modules/toyvolume/rendering/renderabletoyvolume.cpp index b7d6e94e8e..8dadf4203b 100644 --- a/modules/toyvolume/rendering/renderabletoyvolume.cpp +++ b/modules/toyvolume/rendering/renderabletoyvolume.cpp @@ -37,44 +37,53 @@ namespace { constexpr openspace::properties::Property::PropertyInfo SizeInfo = { "Size", "Size", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ScalingExponentInfo = { "ScalingExponent", "Scaling Exponent", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = { "StepSize", "Step Size", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TranslationInfo = { "Translation", "Translation", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RotationInfo = { "Rotation", "Euler rotation", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + // @VISIBILITY(3.) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ColorInfo = { "Color", "Color", - "" // @TODO Missing documentation + "", // @TODO Missing documentation + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo DownscaleVolumeRenderingInfo = { "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/vislab/rendering/renderabledistancelabel.cpp b/modules/vislab/rendering/renderabledistancelabel.cpp index 071039b17d..80c2fa3aac 100644 --- a/modules/vislab/rendering/renderabledistancelabel.cpp +++ b/modules/vislab/rendering/renderabledistancelabel.cpp @@ -41,21 +41,25 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DistanceUnitInfo = { "DistanceUnit", "Distance Unit", "Property to define the unit in which the distance should be displayed. " - "Defaults to 'km' if not specified" + "Defaults to 'km' if not specified", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo CustomUnitDescriptorInfo = { "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 }; struct [[codegen::Dictionary(RenderableDistanceLabel)]] Parameters { diff --git a/modules/volume/rendering/renderabletimevaryingvolume.cpp b/modules/volume/rendering/renderabletimevaryingvolume.cpp index d0d5838dc2..21f04ae866 100644 --- a/modules/volume/rendering/renderabletimevaryingvolume.cpp +++ b/modules/volume/rendering/renderabletimevaryingvolume.cpp @@ -55,70 +55,85 @@ namespace { constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = { "StepSize", "Step Size", - "Specifies how often to sample on the raycaster. Lower step -> higher resolution" + "Specifies how often to sample on the raycaster. Lower step -> higher resolution", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GridTypeInfo = { "GridType", "Grid Type", "Spherical or Cartesian grid", - openspace::properties::Property::Visibility::Developer + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo SecondsBeforeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo SecondsAfterInfo = { "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" + "The volume renderer's general brightness", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo rNormalizationInfo = { "RNormalization", "Radius normalization", - "" // @TODO Missing documentation + "", // @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" + "Limit the volume's radius", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(RenderableTimeVaryingVolume)]] Parameters { diff --git a/modules/volume/transferfunctionhandler.cpp b/modules/volume/transferfunctionhandler.cpp index 12878a6e83..c6968542cb 100644 --- a/modules/volume/transferfunctionhandler.cpp +++ b/modules/volume/transferfunctionhandler.cpp @@ -32,31 +32,37 @@ 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" + "Save your transfer function", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/modules/webbrowser/src/screenspacebrowser.cpp b/modules/webbrowser/src/screenspacebrowser.cpp index 420947a95d..f1ebe5fc81 100644 --- a/modules/webbrowser/src/screenspacebrowser.cpp +++ b/modules/webbrowser/src/screenspacebrowser.cpp @@ -41,19 +41,23 @@ namespace { constexpr openspace::properties::Property::PropertyInfo DimensionsInfo = { "Dimensions", "Browser Dimensions", - "Set the dimensions of the web browser windows" + "Set the dimensions of the web browser windows", + // @VISIBILITY(2.33) + 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 }; struct [[codegen::Dictionary(ScreenSpaceBrowser)]] Parameters { diff --git a/modules/webbrowser/webbrowsermodule.cpp b/modules/webbrowser/webbrowsermodule.cpp index cbb4bbf57e..f0fec3e77a 100644 --- a/modules/webbrowser/webbrowsermodule.cpp +++ b/modules/webbrowser/webbrowsermodule.cpp @@ -58,14 +58,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo BrowserUpdateIntervalInfo = { "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 }; } // namespace diff --git a/modules/webgui/webguimodule.cpp b/modules/webgui/webguimodule.cpp index b334a39a77..26b9ab478e 100644 --- a/modules/webgui/webguimodule.cpp +++ b/modules/webgui/webguimodule.cpp @@ -44,32 +44,39 @@ namespace { constexpr openspace::properties::Property::PropertyInfo ServerProcessEnabledInfo = { "ServerProcessEnabled", "Enable Server Process", - "Enable the node js based process used to serve the Web GUI" + "Enable the node js based process used to serve the Web GUI", + // @VISIBILITY(3.5) + 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 }; constexpr openspace::properties::Property::PropertyInfo ServerProcessEntryPointInfo = { "ServerProcessEntryPoint", "Server Process Entry Point", - "The node js command to invoke" + "The node js command to invoke", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DirectoriesInfo = { @@ -78,13 +85,17 @@ namespace { "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) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DefaultEndpointInfo = { "DefaultEndpoint", "Default Endpoint", "The 'default' endpoint. The server will redirect http requests from / to " - "/" + "/", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ServedDirectoriesInfo = { @@ -93,7 +104,8 @@ 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 }; struct [[codegen::Dictionary(WebGuiModule)]] Parameters { diff --git a/src/engine/moduleengine.cpp b/src/engine/moduleengine.cpp index e2fe9f2a3b..f3190a224a 100644 --- a/src/engine/moduleengine.cpp +++ b/src/engine/moduleengine.cpp @@ -42,7 +42,9 @@ 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" + "same order in which they were initialized", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/engine/openspaceengine.cpp b/src/engine/openspaceengine.cpp index 508567d1b7..aa71d3f277 100644 --- a/src/engine/openspaceengine.cpp +++ b/src/engine/openspaceengine.cpp @@ -119,20 +119,23 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo VisibilityInfo = { "PropertyVisibility", "Property Visibility", "Hides or displays different settings in the GUI depending on how advanced they " - "are" + "are", + openspace::properties::Property::Visibility::Always }; constexpr openspace::properties::Property::PropertyInfo ShowHiddenSceneInfo = { "ShowHiddenSceneGraphNodes", "Show Hidden Scene Graph Nodes", - "If checked, hidden scene graph nodes are visible in the UI" + "If checked, hidden scene graph nodes are visible in the UI", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo FadeDurationInfo = { @@ -141,14 +144,17 @@ namespace { "Controls how long time the fading in/out takes when enabling/disabling an " "object through a checkbox in the UI. Holding SHIFT while clicking the " "checkbox will enable/disable the renderable without fading, as will setting " - "this value to zero." + "this value to zero.", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DisableMouseInputInfo = { "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)" + "double inputs on touch (from both touch input and inserted mouse inputs)", + // @VISIBILITY(2.67) + openspace::properties::Property::Visibility::User }; } // namespace diff --git a/src/interaction/interactionmonitor.cpp b/src/interaction/interactionmonitor.cpp index 0fedd45769..5410714cfb 100644 --- a/src/interaction/interactionmonitor.cpp +++ b/src/interaction/interactionmonitor.cpp @@ -33,13 +33,18 @@ namespace { "IdleTime", "Idle Time", "Time in seconds that has passed from latest registered interaction until the " - "application goes idle" + "application goes idle", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; + constexpr openspace::properties::Property::PropertyInfo IsInActiveStateInfo = { "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" + "application is in idle state, true if it is in active state", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/interaction/sessionrecording.cpp b/src/interaction/sessionrecording.cpp index cc25f89000..3adfa64eb9 100644 --- a/src/interaction/sessionrecording.cpp +++ b/src/interaction/sessionrecording.cpp @@ -63,21 +63,23 @@ namespace { constexpr std::string_view _loggerCat = "SessionRecording"; + constexpr bool UsingTimeKeyframes = false; + constexpr openspace::properties::Property::PropertyInfo RenderPlaybackInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo IgnoreRecordedScaleInfo = { "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 }; - - constexpr bool UsingTimeKeyframes = false; } // namespace namespace openspace::interaction { diff --git a/src/navigation/navigationhandler.cpp b/src/navigation/navigationhandler.cpp index a20d6248e7..4134e9ff47 100644 --- a/src/navigation/navigationhandler.cpp +++ b/src/navigation/navigationhandler.cpp @@ -63,26 +63,30 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FrameInfo = { "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 }; } // namespace diff --git a/src/navigation/orbitalnavigator.cpp b/src/navigation/orbitalnavigator.cpp index 303f0ff53b..f2bf297682 100644 --- a/src/navigation/orbitalnavigator.cpp +++ b/src/navigation/orbitalnavigator.cpp @@ -48,33 +48,45 @@ namespace { constexpr double AngleEpsilon = 1e-7; constexpr double DistanceRatioAimThreshold = 1e-4; + constexpr std::string_view IdleKeyOrbit = "Orbit"; + constexpr std::string_view IdleKeyOrbitAtConstantLat = "OrbitAtConstantLatitude"; + constexpr std::string_view IdleKeyOrbitAroundUp = "OrbitAroundUp"; + constexpr openspace::properties::Property::PropertyInfo AnchorInfo = { "Anchor", "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" + "can be the anchor node", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo AimInfo = { "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" + "direction is relative to the vector from the camera position to this node", + // @VISIBILITY(1.67) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RetargetAnchorInfo = { "RetargetAnchor", "Retarget Anchor", "When triggered, this property starts an interpolation to reset the " - "camera direction to the anchor node" + "camera direction to the anchor node", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RetargetAimInfo = { "RetargetAim", "Retarget Aim", "When triggered, this property starts an interpolation to reset the " - "camera direction to the aim node" + "camera direction to the aim node", + // @VISIBILITY(1.67) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RollFrictionInfo = { @@ -82,7 +94,9 @@ 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" + "is disabled, the camera will roll forever", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RotationalFrictionInfo = { @@ -90,7 +104,9 @@ 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" + "is disabled, the camera will rotate forever", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo ZoomFrictionInfo = { @@ -98,28 +114,33 @@ 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" + "disabled, the camera will zoom in or out forever", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo MouseSensitivityInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo JoystickSensitivityInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo WebsocketSensitivityInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo FrictionInfo = { @@ -127,7 +148,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FollowAnchorNodeInfo = { @@ -136,7 +158,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FollowAnchorNodeDistanceInfo = @@ -145,7 +168,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo StereoInterpolationTimeInfo = @@ -153,7 +177,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo @@ -162,14 +187,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FollowRotationInterpTimeInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo InvertMouseButtons = { @@ -177,7 +204,9 @@ 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" + "value is 'true', these two functionalities are reversed", + // @VISIBILITY(1.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo @@ -188,7 +217,8 @@ namespace { "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" + "If disabled, view scale will be set to 10^StaticViewScaleExponent", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo StaticViewScaleExponentInfo = @@ -196,7 +226,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo @@ -206,7 +237,9 @@ 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" + "UseAdaptiveStereoscopicDepthInfo is set to true", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ConstantVelocityFlight = { @@ -214,21 +247,26 @@ namespace { "Constant Velocitry 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" + "consider adjusting the mouse sensitivity to a lower value", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ApplyIdleBehaviorInfo = { "ApplyIdleBehavior", "Apply Idle Behavior", "When set to true, the chosen idle behavior will be applied to the camera, " - "moving the camera accordingly" + "moving the camera accordingly", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo IdleBehaviorInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo @@ -237,14 +275,18 @@ namespace { "ShouldTriggerWhenIdle", "Should Trigger When Idle", "If true, the chosen idle behavior will trigger automatically after a certain " - "time (see 'IdleWaitTime' property)" + "time (see 'IdleWaitTime' property)", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo IdleWaitTimeInfo = { "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" + "has been performed. Note that friction counts as camera interaction", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo IdleBehaviorSpeedInfo = { @@ -252,7 +294,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo InvertIdleBehaviorInfo = { @@ -260,7 +303,9 @@ 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" + "default, and will rotate to the left when inverted", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo AbortOnCameraInteractionInfo = @@ -270,7 +315,9 @@ 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" + "recording playback, or navigating manually using an input device", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo @@ -279,7 +326,9 @@ 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" + "or canceled, in seconds", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; static const openspace::properties::PropertyOwner::PropertyOwnerInfo LimitZoomInfo = { @@ -295,33 +344,36 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo MinimumDistanceInfo = { "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" + "in meters above the surface", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo EnabledMaximumDistanceInfo = { "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" + "the set maximum allowed distance", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo MaximumDistanceInfo = { "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" + "given in meters above the surface", + // @VISIBILITY(?) + openspace::properties::Property::Visibility::AdvancedUser }; - - constexpr std::string_view IdleKeyOrbit = "Orbit"; - constexpr std::string_view IdleKeyOrbitAtConstantLat = "OrbitAtConstantLatitude"; - constexpr std::string_view IdleKeyOrbitAroundUp = "OrbitAroundUp"; } // namespace namespace openspace::interaction { diff --git a/src/navigation/pathnavigator.cpp b/src/navigation/pathnavigator.cpp index e505201f45..df1c4f3689 100644 --- a/src/navigation/pathnavigator.cpp +++ b/src/navigation/pathnavigator.cpp @@ -58,13 +58,15 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo SpeedScaleInfo = { @@ -72,14 +74,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo IdleBehaviorOnFinishInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ArrivalDistanceFactorInfo = { @@ -88,7 +92,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RotationSpeedFactorInfo = { @@ -96,7 +101,9 @@ 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 fast, and so on" + "seconds. A value of 2 means twice that fast, and so on", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo MinBoundingSphereInfo = { @@ -104,14 +111,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RelevantNodeTagsInfo = { "RelevantNodeTags", "Relevant Node Tags", "List of tags for the nodes that are relevant for path creation, for example " - "when avoiding collisions" + "when avoiding collisions", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/network/parallelpeer.cpp b/src/network/parallelpeer.cpp index 60bd016d3d..28a1f12c0a 100644 --- a/src/network/parallelpeer.cpp +++ b/src/network/parallelpeer.cpp @@ -50,34 +50,39 @@ namespace { "Password", "Password", "The general password that allows this OpenSpace instance access to the Wormhole " - "server" + "server", + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo HostPasswordInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo PortInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo NameInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo BufferTimeInfo = { @@ -86,7 +91,9 @@ 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" + "delay", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo TimeKeyFrameInfo = { @@ -94,7 +101,9 @@ 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" + "require higher internet bandwidth", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CameraKeyFrameInfo = { @@ -102,7 +111,9 @@ 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" + "time, but also more internet traffic", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; } // namespace diff --git a/src/rendering/dashboard.cpp b/src/rendering/dashboard.cpp index d2b99fcdaf..d3ad44420c 100644 --- a/src/rendering/dashboard.cpp +++ b/src/rendering/dashboard.cpp @@ -38,14 +38,17 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo StartPositionOffsetInfo = { "StartPositionOffset", "Start Position Offset", "A 2D vector controlling where the dashboard rendering starts. Adding an offset " - "in x and y-direction on screen" + "in x and y-direction on screen", + // @VISIBILITY(2.75) + openspace::properties::Property::Visibility::User }; } // namespace diff --git a/src/rendering/dashboarditem.cpp b/src/rendering/dashboarditem.cpp index 4060f685dd..ab2eb27ac5 100644 --- a/src/rendering/dashboarditem.cpp +++ b/src/rendering/dashboarditem.cpp @@ -37,7 +37,9 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is Enabled", - "If this value is set to 'true' this dashboard item is shown in the dashboard" + "If this value is set to 'true' this dashboard item is shown in the dashboard", + // @VISIBILITY(1.75) + openspace::properties::Property::Visibility::NoviceUser }; struct [[codegen::Dictionary(DashboardItem)]] Parameters { diff --git a/src/rendering/dashboardtextitem.cpp b/src/rendering/dashboardtextitem.cpp index 47d4bfa478..a423e841c5 100644 --- a/src/rendering/dashboardtextitem.cpp +++ b/src/rendering/dashboardtextitem.cpp @@ -35,13 +35,17 @@ 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" + "internal name registered previously, or it can refer to a path that is used", + // @VISIBILITY(2.33) + 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" + "This value determines the size of the font that is used to render the distance", + // @VISIBILITY(2.33) + openspace::properties::Property::Visibility::User }; struct [[codegen::Dictionary(DashboardTextItem)]] Parameters { diff --git a/src/rendering/fadeable.cpp b/src/rendering/fadeable.cpp index a1439dc086..22ea057424 100644 --- a/src/rendering/fadeable.cpp +++ b/src/rendering/fadeable.cpp @@ -33,7 +33,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo FadeInfo = { @@ -45,7 +46,7 @@ namespace { "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 - openspace::properties::Property::Visibility::Hidden + openspace::properties::Property::Visibility::Developer }; } // namespace diff --git a/src/rendering/luaconsole.cpp b/src/rendering/luaconsole.cpp index b7d97d74b2..d87833ea29 100644 --- a/src/rendering/luaconsole.cpp +++ b/src/rendering/luaconsole.cpp @@ -72,38 +72,44 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo RemoveScriptingInfo = { "RemoteScripting", "Remote scripting", "Determines whether the entered commands will only be executed locally (if this " - "is disabled), or whether they will be send to connected remove instances" + "is disabled), or whether they will be send to connected remove instances", + 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 }; std::string sanitizeInput(std::string str) { diff --git a/src/rendering/renderable.cpp b/src/rendering/renderable.cpp index b8dbaabe78..89fa5a45f8 100644 --- a/src/rendering/renderable.cpp +++ b/src/rendering/renderable.cpp @@ -45,14 +45,17 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is Enabled", - "This setting determines whether this object will be visible or not" + "This setting determines whether this object will be visible or not", + // @VISIBILITY(0.33) + openspace::properties::Property::Visibility::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo RenderableTypeInfo = { "Type", "Renderable Type", "This tells the type of the renderable", - openspace::properties::Property::Visibility::Hidden + // @VISIBILITY(3.4) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo RenderableRenderBinModeInfo = @@ -61,7 +64,8 @@ namespace { "Render Bin Mode", "This value specifies if the renderable should be rendered in the Background," "Opaque, Pre/PostDeferredTransparency, or Overlay rendering step", - openspace::properties::Property::Visibility::Developer + // @VISIBILITY(3.2) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DimInAtmosphereInfo = { @@ -69,7 +73,7 @@ namespace { "Dim In Atmosphere", "Enables/Disables if the object should be dimmed when the camera is in the " "sunny part of an atmosphere", - openspace::properties::Property::Visibility::Developer + openspace::properties::Property::Visibility::AdvancedUser }; struct [[codegen::Dictionary(Renderable)]] Parameters { diff --git a/src/rendering/renderengine.cpp b/src/rendering/renderengine.cpp index 85da66d100..9410a1c6ee 100644 --- a/src/rendering/renderengine.cpp +++ b/src/rendering/renderengine.cpp @@ -1,3 +1,4 @@ + /***************************************************************************************** * * * OpenSpace * @@ -83,7 +84,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ShowLogInfo = { @@ -91,28 +93,34 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo VerticalLogOffsetInfo = { "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" + "is scaled with the vertical resolution", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ShowVersionInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ShowCameraInfo = { "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" + "shown on the screen", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ScreenshotWindowIdsInfo = { @@ -120,7 +128,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ApplyWarpingInfo = { @@ -129,27 +138,32 @@ 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" + "Show updating, rendering, and network statistics on all rendering nodes", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ScreenshotUseDateInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo ShowFrameNumberInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo DisableMasterInfo = { @@ -159,7 +173,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo GlobalRotationInfo = { @@ -168,14 +183,16 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ScreenSpaceRotationInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo MasterRotationInfo = { @@ -183,7 +200,8 @@ 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 = { @@ -191,46 +209,55 @@ namespace { "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" + "final colors", + openspace::properties::Property::Visibility::Hidden }; constexpr openspace::properties::Property::PropertyInfo HDRExposureInfo = { "HDRExposure", "HDR Exposure", "This value determines the amount of light per unit area reaching the equivalent " - "of an electronic image sensor" + "of an electronic image sensor", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GammaInfo = { "Gamma", "Gamma Correction", "Gamma, is the nonlinear operation used to encode and decode luminance or " - "tristimulus values in the image" + "tristimulus values in the image", + openspace::properties::Property::Visibility::AdvancedUser }; 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 }; constexpr openspace::properties::Property::PropertyInfo FramerateLimitInfo = { "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" + "frames per second without using V-Sync", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo HorizFieldOfViewInfo = { @@ -238,32 +265,39 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo GlobalBlackoutFactorInfo = { "BlackoutFactor", "Blackout Factor", "The blackout factor of the rendering. This can be used for fading in or out the " - "rendering window" + "rendering window", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FXAAInfo = { "FXAA", "Enable FXAA", - "Enable FXAA" + "Enable FXAA", + // @VISIBILITY(3.5) + 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 e02f3f1448..b0915128d2 100644 --- a/src/rendering/screenspacerenderable.cpp +++ b/src/rendering/screenspacerenderable.cpp @@ -50,7 +50,8 @@ namespace { constexpr openspace::properties::Property::PropertyInfo EnabledInfo = { "Enabled", "Is 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::NoviceUser }; constexpr openspace::properties::Property::PropertyInfo @@ -63,21 +64,25 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo UsePerspectiveProjectionInfo = { "UsePerspectiveProjection", "Use Perspective Projection", - "Determines whetether the z/radius values affects the size of the plane or not" + "Determines whetether the z/radius values affects the size of the plane or not", + // @VISIBILITY(3.25) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo CartesianPositionInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo RadiusAzimuthElevationInfo = { @@ -85,7 +90,8 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo ScaleInfo = { @@ -93,20 +99,24 @@ 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" + "the image being displayed", + // @VISIBILITY(1.6) + 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 }; constexpr openspace::properties::Property::PropertyInfo MultiplyColorInfo = { "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 }; constexpr openspace::properties::Property::PropertyInfo BackgroundColorInfo = { @@ -114,34 +124,39 @@ 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 }; constexpr openspace::properties::Property::PropertyInfo DeleteInfo = { "Delete", "Delete", "If this property is triggered, this screen space plane is removed from the " - "scene" + "scene", + // @VISIBILITY(2.25) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo FaceCameraInfo = { "FaceCamera", "Face Camera", "If enabled, the local rotation is applied after the plane is rotated to face " - "the camera" + "the camera", + // @VISIBILITY(1.25) + 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 }; float wrap(float value, float min, float max) { return glm::mod(value - min, max - min) + min; } - struct [[codegen::Dictionary(ScreenSpaceRenderable)]] Parameters { // The type of the Screenspace renderable that is to be created. The available // types of Screenspace renderable depend on the configuration of the application diff --git a/src/scene/lightsource.cpp b/src/scene/lightsource.cpp index 063742cfe1..78e909c3a1 100644 --- a/src/scene/lightsource.cpp +++ b/src/scene/lightsource.cpp @@ -38,7 +38,8 @@ 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 }; struct [[codegen::Dictionary(LightSource)]] Parameters { diff --git a/src/scene/scenegraphnode.cpp b/src/scene/scenegraphnode.cpp index 3a0b211bd2..c20dccbd04 100644 --- a/src/scene/scenegraphnode.cpp +++ b/src/scene/scenegraphnode.cpp @@ -47,35 +47,37 @@ 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", - openspace::properties::Property::Visibility::Hidden + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ScreenVisibilityInfo = { "ScreenVisibility", "ScreenVisibility", "Determines if the node is currently visible on screen", - openspace::properties::Property::Visibility::Hidden + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo DistanceFromCamToNodeInfo = { "DistanceFromCamToNode", "DistanceFromCamToNode", "The distance from the camera to the node surface", - openspace::properties::Property::Visibility::Hidden + openspace::properties::Property::Visibility::Developer }; constexpr openspace::properties::Property::PropertyInfo ScreenSizeRadiusInfo = { "ScreenSizeRadius", "ScreenSizeRadius", "The screen size of the radius of the node", - openspace::properties::Property::Visibility::Hidden + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo VisibilityDistanceInfo = { @@ -83,7 +85,7 @@ namespace { "VisibilityDistance", "The distace in world coordinates between node and camera at which the " "screenspace object will become visible", - openspace::properties::Property::Visibility::Hidden + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo BoundingSphereInfo = { @@ -94,7 +96,7 @@ namespace { "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", - openspace::properties::Property::Visibility::Developer + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo InteractionSphereInfo = { @@ -104,21 +106,25 @@ namespace { "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", - openspace::properties::Property::Visibility::Developer + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ApproachFactorInfo = { "ApproachFactor", "Approach Factor", "This value is a multiplication factor for the interaction sphere that " - "determines when the camera is 'approaching' the scene graph node" + "determines when the camera is 'approaching' the scene graph node", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo ReachFactorInfo = { "ReachFactor", "Reach Factor", "This value is a multiplication factor for the interaction sphere that " - "determines when the camera has 'reached' the scene graph node" + "determines when the camera has 'reached' the scene graph node", + // @VISIBILITY(3.5) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo GuiPathInfo = { @@ -157,7 +163,8 @@ namespace { "Show Debug Sphere", "If enabled the bounding sphere of this scene graph node is rendered as a debug " "method", - openspace::properties::Property::Visibility::Developer + // @VISIBILITY(3.67) + openspace::properties::Property::Visibility::AdvancedUser }; constexpr openspace::properties::Property::PropertyInfo @@ -533,7 +540,9 @@ SceneGraphNode::SceneGraphNode() { addProperty(_computeScreenSpaceValues); addProperty(_screenSpacePosition); + _screenVisibility.setReadOnly(true); addProperty(_screenVisibility); + _distFromCamToNode.setReadOnly(true); addProperty(_distFromCamToNode); addProperty(_screenSizeRadius); addProperty(_visibilityDistance); diff --git a/src/scripting/scriptscheduler.cpp b/src/scripting/scriptscheduler.cpp index 39a0d1ff7e..0cf65ad6ef 100644 --- a/src/scripting/scriptscheduler.cpp +++ b/src/scripting/scriptscheduler.cpp @@ -39,7 +39,9 @@ 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" + "time as normal", + // @VISIBILITY(2.5) + openspace::properties::Property::Visibility::User }; constexpr openspace::properties::Property::PropertyInfo ShouldRunAllTimeJumpInfo = { @@ -47,7 +49,8 @@ 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 }; struct [[codegen::Dictionary(ScheduledScript)]] Parameters {