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

Add documentation to the RenderableGalaxy (closes #1848)

Browse Source
This commit is contained in:
Alexander Bock
2022-01-26 23:53:33 +01:00
parent 162141f2db
commit bbfaf93a41
1 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
modules/galaxy/rendering/renderablegalaxy.cpp
View File

@@ -75,37 +75,45 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo VolumeRenderingEnabledInfo = {
"VolumeRenderingEnabled",
"Volume Rendering",
"" // @TODO Missing documentation
"If this value is enabled, the volume rendering component of the galaxy "
"rendering is turned on. Otherwise, the volume rendering is skipped"
};
constexpr openspace::properties::Property::PropertyInfo StarRenderingEnabledInfo = {
"StarRenderingEnabled",
"Star Rendering",
"" // @TODO Missing documentation
"If this value is enabled, the point-based star rendering component of the "
"galaxy rendering is turned on. Otherwise, the volume rendering is skipped"
};
constexpr openspace::properties::Property::PropertyInfo StepSizeInfo = {
"StepSize",
"Step Size",
"" // @TODO Missing documentation
"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"
};
constexpr openspace::properties::Property::PropertyInfo AbsorptionMultiplyInfo = {
"AbsorptionMultiply",
"Absorption Multiplier",
"" // @TODO Missing documentation
"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"
};
constexpr openspace::properties::Property::PropertyInfo EmissionMultiplyInfo = {
"EmissionMultiply",
"Emission Multiplier",
"" // @TODO Missing documentation
"A unit-less scale factor for the amount of light being emitted by dust in the "
"galaxy."
};
constexpr openspace::properties::Property::PropertyInfo RotationInfo = {
"Rotation",
"Euler rotation",
"" // @TODO Missing documentation
"The internal rotation of the volume rendering in Euler angles",
openspace::properties::Property::Visibility::Developer
};
constexpr openspace::properties::Property::PropertyInfo StarRenderingMethodInfo = {
@@ -118,7 +126,10 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledPointsRatioInfo = {
"EnabledPointsRatio",
"Enabled points",
"" // @TODO Missing documentation
"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."
};
constexpr openspace::properties::Property::PropertyInfo DownscaleVolumeRenderingInfo =
@@ -237,8 +248,8 @@ RenderableGalaxy::RenderableGalaxy(const ghoul::Dictionary& dictionary)
, _volumeRenderingEnabled(VolumeRenderingEnabledInfo, true)
, _starRenderingEnabled(StarRenderingEnabledInfo, true)
, _stepSize(StepSizeInfo, 0.01f, 0.001f, 0.05f, 0.001f)
, _absorptionMultiply(AbsorptionMultiplyInfo, 40.f, 0.0f, 200.0f)
, _emissionMultiply(EmissionMultiplyInfo, 200.f, 0.0f, 1000.0f)
, _absorptionMultiply(AbsorptionMultiplyInfo, 40.f, 0.f, 200.0f)
, _emissionMultiply(EmissionMultiplyInfo, 200.f, 0.f, 1000.0f)
, _starRenderingMethod(
StarRenderingMethodInfo,
properties::OptionProperty::DisplayType::Dropdown