mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-06 03:29:44 -06:00
Code Issues Packages Projects Releases Wiki Activity

Adapt the visibility settings for all properties

Browse Source
This commit is contained in:
Alexander Bock
2023-04-15 09:33:31 +02:00
committed by GitHub
parent 1ef6cb0c02
commit ca916877b2
152 changed files with 2098 additions and 894 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
modules/base/dashboard/dashboarditemangle.cpp
View File

@@ -50,7 +50,9 @@ namespace {
"SourceType",
"Source Type",
"The type of position that is used as the triangle apex used to calculate the "
"angle. The default value is 'Camera'"
"angle. The default value is 'Camera'",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SourceNodeNameInfo = {
@@ -59,7 +61,9 @@ namespace {
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the apex of the triangle used to calculate the "
"angle. The computed angle is the incident angle to Source in the triangle ("
"Source, Reference, Destination)"
"Source, Reference, Destination)",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ReferenceTypeInfo = {
@@ -67,14 +71,18 @@ namespace {
"Reference Type",
"The type of position that is used as the destination of the reference line used "
"to calculate the angle. The computed angle is the incident angle to Source in "
"the triangle (Source, Reference, Destination)"
"the triangle (Source, Reference, Destination)",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ReferenceNodeNameInfo = {
"ReferenceNodeName",
"Reference Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the reference direction to compute the angle"
"node that is to be used as the reference direction to compute the angle",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DestinationTypeInfo = {
@@ -82,14 +90,18 @@ namespace {
"Destination Type",
"The type of position that is used as the destination to calculate the angle. "
"The computed angle is the incident angle to Source in the triangle ("
"Source, Reference, Destination). The default value for this is 'Focus'"
"Source, Reference, Destination). The default value for this is 'Focus'",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DestinationNodeNameInfo = {
"DestinationNodeName",
"Destination Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the destination for computing the angle"
"node that is to be used as the destination for computing the angle",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemAngle)]] Parameters {

7
modules/base/dashboard/dashboarditemdate.cpp
View File

@@ -40,7 +40,8 @@ namespace {
"FormatString",
"Format String",
"The format text describing how this dashboard item renders its text. This text "
"must contain exactly one {} which is a placeholder that will contain the date"
"must contain exactly one {} which is a placeholder that will contain the date",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo TimeFormatInfo = {
@@ -49,7 +50,9 @@ namespace {
"The format string used for formatting the date/time before being passed to the "
"string in FormatString. See "
"https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/timout_c.html for full "
"information about how to structure this format"
"information about how to structure this format",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemDate)]] Parameters {

22
modules/base/dashboard/dashboarditemdistance.cpp
View File

@@ -52,28 +52,36 @@ namespace {
"SourceType",
"Source Type",
"The type of position that is used as the source to calculate the distance. The "
"default value is 'Camera'"
"default value is 'Camera'",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SourceNodeNameInfo = {
"SourceNodeName",
"Source Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the source for computing the distance"
"node that is to be used as the source for computing the distance",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DestinationTypeInfo = {
"DestinationType",
"Destination Type",
"The type of position that is used as the destination to calculate the distance. "
"The default value for this is 'Focus'"
"The default value for this is 'Focus'",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DestinationNodeNameInfo = {
"DestinationNodeName",
"Destination Node Name",
"If a scene graph node is selected as type, this value specifies the name of the "
"node that is to be used as the destination for computing the distance"
"node that is to be used as the destination for computing the distance",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SimplificationInfo = {
@@ -81,7 +89,8 @@ namespace {
"Simplification",
"If this value is enabled, the distance is displayed in nuanced units, such as "
"km, AU, light years, parsecs, etc. If this value is disabled, the unit can be "
"explicitly requested"
"explicitly requested",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RequestedUnitInfo = {
@@ -96,7 +105,8 @@ namespace {
"Format String",
"The format string that is used for formatting the distance string. This format "
"receives four parameters: The name of the source, the name of the destination "
"the value of the distance and the unit of the distance"
"the value of the distance and the unit of the distance",
openspace::properties::Property::Visibility::AdvancedUser
};
std::vector<std::string> unitList() {

15
modules/base/dashboard/dashboarditemelapsedtime.cpp
View File

@@ -41,14 +41,17 @@ namespace {
"Format String",
"The format text describing how this dashboard item renders its text. This text "
"must contain exactly one {} which is a placeholder that will contain the value "
"of the elapsed time."
"of the elapsed time.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ReferenceTimeInfo = {
"ReferenceTime",
"Reference Time",
"The reference time relative to which the elapsed time is specified. The format "
"must be an ISO 8601-compliant date string"
"must be an ISO 8601-compliant date string",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SimplifyTimeInfo = {
@@ -56,14 +59,18 @@ namespace {
"Simplify Time",
"If this value is enabled, the elapsed time will be simplified into seconds, "
"minutes, hours, etc. If the value is disabled, the elapsed time is always "
"presented in seconds. The default value for this is 'true'."
"presented in seconds. The default value for this is 'true'.",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LowestTimeUnitInfo = {
"LowestTimeUnit",
"Lowest Time Unit when Simplifying",
"If 'SimplifyTime' is enabled, this is the lowest time unit that will be shown. "
"All finer grained timesteps will be ignored."
"All finer grained timesteps will be ignored.",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemElapsedTime)]] Parameters {

7
modules/base/dashboard/dashboarditemframerate.cpp
View File

@@ -48,14 +48,17 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo FrametimeInfo = {
"FrametimeType",
"Type of the frame time display",
"This value determines the units in which the frame time is displayed"
"This value determines the units in which the frame time is displayed",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ClearCacheInfo = {
"ClearCache",
"Clear Cache",
"Clears the cache of this DashboardItemFramerate item. If the selected option "
"does not use any caching, this trigger does not do anything"
"does not use any caching, this trigger does not do anything",
openspace::properties::Property::Visibility::AdvancedUser
};
[[ nodiscard ]] char* formatDt(std::vector<char>& buffer) {

20
modules/base/dashboard/dashboarditeminputstate.cpp
View File

@@ -37,31 +37,41 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ShowWhenEnabledInfo = {
"ShowWhenEnabled",
"Show when enabled",
"Show text when the input is enabled"
"Show text when the input is enabled",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowWhenDisabledInfo = {
"ShowWhenDisabled",
"Show when disabled",
"Show text when the input is disabled"
"Show text when the input is disabled",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowKeyboardInfo = {
"ShowKeyboard",
"Show Keyboard information",
"Display the state of the keyboard input"
"Display the state of the keyboard input",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowMouseInfo = {
"ShowMouse",
"Show Mouse information",
"Display the state of the mouse input"
"Display the state of the mouse input",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShowJoystickInfo = {
"ShowJoystick",
"Show Joystick information",
"Display the state of the joystick input"
"Display the state of the joystick input",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemPropertyValue)]] Parameters {

8
modules/base/dashboard/dashboarditempropertyvalue.cpp
View File

@@ -38,7 +38,9 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo PropertyUriInfo = {
"URI",
"Property URI",
"The URI of the property that is displayed in this dashboarditem"
"The URI of the property that is displayed in this dashboarditem",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DisplayStringInfo = {
@@ -46,7 +48,9 @@ namespace {
"Display String",
"The String that is being displayed. It must either be empty (in which case only "
"the value itself will be displayed), or it must contain extact one instance of "
"{}, which will be replaced with the value of the property during rendering"
"{}, which will be replaced with the value of the property during rendering",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemPropertyValue)]] Parameters {

14
modules/base/dashboard/dashboarditemsimulationincrement.cpp
View File

@@ -41,14 +41,18 @@ namespace {
"Time Simplification",
"If this value is enabled, the time is displayed in nuanced units, such as "
"minutes, hours, days, years, etc. If this value is disabled, it is always "
"displayed in seconds"
"displayed in seconds",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RequestedUnitInfo = {
"RequestedUnit",
"Requested Unit",
"If the simplification is disabled, this time unit is used as a destination to "
"convert the seconds into"
"convert the seconds into",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo TransitionFormatInfo = {
@@ -59,7 +63,8 @@ namespace {
"delta time. This format gets five parameters in this order: The target delta "
"time value, the target delta time unit, the string 'Paused' if the delta time "
"is paused or the empty string otherwise, the current delta time value, and the "
"current delta time unit"
"current delta time unit",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RegularFormatInfo = {
@@ -68,7 +73,8 @@ namespace {
"The format string used to format the text if the target delta time is the same "
"as the current delta time. This format gets three parameters in this order: "
"The target delta value, the target delta unit, and the string 'Paused' if the "
"delta time is paused or the empty string otherwise"
"delta time is paused or the empty string otherwise",
openspace::properties::Property::Visibility::AdvancedUser
};
std::vector<std::string> unitList() {

4
modules/base/dashboard/dashboarditemspacing.cpp
View File

@@ -33,7 +33,9 @@ namespace {
"Spacing",
"Spacing",
"This value determines the spacing (in pixels) that this item represents. The "
"default value is 15"
"default value is 15",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemSpacing)]] Parameters {

3
modules/base/dashboard/dashboarditemtext.cpp
View File

@@ -37,7 +37,8 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo TextInfo = {
"Text",
"Text",
"The text to be displayed"
"The text to be displayed",
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardItemText)]] Parameters {

6
modules/base/dashboard/dashboarditemvelocity.cpp
View File

@@ -45,14 +45,16 @@ namespace {
"Simplification",
"If this value is enabled, the velocity is displayed in nuanced units, such as "
"m/s, AU/s, light years / s etc. If this value is disabled, the unit can be "
"explicitly requested"
"explicitly requested",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RequestedUnitInfo = {
"RequestedUnit",
"Requested Unit",
"If the simplification is disabled, this distance unit is used for the velocity "
"display"
"display",
openspace::properties::Property::Visibility::User
};
std::vector<std::string> unitList() {

4
modules/base/lightsource/cameralightsource.cpp
View File

@@ -33,7 +33,9 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo IntensityInfo = {
"Intensity",
"Intensity",
"The intensity of this light source"
"The intensity of this light source",
// @VISIBILITY(1.75)
openspace::properties::Property::Visibility::NoviceUser
};
struct [[codegen::Dictionary(CameraLightSource)]] Parameters {

7
modules/base/lightsource/scenegraphlightsource.cpp
View File

@@ -37,13 +37,16 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo IntensityInfo = {
"Intensity",
"Intensity",
"The intensity of this light source"
"The intensity of this light source",
// @VISIBILITY(1.75)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo NodeInfo = {
"Node",
"Node",
"The identifier of the scene graph node to follow"
"The identifier of the scene graph node to follow",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(SceneGraphLightSource)]] Parameters {

10
modules/base/rendering/grids/renderableboxgrid.cpp
View File

@@ -39,19 +39,23 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered"
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.17)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the spherical grid"
"This value specifies the line width of the spherical grid",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Grid Size",
"This value species the size of each dimensions of the box"
"This value species the size of each dimensions of the box",
openspace::properties::Property::Visibility::AdvancedUser
};
static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {

25
modules/base/rendering/grids/renderablegrid.cpp
View File

@@ -39,20 +39,26 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered"
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.25)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo HighlightColorInfo = {
"HighlightColor",
"Highlight Color",
"This value determines the color of the highlighted lines in the grid"
"This value determines the color of the highlighted lines in the grid",
// @VISIBILITY(1.25)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Number of Segments",
"This value specifies the number of segments that are used to render the "
"grid in each direction"
"grid in each direction",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo HighlightRateInfo = {
@@ -60,25 +66,30 @@ namespace {
"Highlight Rate",
"The rate that the columns and rows are highlighted, counted with respect to the "
"center of the grid. If the number of segments in the grid is odd, the "
"highlighting might be offset from the center."
"highlighting might be offset from the center.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the grid"
"This value specifies the line width of the grid",
// @VISIBILITY(1.5)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo HighlightLineWidthInfo = {
"HighlightLineWidth",
"Highlight Line Width",
"This value specifies the line width of the highlighted lines in the grid"
"This value specifies the line width of the highlighted lines in the grid",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Grid Size",
"This value species the size of each dimensions of the grid"
"This value species the size of each dimensions of the grid",
openspace::properties::Property::Visibility::User
};
static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {

19
modules/base/rendering/grids/renderableradialgrid.cpp
View File

@@ -40,27 +40,34 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered"
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.25)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo GridSegmentsInfo = {
"GridSegments",
"Number of Grid Segments",
"Specifies the number of segments for the grid, in the radial and angular "
"direction respectively"
"direction respectively",
// @VISIBILITY(2.5)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo CircleSegmentsInfo = {
"CircleSegments",
"Number of Circle Segments",
"This value specifies the number of segments that is used to render each circle "
"in the grid"
"in the grid",
// @VISIBILITY(2.5)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the spherical grid"
"This value specifies the line width of the spherical grid",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RadiiInfo = {
@@ -68,7 +75,9 @@ namespace {
"Inner and Outer Radius",
"The radii values that determine the size of the circular grid. The first value "
"is the radius of the inmost ring and the second is the radius of the outmost "
"ring"
"ring",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {

12
modules/base/rendering/grids/renderablesphericalgrid.cpp
View File

@@ -39,20 +39,26 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"This value determines the color of the grid lines that are rendered"
"This value determines the color of the grid lines that are rendered",
// @VISIBILITY(1.25)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Number of Segments",
"This value specifies the number of segments that are used to render the "
"surrounding sphere"
"surrounding sphere",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width of the spherical grid"
"This value specifies the line width of the spherical grid",
// @VISIBILITY(1.67)
openspace::properties::Property::Visibility::NoviceUser
};
static const openspace::properties::PropertyOwner::PropertyOwnerInfo LabelsInfo = {

12
modules/base/rendering/renderablecartesianaxes.cpp
View File

@@ -40,19 +40,25 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo XColorInfo = {
"XColor",
"X Color",
"This value determines the color of the x axis"
"This value determines the color of the x axis",
// @VISIBILITY(1.5)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo YColorInfo = {
"YColor",
"Y Color",
"This value determines the color of the y axis"
"This value determines the color of the y axis",
// @VISIBILITY(1.5)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo ZColorInfo = {
"ZColor",
"Z Color",
"This value determines the color of the z axis"
"This value determines the color of the z axis",
// @VISIBILITY(1.5)
openspace::properties::Property::Visibility::NoviceUser
};
struct [[codegen::Dictionary(RenderableCartesianAxes)]] Parameters {

11
modules/base/rendering/renderabledisc.cpp
View File

@@ -47,13 +47,17 @@ namespace {
"Texture",
"Texture",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture to be used for the color"
"texture to be used for the color",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value specifies the outer radius of the disc in meter"
"This value specifies the outer radius of the disc in meter",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo WidthInfo = {
@@ -61,7 +65,8 @@ namespace {
"Width",
"This value is used to set the width of the disc. The actual width is set "
"based on the given size and this value should be set between 0 and 1. A value "
"of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size"
"of 1 results in a full circle and 0.5 a disc with an inner radius of 0.5*size",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableDisc)]] Parameters {

43
modules/base/rendering/renderablelabel.cpp
View File

@@ -92,55 +92,71 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = {
"BlendMode",
"Blending Mode",
"This determines the blending mode that is applied to the renderable"
"This determines the blending mode that is applied to the renderable",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
"Color",
"Color",
"The label text color"
"The label text color",
// @VISIBILITY(1.33)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = {
"FontSize",
"Font Size",
"The font size (in points) for the label"
"The font size (in points) for the label",
// @VISIBILITY(2.5)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value affects the size scale of the label"
"This value affects the size scale of the label",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo TextInfo = {
"Text",
"Text",
"The text that will be displayed on screen"
"The text that will be displayed on screen",
// @VISIBILITY(1.8)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo MinMaxSizeInfo = {
"MinMaxSize",
"Min and Max Size",
"The minimum and maximum size (in pixels) of the label"
"The minimum and maximum size (in pixels) of the label",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo TransformationMatrixInfo = {
"TransformationMatrix",
"Transformation Matrix",
"Transformation matrix to be applied to the label"
"Transformation matrix to be applied to the label",
// @VISIBILITY(3.6)
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OrientationOptionInfo = {
"OrientationOption",
"Orientation Option",
"Label orientation rendering mode"
"Label orientation rendering mode",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EnableFadingEffectInfo = {
"EnableFading",
"Enable/Disable Fade-in Effect",
"Enable/Disable the Fade-in effect"
"Enable/Disable the Fade-in effect",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo FadeWidthsInfo = {
@@ -150,20 +166,23 @@ namespace {
"The first value is the distance before the closest distance and the second "
"the one after the furthest distance. For example, with the unit Parsec (pc), "
"a value of {1, 2} will make the label being fully faded out 1 Parsec before "
"the closest distance and 2 Parsec away from the furthest distance"
"the closest distance and 2 Parsec away from the furthest distance",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeDistancesInfo = {
"FadeDistances",
"Fade Distances",
"The distance range in which the labels should be fully opaque, specified in "
"the chosen unit. The distance from the position of the label to the camera"
"the chosen unit. The distance from the position of the label to the camera",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeUnitOptionInfo = {
"FadeUnit",
"Fade Distance Unit",
"Distance unit for fade-in/-out distance calculations. Defaults to \"au\""
"Distance unit for fade-in/-out distance calculations. Defaults to \"au\"",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableLabel)]] Parameters {

37
modules/base/rendering/renderablemodel.cpp
View File

@@ -88,70 +88,85 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnableAnimationInfo = {
"EnableAnimation",
"Enable Animation",
"Enable or disable the animation for the model if it has any"
"Enable or disable the animation for the model if it has any",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo AmbientIntensityInfo = {
"AmbientIntensity",
"Ambient Intensity",
"A multiplier for ambient lighting"
"A multiplier for ambient lighting",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo DiffuseIntensityInfo = {
"DiffuseIntensity",
"Diffuse Intensity",
"A multiplier for diffuse lighting"
"A multiplier for diffuse lighting",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SpecularIntensityInfo = {
"SpecularIntensity",
"Specular Intensity",
"A multiplier for specular lighting"
"A multiplier for specular lighting",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ShadingInfo = {
"PerformShading",
"Perform Shading",
"This value determines whether this model should be shaded by using the position "
"of the Sun"
"of the Sun",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EnableFaceCullingInfo = {
"EnableFaceCulling",
"Enable Face Culling",
"Enable OpenGL automatic face culling optimization"
"Enable OpenGL automatic face culling optimization",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ModelTransformInfo = {
"ModelTransform",
"Model Transform",
"This value specifies the model transform that is applied to the model before "
"all other transformations are applied"
"all other transformations are applied",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo RotationVecInfo = {
"RotationVector",
"Rotation Vector",
"Rotation Vector using degrees"
"Rotation Vector using degrees",
// @VISIBILITY(3.75)
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo LightSourcesInfo = {
"LightSources",
"Light Sources",
"A list of light sources that this model should accept light from"
"A list of light sources that this model should accept light from",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo EnableDepthTestInfo = {
"EnableDepthTest",
"Enable Depth Test",
"Enable Depth Testing for the Model"
"Enable Depth Testing for the Model",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo BlendingOptionInfo = {
"BlendingOption",
"Blending Options",
"Changes the blending function used to calculate the colors of the model with "
"respect to the opacity"
"respect to the opacity",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableModel)]] Parameters {

13
modules/base/rendering/renderablenodeline.cpp
View File

@@ -45,26 +45,31 @@ namespace {
"StartNode",
"Start Node",
"The identifier of the node the line starts from. Defaults to 'Root' if not "
"specified."
"specified.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EndNodeInfo = {
"EndNode",
"End Node",
"The identifier of the node the line ends at. Defaults to 'Root' if not "
"specified."
"specified.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineColorInfo = {
"Color",
"Color",
"This value determines the RGB color for the line"
"This value determines the RGB color for the line",
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width"
"This value specifies the line width",
// @VISIBILITY(1.75)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo StartOffsetInfo = {

16
modules/base/rendering/renderableplane.cpp
View File

@@ -54,7 +54,8 @@ namespace {
"Billboard mode",
"This value specifies whether the plane is a billboard, which means that it is "
"always facing the camera. If this is false, it can be oriented using other "
"transformations"
"transformations",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MirrorBacksideInfo = {
@@ -62,13 +63,16 @@ namespace {
"Mirror backside of image plane",
"If this value is set to false, the image plane will not be mirrored when "
"looking from the backside. This is usually desirable when the image shows "
"data at a specific location, but not if it is displaying text for example"
"data at a specific location, but not if it is displaying text for example",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size (in meters)",
"This value specifies the size of the plane in meters"
"This value specifies the size of the plane in meters",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo AutoScaleInfo = {
@@ -81,14 +85,16 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo BlendModeInfo = {
"BlendMode",
"Blending Mode",
"This determines the blending mode that is applied to this plane"
"This determines the blending mode that is applied to this plane",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MultiplyColorInfo = {
"MultiplyColor",
"Multiply Color",
"If set, the plane's texture is multiplied with this color. Useful for applying "
"a color grayscale images"
"a color grayscale images",
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(RenderablePlane)]] Parameters {

4
modules/base/rendering/renderableplaneimagelocal.cpp
View File

@@ -42,7 +42,9 @@ namespace {
"Texture",
"Texture",
"This value specifies an image that is loaded from disk and is used as a texture "
"that is applied to this plane. This image has to be square"
"that is applied to this plane. This image has to be square",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(RenderablePlaneImageLocal)]] Parameters {

4
modules/base/rendering/renderableplaneimageonline.cpp
View File

@@ -39,7 +39,9 @@ namespace {
"Image URL",
"Sets the URL of the texture that is displayed on this screen space plane. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed"
"and displayed",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(RenderablePlaneImageOnline)]] Parameters {

7
modules/base/rendering/renderableplanetimevaryingimage.cpp
View File

@@ -45,14 +45,17 @@ namespace {
"SourceFolder",
"Source Folder",
"This value specifies the image directory that is loaded from disk and "
"is used as a texture that is applied to this plane"
"is used as a texture that is applied to this plane",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RenderTypeInfo = {
"RenderType",
"Render Type",
"This value specifies if the plane should be rendered in the Background, "
"Opaque, Transparent, or Overlay rendering step"
"Opaque, Transparent, or Overlay rendering step",
// @VISIBILITY(3.67)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderablePlaneTimeVaryingImage)]] Parameters {

28
modules/base/rendering/renderableprism.cpp
View File

@@ -43,45 +43,59 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Segments",
"The number of segments the shape of the prism should have"
"The number of segments the shape of the prism should have",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LinesInfo = {
"NumLines",
"Number of Lines",
"The number of lines connecting the two shapes of the prism. They will be evenly "
"distributed around the bounding circle that makes up the shape of the prism"
"distributed around the bounding circle that makes up the shape of the prism",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RadiusInfo = {
"Radius",
"Radius",
"The radius of the prism's shape in meters"
"The radius of the prism's shape in meters",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo BaseRadiusInfo = {
"BaseRadius",
"Base Radius",
"The radius of the base of the prism's shape, in meters. By default it is given "
"the same radius as the outer shape"
"the same radius as the outer shape",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
"LineWidth",
"Line Width",
"This value specifies the line width"
"This value specifies the line width",
// @VISIBILITY(2.0)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineColorInfo = {
"Color",
"Color",
"This value determines the RGB color for the line"
"This value determines the RGB color for the line",
// @VISIBILITY(1.2)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo LengthInfo = {
"Length",
"Length",
"The length of the prism in meters"
"The length of the prism in meters",
// @VISIBILITY(2.8)
openspace::properties::Property::Visibility::User
};
// Generate vertices around the unit circle on the XY-plane

26
modules/base/rendering/renderablesphere.cpp
View File

@@ -57,32 +57,39 @@ namespace {
"Texture",
"This value specifies an image that is loaded from disk and is used as a texture "
"that is applied to this sphere. This image is expected to be an equirectangular "
"projection"
"projection",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = {
"MirrorTexture",
"Mirror Texture",
"Mirror the texture along the x-axis"
"Mirror the texture along the x-axis",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo OrientationInfo = {
"Orientation",
"Orientation",
"Specifies whether the texture is applied to the inside of the sphere, the "
"outside of the sphere, or both"
"outside of the sphere, or both",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Number of Segments",
"This value specifies the number of segments that the sphere is separated in"
"This value specifies the number of segments that the sphere is separated in",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size (in meters)",
"This value specifies the radius of the sphere in meters"
"This value specifies the radius of the sphere in meters",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeOutThresholdInfo = {
@@ -90,7 +97,8 @@ namespace {
"Fade-Out Threshold",
"This value determines percentage of the sphere that is visible before starting "
"to fade it out. A negative or zero value means no fading out will happen. This "
"is also the default"
"is also the default",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeInThresholdInfo = {
@@ -99,13 +107,15 @@ namespace {
"This value determines the distance from center of MilkyWay from where the "
"astronomical object starts to fade in, given as a percentage of the size of "
"the object. A negative or zero value means no fading in will happen. This is "
"also the default"
"also the default",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = {
"DisableFadeInOut",
"Disable Fade-In/Fade-Out effects",
"Enables/Disables the fade in and out effects"
"Enables/Disables the fade in and out effects",
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(RenderableSphere)]] Parameters {

26
modules/base/rendering/renderabletimevaryingsphere.cpp
View File

@@ -59,52 +59,62 @@ namespace {
"Texture Source",
"This value specifies a directory of images that are loaded from disk and is "
"used as a texture that is applied to this sphere. The images are expected to "
"be an equirectangular projection"
"be an equirectangular projection",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo MirrorTextureInfo = {
"MirrorTexture",
"Mirror Texture",
"Mirror the texture along the x-axis"
"Mirror the texture along the x-axis",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo OrientationInfo = {
"Orientation",
"Orientation",
"Specifies whether the texture is applied to the inside of the sphere, the "
"outside of the sphere, or both"
"outside of the sphere, or both",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SegmentsInfo = {
"Segments",
"Number of Segments",
"This value specifies the number of segments that the sphere is separated in"
"This value specifies the number of segments that the sphere is separated in",
// @VISIBILITY(2.67)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size (in meters)",
"This value specifies the radius of the sphere in meters"
"This value specifies the radius of the sphere in meters",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeOutThresholdInfo = {
"FadeOutThreshold",
"Fade-Out Threshold",
"This value determines percentage of the sphere is visible before starting "
"fading-out it"
"fading-out it",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo FadeInThresholdInfo = {
"FadeInThreshold",
"Fade-In Threshold",
"Distance from center of MilkyWay from where the astronomical object starts to "
"fade in"
"fade in",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DisableFadeInOutInfo = {
"DisableFadeInOut",
"Disable Fade-In/Fade-Out effects",
"Enables/Disables the Fade-In/Out effects"
"Enables/Disables the Fade-In/Out effects",
// @VISIBILITY(2.33)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(RenderableTimeVaryingSphere)]] Parameters {

23
modules/base/rendering/renderabletrail.cpp
View File

@@ -71,7 +71,9 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo LineColorInfo = {
"Color",
"Color",
"This value determines the RGB main color for the lines and points of the trail"
"This value determines the RGB main color for the lines and points of the trail",
// @VISIBILITY(1.2)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo EnableFadeInfo = {
@@ -79,7 +81,9 @@ namespace {
"Enable line fading of old points",
"Toggles whether the trail should fade older points out. If this value is "
"'true', the 'Fade' parameter determines the speed of fading. If this value is "
"'false', the entire trail is rendered at full opacity and color"
"'false', the entire trail is rendered at full opacity and color",
// @VISIBILITY(1.25)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo FadeInfo = {
@@ -87,7 +91,9 @@ namespace {
"Line fade",
"The fading factor that is applied to the trail if the 'EnableFade' value is "
"'true'. If it is 'false', this setting has no effect. The higher the number, "
"the less fading is applied"
"the less fading is applied",
// @VISIBILITY(2.5)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo LineWidthInfo = {
@@ -95,7 +101,9 @@ namespace {
"Line Width",
"This value specifies the line width of the trail if the selected rendering "
"method includes lines. If the rendering mode is set to Points, this value is "
"ignored"
"ignored",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo PointSizeInfo = {
@@ -104,7 +112,9 @@ namespace {
"This value specifies the base size of the points along the line if the selected "
"rendering method includes points. If the rendering mode is set the Lines, this "
"value is ignored. If a subsampling of the values is performed, the subsampled "
"values are half this size"
"values are half this size",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo RenderingModeInfo = {
@@ -112,7 +122,8 @@ namespace {
"Rendering Mode",
"Determines how the trail should be rendered to the screen. If 'Lines' is "
"selected, only the line part is visible, if 'Points' is selected, only the "
"corresponding points (and subpoints) are shown. 'Lines+Points' shows both parts"
"corresponding points (and subpoints) are shown. 'Lines+Points' shows both parts",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableTrail)]] Parameters {

10
modules/base/rendering/renderabletrailorbit.cpp
View File

@@ -93,7 +93,8 @@ namespace {
"The objects period, i.e. the length of its orbit around the parent object given "
"in (Earth) days. In the case of Earth, this would be a sidereal year "
"(=365.242 days). If this values is specified as multiples of the period, it is "
"possible to show the effects of precession"
"possible to show the effects of precession",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ResolutionInfo = {
@@ -102,14 +103,17 @@ namespace {
"The number of samples along the orbit. This determines the resolution of the "
"trail; the tradeoff being that a higher resolution is able to resolve more "
"detail, but will take more resources while rendering, too. The higher, the "
"smoother the trail, but also more memory will be used"
"smoother the trail, but also more memory will be used",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RenderableTypeInfo = {
"RenderableType",
"RenderableType",
"This value specifies if the orbit should be rendered in the Background,"
"Opaque, Transparent, or Overlay rendering step. Default is Transparent"
"Opaque, Transparent, or Overlay rendering step. Default is Transparent",
// @VISIBILITY(3.25)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableTrailOrbit)]] Parameters {

20
modules/base/rendering/renderabletrailtrajectory.cpp
View File

@@ -48,14 +48,16 @@ namespace {
"StartTime",
"Start Time",
"The start time for the range of this trajectory. The date must be in ISO 8601 "
"format: YYYY MM DD HH:mm:ss.xxx"
"format: YYYY MM DD HH:mm:ss.xxx",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo EndTimeInfo = {
"EndTime",
"End Time",
"The end time for the range of this trajectory. The date must be in ISO 8601 "
"format: YYYY MM DD HH:mm:ss.xxx"
"format: YYYY MM DD HH:mm:ss.xxx",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SampleIntervalInfo = {
@@ -64,7 +66,8 @@ namespace {
"The interval between samples of the trajectory. This value (together with "
"'TimeStampSubsampleFactor') determines how far apart (in time) the samples are "
"spaced along the trajectory. The time interval between 'StartTime' and "
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments"
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo TimeSubSampleInfo = {
@@ -73,14 +76,17 @@ namespace {
"The factor that is used to create subsamples along the trajectory. This value "
"(together with 'SampleInterval') determines how far apart (in time) the samples "
"are spaced along the trajectory. The time interval between 'StartTime' and "
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments"
"'EndTime' is split into 'SampleInterval' * 'TimeStampSubsampleFactor' segments",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RenderFullPathInfo = {
"ShowFullTrail",
"Render Full Trail",
"If this value is set to 'true', the entire trail will be rendered; if it is "
"'false', only the trail until the current time in the application will be shown"
"'false', only the trail until the current time in the application will be shown",
// @VISIBILITY(1.25)
openspace::properties::Property::Visibility::NoviceUser
};
constexpr openspace::properties::Property::PropertyInfo SweepChunkSizeInfo = {
@@ -88,7 +94,9 @@ namespace {
"Sweep Chunk Size",
"The number of vertices that will be calculated each frame whenever the trail "
"needs to be recalculated. "
"A greater value will result in more calculations per frame."
"A greater value will result in more calculations per frame.",
// @VISIBILITY(?)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(RenderableTrailTrajectory)]] Parameters {

3
modules/base/rendering/screenspacedashboard.cpp
View File

@@ -41,7 +41,8 @@ namespace {
"UseMainDashboard",
"Use main dashboard",
"If this value is set to 'true', this ScreenSpaceDashboard will use the "
"main dashboard instead of creating an independent one"
"main dashboard instead of creating an independent one",
openspace::properties::Property::Visibility::Developer
};
struct [[codegen::Dictionary(ScreenSpaceDashboard)]] Parameters {

4
modules/base/rendering/screenspaceframebuffer.cpp
View File

@@ -36,7 +36,9 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value explicitly specifies the size of the screen space plane"
"This value explicitly specifies the size of the screen space plane",
// @VISIBILITY(3.75)
openspace::properties::Property::Visibility::AdvancedUser
};
} // namespace

4
modules/base/rendering/screenspaceimagelocal.cpp
View File

@@ -42,7 +42,9 @@ namespace {
"Sets the path of the texture that is displayed on this screen space plane. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed. The size of the image will also automatically set the default "
"size of this plane"
"size of this plane",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(ScreenSpaceImageLocal)]] Parameters {

4
modules/base/rendering/screenspaceimageonline.cpp
View File

@@ -42,7 +42,9 @@ namespace {
"Sets the URL of the texture that is displayed on this screen space plane. If "
"this value is changed, the image at the new path will automatically be loaded "
"and displayed. The size of the image will also automatically set the default "
"size of this plane"
"size of this plane",
// @VISIBILITY(2.4)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(ScreenSpaceImageOnline)]] Parameters {

8
modules/base/rotation/constantrotation.cpp
View File

@@ -34,13 +34,17 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo RotationInfo = {
"RotationAxis",
"Rotation Axis",
"This value is the rotation axis around which the object will rotate"
"This value is the rotation axis around which the object will rotate",
// @VISIBILITY(3.33)
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RotationRateInfo = {
"RotationRate",
"Rotation Rate",
"This value determines the number of revolutions per in-game second"
"This value determines the number of revolutions per in-game second",
// @VISIBILITY(3.33)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(ConstantRotation)]] Parameters {

55
modules/base/rotation/fixedrotation.cpp
View File

@@ -42,7 +42,9 @@ namespace {
"Enabled",
"If this value is 'true', all the machinery of this rotation is used, of it is "
"'false', it provides the ability to change its attributes without risking some "
"undefined behavior"
"undefined behavior",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo XAxisTypeInfo = {
@@ -51,7 +53,8 @@ namespace {
"This value specifies how this axis is being specified, that is whether it is "
"referencing another object, specifying an absolute vector, or whether it is "
"using the right handed coordinate system completion based off the other two "
"vectors"
"vectors",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo YAxisTypeInfo = {
@@ -60,7 +63,8 @@ namespace {
"This value specifies how this axis is being specified, that is whether it is "
"referencing another object, specifying an absolute vector, or whether it is "
"using the right handed coordinate system completion based off the other two "
"vectors"
"vectors",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ZAxisTypeInfo = {
@@ -69,7 +73,8 @@ namespace {
"This value specifies how this axis is being specified, that is whether it is "
"referencing another object, specifying an absolute vector, or whether it is "
"using the right handed coordinate system completion based off the other two "
"vectors"
"vectors",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo XAxisObjectInfo = {
@@ -77,7 +82,8 @@ namespace {
"xAxis: Focus Object",
"This is the object that the axis will focus on. This object must name an "
"existing scene graph node in the currently loaded scene and the rotation will "
"stay fixed to the current position of that object"
"stay fixed to the current position of that object",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo YAxisObjectInfo = {
@@ -85,7 +91,8 @@ namespace {
"yAxis: Focus Object",
"This is the object that the axis will focus on. This object must name an "
"existing scene graph node in the currently loaded scene and the rotation will "
"stay fixed to the current position of that object"
"stay fixed to the current position of that object",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ZAxisObjectInfo = {
@@ -93,7 +100,8 @@ namespace {
"zAxis: Focus Object",
"This is the object that the axis will focus on. This object must name an "
"existing scene graph node in the currently loaded scene and the rotation will "
"stay fixed to the current position of that object"
"stay fixed to the current position of that object",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo XAxisInvertObjectInfo = {
@@ -101,7 +109,8 @@ namespace {
"xAxis: Invert Object Point Direction",
"If this value is set to 'true', and the type is set to 'Object', the inverse of "
"the pointing direction is used, causing the object to point away from the "
"referenced object"
"referenced object",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo YAxisInvertObjectInfo = {
@@ -109,7 +118,8 @@ namespace {
"yAxis: Invert Object Point Direction",
"If this value is set to 'true', and the type is set to 'Object', the inverse of "
"the pointing direction is used, causing the object to point away from the "
"referenced object"
"referenced object",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ZAxisInvertObjectInfo = {
@@ -117,25 +127,32 @@ namespace {
"zAxis: Invert Object Point Direction",
"If this value is set to 'true', and the type is set to 'Object', the inverse of "
"the pointing direction is used, causing the object to point away from the "
"referenced object"
"referenced object",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo XAxisVectorInfo = {
"xAxisVector",
"xAxis: Direction vector",
"This value specifies a static direction vector that is used for a fixed rotation"
"This value specifies a static direction vector that is used for a fixed "
"rotation",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo YAxisVectorInfo = {
"yAxisVector",
"yAxis: Direction vector",
"This value specifies a static direction vector that is used for a fixed rotation"
"This value specifies a static direction vector that is used for a fixed "
"rotation",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ZAxisVectorInfo = {
"zAxisVector",
"zAxis: Direction vector",
"This value specifies a static direction vector that is used for a fixed rotation"
"This value specifies a static direction vector that is used for a fixed "
"rotation",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo XAxisOrthogonalVectorInfo = {
@@ -143,7 +160,8 @@ namespace {
"xAxis: Vector is orthogonal",
"This value determines whether the vector specified is used directly, or whether "
"it is used together with another non-coordinate system completion vector to "
"construct an orthogonal vector instead"
"construct an orthogonal vector instead",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo YAxisOrthogonalVectorInfo = {
@@ -151,7 +169,8 @@ namespace {
"yAxis: Vector is orthogonal",
"This value determines whether the vector specified is used directly, or whether "
"it is used together with another non-coordinate system completion vector to "
"construct an orthogonal vector instead"
"construct an orthogonal vector instead",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo ZAxisOrthogonalVectorInfo = {
@@ -159,7 +178,8 @@ namespace {
"zAxis: Vector is orthogonal",
"This value determines whether the vector specified is used directly, or whether "
"it is used together with another non-coordinate system completion vector to "
"construct an orthogonal vector instead"
"construct an orthogonal vector instead",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo AttachedInfo = {
@@ -167,7 +187,8 @@ namespace {
"Attached Node",
"This is the name of the node that this rotation is attached to, this value is "
"only needed if any of the three axis uses the Object type. In this case, the "
"location of the attached node is required to compute the relative direction"
"location of the attached node is required to compute the relative direction",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(FixedRotation)]] Parameters {

4
modules/base/rotation/luarotation.cpp
View File

@@ -43,7 +43,9 @@ namespace {
"'rotation' that takes the current simulation time in seconds past the J2000 "
"epoch as the first argument, the current wall time as milliseconds past the "
"J2000 epoch as the second argument and computes the rotation returned as 9 "
"values"
"values",
// @VISIBILITY(3.25)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(LuaRotation)]] Parameters {

4
modules/base/rotation/staticrotation.cpp
View File

@@ -32,7 +32,9 @@ namespace {
"Rotation",
"Rotation",
"This value is the used as a 3x3 rotation matrix that is applied to the scene "
"graph node that this transformation is attached to relative to its parent"
"graph node that this transformation is attached to relative to its parent",
// @VISIBILITY(3.0)
openspace::properties::Property::Visibility::AdvancedUser
};
// Conversion from rotation matrix to euler angles, given that the rotation is a pure

4
modules/base/rotation/timelinerotation.cpp
View File

@@ -35,7 +35,9 @@ namespace {
"ShouldInterpolate",
"Should Interpolate",
"If this value is set to 'true', an interpolation is applied between the given "
"keyframes. If this value is set to 'false', the interpolation is not applied"
"keyframes. If this value is set to 'false', the interpolation is not applied",
// @VISIBILITY(3.2)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(TimelineRotation)]] Parameters {

4
modules/base/scale/luascale.cpp
View File

@@ -42,7 +42,9 @@ namespace {
"scaling factor for this transformation. The script needs to define a function "
"'scale' that takes the current simulation time in seconds past the J2000 epoch "
"as the first argument, the current wall time as milliseconds past the J2000 "
"epoch the second argument and computes the three scaling factors"
"epoch the second argument and computes the three scaling factors",
// @VISIBILITY(3.25)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(LuaScale)]] Parameters {

3
modules/base/scale/nonuniformstaticscale.cpp
View File

@@ -32,7 +32,8 @@ namespace {
"Scale",
"Scale",
"These values are used as scaling factors for the scene graph node that this "
"transformation is attached to relative to its parent"
"transformation is attached to relative to its parent",
openspace::properties::Property::Visibility::NoviceUser
};
struct [[codegen::Dictionary(NonUniformStaticScale)]] Parameters {

3
modules/base/scale/staticscale.cpp
View File

@@ -32,7 +32,8 @@ namespace {
"Scale",
"Scale",
"This value is used as a scaling factor for the scene graph node that this "
"transformation is attached to relative to its parent"
"transformation is attached to relative to its parent",
openspace::properties::Property::Visibility::NoviceUser
};
struct [[codegen::Dictionary(StaticScale)]] Parameters {

11
modules/base/scale/timedependentscale.cpp
View File

@@ -37,14 +37,18 @@ namespace {
"The date at which this scale will be 0. The current value of the scale is "
"computed by taking the difference between the current time and the reference "
"date and multiplying it by the speed. This field must be formatted as: "
"YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds"
"YYYY-MM-DDThh:mm:ss.uuu where h is a 24h clock and u microseconds",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo SpeedInfo = {
"Speed",
"Speed",
"The speed at which the value grows or shrinks. The units for this are meters "
"per second. The default value is 1 m/s"
"per second. The default value is 1 m/s",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo ClampToPositiveInfo = {
@@ -52,7 +56,8 @@ namespace {
"Clamp to Positive",
"If this value is true, the velocity computation will never result in any "
"negative values. This is useful for instantaneous events that only propagate "
"forwards. The default value is 'true'"
"forwards. The default value is 'true'",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(TimeDependentScale)]] Parameters {

16
modules/base/timeframe/timeframeinterval.cpp
View File

@@ -34,25 +34,33 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo HasStartInfo = {
"HasStart",
"Has Start",
"If enabled, this TimeFrame will be inactive before the Start"
"If enabled, this TimeFrame will be inactive before the Start",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo StartInfo = {
"Start",
"Start",
"Specifies the time when this TimeFrame becomes active"
"Specifies the time when this TimeFrame becomes active",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo HasEndInfo = {
"HasEnd",
"Has End",
"If enabled, this TimeFrame will be inactive after the End"
"If enabled, this TimeFrame will be inactive after the End",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo EndInfo = {
"End",
"End",
"Specifies the time when this TimeFrame becomes inactive"
"Specifies the time when this TimeFrame becomes inactive",
// @VISIBILITY(2.75)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(TimeFrameInterval)]] Parameters {

4
modules/base/timeframe/timeframeunion.cpp
View File

@@ -35,7 +35,9 @@ namespace {
"TimeFrames",
"Time Frames",
"A vector of time frames to combine into one. The time frame is active when any "
"of the contained time frames are, but not in gaps between contained time frames"
"of the contained time frames are, but not in gaps between contained time frames",
// @VISIBILITY(3.75)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(TimeFrameUnion)]] Parameters {

4
modules/base/translation/luatranslation.cpp
View File

@@ -43,7 +43,9 @@ namespace {
"translation for this transformation. The script needs to define a function "
"'translate' that takes the current simulation time in seconds past the J2000 "
"epoch as the first argument, the current wall time as milliseconds past the "
"J2000 epoch as the second argument and computes the translation"
"J2000 epoch as the second argument and computes the translation",
// @VISIBILITY(3.75)
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(LuaTranslation)]] Parameters {

4
modules/base/translation/statictranslation.cpp
View File

@@ -32,7 +32,9 @@ namespace {
"Position",
"Position",
"This value is used as a static offset (in meters) that is applied to the scene "
"graph node that this transformation is attached to relative to its parent"
"graph node that this transformation is attached to relative to its parent",
// @VISIBILITY(2.25)
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(StaticTranslation)]] Parameters {

3
modules/base/translation/timelinetranslation.cpp
View File

@@ -35,7 +35,8 @@ namespace {
"ShouldInterpolate",
"Should Interpolate",
"If this value is set to 'true', an interpolation is applied between the given "
"keyframes. If this value is set to 'false', the interpolation is not applied"
"keyframes. If this value is set to 'false', the interpolation is not applied",
openspace::properties::Property::Visibility::AdvancedUser
};
struct [[codegen::Dictionary(TimelineTranslation)]] Parameters {