Adding periods to the description texts

This commit is contained in:
Alexander Bock
2024-04-23 22:33:17 +02:00
parent c9fd9543e6
commit 78b3b4fb2e
156 changed files with 887 additions and 1194 deletions
@@ -43,7 +43,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo AtmosphereHeightInfo = {
"AtmosphereHeight",
"Atmosphere Height (KM)",
"The thickness of the atmosphere in km",
"The thickness of the atmosphere in kilometers.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -52,22 +52,22 @@ namespace {
"AverageGroundReflectance",
"Average Ground Reflectance (%)",
"Average percentage of light reflected by the ground during the pre-calculation "
"phase",
"phase.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo GroundRadianceEmissionInfo = {
"GroundRadianceEmission",
"Percentage of initial radiance emitted from ground",
"Multiplier of the ground radiance color during the rendering phase",
"Multiplier of the ground radiance color during the rendering phase.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RayleighHeightScaleInfo = {
"RayleighHeightScale",
"Rayleigh Scale Height (KM)",
"It is the vertical distance over which the density and pressure fall by a "
"constant factor",
"The vertical distance over which the density and pressure falls by a constant "
"factor.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -75,14 +75,14 @@ namespace {
{
"RayleighScatteringCoeff",
"Rayleigh Scattering Coeff",
"Rayleigh sea-level scattering coefficients in meters",
"Rayleigh sea-level scattering coefficients in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OzoneLayerInfo = {
"Ozone",
"Ozone Layer Enabled",
"Enables/Disable Ozone Layer during pre-calculation phase",
"Enables/Disable Ozone Layer during pre-calculation phase.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -90,14 +90,14 @@ namespace {
"OzoneLayerHeightScale",
"Ozone Scale Height (KM)",
"It is the vertical distance over which the density and pressure fall by a "
"constant factor",
"constant factor.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OzoneLayerCoeffInfo = {
"OzoneLayerCoeff",
"Ozone Layer Extinction Coeff",
"Ozone scattering coefficients in meters",
"Ozone scattering coefficients in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -105,16 +105,14 @@ namespace {
"MieHeightScale",
"Mie Scale Height (KM)",
"It is the vertical distance over which the density and pressure fall by a "
"constant factor",
// @VISIBILITY(3.2)
"constant factor.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MieScatteringCoeffInfo = {
"MieScatteringCoeff",
"Mie Scattering Coeff",
"Mie sea-level scattering coefficients in meters",
// @VISIBILITY(3.2)
"Mie sea-level scattering coefficients in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -123,24 +121,21 @@ namespace {
{
"MieScatteringExtinctionPropCoefficient",
"Mie Scattering/Extinction Proportion Coefficient (%)",
"Mie Scattering/Extinction Proportion Coefficient (%)",
// @VISIBILITY(3.2)
"Mie Scattering/Extinction Proportion Coefficient.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MieAsymmetricFactorGInfo = {
"MieAsymmetricFactorG",
"Mie Asymmetric Factor G",
"Averaging of the scattering angle over a high number of scattering events",
// @VISIBILITY(3.2)
"Averaging of the scattering angle over a high number of scattering events.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SunIntensityInfo = {
"SunIntensity",
"Sun Intensity",
"Unitless for now",
// @VISIBILITY(2.6)
"Unitless for now.",
openspace::properties::Property::Visibility::User
};
@@ -149,7 +144,7 @@ namespace {
{
"SunFollowingCamera",
"Enable Sun On Camera Position",
"When selected the Sun is artificially positioned behind the observer all times",
"When selected the Sun is artificially positioned behind the observer all times.",
openspace::properties::Property::Visibility::User
};
@@ -157,14 +152,13 @@ namespace {
"EclipseHardShadowsInfo",
"Enable Hard Shadows for Eclipses",
"Enable/Disables hard shadows through the atmosphere",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo AtmosphereDimmingHeightInfo ={
"AtmosphereDimmingHeight",
"Atmosphere Dimming Height",
"Percentage of the atmosphere where other objects, such as the stars, are faded",
"Percentage of the atmosphere where other objects, such as the stars, are faded.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -172,14 +166,14 @@ namespace {
"AtmosphereDimmingSunsetAngle",
"Atmosphere Dimming Sunset Angle",
"The angle (degrees) between the Camera and the Sun where the sunset starts, and "
"the atmosphere starts to fade in objects such as the stars",
"the atmosphere starts to fade in objects such as the stars.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SunAngularSize = {
"SunAngularSize",
"Angular Size of the Sun",
"Specifies the angular size of the Sun in degrees",
"Specifies the angular size of the Sun in degrees.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -188,7 +182,7 @@ namespace {
"Name of the light source",
"This value is the name of a scene graph node that should be used as the source "
"of illumination for the atmosphere. If this value is not specified, the solar "
"system's Sun is used instead",
"system's Sun is used instead.",
openspace::properties::Property::Visibility::AdvancedUser
};
+6 -12
View File
@@ -50,8 +50,7 @@ namespace {
"SourceType",
"Source Type",
"The type of position that is used as the triangle apex used to calculate the "
"angle. The default value is 'Camera'",
// @VISIBILITY(2.67)
"angle. The default value is 'Camera'.",
openspace::properties::Property::Visibility::User
};
@@ -61,8 +60,7 @@ namespace {
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the apex of the triangle used to calculate the "
"angle. The computed angle is the incident angle to Source in the triangle ("
"Source, Reference, Destination)",
// @VISIBILITY(2.67)
"Source, Reference, Destination).",
openspace::properties::Property::Visibility::User
};
@@ -71,8 +69,7 @@ namespace {
"Reference Type",
"The type of position that is used as the destination of the reference line used "
"to calculate the angle. The computed angle is the incident angle to Source in "
"the triangle (Source, Reference, Destination)",
// @VISIBILITY(2.67)
"the triangle (Source, Reference, Destination).",
openspace::properties::Property::Visibility::User
};
@@ -80,8 +77,7 @@ namespace {
"ReferenceNodeName",
"Reference Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the reference direction to compute the angle",
// @VISIBILITY(2.67)
"node that is to be used as the reference direction to compute the angle.",
openspace::properties::Property::Visibility::User
};
@@ -90,8 +86,7 @@ namespace {
"Destination Type",
"The type of position that is used as the destination to calculate the angle. "
"The computed angle is the incident angle to Source in the triangle ("
"Source, Reference, Destination). The default value for this is 'Focus'",
// @VISIBILITY(2.67)
"Source, Reference, Destination). The default value for this is 'Focus'.",
openspace::properties::Property::Visibility::User
};
@@ -99,8 +94,7 @@ namespace {
"DestinationNodeName",
"Destination Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the destination for computing the angle",
// @VISIBILITY(2.67)
"node that is to be used as the destination for computing the angle.",
openspace::properties::Property::Visibility::User
};
+2 -3
View File
@@ -40,7 +40,7 @@ namespace {
"FormatString",
"Format String",
"The format text describing how this dashboard item renders its text. This text "
"must contain exactly one {} which is a placeholder that will contain the date",
"must contain exactly one {} which is a placeholder that will contain the date.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -50,8 +50,7 @@ namespace {
"The format string used for formatting the date/time before being passed to the "
"string in FormatString. See "
"https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/timout_c.html for full "
"information about how to structure this format",
// @VISIBILITY(2.75)
"information about how to structure this format.",
openspace::properties::Property::Visibility::User
};
@@ -52,8 +52,7 @@ namespace {
"SourceType",
"Source Type",
"The type of position that is used as the source to calculate the distance. The "
"default value is 'Camera'",
// @VISIBILITY(2.67)
"default value is 'Camera'.",
openspace::properties::Property::Visibility::User
};
@@ -61,8 +60,7 @@ namespace {
"SourceNodeName",
"Source Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the source for computing the distance",
// @VISIBILITY(2.67)
"node that is to be used as the source for computing the distance.",
openspace::properties::Property::Visibility::User
};
@@ -70,8 +68,7 @@ namespace {
"DestinationType",
"Destination Type",
"The type of position that is used as the destination to calculate the distance. "
"The default value for this is 'Focus'",
// @VISIBILITY(2.67)
"The default value for this is 'Focus'.",
openspace::properties::Property::Visibility::User
};
@@ -79,8 +76,7 @@ namespace {
"DestinationNodeName",
"Destination Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the destination for computing the distance",
// @VISIBILITY(2.33)
"node that is to be used as the destination for computing the distance.",
openspace::properties::Property::Visibility::User
};
@@ -89,7 +85,7 @@ namespace {
"Simplification",
"If this value is enabled, the distance is displayed in nuanced units, such as "
"km, AU, light years, parsecs, etc. If this value is disabled, the unit can be "
"explicitly requested",
"explicitly requested.",
openspace::properties::Property::Visibility::User
};
@@ -97,7 +93,7 @@ namespace {
"RequestedUnit",
"Requested Unit",
"If the simplification is disabled, this distance unit is used as a destination "
"to convert the meters into"
"to convert the meters into."
};
constexpr openspace::properties::Property::PropertyInfo FormatStringInfo = {
@@ -105,7 +101,7 @@ namespace {
"Format String",
"The format string that is used for formatting the distance string. This format "
"receives four parameters: The name of the source, the name of the destination "
"the value of the distance and the unit of the distance",
"the value of the distance and the unit of the distance.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -49,8 +49,7 @@ namespace {
"ReferenceTime",
"Reference Time",
"The reference time relative to which the elapsed time is specified. The format "
"must be an ISO 8601-compliant date string",
// @VISIBILITY(2.75)
"must be an ISO 8601-compliant date string.",
openspace::properties::Property::Visibility::User
};
@@ -60,7 +59,6 @@ namespace {
"If this value is enabled, the elapsed time will be simplified into seconds, "
"minutes, hours, etc. If the value is disabled, the elapsed time is always "
"presented in seconds. The default value for this is 'true'.",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
@@ -69,7 +67,6 @@ namespace {
"Lowest Time Unit when Simplifying",
"If 'SimplifyTime' is enabled, this is the lowest time unit that will be shown. "
"All finer grained timesteps will be ignored.",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
@@ -48,8 +48,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo FrametimeInfo = {
"FrametimeType",
"Type of the frame time display",
"This value determines the units in which the frame time is displayed",
// @VISIBILITY(2.75)
"This value determines the units in which the frame time is displayed.",
openspace::properties::Property::Visibility::User
};
@@ -57,11 +56,11 @@ namespace {
"ClearCache",
"Clear Cache",
"Clears the cache of this DashboardItemFramerate item. If the selected option "
"does not use any caching, this trigger does not do anything",
"does not use any caching, this trigger does not do anything.",
openspace::properties::Property::Visibility::AdvancedUser
};
[[ nodiscard ]] char* formatDt(std::vector<char>& buffer) {
[[nodiscard]] char* formatDt(std::vector<char>& buffer) {
return std::format_to(
buffer.data(),
"Avg. Frametime: {:.2f} ms\0",
@@ -69,7 +68,7 @@ namespace {
);
}
[[ nodiscard ]] char* formatDtExtremes(std::vector<char>& buffer,
[[nodiscard]] char* formatDtExtremes(std::vector<char>& buffer,
double minFrametimeCache,
double maxFrametimeCache)
{
@@ -84,7 +83,7 @@ namespace {
);
}
[[ nodiscard ]] char* formatDtStandardDeviation(std::vector<char>& buffer) {
[[nodiscard]] char* formatDtStandardDeviation(std::vector<char>& buffer) {
return std::format_to(
buffer.data(),
"Frametime standard deviation : {:.2f} ms\0",
@@ -92,7 +91,7 @@ namespace {
);
}
[[ nodiscard ]] char* formatDtCoefficientOfVariation(std::vector<char>& buffer) {
[[nodiscard]] char* formatDtCoefficientOfVariation(std::vector<char>& buffer) {
return std::format_to(
buffer.data(),
"Frametime coefficient of variation : {:.2f} %\0",
@@ -101,7 +100,7 @@ namespace {
);
}
[[ nodiscard ]] char* formatFps(std::vector<char>& buffer) {
[[nodiscard]] char* formatFps(std::vector<char>& buffer) {
return std::format_to(
buffer.data(),
"FPS: {:3.2f}\0",
@@ -109,7 +108,7 @@ namespace {
);
}
[[ nodiscard ]] char* formatAverageFps(std::vector<char>& buffer) {
[[nodiscard]] char* formatAverageFps(std::vector<char>& buffer) {
return std::format_to(
buffer.data(),
"Avg. FPS: {:3.2f}\0",
@@ -117,7 +116,7 @@ namespace {
);
}
[[ nodiscard ]] char* format(std::vector<char>& buffer, FrametimeType frametimeType,
[[nodiscard]] char* format(std::vector<char>& buffer, FrametimeType frametimeType,
double minFrametimeCache, double maxFrametimeCache)
{
using namespace openspace;
@@ -37,40 +37,35 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ShowWhenEnabledInfo = {
"ShowWhenEnabled",
"Show when enabled",
"Show text when the input is enabled",
// @VISIBILITY(?)
"Show text when the input is enabled.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowWhenDisabledInfo = {
"ShowWhenDisabled",
"Show when disabled",
"Show text when the input is disabled",
// @VISIBILITY(?)
"Show text when the input is disabled.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowKeyboardInfo = {
"ShowKeyboard",
"Show Keyboard information",
"Display the state of the keyboard input",
// @VISIBILITY(?)
"Display the state of the keyboard input.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowMouseInfo = {
"ShowMouse",
"Show Mouse information",
"Display the state of the mouse input",
// @VISIBILITY(?)
"Display the state of the mouse input.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowJoystickInfo = {
"ShowJoystick",
"Show Joystick information",
"Display the state of the joystick input",
// @VISIBILITY(?)
"Display the state of the joystick input.",
openspace::properties::Property::Visibility::User
};
@@ -56,8 +56,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo PropertyUriInfo = {
"URI",
"Property URI",
"The URI of the property that is displayed in this dashboarditem",
// @VISIBILITY(2.67)
"The URI of the property that is displayed in this dashboard item.",
openspace::properties::Property::Visibility::User
};
@@ -69,8 +68,7 @@ namespace {
"instances of {}, which will be replaced with the value(s) of the property "
"during rendering. For scalar types, there has to be exactly one instance of {}, "
"for vector types, there need to be as many {} as there are compoents in the "
"vector, for example two {} for vec2 types, three for vec3 types, etc",
// @VISIBILITY(2.67)
"vector, for example two {} for vec2 types, three for vec3 types, etc.",
openspace::properties::Property::Visibility::User
};
@@ -41,8 +41,7 @@ namespace {
"Time Simplification",
"If this value is enabled, the time is displayed in nuanced units, such as "
"minutes, hours, days, years, etc. If this value is disabled, it is always "
"displayed in seconds",
// @VISIBILITY(2.33)
"displayed in seconds.",
openspace::properties::Property::Visibility::User
};
@@ -50,8 +49,7 @@ namespace {
"RequestedUnit",
"Requested Unit",
"If the simplification is disabled, this time unit is used as a destination to "
"convert the seconds into",
// @VISIBILITY(2.33)
"convert the seconds into.",
openspace::properties::Property::Visibility::User
};
@@ -63,7 +61,7 @@ namespace {
"delta time. This format gets five parameters in this order: The target delta "
"time value, the target delta time unit, the string 'Paused' if the delta time "
"is paused or the empty string otherwise, the current delta time value, and the "
"current delta time unit",
"current delta time unit.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -73,7 +71,7 @@ namespace {
"The format string used to format the text if the target delta time is the same "
"as the current delta time. This format gets three parameters in this order: "
"The target delta value, the target delta unit, and the string 'Paused' if the "
"delta time is paused or the empty string otherwise",
"delta time is paused or the empty string otherwise.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -33,8 +33,7 @@ namespace {
"Spacing",
"Spacing",
"This value determines the spacing (in pixels) that this item represents. The "
"default value is 15",
// @VISIBILITY(2.33)
"default value is 15.",
openspace::properties::Property::Visibility::User
};
+1 -1
View File
@@ -37,7 +37,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo TextInfo = {
"Text",
"Text",
"The text to be displayed",
"The text to be displayed.",
openspace::properties::Property::Visibility::User
};
@@ -45,7 +45,7 @@ namespace {
"Simplification",
"If this value is enabled, the velocity is displayed in nuanced units, such as "
"m/s, AU/s, light years / s etc. If this value is disabled, the unit can be "
"explicitly requested",
"explicitly requested.",
openspace::properties::Property::Visibility::User
};
@@ -53,7 +53,7 @@ namespace {
"RequestedUnit",
"Requested Unit",
"If the simplification is disabled, this distance unit is used for the velocity "
"display",
"display.",
openspace::properties::Property::Visibility::User
};
@@ -33,8 +33,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo IntensityInfo = {
"Intensity",
"Intensity",
"The intensity of this light source",
// @VISIBILITY(1.75)
"The intensity of this light source.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -37,15 +37,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo IntensityInfo = {
"Intensity",
"Intensity",
"The intensity of this light source",
// @VISIBILITY(1.75)
"The intensity of this light source.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo NodeCameraStateInfo = {
"Node",
"Node",
"The identifier of the scene graph node to follow",
"The identifier of the scene graph node to follow.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -39,29 +39,28 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.17)
"This value determines the color of the grid lines that are rendered.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the spherical grid",
"This value specifies the line width of the spherical grid.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Grid Size",
"This value species the size of each dimensions of the box",
"This value species the size of each dimensions of the box.",
openspace::properties::Property::Visibility::AdvancedUser
};
const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {
"Labels",
"Labels",
"The labels for the grid"
"The labels for the grid."
};
struct [[codegen::Dictionary(RenderableBoxGrid)]] Parameters {
@@ -39,16 +39,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.25)
"This value determines the color of the grid lines that are rendered.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo HighlightColorInfo = {
"HighlightColor",
"Highlight Color",
"This value determines the color of the highlighted lines in the grid",
// @VISIBILITY(1.25)
"This value determines the color of the highlighted lines in the grid.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -56,8 +54,7 @@ namespace {
"Segments",
"Number of Segments",
"This value specifies the number of segments that are used to render the "
"grid in each direction",
// @VISIBILITY(2.75)
"grid in each direction.",
openspace::properties::Property::Visibility::User
};
@@ -73,29 +70,28 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the grid",
// @VISIBILITY(1.5)
"This value specifies the line width of the grid.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo HighlightLineWidthInfo = {
"HighlightLineWidth",
"Highlight Line Width",
"This value specifies the line width of the highlighted lines in the grid",
"This value specifies the line width of the highlighted lines in the grid.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Grid Size",
"This value species the size of each dimensions of the grid",
"This value species the size of each dimensions of the grid.",
openspace::properties::Property::Visibility::User
};
const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {
"Labels",
"Labels",
"The labels for the grid"
"The labels for the grid."
};
struct [[codegen::Dictionary(RenderableGrid)]] Parameters {
@@ -40,8 +40,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.25)
"This value determines the color of the grid lines that are rendered.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -49,8 +48,7 @@ namespace {
"GridSegments",
"Number of Grid Segments",
"Specifies the number of segments for the grid, in the radial and angular "
"direction respectively",
// @VISIBILITY(2.5)
"direction respectively.",
openspace::properties::Property::Visibility::User
};
@@ -58,15 +56,14 @@ namespace {
"CircleSegments",
"Number of Circle Segments",
"This value specifies the number of segments that is used to render each circle "
"in the grid",
// @VISIBILITY(2.5)
"in the grid.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the spherical grid",
"This value specifies the line width of the spherical grid.",
openspace::properties::Property::Visibility::User
};
@@ -75,15 +72,14 @@ namespace {
"Inner and Outer Radius",
"The radii values that determine the size of the circular grid. The first value "
"is the radius of the inmost ring and the second is the radius of the outmost "
"ring",
// @VISIBILITY(2.67)
"ring.",
openspace::properties::Property::Visibility::User
};
const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {
"Labels",
"Labels",
"The labels for the grid"
"The labels for the grid."
};
struct [[codegen::Dictionary(RenderableRadialGrid)]] Parameters {
@@ -39,8 +39,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.25)
"This value determines the color of the grid lines that are rendered.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -48,23 +47,21 @@ namespace {
"Segments",
"Number of Segments",
"This value specifies the number of segments that are used to render the "
"surrounding sphere",
// @VISIBILITY(2.25)
"surrounding sphere.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the spherical grid",
// @VISIBILITY(1.67)
"This value specifies the line width of the spherical grid.",
openspace::properties::Property::Visibility::NoviceUser
};
const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {
"Labels",
"Labels",
"The labels for the grid"
"The labels for the grid."
};
struct [[codegen::Dictionary(RenderableSphericalGrid)]] Parameters {
@@ -138,15 +138,14 @@ namespace {
"FixedColor",
"Fixed Color",
"This value is used to define the color of the points when no color map is"
"used",
"used.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo DrawElementsInfo = {
"DrawElements",
"Draw Elements",
"Enables/Disables the drawing of the points",
// @VISIBILITY(1.25)
"Enables/Disables the drawing of the points.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -169,7 +168,6 @@ namespace {
"camera is outside this range and fully invisible when inside the range. With "
"inverted fading the situation is the opposite: the points are visible inside "
"hen closer than the min value of the range and invisible when further away.",
// @VISIBILITY(3.25)
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -235,7 +233,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo HasOrientationDataInfo = {
"HasOrientationData",
"Has Orientation Data",
"Set to true if orientation data was read from the dataset",
"Set to true if orientation data was read from the dataset.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -40,24 +40,21 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo XColorInfo = {
"XColor",
"X Color",
"This value determines the color of the x axis",
// @VISIBILITY(1.5)
"This value determines the color of the x axis.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo YColorInfo = {
"YColor",
"Y Color",
"This value determines the color of the y axis",
// @VISIBILITY(1.5)
"This value determines the color of the y axis.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo ZColorInfo = {
"ZColor",
"Z Color",
"This value determines the color of the z axis",
// @VISIBILITY(1.5)
"This value determines the color of the z axis.",
openspace::properties::Property::Visibility::NoviceUser
};
+3 -5
View File
@@ -47,16 +47,14 @@ namespace {
"Texture",
"Texture",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture to be used for the color",
// @VISIBILITY(2.75)
"texture to be used for the color.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value specifies the outer radius of the disc in meter",
// @VISIBILITY(2.75)
"This value specifies the outer radius of the disc in meters.",
openspace::properties::Property::Visibility::User
};
@@ -65,7 +63,7 @@ namespace {
"Width",
"This value is used to set the width of the disc. The actual width is set "
"based on the given size and this value should be set between 0 and 1. A value "
"of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size",
"of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size.",
openspace::properties::Property::Visibility::AdvancedUser
};
+12 -19
View File
@@ -92,70 +92,63 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = {
"BlendMode",
"Blending Mode",
"This determines the blending mode that is applied to the renderable",
"This determines the blending mode that is applied to the renderable.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"The label text color",
// @VISIBILITY(1.33)
"The label text color.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = {
"FontSize",
"Font Size",
"The font size (in points) for the label",
// @VISIBILITY(2.5)
"The font size (in points) for the label.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value affects the size scale of the label",
// @VISIBILITY(2.75)
"This value affects the size scale of the label.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo TextInfo = {
"Text",
"Text",
"The text that will be displayed on screen",
// @VISIBILITY(1.8)
"The text that will be displayed on screen.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo MinMaxSizeInfo = {
"MinMaxSize",
"Min and Max Size",
"The minimum and maximum size (in pixels) of the label",
"The minimum and maximum size (in pixels) of the label.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo TransformationMatrixInfo = {
"TransformationMatrix",
"Transformation Matrix",
"Transformation matrix to be applied to the label",
// @VISIBILITY(3.6)
"Transformation matrix to be applied to the label.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OrientationOptionInfo = {
"OrientationOption",
"Orientation Option",
"Label orientation rendering mode",
// @VISIBILITY(2.8)
"Label orientation rendering mode.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EnableFadingEffectInfo = {
"EnableFading",
"Enable/Disable Fade-in Effect",
"Enable/Disable the Fade-in effect",
// @VISIBILITY(?)
"Enable/Disable the Fade-in effect.",
openspace::properties::Property::Visibility::User
};
@@ -166,7 +159,7 @@ namespace {
"The first value is the distance before the closest distance and the second "
"the one after the furthest distance. For example, with the unit Parsec (pc), "
"a value of {1, 2} will make the label being fully faded out 1 Parsec before "
"the closest distance and 2 Parsec away from the furthest distance",
"the closest distance and 2 Parsec away from the furthest distance.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -174,14 +167,14 @@ namespace {
"FadeDistances",
"Fade Distances",
"The distance range in which the labels should be fully opaque, specified in "
"the chosen unit. The distance from the position of the label to the camera",
"the chosen unit. The distance from the position of the label to the camera.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeUnitOptionInfo = {
"FadeUnit",
"Fade Distance Unit",
"Distance unit for fade-in/-out distance calculations. Defaults to \"au\"",
"Distance unit for fade-in/-out distance calculations. Defaults to \"au\".",
openspace::properties::Property::Visibility::AdvancedUser
};
+13 -17
View File
@@ -86,31 +86,28 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnableAnimationInfo = {
"EnableAnimation",
"Enable Animation",
"Enable or disable the animation for the model if it has any",
"Enable or disable the animation for the model if it has any.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = {
"AmbientIntensity",
"Ambient Intensity",
"A multiplier for ambient lighting",
// @VISIBILITY(2.4)
"A multiplier for ambient lighting.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DiffuseIntensityInfo = {
"DiffuseIntensity",
"Diffuse Intensity",
"A multiplier for diffuse lighting",
// @VISIBILITY(2.4)
"A multiplier for diffuse lighting.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SpecularIntensityInfo = {
"SpecularIntensity",
"Specular Intensity",
"A multiplier for specular lighting",
// @VISIBILITY(2.4)
"A multiplier for specular lighting.",
openspace::properties::Property::Visibility::User
};
@@ -118,14 +115,14 @@ namespace {
"PerformShading",
"Perform Shading",
"This value determines whether this model should be shaded by using the position "
"of the Sun",
"of the Sun.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EnableFaceCullingInfo = {
"EnableFaceCulling",
"Enable Face Culling",
"Enable OpenGL automatic face culling optimization",
"Enable OpenGL automatic face culling optimization.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -133,14 +130,14 @@ namespace {
"ModelTransform",
"Model Transform",
"This value specifies the model transform that is applied to the model before "
"all other transformations are applied",
"all other transformations are applied.",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo PivotInfo = {
"Pivot",
"Pivot",
"A vector that moves the place of origin for the model",
"A vector that moves the place of origin for the model.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -151,29 +148,28 @@ namespace {
"provided in the asset file, you can see and change it here. If instead a unit "
"name was provided in the asset, this is the value that that name represents. "
"For example 'Centimeter' becomes 0.01. For more information see "
"http://wiki.openspaceproject.com/docs/builders/models/model-scale.html",
"http://wiki.openspaceproject.com/docs/builders/models/model-scale.html.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RotationVecInfo = {
"RotationVector",
"Rotation Vector",
"Rotation Vector using degrees",
// @VISIBILITY(3.75)
"Rotation Vector using degrees.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo LightSourcesInfo = {
"LightSources",
"Light Sources",
"A list of light sources that this model should accept light from",
"A list of light sources that this model should accept light from.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo EnableDepthTestInfo = {
"EnableDepthTest",
"Enable Depth Test",
"Enable Depth Testing for the Model",
"Enable Depth Testing for the Model.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -181,7 +177,7 @@ namespace {
"BlendingOption",
"Blending Options",
"Changes the blending function used to calculate the colors of the model with "
"respect to the opacity",
"respect to the opacity.",
openspace::properties::Property::Visibility::AdvancedUser
};
+15 -15
View File
@@ -48,21 +48,21 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo StartNodeInfo = {
"StartNode",
"Start Node",
"The identifier of the node the arrow starts from",
"The identifier of the node the arrow starts from.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo EndNodeInfo = {
"EndNode",
"End Node",
"The identifier of the node the arrow should point towards",
"The identifier of the node the arrow should point towards.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the RGB color for the arrow",
"This value determines the RGB color for the arrow.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -70,7 +70,7 @@ namespace {
"Segments",
"Number of Segments",
"This value specifies the number of segments that the shapes for the arrow are "
"separated in. A higher number leads to a higher resolution",
"separated in. A higher number leads to a higher resolution.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -87,7 +87,7 @@ namespace {
"Arrow Head Size",
"This size of the arrow head, given in relative value of the entire length of "
"the arrow. For example, 0.1 makes the arrow head length be 10% of the full "
"arrow length",
"arrow length.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -95,7 +95,7 @@ namespace {
"ArrowHeadWidthFactor",
"Arrow Head Width Factor",
"A factor that is multiplied with the width, or the arrow itself, to determine "
"the width of the base of the arrow head",
"the width of the base of the arrow head.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -105,7 +105,7 @@ namespace {
"The distance from the center of the start node where the arrow starts. "
"If 'UseRelativeOffset' is true, the value should be given as a factor to "
"multiply with the bounding sphere of the node. Otherwise, the value is "
"specified in meters",
"specified in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -113,7 +113,7 @@ namespace {
"UseRelativeOffset",
"Use Relative Offset Distance",
"Decide whether to use relative distances (in units of start node bounding "
"sphere) for the offset distance. If false, meters is used",
"sphere) for the offset distance. If false, meters is used.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -122,7 +122,7 @@ namespace {
"Length",
"The length of the arrow, given either in meters or as a factor to be "
"multiplied with the bounding sphere of the start node (if "
"'UseRelativeLength' is true)",
"'UseRelativeLength' is true).",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -130,42 +130,42 @@ namespace {
"UseRelativeLength",
"Use Relative Length",
"Decide whether to use relative size (in units of start node bounding "
"sphere) for the length of the arrow. If false, meters is used",
"sphere) for the length of the arrow. If false, meters is used.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo WidthInfo = {
"Width",
"Width",
"This value specifies the width of the arrow shape",
"This value specifies the width of the arrow shape.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = {
"AmbientIntensity",
"Ambient Intensity",
"A multiplier for ambient lighting for the shading of the arrow",
"A multiplier for ambient lighting for the shading of the arrow.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DiffuseIntensityInfo = {
"DiffuseIntensity",
"Diffuse Intensity",
"A multiplier for diffuse lighting for the shading of the arrow",
"A multiplier for diffuse lighting for the shading of the arrow.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SpecularIntensityInfo = {
"SpecularIntensity",
"Specular Intensity",
"A multiplier for specular lighting for the shading of the arrow",
"A multiplier for specular lighting for the shading of the arrow.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShadingEnabledInfo = {
"PerformShading",
"Perform Shading",
"This value determines whether shading should be applied to the arrow model",
"This value determines whether shading should be applied to the arrow model.",
openspace::properties::Property::Visibility::User
};
@@ -60,15 +60,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo LineColorInfo = {
"Color",
"Color",
"This value determines the RGB color for the line",
"This value determines the RGB color for the line.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width",
// @VISIBILITY(1.75)
"This value specifies the line width.",
openspace::properties::Property::Visibility::NoviceUser
};
+5 -6
View File
@@ -56,7 +56,7 @@ namespace {
"Billboard mode",
"This value specifies whether the plane is a billboard, which means that it is "
"always facing the camera. If this is false, it can be oriented using other "
"transformations",
"transformations.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -65,15 +65,14 @@ namespace {
"Mirror backside of image plane",
"If this value is set to false, the image plane will not be mirrored when "
"looking from the backside. This is usually desirable when the image shows "
"data at a specific location, but not if it is displaying text for example",
// @VISIBILITY(2.67)
"data at a specific location, but not if it is displaying text for example.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size (in meters)",
"This value specifies the size of the plane in meters",
"This value specifies the size of the plane in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -87,7 +86,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = {
"BlendMode",
"Blending Mode",
"This determines the blending mode that is applied to this plane",
"This determines the blending mode that is applied to this plane.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -95,7 +94,7 @@ namespace {
"MultiplyColor",
"Multiply Color",
"If set, the plane's texture is multiplied with this color. Useful for applying "
"a color grayscale images",
"a color grayscale images.",
openspace::properties::Property::Visibility::User
};
@@ -42,8 +42,7 @@ namespace {
"Texture",
"Texture",
"This value specifies an image that is loaded from disk and is used as a texture "
"that is applied to this plane. This image has to be square",
// @VISIBILITY(2.25)
"that is applied to this plane. This image has to be square.",
openspace::properties::Property::Visibility::User
};
@@ -39,8 +39,7 @@ namespace {
"Image URL",
"Sets the URL of the texture that is displayed on this screen space plane. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed",
// @VISIBILITY(2.25)
"and displayed.",
openspace::properties::Property::Visibility::User
};
@@ -45,7 +45,7 @@ namespace {
"SourceFolder",
"Source Folder",
"This value specifies the image directory that is loaded from disk and "
"is used as a texture that is applied to this plane",
"is used as a texture that is applied to this plane.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -53,8 +53,7 @@ namespace {
"RenderType",
"Render Type",
"This value specifies if the plane should be rendered in the Background, "
"Opaque, Transparent, or Overlay rendering step",
// @VISIBILITY(3.67)
"Opaque, Transparent, or Overlay rendering step.",
openspace::properties::Property::Visibility::AdvancedUser
};
+7 -14
View File
@@ -44,8 +44,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Segments",
"The number of segments the shape of the prism should have",
// @VISIBILITY(2.8)
"The number of segments the shape of the prism should have.",
openspace::properties::Property::Visibility::User
};
@@ -53,16 +52,14 @@ namespace {
"NumLines",
"Number of Lines",
"The number of lines connecting the two shapes of the prism. They will be evenly "
"distributed around the bounding circle that makes up the shape of the prism",
// @VISIBILITY(2.8)
"distributed around the bounding circle that makes up the shape of the prism.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RadiusInfo = {
"Radius",
"Radius",
"The radius of the prism's shape in meters",
// @VISIBILITY(2.8)
"The radius of the prism's shape in meters.",
openspace::properties::Property::Visibility::User
};
@@ -70,32 +67,28 @@ namespace {
"BaseRadius",
"Base Radius",
"The radius of the base of the prism's shape, in meters. By default it is given "
"the same radius as the outer shape",
// @VISIBILITY(2.8)
"the same radius as the outer shape.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width",
// @VISIBILITY(2.0)
"This value specifies the line width.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineColorInfo = {
"Color",
"Color",
"This value determines the RGB color for the line",
// @VISIBILITY(1.2)
"This value determines the RGB color for the line.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LengthInfo = {
"Length",
"Length",
"The length of the prism in meters",
// @VISIBILITY(2.8)
"The length of the prism in meters.",
openspace::properties::Property::Visibility::User
};
+7 -8
View File
@@ -48,15 +48,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size (in meters)",
"This value specifies the radius of the sphere in meters",
"This value specifies the radius of the sphere in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Number of Segments",
"This value specifies the number of segments that the sphere is separated in",
// @VISIBILITY(2.67)
"This value specifies the number of segments that the sphere is separated in.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -70,21 +69,21 @@ namespace {
"Orientation",
"Orientation",
"Specifies whether the texture is applied to the inside of the sphere, the "
"outside of the sphere, or both",
"outside of the sphere, or both.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = {
"MirrorTexture",
"Mirror Texture",
"Mirror the texture along the x-axis",
"Mirror the texture along the x-axis.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = {
"DisableFadeInOut",
"Disable Fade-In/Fade-Out effects",
"Enables/Disables the fade in and out effects",
"Enables/Disables the fade in and out effects.",
openspace::properties::Property::Visibility::User
};
@@ -94,7 +93,7 @@ namespace {
"This value determines the distance from center of MilkyWay from where the "
"astronomical object starts to fade in, given as a percentage of the size of "
"the object. A negative or zero value means no fading in will happen. This is "
"also the default",
"also the default.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -103,7 +102,7 @@ namespace {
"Fade-Out Threshold",
"This value determines percentage of the sphere that is visible before starting "
"to fade it out. A negative or zero value means no fading out will happen. This "
"is also the default",
"is also the default.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -38,8 +38,7 @@ namespace {
"Texture",
"This value specifies an image that is loaded from disk and is used as a texture "
"that is applied to this sphere. This image is expected to be an equirectangular "
"projection",
// @VISIBILITY(2.33)
"projection.",
openspace::properties::Property::Visibility::User
};
@@ -38,8 +38,7 @@ namespace {
"Image URL",
"Sets the URL of the texture that is displayed on this sphere. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed. This image is expected to be an equirectangular projection",
// @VISIBILITY(2.25)
"and displayed. This image is expected to be an equirectangular projection.",
openspace::properties::Property::Visibility::User
};
@@ -55,7 +55,7 @@ namespace {
"Texture Source",
"This value specifies a directory of images that are loaded from disk and is "
"used as a texture that is applied to this sphere. The images are expected to "
"be an equirectangular projection",
"be an equirectangular projection.",
openspace::properties::Property::Visibility::AdvancedUser
};
+7 -12
View File
@@ -73,8 +73,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo LineColorInfo = {
"Color",
"Color",
"This value determines the RGB main color for the lines and points of the trail",
// @VISIBILITY(1.2)
"This value determines the RGB main color for the lines and points of the trail.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -83,8 +82,7 @@ namespace {
"Enable line fading of old points",
"Toggles whether the trail should fade older points out. If this value is "
"'true', the 'Fade' parameter determines the speed of fading. If this value is "
"'false', the entire trail is rendered at full opacity and color",
// @VISIBILITY(1.25)
"'false', the entire trail is rendered at full opacity and color.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -95,7 +93,6 @@ namespace {
"value of 1 will result in a trail that covers the entire extent. The setting "
"only applies if 'EnableFade' is 'true'. If it is 'false', this setting has "
"no effect.",
// @VISIBILITY(2.5)
openspace::properties::Property::Visibility::User
};
@@ -110,7 +107,6 @@ namespace {
"will result in a trail that starts fading immediately, becoming fully "
"transparent by the end of the trail. This setting only applies if the "
"'EnableFade' value is 'true'. If it is 'false', this setting has no effect.",
// @VISIBILITY(2.5)
openspace::properties::Property::Visibility::User
};
@@ -119,8 +115,7 @@ namespace {
"Line Width",
"This value specifies the line width of the trail if the selected rendering "
"method includes lines. If the rendering mode is set to Points, this value is "
"ignored",
// @VISIBILITY(2.4)
"ignored.",
openspace::properties::Property::Visibility::User
};
@@ -130,8 +125,7 @@ namespace {
"This value specifies the base size of the points along the line if the selected "
"rendering method includes points. If the rendering mode is set the Lines, this "
"value is ignored. If a subsampling of the values is performed, the subsampled "
"values are half this size",
// @VISIBILITY(2.4)
"values are half this size.",
openspace::properties::Property::Visibility::User
};
@@ -140,12 +134,13 @@ namespace {
"Rendering Mode",
"Determines how the trail should be rendered. If 'Lines' is "
"selected, only the line part is visible, if 'Points' is selected, only the "
"corresponding points (and subpoints) are shown. 'Lines+Points' shows both parts",
"corresponding points (and subpoints) are shown. 'Lines+Points' shows both "
"parts.",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableTrail)]] Parameters {
// This object is used to compute locations along the path. Any Translation
// This object is used to compute locations along the path. Any Translation
// object can be used here
ghoul::Dictionary translation
[[codegen::reference("core_transform_translation")]];
@@ -93,7 +93,7 @@ namespace {
"The objects period, i.e. the length of its orbit around the parent object given "
"in (Earth) days. In the case of Earth, this would be a sidereal year "
"(=365.242 days). If this values is specified as multiples of the period, it is "
"possible to show the effects of precession",
"possible to show the effects of precession.",
openspace::properties::Property::Visibility::User
};
@@ -103,7 +103,7 @@ namespace {
"The number of samples along the orbit. This determines the resolution of the "
"trail; the tradeoff being that a higher resolution is able to resolve more "
"detail, but will take more resources while rendering, too. The higher, the "
"smoother the trail, but also more memory will be used",
"smoother the trail, but also more memory will be used.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -111,8 +111,7 @@ namespace {
"RenderableType",
"RenderableType",
"This value specifies if the orbit should be rendered in the Background,"
"Opaque, Transparent, or Overlay rendering step. Default is Transparent",
// @VISIBILITY(3.25)
"Opaque, Transparent, or Overlay rendering step. Default is Transparent.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -48,7 +48,7 @@ namespace {
"StartTime",
"Start Time",
"The start time for the range of this trajectory. The date must be in ISO 8601 "
"format: YYYY MM DD HH:mm:ss.xxx",
"format: YYYY MM DD HH:mm:ss.xxx.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -56,7 +56,7 @@ namespace {
"EndTime",
"End Time",
"The end time for the range of this trajectory. The date must be in ISO 8601 "
"format: YYYY MM DD HH:mm:ss.xxx",
"format: YYYY MM DD HH:mm:ss.xxx.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -66,7 +66,7 @@ namespace {
"The interval between samples of the trajectory. This value (together with "
"'TimeStampSubsampleFactor') determines how far apart (in time) the samples are "
"spaced along the trajectory. The time interval between 'StartTime' and "
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments",
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -76,7 +76,7 @@ namespace {
"The factor that is used to create subsamples along the trajectory. This value "
"(together with 'SampleInterval') determines how far apart (in time) the samples "
"are spaced along the trajectory. The time interval between 'StartTime' and "
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments",
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -84,8 +84,8 @@ namespace {
"ShowFullTrail",
"Render Full Trail",
"If this value is set to 'true', the entire trail will be rendered; if it is "
"'false', only the trail until the current time in the application will be shown",
// @VISIBILITY(1.25)
"'false', only the trail until the current time in the application will be "
"shown.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -93,8 +93,8 @@ namespace {
"SweepChunkSize",
"Sweep Chunk Size",
"The number of vertices that will be calculated each frame whenever the trail "
"needs to be recalculated. "
"A greater value will result in more calculations per frame.",
"needs to be recalculated. A greater value will result in more calculations per "
"frame.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -113,7 +113,8 @@ namespace {
"AccurateTrailPositions",
"Number of Accurate Trail Points",
"The number of vertices, each side of the object, that will be recalculated "
"for greater accuracy. This also ensures that the object connects with the trail.",
"for greater accuracy. This also ensures that the object connects with the "
"trail.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -41,7 +41,7 @@ namespace {
"UseMainDashboard",
"Use main dashboard",
"If this value is set to 'true', this ScreenSpaceDashboard will use the "
"main dashboard instead of creating an independent one",
"main dashboard instead of creating an independent one.",
openspace::properties::Property::Visibility::Developer
};
@@ -36,8 +36,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value explicitly specifies the size of the screen space plane",
// @VISIBILITY(3.75)
"This value explicitly specifies the size of the screen space plane.",
openspace::properties::Property::Visibility::AdvancedUser
};
} // namespace
@@ -42,8 +42,7 @@ namespace {
"Sets the path of the texture that is displayed on this screen space plane. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed. The size of the image will also automatically set the default "
"size of this plane",
// @VISIBILITY(2.4)
"size of this plane.",
openspace::properties::Property::Visibility::User
};
@@ -42,8 +42,7 @@ namespace {
"Sets the URL of the texture that is displayed on this screen space plane. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed. The size of the image will also automatically set the default "
"size of this plane",
// @VISIBILITY(2.4)
"size of this plane.",
openspace::properties::Property::Visibility::User
};
+2 -4
View File
@@ -34,16 +34,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo RotationInfo = {
"RotationAxis",
"Rotation Axis",
"This value is the rotation axis around which the object will rotate",
// @VISIBILITY(3.33)
"This value is the rotation axis around which the object will rotate.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RotationRateInfo = {
"RotationRate",
"Rotation Rate",
"This value determines the number of revolutions per in-game second",
// @VISIBILITY(3.33)
"This value determines the number of revolutions per in-game second.",
openspace::properties::Property::Visibility::AdvancedUser
};
+17 -18
View File
@@ -42,8 +42,7 @@ namespace {
"Enabled",
"If this value is 'true', all the machinery of this rotation is used, of it is "
"'false', it provides the ability to change its attributes without risking some "
"undefined behavior",
// @VISIBILITY(2.75)
"undefined behavior.",
openspace::properties::Property::Visibility::User
};
@@ -53,7 +52,7 @@ namespace {
"This value specifies how this axis is being specified, that is whether it is "
"referencing another object, specifying an absolute vector, or whether it is "
"using the right handed coordinate system completion based off the other two "
"vectors",
"vectors.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -63,7 +62,7 @@ namespace {
"This value specifies how this axis is being specified, that is whether it is "
"referencing another object, specifying an absolute vector, or whether it is "
"using the right handed coordinate system completion based off the other two "
"vectors",
"vectors.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -73,7 +72,7 @@ namespace {
"This value specifies how this axis is being specified, that is whether it is "
"referencing another object, specifying an absolute vector, or whether it is "
"using the right handed coordinate system completion based off the other two "
"vectors",
"vectors.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -82,7 +81,7 @@ namespace {
"xAxis: Focus Object",
"This is the object that the axis will focus on. This object must name an "
"existing scene graph node in the currently loaded scene and the rotation will "
"stay fixed to the current position of that object",
"stay fixed to the current position of that object.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -91,7 +90,7 @@ namespace {
"yAxis: Focus Object",
"This is the object that the axis will focus on. This object must name an "
"existing scene graph node in the currently loaded scene and the rotation will "
"stay fixed to the current position of that object",
"stay fixed to the current position of that object.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -100,7 +99,7 @@ namespace {
"zAxis: Focus Object",
"This is the object that the axis will focus on. This object must name an "
"existing scene graph node in the currently loaded scene and the rotation will "
"stay fixed to the current position of that object",
"stay fixed to the current position of that object.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -109,7 +108,7 @@ namespace {
"xAxis: Invert Object Point Direction",
"If this value is set to 'true', and the type is set to 'Object', the inverse of "
"the pointing direction is used, causing the object to point away from the "
"referenced object",
"referenced object.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -118,7 +117,7 @@ namespace {
"yAxis: Invert Object Point Direction",
"If this value is set to 'true', and the type is set to 'Object', the inverse of "
"the pointing direction is used, causing the object to point away from the "
"referenced object",
"referenced object.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -127,7 +126,7 @@ namespace {
"zAxis: Invert Object Point Direction",
"If this value is set to 'true', and the type is set to 'Object', the inverse of "
"the pointing direction is used, causing the object to point away from the "
"referenced object",
"referenced object.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -135,7 +134,7 @@ namespace {
"xAxisVector",
"xAxis: Direction vector",
"This value specifies a static direction vector that is used for a fixed "
"rotation",
"rotation.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -143,7 +142,7 @@ namespace {
"yAxisVector",
"yAxis: Direction vector",
"This value specifies a static direction vector that is used for a fixed "
"rotation",
"rotation.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -151,7 +150,7 @@ namespace {
"zAxisVector",
"zAxis: Direction vector",
"This value specifies a static direction vector that is used for a fixed "
"rotation",
"rotation.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -160,7 +159,7 @@ namespace {
"xAxis: Vector is orthogonal",
"This value determines whether the vector specified is used directly, or whether "
"it is used together with another non-coordinate system completion vector to "
"construct an orthogonal vector instead",
"construct an orthogonal vector instead.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -169,7 +168,7 @@ namespace {
"yAxis: Vector is orthogonal",
"This value determines whether the vector specified is used directly, or whether "
"it is used together with another non-coordinate system completion vector to "
"construct an orthogonal vector instead",
"construct an orthogonal vector instead.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -178,7 +177,7 @@ namespace {
"zAxis: Vector is orthogonal",
"This value determines whether the vector specified is used directly, or whether "
"it is used together with another non-coordinate system completion vector to "
"construct an orthogonal vector instead",
"construct an orthogonal vector instead.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -187,7 +186,7 @@ namespace {
"Attached Node",
"This is the name of the node that this rotation is attached to, this value is "
"only needed if any of the three axis uses the Object type. In this case, the "
"location of the attached node is required to compute the relative direction",
"location of the attached node is required to compute the relative direction.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -2
View File
@@ -43,8 +43,7 @@ namespace {
"'rotation' that takes the current simulation time in seconds past the J2000 "
"epoch as the first argument, the current wall time as milliseconds past the "
"J2000 epoch as the second argument and computes the rotation returned as 9 "
"values",
// @VISIBILITY(3.25)
"values.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -2
View File
@@ -32,8 +32,7 @@ namespace {
"Rotation",
"Rotation",
"This value is the used as a 3x3 rotation matrix that is applied to the scene "
"graph node that this transformation is attached to relative to its parent",
// @VISIBILITY(3.0)
"graph node that this transformation is attached to relative to its parent.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -2
View File
@@ -35,8 +35,7 @@ namespace {
"ShouldInterpolate",
"Should Interpolate",
"If this value is set to 'true', an interpolation is applied between the given "
"keyframes. If this value is set to 'false', the interpolation is not applied",
// @VISIBILITY(3.2)
"keyframes. If this value is set to 'false', the interpolation is not applied.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -2
View File
@@ -42,8 +42,7 @@ namespace {
"scaling factor for this transformation. The script needs to define a function "
"'scale' that takes the current simulation time in seconds past the J2000 epoch "
"as the first argument, the current wall time as milliseconds past the J2000 "
"epoch the second argument and computes the three scaling factors",
// @VISIBILITY(3.25)
"epoch the second argument and computes the three scaling factors.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -1
View File
@@ -32,7 +32,7 @@ namespace {
"Scale",
"Scale",
"These values are used as scaling factors for the scene graph node that this "
"transformation is attached to relative to its parent",
"transformation is attached to relative to its parent.",
openspace::properties::Property::Visibility::NoviceUser
};
+1 -1
View File
@@ -32,7 +32,7 @@ namespace {
"Scale",
"Scale",
"This value is used as a scaling factor for the scene graph node that this "
"transformation is attached to relative to its parent",
"transformation is attached to relative to its parent.",
openspace::properties::Property::Visibility::NoviceUser
};
+3 -5
View File
@@ -37,8 +37,7 @@ namespace {
"The date at which this scale will be 0. The current value of the scale is "
"computed by taking the difference between the current time and the reference "
"date and multiplying it by the speed. This field must be formatted as: "
"YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds",
// @VISIBILITY(2.75)
"YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds.",
openspace::properties::Property::Visibility::User
};
@@ -46,8 +45,7 @@ namespace {
"Speed",
"Speed",
"The speed at which the value grows or shrinks. The units for this are meters "
"per second. The default value is 1 m/s",
// @VISIBILITY(2.75)
"per second. The default value is 1 m/s.",
openspace::properties::Property::Visibility::User
};
@@ -57,7 +55,7 @@ namespace {
"If this value is true, the velocity computation will be clamped to a positive "
"value if the current simulation time is before the `ReferenceDate`. This is "
"useful for instantaneous events that only propagate forwards in time. The "
"default value is 'true'",
"default value is 'true'.",
openspace::properties::Property::Visibility::AdvancedUser
};
+4 -8
View File
@@ -34,32 +34,28 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo HasStartInfo = {
"HasStart",
"Has Start",
"If enabled, this TimeFrame will be inactive before the Start",
// @VISIBILITY(2.75)
"If enabled, this TimeFrame will be inactive before the Start.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo StartInfo = {
"Start",
"Start",
"Specifies the time when this TimeFrame becomes active",
// @VISIBILITY(2.75)
"Specifies the time when this TimeFrame becomes active.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo HasEndInfo = {
"HasEnd",
"Has End",
"If enabled, this TimeFrame will be inactive after the End",
// @VISIBILITY(2.75)
"If enabled, this TimeFrame will be inactive after the End.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EndInfo = {
"End",
"End",
"Specifies the time when this TimeFrame becomes inactive",
// @VISIBILITY(2.75)
"Specifies the time when this TimeFrame becomes inactive.",
openspace::properties::Property::Visibility::User
};
+2 -2
View File
@@ -35,8 +35,8 @@ namespace {
"TimeFrames",
"Time Frames",
"A vector of time frames to combine into one. The time frame is active when any "
"of the contained time frames are, but not in gaps between contained time frames",
// @VISIBILITY(3.75)
"of the contained time frames are, but not in gaps between contained time "
"frames.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -2
View File
@@ -43,8 +43,7 @@ namespace {
"translation for this transformation. The script needs to define a function "
"'translation' that takes the current simulation time in seconds past the J2000 "
"epoch as the first argument, the current wall time as milliseconds past the "
"J2000 epoch as the second argument and computes the translation",
// @VISIBILITY(3.75)
"J2000 epoch as the second argument and computes the translation.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -32,7 +32,7 @@ namespace {
"Position",
"Position",
"This value is used as a static offset (in meters) that is applied to the scene "
"graph node that this transformation is attached to relative to its parent",
"graph node that this transformation is attached to relative to its parent.",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
@@ -35,7 +35,7 @@ namespace {
"ShouldInterpolate",
"Should Interpolate",
"If this value is set to 'true', an interpolation is applied between the given "
"keyframes. If this value is set to 'false', the interpolation is not applied",
"keyframes. If this value is set to 'false', the interpolation is not applied.",
openspace::properties::Property::Visibility::AdvancedUser
};
+5 -8
View File
@@ -41,38 +41,35 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"This setting determines whether the browser should be enabled or not",
"This setting determines whether the browser should be enabled or not.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ReloadInfo = {
"Reload",
"Reload",
"Trigger this property to reload the browser",
// @VISIBILITY(2.2)
"Trigger this property to reload the browser.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo VisibleInfo = {
"Visible",
"Is Visible",
"This setting determines whether the browser should be visible or not",
// @VISIBILITY(2.75)
"This setting determines whether the browser should be visible or not.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo GuiUrlInfo = {
"GuiUrl",
"GUI URL",
"The URL of the webpage that is used to load the WebGUI from",
// @VISIBILITY(3.5)
"The URL of the webpage that is used to load the WebGUI from.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo GuiScaleInfo = {
"GuiScale",
"Gui Scale",
"GUI scale multiplier",
"GUI scale multiplier.",
openspace::properties::Property::Visibility::Always
};
} // namespace
@@ -51,8 +51,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo TextureInfo = {
"Texture",
"Texture",
"The OpenGL name of the texture that is displayed on this plane",
// @VISIBILITY(3.75)
"The OpenGL name of the texture that is displayed on this plane.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -61,24 +60,21 @@ namespace {
"Billboard mode",
"This value specifies whether the plane is a billboard, which means that it is "
"always facing the camera. If this is false, it can be oriented using other "
"transformations",
// @VISIBILITY(3.75)
"transformations.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size (in meters)",
"This value specifies the size of the plane in meters",
// @VISIBILITY(3.75)
"This value specifies the size of the plane in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OriginInfo = {
"Origin",
"Texture Coordinate Origin",
"The origin of the texture coorinate system",
// @VISIBILITY(3.75)
"The origin of the texture coorinate system.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -62,7 +62,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo TextColorInfo = {
"TextColor",
"Text Color",
"The text color for the astronomical object",
"The text color for the astronomical object.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -70,14 +70,14 @@ namespace {
"TextOpacity",
"Text Opacity",
"Determines the transparency of the text label, where 1 is completely opaque "
"and 0 fully transparent",
"and 0 fully transparent.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo TextSizeInfo = {
"TextSize",
"Text Size",
"The text size for the astronomical object labels",
"The text size for the astronomical object labels.",
openspace::properties::Property::Visibility::User
};
@@ -85,7 +85,7 @@ namespace {
"LabelFile",
"Label File",
"The path to the label file that contains information about the astronomical "
"objects being rendered",
"objects being rendered.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -93,44 +93,42 @@ namespace {
"TextMinMaxSize",
"Text Min/Max Size",
"The minimum and maximum size (in pixels) of the text for the labels for the "
"astronomical objects being rendered",
"astronomical objects being rendered.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"If the DU mesh is of wire type, this value determines the width of the lines",
// @VISIBILITY(1.75)
"If the DU mesh is of wire type, this value determines the width of the lines.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo DrawElementsInfo = {
"DrawElements",
"Draw Elements",
"Enables/Disables the drawing of the astronomical objects",
"Enables/Disables the drawing of the astronomical objects.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo DrawLabelInfo = {
"DrawLabels",
"Draw Labels",
"Determines whether labels should be drawn or hidden",
"Determines whether labels should be drawn or hidden.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo MeshColorInfo = {
"MeshColor",
"Meshes colors",
"The defined colors for the meshes to be rendered",
// @VISIBILITY(1.25)
"The defined colors for the meshes to be rendered.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo RenderOptionInfo = {
"RenderOption",
"Render Option",
"Debug option for rendering of billboards and texts",
"Debug option for rendering of billboards and texts.",
openspace::properties::Property::Visibility::AdvancedUser
};
+14 -17
View File
@@ -53,28 +53,28 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"Decides if the GUI for this module should be enabled",
"Decides if the GUI for this module should be enabled.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DataFolderInfo = {
"DataFolder",
"Data Folder",
"The path to the folder containing the exoplanets data and lookup table",
"The path to the folder containing the exoplanets data and lookup table.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo BvColorMapInfo = {
"BvColormap",
"B-V Colormap",
"The path to a cmap file that maps a B-V color index to an RGB color",
"The path to a cmap file that maps a B-V color index to an RGB color.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo StarTextureInfo = {
"StarTexture",
"Star Texture",
"The path to a grayscale image that is used for the host star surfaces",
"The path to a grayscale image that is used for the host star surfaces.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -82,7 +82,7 @@ namespace {
"StarGlareTexture",
"Star Glare Texture",
"The path to a grayscale image that is used for the glare effect of the "
"host stars",
"host stars.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -90,7 +90,7 @@ namespace {
"NoDataTexture",
"No Data Star Texture",
"A path to a texture that is used to represent that there is missing data about "
"the star. For example no color information",
"the star. For example no color information.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -98,7 +98,7 @@ namespace {
"OrbitDiscTexture",
"Orbit Disc Texture",
"A path to a 1-dimensional image used as a transfer function for the "
"exoplanets' orbit uncertainty disc",
"exoplanets' orbit uncertainty disc.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -106,7 +106,7 @@ namespace {
"HabitableZoneTexture",
"Habitable Zone Texture",
"A path to a 1-dimensional image used as a transfer function for the "
"habitable zone disc",
"habitable zone disc.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -115,7 +115,7 @@ namespace {
"Comparison Circle Color",
"Decides the color of the 1 AU size comparison circles that are generated as "
"part of an exoplanet system. Changing the color will not modify already "
"existing circles",
"existing circles.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -123,8 +123,7 @@ namespace {
"ShowComparisonCircle",
"Show Comparison Circle",
"If true, the 1 AU size comparison circle is enabled per default when an "
"exoplanet system is created",
// @VISIBILITY(1.8)
"exoplanet system is created.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -132,7 +131,7 @@ namespace {
"ShowOrbitUncertainty",
"Show Orbit Uncertainty",
"If true, a disc showing the uncertainty for each planetary orbit is enabled per "
"default when an exoplanet system is created",
"default when an exoplanet system is created.",
openspace::properties::Property::Visibility::User
};
@@ -140,7 +139,7 @@ namespace {
"ShowHabitableZone",
"Show Habitable Zone",
"If true, the habitable zone disc is enabled per default when an exoplanet "
"system is created",
"system is created.",
openspace::properties::Property::Visibility::User
};
@@ -148,8 +147,7 @@ namespace {
"UseOptimisticZone",
"Use Optimistic Zone Boundaries",
"If true, the habitable zone is computed with optimistic boundaries per default "
"when an exoplanet system is created",
// @VISIBILITY(2.8)
"when an exoplanet system is created.",
openspace::properties::Property::Visibility::User
};
@@ -157,8 +155,7 @@ namespace {
"HabitableZoneOpacity",
"Habitable Zone Opacity",
"The opacity value used for the habitable zone renderable for a created "
"exoplanet system",
// @VISIBILITY(1.5)
"exoplanet system.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -49,14 +49,14 @@ namespace {
"Texture",
"Texture",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture which is used for the color",
"texture which is used for the color.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value specifies the semi-major axis of the orbit, in meter",
"This value specifies the semi-major axis of the orbit, in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -64,7 +64,7 @@ namespace {
"Eccentricity",
"Eccentricity",
"This value determines the eccentricity, that is the deviation from a perfect "
"sphere, for this orbit",
"sphere, for this orbit.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -74,7 +74,7 @@ namespace {
"This property determines the width of the disc. The values specify the lower "
"and upper deviation from the semi major axis, respectively. The values are "
"relative to the size of the semi-major axis. That is, 0 means no deviation "
"from the semi-major axis and 1 is a whole semi-major axis's worth of deviation",
"from the semi-major axis and 1 is a whole semi-major axis's worth of deviation.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -82,8 +82,7 @@ namespace {
"MultiplyColor",
"Multiply Color",
"If set, the disc's texture is multiplied with this color. Useful for applying a "
"color grayscale images",
// @VISIBILITY(1.5)
"color grayscale images.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -71,10 +71,8 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = {
"Stepsize",
//"StepSize",
"Fieldline Step Size",
"Fieldline Step Size.",
"", // @TODO Missing documentation
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
@@ -53,110 +53,104 @@ namespace {
"ColorMethod",
"Color Method",
"Color lines uniformly or using color tables based on extra quantities like, for "
"examples, temperature or particle density",
"examples, temperature or particle density.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ColorQuantityInfo = {
"ColorQuantity",
"Quantity to Color By",
"Quantity used to color lines if the 'By Quantity' color method is selected",
// @VISIBILITY(2.67)
"Quantity used to color lines if the 'By Quantity' color method is selected.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ColorMinMaxInfo = {
"ColorQuantityMinMax",
"ColorTable Min Value",
"Value to map to the lowest and highest end of the color table",
"Value to map to the lowest and highest end of the color table.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ColorTablePathInfo = {
"ColorTablePath",
"Path to Color Table",
"Color Table/Transfer Function to use for 'By Quantity' coloring",
"Color Table/Transfer Function to use for 'By Quantity' coloring.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ColorUniformInfo = {
"Color",
"Uniform Line Color",
"The uniform color of lines shown when 'Color Method' is set to 'Uniform'",
// @VISIBILITY(1.67)
"The uniform color of lines shown when 'Color Method' is set to 'Uniform'.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo ColorUseABlendingInfo = {
"ABlendingEnabled",
"Additive Blending",
"Activate/deactivate additive blending",
"Activate/deactivate additive blending.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DomainEnabledInfo = {
"DomainEnabled",
"Domain Limits",
"Enable/Disable domain limits",
"Enable/Disable domain limits.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DomainXInfo = {
"LimitsX",
"X-limits",
"Valid range along the X-axis. [Min, Max]",
"Valid range along the X-axis. [Min, Max].",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DomainYInfo = {
"LimitsY",
"Y-limits",
"Valid range along the Y-axis. [Min, Max]",
"Valid range along the Y-axis. [Min, Max].",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DomainZInfo = {
"LimitsZ",
"Z-limits",
"Valid range along the Z-axis. [Min, Max]",
"Valid range along the Z-axis. [Min, Max].",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DomainRInfo = {
"LimitsR",
"Radial limits",
"Valid radial range. [Min, Max]",
"Valid radial range. [Min, Max].",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FlowColorInfo = {
"FlowColor",
"Flow Color",
"Color of particles flow direction indication",
// @VISIBILITY(1.33)
"Color of particles flow direction indication.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo FlowEnabledInfo = {
"FlowEnabled",
"Flow Direction",
"Toggles the rendering of moving particles along the lines. Can, for example, "
"illustrate magnetic flow",
// @VISIBILITY(1.67)
"illustrate magnetic flow.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo FlowReversedInfo = {
"Reversed",
"Reversed Flow",
"Toggle to make the flow move in the opposite direction",
"Toggle to make the flow move in the opposite direction.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo FlowParticleSizeInfo = {
"ParticleSize",
"Particle Size",
"Size of the particles",
// @VISIBILITY(2.33)
"Size of the particles.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo FlowParticleSpacingInfo = {
"ParticleSpacing",
"Particle Spacing",
"Spacing inbetween particles",
// @VISIBILITY(2.33)
"Spacing inbetween particles.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo FlowSpeedInfo = {
"Speed",
"Speed",
"Speed of the flow",
"Speed of the flow.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo MaskingEnabledInfo = {
@@ -165,32 +159,31 @@ namespace {
"Enable/disable masking. Use masking to show lines where a given quantity is "
"within a given range, for example, if you only want to see where the "
"temperature is between 10 and 20 degrees. Also used for masking out line "
"topologies like solar wind & closed lines",
"topologies like solar wind & closed lines.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MaskingMinMaxInfo = {
"MaskingMinLimit",
"Lower Limit",
"Lower and upper limit of the valid masking range",
"Lower and upper limit of the valid masking range.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MaskingQuantityInfo = {
"MaskingQuantity",
"Quantity used for Masking",
"Quantity used for masking",
"Quantity used for masking.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the fieldlines",
// @VISIBILITY(1.33)
"This value specifies the line width of the fieldlines.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo TimeJumpButtonInfo = {
"TimeJumpToStart",
"Jump to Start Of Sequence",
"Performs a time jump to the start of the sequence",
"Performs a time jump to the start of the sequence.",
openspace::properties::Property::Visibility::NoviceUser
};
+33 -45
View File
@@ -57,7 +57,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo FilePathInfo = {
"File",
"File Path",
"The path to the file with data for the stars to be rendered",
"The path to the file with data for the stars to be rendered.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -71,8 +71,7 @@ namespace {
"data, construct an Octree and render it. 'BinaryOctree' will read a constructed "
"Octree from binary file and render full data. 'StreamOctree' will read an index "
"file with full Octree structure and then stream nodes during runtime. (This "
"option is suited for bigger datasets)",
// @VISIBILITY(3.67)
"option is suited for bigger datasets).",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -81,7 +80,7 @@ namespace {
"Render Mode",
"This value determines which predefined columns to use in rendering. If "
"'Static' only the position of the stars is used. 'Color' uses position + color "
"parameters and 'Motion' uses pos, color as well as velocity for the stars",
"parameters and 'Motion' uses pos, color as well as velocity for the stars.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -93,7 +92,7 @@ namespace {
"filter. If 'Billboard_*' is chosen then the geometry shaders will generate "
"screen-faced billboards for all stars. For '*_SSBO' the data will be stored in "
"Shader Storage Buffer Objects while '*_VBO' uses Vertex Buffer Objects for the "
"streaming. OBS! SSBO won't work on Apple",
"streaming. OBS! SSBO won't work on Apple.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -101,7 +100,7 @@ namespace {
"Texture",
"Point Spread Function Texture",
"The path to the texture that should be used as a point spread function for the "
"stars",
"stars.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -109,8 +108,7 @@ namespace {
"LuminosityMultiplier",
"Luminosity Multiplier",
"Factor by which to multiply the luminosity with. [Works in Color and Motion "
"modes]",
// @VISIBILITY(2.33)
"modes].",
openspace::properties::Property::Visibility::User
};
@@ -118,8 +116,7 @@ namespace {
"MagnitudeBoost",
"Magnitude Boost",
"Sets what percent of the star magnitude that will be used as boost to star "
"size. [Works only with billboards in Color and Motion modes]",
// @VISIBILITY(2.33)
"size. [Works only with billboards in Color and Motion modes].",
openspace::properties::Property::Visibility::User
};
@@ -128,24 +125,21 @@ namespace {
"Cut Off Threshold",
"Set threshold for when to cut off star rendering. Stars closer than this "
"threshold are given full opacity. Farther away, stars dim proportionally to the "
"4-logarithm of their distance",
// @VISIBILITY(2.33)
"4-logarithm of their distance.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SharpnessInfo = {
"Sharpness",
"Sharpness",
"Adjust star sharpness. [Works only with billboards]",
// @VISIBILITY(?)
"Adjust star sharpness. [Works only with billboards].",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo BillboardSizeInfo = {
"BillboardSize",
"Billboard Size",
"Set the billboard size of all stars. [Works only with billboards]",
// @VISIBILITY(?)
"Set the billboard size of all stars. [Works only with billboards].",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -153,7 +147,7 @@ namespace {
"CloseUpBoostDist",
"Close-Up Boost Distance [pc]",
"Set the distance where stars starts to increase in size. Unit is Parsec [Works "
"only with billboards]",
"only with billboards].",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -161,7 +155,7 @@ namespace {
"FilterSize",
"Filter Size [px]",
"Set the filter size in pixels used in tonemapping for point splatting rendering"
"[Works only with points]",
"[Works only with points].",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -169,7 +163,7 @@ namespace {
"Sigma",
"Normal Distribution Sigma",
"Set the normal distribution sigma used in tonemapping for point splatting "
"rendering. [Works only with points]",
"rendering. [Works only with points].",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -179,7 +173,7 @@ namespace {
"Determines how many additional nodes around the camera that will be fetched "
"from disk. The first value determines how many additional layers of parents "
"that will be fetched. The second value determines how many layers of descendant "
"that will be fetched from the found parents",
"that will be fetched from the found parents.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -189,7 +183,7 @@ namespace {
"Set the threshold for how big the elliptic weight of a pixel has to be to "
"contribute to the final elliptic shape. A smaller value gives a more visually "
"pleasing result while a bigger value will speed up the rendering on skewed "
"frustums (aka Domes)",
"frustums (aka Domes).",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -197,7 +191,7 @@ namespace {
"ColorMap",
"Color Texture",
"The path to the texture that is used to convert from the magnitude of the star "
"to its color. The texture is used as a one dimensional lookup function",
"to its color. The texture is used as a one dimensional lookup function.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -206,7 +200,7 @@ namespace {
"First Row to Read",
"Defines the first row that will be read from the specified FITS file No need to "
"define if data already has been processed. [Works only with "
"FileReaderOption::Fits]",
"FileReaderOption::Fits].",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -215,7 +209,7 @@ namespace {
"Last Row to Read",
"Defines the last row that will be read from the specified FITS file; has to be "
"equal to or greater than FirstRow. No need to define if data already has been "
"processed. [Works only with FileReaderOption::Fits]",
"processed. [Works only with FileReaderOption::Fits].",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -224,16 +218,14 @@ namespace {
"Column Names",
"A list of strings with the names of all the columns that are to be read from "
"the specified FITS file. No need to define if data already has been processed. "
"[Works only with FileReaderOption::Fits]",
// @VISIBILITY(3.67)
"[Works only with FileReaderOption::Fits].",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo NumRenderedStarsInfo = {
"NumRenderedStars",
"Rendered Stars",
"The number of rendered stars in the current frame",
// @VISIBILITY(3.67)
"The number of rendered stars in the current frame.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -241,8 +233,7 @@ namespace {
"CpuRamBudget",
"CPU RAM Budget",
"Current remaining budget (bytes) on the CPU RAM for loading more node data "
"files",
// @VISIBILITY(3.33)
"files.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -250,8 +241,7 @@ namespace {
"GpuStreamBudget",
"GPU Stream Budget",
"Current remaining memory budget [in number of chunks] on the GPU for streaming "
"additional stars",
// @VISIBILITY(3.67)
"additional stars.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -259,15 +249,14 @@ namespace {
"LodPixelThreshold",
"LOD Pixel Threshold",
"The number of total pixels a nodes AABB can have in clipping space before its "
"parent is fetched as LOD cache",
"parent is fetched as LOD cache.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MaxGpuMemoryPercentInfo = {
"MaxGpuMemoryPercent",
"Max GPU Memory",
"Sets the max percent of existing GPU memory budget that the streaming will use",
// @VISIBILITY(3.33)
"Sets the max percent of existing GPU memory budget that the streaming will use.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -275,8 +264,7 @@ namespace {
"MaxCpuMemoryPercent",
"Max CPU Memory",
"Sets the max percent of existing CPU memory budget that the streaming of files "
"will use",
// @VISIBILITY(3.33)
"will use.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -285,7 +273,7 @@ namespace {
"PosX Threshold",
"If defined then only stars with Position X values between [min, max] will be "
"rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is "
"read as +Inf). Measured in kiloParsec",
"read as +Inf). Measured in kiloParsec.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -294,7 +282,7 @@ namespace {
"PosY Threshold",
"If defined then only stars with Position Y values between [min, max] will be "
"rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is "
"read as +Inf). Measured in kiloParsec",
"read as +Inf). Measured in kiloParsec.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -303,7 +291,7 @@ namespace {
"PosZ Threshold",
"If defined then only stars with Position Z values between [min, max] will be "
"rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is "
"read as +Inf). Measured in kiloParsec",
"read as +Inf). Measured in kiloParsec.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -313,7 +301,7 @@ namespace {
"If defined then only stars with G mean magnitude values between [min, max] will "
"be rendered (if min is set to 20.0 it is read as -Inf, if max is set to 20.0 it "
"is read as +Inf). If min = max then all values equal min|max will be filtered "
"away",
"away.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -322,7 +310,8 @@ namespace {
"Bp-Rp Threshold",
"If defined then only stars with Bp-Rp color values between [min, max] will be "
"rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is "
"read as +Inf). If min = max then all values equal min|max will be filtered away",
"read as +Inf). If min = max then all values equal min|max will be filtered "
"away.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -331,15 +320,14 @@ namespace {
"Dist Threshold",
"If defined then only stars with Distances values between [min, max] will be "
"rendered (if min is set to 0.0 it is read as -Inf, if max is set to 0.0 it is "
"read as +Inf). Measured in kParsec",
"read as +Inf). Measured in kParsec.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ReportGlErrorsInfo = {
"ReportGlErrors",
"Report GL Errors",
"If set to true, any OpenGL errors will be reported if encountered",
// @VISIBILITY(3.67)
"If set to true, any OpenGL errors will be reported if encountered.",
openspace::properties::Property::Visibility::AdvancedUser
};
+10 -13
View File
@@ -78,7 +78,7 @@ namespace {
"VolumeRenderingEnabled",
"Volume Rendering",
"If this value is enabled, the volume rendering component of the galaxy "
"rendering is turned on. Otherwise, the volume rendering is skipped",
"rendering is turned on. Otherwise, the volume rendering is skipped.",
openspace::properties::Property::Visibility::User
};
@@ -86,7 +86,7 @@ namespace {
"StarRenderingEnabled",
"Star Rendering",
"If this value is enabled, the point-based star rendering component of the "
"galaxy rendering is turned on. Otherwise, the volume rendering is skipped",
"galaxy rendering is turned on. Otherwise, the volume rendering is skipped.",
openspace::properties::Property::Visibility::User
};
@@ -95,7 +95,7 @@ namespace {
"Step Size",
"Determines the distance between steps taken in the volume rendering. The lower "
"the number is, the better the rendering looks, but also takes more "
"computational resources to render",
"computational resources to render.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -104,8 +104,7 @@ namespace {
"Absorption Multiplier",
"A unit-less scale factor for the probability of dust absorbing a light "
"particle. The amount of absorption determines the spectrum of the light that is "
"emitted from the galaxy",
// @VISIBILITY(2.5)
"emitted from the galaxy.",
openspace::properties::Property::Visibility::User
};
@@ -113,15 +112,14 @@ namespace {
"EmissionMultiply",
"Emission Multiplier",
"A unit-less scale factor for the amount of light being emitted by dust in the "
"galaxy",
// @VISIBILITY(2.5)
"galaxy.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RotationInfo = {
"Rotation",
"Euler rotation",
"The internal rotation of the volume rendering in Euler angles",
"The internal rotation of the volume rendering in Euler angles.",
openspace::properties::Property::Visibility::Developer
};
@@ -129,7 +127,7 @@ namespace {
"StarRenderingMethod",
"Star Rendering Method",
"This value determines which rendering method is used for visualization of the "
"stars",
"stars.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -139,7 +137,7 @@ namespace {
"The ratio of point-like stars that are rendered to produce the overall galaxy "
"image. At a value of 0, no stars are rendered, at a value of 1 all points "
"contained in the dataset are rendered. The specific value chosen is a "
"compromise between image fidelity and rendering performance",
"compromise between image fidelity and rendering performance.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -147,8 +145,7 @@ namespace {
{
"Downscale",
"Downscale Factor Volume Rendering",
"This value sets the downscaling factor when rendering the current volume",
// @VISIBILITY(2.5)
"This value sets the downscaling factor when rendering the current volume.",
openspace::properties::Property::Visibility::User
};
@@ -156,7 +153,7 @@ namespace {
{
"Steps",
"Number of RayCasting Steps",
"This value set the number of integration steps during the raycasting procedure",
"This value set the number of integration steps during the raycasting procedure.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -98,16 +98,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo TileCacheSizeInfo = {
"TileCacheSize",
"Tile Cache Size",
"The maximum size of the MemoryAwareTileCache, on the CPU and GPU",
"The maximum size of the MemoryAwareTileCache, on the CPU and GPU.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo
DefaultGeoPointTextureInfo =
{
constexpr openspace::properties::Property::PropertyInfo DefaultGeoPointTextureInfo = {
"DefaultGeoPointTexture",
"Default Geo Point Texture",
"A path to a texture to use as default for GeoJson points"
"A path to a texture to use as default for GeoJson points."
};
constexpr openspace::properties::Property::PropertyInfo MRFCacheEnabledInfo = {
@@ -45,15 +45,15 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo DisplayFormatInfo = {
"DisplayFormat",
"Display Format",
"Choosing the format in which the camera location is displayed",
"Choosing the format in which the camera location is displayed.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SignificantDigitsInfo = {
"SignificantDigits",
"Significant Digits",
"Determines the number of significant digits that are shown in the location text",
// @VISIBILITY(3.25)
"Determines the number of significant digits that are shown in the location "
"text.",
openspace::properties::Property::Visibility::AdvancedUser
};
+2 -2
View File
@@ -42,7 +42,7 @@ namespace {
"LogGdalErrors",
"Log GDAL errors",
"If this value is enabled, any error that is raised by GDAL will be logged using "
"the logmanager. If this value is disabled, any error will be ignored",
"the logmanager. If this value is disabled, any error will be ignored.",
openspace::properties::Property::Visibility::Developer
};
@@ -50,7 +50,7 @@ namespace {
"GdalMaximumCacheSize",
"GDAL maximum cache size",
"This function sets the maximum amount of RAM memory in MB that GDAL is "
"permitted to use for caching",
"permitted to use for caching.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -61,14 +61,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"This setting determines whether this object will be visible or not",
"This setting determines whether this object will be visible or not.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FileInfo = {
"File",
"File",
"Path to the GeoJSON file to base the rendering on",
"Path to the GeoJSON file to base the rendering on.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -76,7 +76,7 @@ namespace {
"HeightOffset",
"Height Offset",
"A height offset value, in meters. Useful for moving a feature closer to or "
"farther away from the surface",
"farther away from the surface.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -86,7 +86,7 @@ namespace {
"A latitude and longitude offset value, in decimal degrees. Can be used to "
"move the object on the surface and correct potential mismatches with other "
"renderings. Note that changing it during runtime leads to all positions being "
"recomputed",
"recomputed.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -94,7 +94,7 @@ namespace {
"DrawWireframe",
"Wireframe",
"If true, draw the wire frame of the polygons. Used for testing and to "
"investigate tessellation results",
"investigate tessellation results.",
openspace::properties::Property::Visibility::Developer
};
@@ -103,7 +103,7 @@ namespace {
"Prevent Update From Heightmap",
"If true, the polygon mesh will not be automatically updated based on the "
"heightmap, even if the 'RelativeToGround' altitude option is set and the "
"heightmap updates. The data can still be force updated",
"heightmap updates. The data can still be force updated.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -111,7 +111,7 @@ namespace {
"ForceUpdateHeightData",
"Force Update Height Data",
"Triggering this leads to a recomputation of the heights based on the globe "
"height map value at the geometry's positions",
"height map value at the geometry's positions.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -120,7 +120,7 @@ namespace {
"Points Aligned to",
"Decides how the billboards for the points should be rendered in terms of up "
"direction and whether the plane should face the camera. See details on the "
"different options in the wiki",
"different options in the wiki.",
openspace::properties::Property::Visibility::User
};
@@ -128,7 +128,7 @@ namespace {
"FlyToFeature",
"Fly To Feature",
"Triggering this leads to the camera flying to a position that show the GeoJson "
"feature. The flight will account for any lat, long or height offset",
"feature. The flight will account for any lat, long or height offset.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -136,7 +136,7 @@ namespace {
"CentroidCoordinate",
"Centroid Coordinate",
"The lat long coordinate of the centroid position of the read geometry. Note "
"that this value does not incude the offset",
"that this value does not incude the offset.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -144,7 +144,7 @@ namespace {
"BoundingBox",
"Bounding Box",
"The lat long coordinates of the lower and upper corner of the bounding box of "
"the read geometry. Note that this value does not incude the offset",
"the read geometry. Note that this value does not incude the offset.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -152,7 +152,7 @@ namespace {
"PointSizeScale",
"Point Size Scale",
"An extra scale value that can be used to increase or decrease the scale of any "
"rendered points in the component, even if a value is set from the GeoJson file",
"rendered points in the component, even if a value is set from the GeoJson file.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -157,7 +157,7 @@ namespace {
"Opacity",
"Opacity",
"This value determines the opacity of this object. A value of 0 means "
"completely transparent",
"completely transparent.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -165,7 +165,7 @@ namespace {
"Color",
"Color",
"The color of the rendered geometry. For points it will be used as a multiply"
"color for any provided texture",
"color for any provided texture.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -173,7 +173,7 @@ namespace {
"FillOpacity",
"Fill Opacity",
"This value determines the opacity of the filled portion of a polygon. Will "
"also be used for extruded features",
"also be used for extruded features.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -181,14 +181,14 @@ namespace {
"FillColor",
"Fill Color",
"The color of the filled portion of a rendered polygon. Will also be used for "
"extruded features",
"extruded features.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"The width of any rendered lines",
"The width of any rendered lines.",
openspace::properties::Property::Visibility::User
};
@@ -196,7 +196,7 @@ namespace {
"PointSize",
"Point Size",
"The size of any rendered points. The size will be scaled based on the "
"bounding sphere of the globe",
"bounding sphere of the globe.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -213,7 +213,7 @@ namespace {
"Extrude",
"Extrude",
"If true, extrude the geometry to intersect the globe.Lines/polygons will be"
"extruded with polygons,and points with lines ",
"extruded with polygons,and points with lines.",
openspace::properties::Property::Visibility::User
};
@@ -222,7 +222,7 @@ namespace {
"Perform Shading",
"If true, perform shading on any create meshes, either from polygons or "
"extruded lines. The shading will be computed based on any light sources of the "
"GeoJson component",
"GeoJson component.",
openspace::properties::Property::Visibility::User
};
@@ -233,7 +233,7 @@ namespace {
"be interpreted. Absolute means that the height is interpreted as the height "
"above the reference ellipsoid, while RelativeToGround takes the height map "
"into account. For coordinates with only two values (latitude and longitude), "
"the height is considered to be equal to zero",
"the height is considered to be equal to zero.",
openspace::properties::Property::Visibility::User
};
@@ -241,7 +241,7 @@ namespace {
"PointTextureAnchor",
"Point Texture Anchor",
"Decides the placement of the point texture in relation to the position. "
"Default is a the bottom of the texture, but it can also be put at the center",
"Default is a the bottom of the texture, but it can also be put at the center.",
openspace::properties::Property::Visibility::User
};
@@ -251,7 +251,7 @@ namespace {
"If false, no tessellation to bend the geometry based on the curvature of the "
"planet is performed. This leads to increased performance, but tessellation is "
"neccessary for large geometry that spans a big portion of the globe. Otherwise "
"it may intersect the surface",
"it may intersect the surface.",
openspace::properties::Property::Visibility::User
};
@@ -261,7 +261,7 @@ namespace {
"If true, use the 'Tessellation Level' to control the level of detail for the "
"tessellation. The distance used will be the 'Tessellation Distance' divided by "
"the 'Tessellation Level', so the higher the level value, the smaller each "
"segment in the geomoetry will be",
"segment in the geomoetry will be.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -282,7 +282,7 @@ namespace {
"larger than this distance will be automatically subdivided into smaller pieces "
"matching this distance, while anything smaller will not be subdivided. Per "
"default this will be set to a distance corresponding to about 1 degree "
"longitude on the globe",
"longitude on the globe.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -64,30 +64,28 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"Enables and disables labels' rendering",
"Enables and disables labels' rendering.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = {
"FontSize",
"Font Size",
"Font size for the rendering labels. This is different fromt text size",
// @VISIBILITY(2.75)
"Font size for the rendering labels. This is different fromt text size.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo MinMaxSizeInfo = {
"MinMaxSize",
"Min/Max Text Size",
"Minimum and maximum label size, in pixels",
"Minimum and maximum label size, in pixels.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"LabelsSize",
"Labels Size",
"This value affects the size scale of the labels",
// @VISIBILITY(2.5)
"This value affects the size scale of the labels.",
openspace::properties::Property::Visibility::User
};
@@ -95,16 +93,14 @@ namespace {
"HeightOffset",
"Height Offset",
"This value moves the label away from the globe surface by the specified "
"distance (in meters)",
// @VISIBILITY(2.75)
"distance (in meters).",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"The text color of the labels",
// @VISIBILITY(1.2)
"The text color of the labels.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -113,7 +109,7 @@ namespace {
"Fade-In Distances",
"The distances above the globe's surface at which the labels start fading in or "
"out, given in meters. The final distances are also adjusted by the specified "
"height offset",
"height offset.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -121,7 +117,7 @@ namespace {
"FadeInEnabled",
"Fade In Enabled",
"Sets whether the labels fade in when approaching the globe from a distance. If "
"false, no fading happens and the labels immediately has full opacity",
"false, no fading happens and the labels immediately has full opacity.",
openspace::properties::Property::Visibility::User
};
@@ -129,29 +125,28 @@ namespace {
"FadeOutEnabled",
"Fade Out Enabled",
"Sets whether the labels fade out when approaching the surface of the globe. If "
"false, no fading happens and the labels stays in full opacity",
"false, no fading happens and the labels stays in full opacity.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DisableCullingInfo = {
"DisableCulling",
"Culling Disabled",
"Labels culling disabled",
"Labels culling disabled.",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo DistanceEPSInfo = {
"DistanceEPS",
"Culling Distance",
"Labels culling distance from globe's center",
"Labels culling distance from globe's center.",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo AlignmentOptionInfo = {
"AlignmentOption",
"Alignment Option",
"Labels are aligned horizontally or circularly related to the planet",
// @VISIBILITY(2.75)
"Labels are aligned horizontally or circularly related to the planet.",
openspace::properties::Property::Visibility::User
};
+6 -11
View File
@@ -40,8 +40,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo GlobeInfo = {
"Globe",
"Attached Globe",
"The globe on which the longitude/latitude is specified",
// @VISIBILITY(2.5)
"The globe on which the longitude/latitude is specified.",
openspace::properties::Property::Visibility::User
};
@@ -50,8 +49,7 @@ namespace {
"Latitude",
"The latitude of the location on the globe's surface. The value can range from "
"-90 to 90, with negative values representing the southern hemisphere of the "
"globe. The default value is 0.0",
// @VISIBILITY(2.25)
"globe. The default value is 0.0.",
openspace::properties::Property::Visibility::User
};
@@ -60,8 +58,7 @@ namespace {
"Longitude",
"The longitude of the location on the globe's surface. The value can range from "
"-180 to 180, with negative values representing the western hemisphere of the "
"globe. The default value is 0.0",
// @VISIBILITY(2.25)
"globe. The default value is 0.0.",
openspace::properties::Property::Visibility::User
};
@@ -69,7 +66,7 @@ namespace {
"Angle",
"Angle",
"A rotation angle that can be used to rotate the object around its own y-axis, "
"which will be pointing out of the globe's surface",
"which will be pointing out of the globe's surface.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -78,16 +75,14 @@ namespace {
"Use Heightmap",
"If set to true, the heightmap will be used when computing the surface normal. "
"This means that the object will be rotated to lay flat on the surface at the "
"given coordinate and follow the shape of the landscape",
// @VISIBILITY(2.5)
"given coordinate and follow the shape of the landscape.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo UseCameraInfo = {
"UseCamera",
"Use Camera",
"If this value is 'true', the lat and lon are updated to match the camera",
// @VISIBILITY(?)
"If this value is 'true', the lat and lon are updated to match the camera.",
openspace::properties::Property::Visibility::AdvancedUser
};
+7 -14
View File
@@ -39,8 +39,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo GlobeInfo = {
"Globe",
"Attached Globe",
"The globe on which the longitude/latitude is specified",
// @VISIBILITY(2.5)
"The globe on which the longitude/latitude is specified.",
openspace::properties::Property::Visibility::User
};
@@ -49,8 +48,7 @@ namespace {
"Latitude",
"The latitude of the location on the globe's surface. The value can range from "
"-90 to 90, with negative values representing the southern hemisphere of the "
"globe. The default value is 0.0",
// @VISIBILITY(2.25)
"globe. The default value is 0.0.",
openspace::properties::Property::Visibility::User
};
@@ -59,8 +57,7 @@ namespace {
"Longitude",
"The longitude of the location on the globe's surface. The value can range from "
"-180 to 180, with negative values representing the western hemisphere of the "
"globe. The default value is 0.0",
// @VISIBILITY(2.25)
"globe. The default value is 0.0.",
openspace::properties::Property::Visibility::User
};
@@ -69,8 +66,7 @@ namespace {
"Altitude",
"The altitude in meters. If the 'UseHeightmap' property is 'true', this is an "
"offset from the actual surface of the globe. If not, this is an offset from the "
"reference ellipsoid. The default value is 0.0",
// @VISIBILITY(2.75)
"reference ellipsoid. The default value is 0.0.",
openspace::properties::Property::Visibility::User
};
@@ -79,24 +75,21 @@ namespace {
"Use Heightmap",
"If this value is 'true', the altitude specified in 'Altitude' will be treated "
"as an offset from the heightmap. Otherwise, it will be an offset from the "
"globe's reference ellipsoid. The default value is 'false'",
// @VISIBILITY(2.5)
"globe's reference ellipsoid. The default value is 'false'.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo UseCameraInfo = {
"UseCamera",
"Use Camera",
"If this value is 'true', the lat and lon are updated to match the camera",
// @VISIBILITY(?)
"If this value is 'true', the lat and lon are updated to match the camera.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo UseCameraAltitudeInfo = {
"UseCameraAltitude",
"Use Camera Altitude",
"If this value is 'true', the altitude is updated to match the camera",
// @VISIBILITY(?)
"If this value is 'true', the altitude is updated to match the camera.",
openspace::properties::Property::Visibility::AdvancedUser
};
+7 -11
View File
@@ -48,7 +48,7 @@ namespace {
"Type",
"Type",
"The type of this Layer. This value is a read-only property and thus cannot be "
"changed",
"changed.",
openspace::properties::Property::Visibility::Developer
};
@@ -56,7 +56,7 @@ namespace {
"BlendMode",
"Blend Mode",
"This value specifies the blend mode that is applied to this layer. The blend "
"mode determines how this layer is added to the underlying layers beneath",
"mode determines how this layer is added to the underlying layers beneath.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -65,8 +65,7 @@ namespace {
"Enabled",
"If this value is enabled, the layer will be used for the final composition of "
"the planet. If this value is disabled, the layer will be ignored in the "
"composition",
// @VISIBILITY(1.17)
"composition.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -74,8 +73,7 @@ namespace {
"Reset",
"Reset",
"If this value is triggered, this layer will be reset. This will delete the "
"local cache for this layer and will trigger a fresh load of all tiles",
// @VISIBILITY(2.5)
"local cache for this layer and will trigger a fresh load of all tiles.",
openspace::properties::Property::Visibility::User
};
@@ -83,8 +81,7 @@ namespace {
"Remove",
"Remove",
"If this value is triggered, a script will be executed that will remove this "
"layer before the next frame",
// @VISIBILITY(2.75)
"layer before the next frame.",
openspace::properties::Property::Visibility::User
};
@@ -92,8 +89,7 @@ namespace {
"Color",
"Color",
"If the 'Type' of this layer is a solid color, this value determines what this "
"solid color is",
// @VISIBILITY(2.5)
"solid color is.",
openspace::properties::Property::Visibility::User
};
@@ -101,7 +97,7 @@ namespace {
"GuiDescription",
"Gui Description",
"This is the description for the scene graph node to be shown in the gui "
"example: Earth is a special place",
"example: Earth is a special place.",
openspace::properties::Property::Visibility::Hidden
};
@@ -32,7 +32,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ChromaKeyColorInfo = {
"ChromaKeyColor",
"Chroma Key Color",
"This color is used as the chroma key for the layer that is adjusted",
"This color is used as the chroma key for the layer that is adjusted.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -40,14 +40,14 @@ namespace {
"ChromaKeyTolerance",
"Chroma Key Tolerance",
"This value determines the tolerance that is used to determine whether a color "
"is matching the selected Chroma key",
"is matching the selected Chroma key.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo TypeInfo = {
"Type",
"Type",
"The type of layer adjustment that is applied to the underlying layer",
"The type of layer adjustment that is applied to the underlying layer.",
openspace::properties::Property::Visibility::AdvancedUser
};
+1 -2
View File
@@ -40,8 +40,7 @@ namespace {
"Blend between levels",
"If this value is enabled, images between different levels are interpolated, "
"rather than switching between levels abruptly. This makes transitions smoother "
"and more visually pleasing",
// @VISIBILITY(2.75)
"and more visually pleasing.",
openspace::properties::Property::Visibility::User
};
} // namespace
@@ -29,16 +29,14 @@ namespace {
"SetDefault",
"Set Default",
"If this value is triggered it will reset all of these values to their default "
"values",
// @VISIBILITY(1.67)
"values.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo GammaInfo = {
"Gamma",
"Gamma",
"This value is used as an exponent to adjust the color for each tile",
// @VISIBILITY(2.67)
"This value is used as an exponent to adjust the color for each tile.",
openspace::properties::Property::Visibility::User
};
@@ -46,8 +44,7 @@ namespace {
"Multiplier",
"Multiplier",
"This value is used as a multiplier to adjust the color applied after taking the "
"gamma value as an exponent",
// @VISIBILITY(2.67)
"gamma value as an exponent.",
openspace::properties::Property::Visibility::User
};
@@ -55,7 +52,7 @@ namespace {
"Offset",
"Offset",
"This value is used as an additive modifier to adjust the color applied after "
"the gamma exponent and the multiplier has been performed",
"the gamma exponent and the multiplier has been performed.",
openspace::properties::Property::Visibility::AdvancedUser
};
} // namespace
@@ -39,7 +39,7 @@ namespace {
"CpuAllocatedTileData",
"CPU allocated tile data (MB)",
"This value denotes the amount of RAM memory (in MB) that this tile cache is "
"utilizing",
"utilizing.",
openspace::properties::Property::Visibility::Developer
};
@@ -47,7 +47,7 @@ namespace {
"GpuAllocatedTileData",
"GPU allocated tile data (MB)",
"This value denotes the amount of GPU memory (in MB) that this tile cache is "
"utilizing",
"utilizing.",
openspace::properties::Property::Visibility::Developer
};
@@ -478,7 +478,7 @@ void MemoryAwareTileCache::createTileAndPut(ProviderTileKey key, RawTile rawTile
);
tex->setPixelData(rawTile.imageData.release(), Texture::TakeOwnership::Yes);
rawTile.imageData = nullptr;
[[ maybe_unused ]] const size_t expectedSize = tex->expectedPixelDataSize();
[[maybe_unused]] const size_t expectedSize = tex->expectedPixelDataSize();
const size_t numBytes = rawTile.textureInitData->totalNumBytes;
ghoul_assert(expectedSize == numBytes, "Pixel data size is incorrect");
_numTextureBytesAllocatedOnCPU += numBytes - previousExpectedDataSize;
@@ -220,7 +220,7 @@ PixelRegion highestResPixelRegion(const GeodeticPatch& geodeticPatch,
}
RawTile::ReadError postProcessErrorCheck(const RawTile& rawTile,
[[ maybe_unused ]] size_t nRasters,
[[maybe_unused]] size_t nRasters,
float noDataValue)
{
ghoul_assert(nRasters == rawTile.tileMetaData.nValues, "Wrong numbers of max values");
+19 -26
View File
@@ -112,7 +112,7 @@ namespace {
"ShowChunkEdges",
"Show chunk edges",
"If this value is set to 'true', the borders between chunks are shown using a "
"red highlight",
"red highlight.",
openspace::properties::Property::Visibility::Developer
};
@@ -121,8 +121,7 @@ namespace {
"Level by projected area (else distance)",
"If this value is set to 'true', the tile level is determined by the area "
"projected on screen. If it is 'false', the distance to the center of the tile "
"is used instead",
// @VISIBILITY(?)
"is used instead.",
openspace::properties::Property::Visibility::Developer
};
@@ -137,8 +136,7 @@ namespace {
"ResetTileProviders",
"Reset tile providers",
"If this property is triggered, all tile provides for the globe are reset and "
"data is reloaded from scratch",
// @VISIBILITY(3.67)
"data is reloaded from scratch.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -148,7 +146,7 @@ namespace {
"This value determines the tile level that is used as the cut off between "
"rendering tiles using the globe model rendering vs the flat in-game rendering "
"method. This value is a tradeoff between not having precision errors in the "
"rendering and represting a tile as flat or curved",
"rendering and represting a tile as flat or curved.",
openspace::properties::Property::Visibility::Developer
};
@@ -158,7 +156,7 @@ namespace {
"Data availability checks before LOD factor impact",
"The number of checks that have to fail/succeed in a row before the dynamic "
"level-of-detail adjusts the actual level-of-detail up or down during a session "
"recording",
"recording.",
openspace::properties::Property::Visibility::Developer
};
@@ -167,7 +165,7 @@ namespace {
"Perform shading",
"This value determines whether there should be lighting applied to the surface "
"of the globe. Note that if there is an atmosphere attached to the planet, there "
"is a separate setting to control the shadowing induced by the atmosphere part",
"is a separate setting to control the shadowing induced by the atmosphere part.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -176,8 +174,7 @@ namespace {
"Use Accurate Normals",
"This value determines whether higher-accuracy normals should be used in the "
"rendering. These normals are calculated based on the height field information "
"and are thus only available if the planet has a height map",
// @VISIBILITY(3.5)
"and are thus only available if the planet has a height map.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -186,30 +183,28 @@ namespace {
"Name of the light source",
"This value is the name of a scene graph node that should be used as the source "
"of illumination for the globe. If this value is not specified, the solar "
"system's Sun is used instead",
"system's Sun is used instead.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo EclipseInfo = {
"Eclipse",
"Eclipse",
"Enables/Disable Eclipse shadows",
"Enables/Disable Eclipse shadows.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo EclipseHardShadowsInfo = {
"EclipseHardShadows",
"Eclipse Hard Shadows",
"Enables the rendering of eclipse shadows using hard shadows",
// @VISIBILITY(2.67)
"Enables the rendering of eclipse shadows using hard shadows.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShadowMappingInfo = {
"ShadowMapping",
"Shadow Mapping",
"Enables shadow mapping algorithm. Used by renderable rings too",
// @VISIBILITY(3.5)
"Enables shadow mapping algorithm. Used by renderable rings, too.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -218,8 +213,7 @@ namespace {
"Render at Distance",
"Tells the rendering engine not to perform distance based performance culling "
"for this globe. Turning this property on will let the globe to be seen at far "
"away distances when normally it would be hidden",
// @VISIBILITY(3.5)
"away distances when normally it would be hidden.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -227,7 +221,7 @@ namespace {
"ZFightingPercentage",
"Z-Fighting Percentage",
"The percentage of the correct distance to the surface being shadowed. Possible "
"values: [0.0, 1.0]",
"values: [0.0, 1.0].",
openspace::properties::Property::Visibility::Developer
};
@@ -235,7 +229,7 @@ namespace {
"NumberShadowSamples",
"Number of Shadow Samples",
"The number of samples used during shadow mapping calculation (Percentage Closer "
"Filtering)",
"Filtering).",
openspace::properties::Property::Visibility::Developer
};
@@ -244,7 +238,7 @@ namespace {
"Target Level of Detail Scale Factor",
"Determines the targeted level-of-detail of the tiles for this globe. A higher "
"value means that the tiles rendered are a higher resolution for the same "
"distance of the camera to the planet",
"distance of the camera to the planet.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -252,21 +246,21 @@ namespace {
"CurrentLodScaleFactor",
"Current Level of Detail Scale Factor (Read Only)",
"The currently used scale factor whose target value is deteremined by "
"'TargetLodScaleFactor'",
"'TargetLodScaleFactor'.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OrenNayarRoughnessInfo = {
"OrenNayarRoughness",
"orenNayarRoughness",
"The roughness factor that is used for the Oren-Nayar lighting mode",
"The roughness factor that is used for the Oren-Nayar lighting mode.",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = {
"AmbientIntensity",
"Ambient Intensity",
"The intensity factor for the ambient light used for light shading",
"The intensity factor for the ambient light used for light shading.",
openspace::properties::Property::Visibility::User
};
@@ -274,8 +268,7 @@ namespace {
"NActiveLayers",
"Number of active layers",
"This is the number of currently active layers, if this value reaches the "
"maximum, bad things will happen",
// @VISIBILITY(2.5)
"maximum, bad things will happen.",
openspace::properties::Property::Visibility::User
};
+13 -14
View File
@@ -74,8 +74,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"Enable/Disable Rings",
// @VISIBILITY(?)
"Enable/Disable Rings.",
openspace::properties::Property::Visibility::User
};
@@ -83,7 +82,7 @@ namespace {
"Texture",
"Texture",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture which is used for these rings",
"texture which is used for these rings.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -91,7 +90,7 @@ namespace {
"TextureFwrd",
"TextureFwrd",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture which is used for forward scattering light in these rings",
"texture which is used for forward scattering light in these rings.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -99,7 +98,7 @@ namespace {
"TextureBckwrd",
"TextureBckwrd",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture which is used for backward scattering light in these rings",
"texture which is used for backward scattering light in these rings.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -107,7 +106,7 @@ namespace {
"TextureUnlit",
"TextureUnlit",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture which is used for unlit part in these rings",
"texture which is used for unlit part in these rings.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -115,7 +114,7 @@ namespace {
"TextureColor",
"TextureColor",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture color which is used for unlit part in these rings",
"texture color which is used for unlit part in these rings.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -123,14 +122,14 @@ namespace {
"TextureTransparency",
"TextureTransparency",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture transparency which is used for unlit part in these rings",
"texture transparency which is used for unlit part in these rings.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value specifies the radius of the rings in meter",
"This value specifies the radius of the rings in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -140,7 +139,7 @@ namespace {
"This value is used to limit the width of the rings. Each of the two values is "
"a value between 0 and 1, where 0 is the center of the ring and 1 is the "
"maximum extent at the radius. For example, if the value is {0.5, 1.0}, the "
"ring is only shown between radius/2 and radius. It defaults to {0.0, 1.0}",
"ring is only shown between radius/2 and radius. It defaults to {0.0, 1.0}.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -149,7 +148,7 @@ namespace {
"Night Factor",
"This value is a multiplicative factor that is applied to the side of the rings "
"that is facing away from the Sun. If this value is equal to '1', no darkening "
"of the night side occurs",
"of the night side occurs.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -157,7 +156,7 @@ namespace {
"ColorFilter",
"Color Filter",
"This value affects the filtering out of part of the rings depending on the "
"color values of the texture. The higher value, the more rings are filtered out",
"color values of the texture. The higher value, the more rings are filtered out.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -165,7 +164,7 @@ namespace {
"ZFightingPercentage",
"Z-Fighting Percentage",
"The percentage of the correct distance to the surface being shadowed. "
"Possible values: [0.0, 1.0]",
"Possible values: [0.0, 1.0].",
openspace::properties::Property::Visibility::Developer
};
@@ -173,7 +172,7 @@ namespace {
"NumberShadowSamples",
"Number of Shadow Samples",
"The number of samples used during shadow mapping calculation "
"(Percentage Closer Filtering)",
"(Percentage Closer Filtering).",
openspace::properties::Property::Visibility::Developer
};
@@ -65,15 +65,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"Enable/Disable Shadows",
"Enable/Disable Shadows.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SaveDepthTextureInfo = {
"SaveDepthTextureInfo",
"Save Depth Texture",
"Debug",
// @VISIBILITY(3.67)
"Debug.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -81,16 +80,14 @@ namespace {
"DistanceFraction",
"Distance Fraction",
"Distance fraction of original distance from light source to the globe to be "
"considered as the new light source distance",
// @VISIBILITY(3.67)
"considered as the new light source distance.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DepthMapSizeInfo = {
"DepthMapSize",
"Depth Map Size",
"The depth map size in pixels. You must entry the width and height values",
// @VISIBILITY(3.67)
"The depth map size in pixels. You must entry the width and height values.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -36,7 +36,7 @@ namespace {
"FilePath",
"File Path",
"The path of the GDAL file or the image file that is to be used in this tile "
"provider",
"provider.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -46,15 +46,14 @@ namespace {
"This value is the preferred size (in pixels) for each tile. Choosing the right "
"value is a tradeoff between more efficiency (larger images) and better quality "
"(smaller images). The tile pixel size has to be smaller than the size of the "
"complete image if a single image is used",
// @VISIBILITY(3.33)
"complete image if a single image is used.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo CompressionInfo = {
"Compression",
"Compression Algorithm",
"The compression algorithm to use for MRF cached tiles",
"The compression algorithm to use for MRF cached tiles.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -33,8 +33,7 @@ namespace {
"Index",
"Index",
"The index into the list of images that is used to pick the currently displayed "
"image",
// @VISIBILITY(2.33)
"image.",
openspace::properties::Property::Visibility::User
};
@@ -42,16 +41,14 @@ namespace {
"NumberImages",
"Number of Images",
"The number of images that can be shown. The 'Index' value must be between 0 and "
"this value - 1",
// @VISIBILITY(?)
"this value - 1.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo CurrentImageInfo = {
"CurrentImage",
"Current Image",
"The read-only value of the currently selected image",
// @VISIBILITY(2.33)
"The read-only value of the currently selected image.",
openspace::properties::Property::Visibility::User
};
@@ -59,7 +56,7 @@ namespace {
"FolderPath",
"Folder Path",
"The path that is used to look for images for this image provider. The path must "
"point to an existing folder that contains images",
"point to an existing folder that contains images.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -32,7 +32,7 @@ namespace {
"FilePath",
"File Path",
"The file path that is used for this image provider. The file must point to an "
"image that is then loaded and used for all tiles",
"image that is then loaded and used for all tiles.",
openspace::properties::Property::Visibility::User
};
@@ -51,7 +51,7 @@ namespace {
"Use Fixed Time",
"If this value is enabled, the time-varying timevarying dataset will always use "
"the time that is specified in the 'FixedTime' property, rather than using the "
"actual time from OpenSpace",
"actual time from OpenSpace.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -59,7 +59,7 @@ namespace {
"FixedTime",
"Fixed Time",
"If the 'UseFixedTime' is enabled, this time will be used instead of the actual "
"time taken from OpenSpace for the displayed tiles",
"time taken from OpenSpace for the displayed tiles.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -30,7 +30,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo UniqueBackgroundColors = {
"UniqueBackgroundColor",
"Unique Background Color",
"If 'true' each index tile will have a unique background color assigned to it",
"If 'true' each index tile will have a unique background color assigned to it.",
openspace::properties::Property::Visibility::Developer
};
+8 -8
View File
@@ -204,24 +204,24 @@ void DateTime::incrementOnce(int value, char unit) {
if (singleIncrement(_minute, value, 0, 59)) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'h':
if (singleIncrement(_hour, value, 0, 23)) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'd':
if (singleIncrement(_day, value, 1, monthSize(_month, _year))) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'M':
inBounds = singleIncrement(_month, value, 1, 12);
_day = std::clamp(_day, 1, monthSize(_month, _year));
if (inBounds) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'y':
_year += value;
break;
@@ -251,26 +251,26 @@ void DateTime::decrementOnce(int value, char unit) {
if (singleDecrement(_minute, value, 0, 59)) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'h':
if (singleDecrement(_hour, value, 0, 23)) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'd':
if (singleDecrement(_day, value, 1,
monthSize(_month == 1 ? 12 : _month - 1, _year)))
{
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'M':
inBounds = singleDecrement(_month, value, 1, 12);
_day = std::clamp(_day, 1, monthSize(_month, _year));
if (inBounds) {
break;
}
[[ fallthrough ]];
[[fallthrough]];
case 'y':
_year -= value;
break;
+4 -4
View File
@@ -55,14 +55,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"This setting determines whether this object will be visible or not",
"This setting determines whether this object will be visible or not.",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo CollapsedInfo = {
"Collapsed",
"Is Collapsed",
"This setting determines whether this window is collapsed or not",
"This setting determines whether this window is collapsed or not.",
openspace::properties::Property::Visibility::Developer
};
@@ -70,14 +70,14 @@ namespace {
"ShowHelpText",
"Show tooltip help",
"If this value is enabled these kinds of tooltips are shown for most properties "
"explaining what impact they have on the visuals",
"explaining what impact they have on the visuals.",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo HelpTextDelayInfo = {
"HelpTextDelay",
"Tooltip Delay (in s)",
"This value determines the delay in seconds after which the tooltip is shown",
"This value determines the delay in seconds after which the tooltip is shown.",
openspace::properties::Property::Visibility::Developer
};
} // namespace
+2 -4
View File
@@ -28,16 +28,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"This setting determines whether this object will be visible or not",
// @VISIBILITY(3.4)
"This setting determines whether this object will be visible or not.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo CollapsedInfo = {
"Collapsed",
"Is Collapsed",
"This setting determines whether this window is collapsed or not",
// @VISIBILITY(3.4)
"This setting determines whether this window is collapsed or not.",
openspace::properties::Property::Visibility::AdvancedUser
};
} // namespace
+2 -4
View File
@@ -42,8 +42,7 @@ namespace {
"Use Tree Layout",
"If this value is checked, this component will display the properties using a "
"tree layout, rather than using a flat map. This value should only be set on "
"property windows that display SceneGraphNodes, or the application might crash",
// @VISIBILITY(3.67)
"property windows that display SceneGraphNodes, or the application might crash.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -52,8 +51,7 @@ namespace {
"Tree Ordering",
"This list determines the order of the first tree layer if it is used. Elements "
"present in this list will be shown first, with an alphabetical ordering for "
"elements not listed",
// @VISIBILITY(3.67)
"elements not listed.",
openspace::properties::Property::Visibility::AdvancedUser
};
+8 -8
View File
@@ -40,35 +40,35 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"This setting determines whether this server interface is enabled or not",
"This setting determines whether this server interface is enabled or not.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo TypeInfo = {
"Type",
"Type",
"Whether the interface is using a Socket or a WebSocket",
"Whether the interface is using a Socket or a WebSocket.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo PortInfo = {
"Port",
"Port",
"The network port to use for this sevrer interface",
"The network port to use for this sevrer interface.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DefaultAccessInfo = {
"DefaultAccess",
"Default Access",
"Sets the default access policy: Allow, RequirePassword or Deny",
"Sets the default access policy: Allow, RequirePassword or Deny.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo AllowAddressesInfo = {
"AllowAddresses",
"Allow Addresses",
"IP addresses or domains that should always be allowed access to this interface",
"IP addresses or domains that should always be allowed access to this interface.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -77,21 +77,21 @@ namespace {
"RequirePasswordAddresses",
"Require Password Addresses",
"IP addresses or domains that should be allowed access if they provide a "
"password",
"password.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DenyAddressesInfo = {
"DenyAddresses",
"Deny Addresses",
"IP addresses or domains that should never be allowed access to this interface",
"IP addresses or domains that should never be allowed access to this interface.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo PasswordInfo = {
"Password",
"Password",
"Password for connecting to this interface",
"Password for connecting to this interface.",
openspace::properties::Property::Visibility::AdvancedUser
};
} // namespace
+10 -16
View File
@@ -42,8 +42,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"Decides if the GUI for this module should be enabled",
// @VISIBILITY(2.5)
"Decides if the GUI for this module should be enabled.",
openspace::properties::Property::Visibility::User
};
@@ -51,7 +50,7 @@ namespace {
"ShowTitleInGuiBrowser",
"Show Title in Gui Browser",
"If true, the name of the currently selected sky browser is shown in the WebGUI "
"browser",
"browser.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -59,8 +58,7 @@ namespace {
"AllowCameraRotation",
"Allow Camera Rotation",
"Toggles if the camera should rotate to look at the sky target if it is going "
"outside of the current field of view",
// @VISIBILITY(1.75)
"outside of the current field of view.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -68,21 +66,21 @@ namespace {
"CameraRotationSpeed",
"Camera Rotation Speed",
"The speed of the rotation of the camera when the camera rotates to look at a "
"coordinate which is outside of the field of view",
"coordinate which is outside of the field of view.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo TargetSpeedInfo = {
"TargetAnimationSpeed",
"Target Animation Speed",
"This determines the speed of the animation of the sky target",
"This determines the speed of the animation of the sky target.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo BrowserSpeedInfo = {
"BrowserAnimationSpeed",
"Field of View Animation Speed",
"This determines the speed of the animation of the field of view in the browser",
"This determines the speed of the animation of the field of view in the browser.",
openspace::properties::Property::Visibility::User
};
@@ -90,8 +88,7 @@ namespace {
"HideTargetsBrowsersWithGui",
"Hide Targets and Browsers with GUI",
"If checked, the targets and browsers will be disabled when the sky browser "
"panel is minimized",
// @VISIBILITY(2.25)
"panel is minimized.",
openspace::properties::Property::Visibility::User
};
@@ -99,7 +96,7 @@ namespace {
"InverseZoomDirection",
"Inverse Zoom Direction",
"If checked, the zoom direction of the scroll over the AAS WWT browser will be "
"inversed",
"inversed.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -107,7 +104,6 @@ namespace {
"SynchronizeAim",
"Synchronize Aim",
"If checked, the target and the browser will have synchronized aim.",
// @VISIBILITY(3.25)
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -115,16 +111,14 @@ namespace {
"SpaceCraftAnimationTime",
"Space Craft Animation Time",
"Sets the duration (in seconds) of the animation of the space craft when it is "
"pointed to where the target is aiming",
// @VISIBILITY(2.5)
"pointed to where the target is aiming.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ImageCollectionInfo = {
"WwtImageCollectionUrl",
"AAS WorldWide Telescope Image Collection Url",
"The url of the image collection which is loaded into AAS WorldWide Telescope",
// @VISIBILITY(3.75)
"The url of the image collection which is loaded into AAS WorldWide Telescope.",
openspace::properties::Property::Visibility::AdvancedUser
};
+3 -5
View File
@@ -39,23 +39,21 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo DimensionsInfo = {
"Dimensions",
"Browser Dimensions",
"Set the dimensions of the web browser window",
// @VISIBILITY(3.75)
"Set the dimensions of the web browser window.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo UrlInfo = {
"Url",
"URL",
"The URL to load",
// @VISIBILITY(3.25)
"The URL to load.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ReloadInfo = {
"Reload",
"Reload",
"Reload the web browser",
"Reload the web browser.",
openspace::properties::Property::Visibility::User
};
@@ -50,7 +50,7 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo crossHairSizeInfo = {
"CrosshairSize",
"Crosshair Size",
"Determines the size of the crosshair. The size is determined in fov (degrees)",
"Determines the size of the crosshair. The size is determined in fov (degrees).",
openspace::properties::Property::Visibility::User
};
@@ -58,16 +58,14 @@ namespace {
"RectangleThreshold",
"Rectangle Threshold",
"When the field of view is larger than the rectangle threshold, a rectangle will "
"be rendered in the target",
// @VISIBILITY(2.33)
"be rendered in the target.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"The thickness of the line of the target. The larger number, the thicker line",
// @VISIBILITY(1.33)
"The thickness of the line of the target. The larger number, the thicker line.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -75,7 +73,6 @@ namespace {
"VerticalFov",
"Vertical Field Of View",
"The vertical field of view of the target.",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
@@ -83,7 +80,7 @@ namespace {
"ApplyRoll",
"Apply Roll",
"Always rotate the target to have it's up direction aligned with the up direction "
"of the camera",
"of the camera.",
openspace::properties::Property::Visibility::User
};
@@ -43,7 +43,7 @@ namespace {
"Quality of Texture",
"A parameter to set the resolution of the texture. 1 is full resolution and "
"slower frame rate. Lower value means lower resolution of texture and faster "
"frame rate",
"frame rate.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -53,15 +53,14 @@ namespace {
"Display a copy of this sky browser at an additional position. This copy will "
"not be interactive. The position is in RAE (Radius, Azimuth, Elevation) "
"coordinates or Cartesian, depending on if the browser uses RAE or Cartesian "
"coordinates",
// @VISIBILITY(2.67)
"coordinates.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DisplayCopyShowInfo = {
"ShowDisplayCopy",
"Show Display Copy",
"Show the display copy",
"Show the display copy.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -69,7 +68,7 @@ namespace {
"IsHidden",
"Is Hidden",
"If checked, the browser will be not be displayed. If it is not checked, it will "
"be",
"be.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -78,7 +77,6 @@ namespace {
"Point Spacecraft",
"If checked, spacecrafts will point towards the coordinate of an image upon "
"selection.",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
@@ -48,7 +48,7 @@ namespace {
"File",
"Vertex File Path",
"The file pointed to with this value contains the vertex locations of the "
"constellations",
"constellations.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -56,7 +56,7 @@ namespace {
"Color",
"Color of constellation lines",
"Specifies the color of the constellation lines. The lines are always drawn at "
"full opacity",
"full opacity.",
openspace::properties::Property::Visibility::NoviceUser
};
@@ -50,21 +50,21 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo SpeckInfo = {
"File",
"Constellation Data File Path",
"The file that contains the data for the constellation lines",
"The file that contains the data for the constellation lines.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DrawElementsInfo = {
"DrawElements",
"Draw Elements",
"Enables/Disables the drawing of the constellations",
"Enables/Disables the drawing of the constellations.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo UnitInfo = {
"Unit",
"Unit",
"The distance unit used for the constellation lines data",
"The distance unit used for the constellation lines data.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -44,30 +44,28 @@ namespace {
"Constellation Names File Path",
"Specifies the file that contains the mapping between constellation "
"abbreviations and full names of the constellations. If this value is empty, the "
"abbreviations are used as the full names",
"abbreviations are used as the full names.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"The line width of the constellation",
// @VISIBILITY(1.67)
"The line width of the constellation.",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo SelectionInfo = {
"ConstellationSelection",
"Constellation Selection",
"The constellations that are selected are displayed on the celestial sphere",
// @VISIBILITY(1.33)
"The constellations that are selected are displayed on the celestial sphere.",
openspace::properties::Property::Visibility::NoviceUser
};
const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {
"Labels",
"Labels",
"The labels for the constellations"
"The labels for the constellations."
};
struct [[codegen::Dictionary(RenderableConstellationsBase)]] Parameters {

Some files were not shown because too many files have changed in this diff Show More