diff --git a/data/scene/atmosphereearth.scene b/data/scene/atmosphereearth.scene index aea608f35b..a129c1700c 100644 --- a/data/scene/atmosphereearth.scene +++ b/data/scene/atmosphereearth.scene @@ -20,13 +20,13 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", true) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", true) openspace.setPropertyValue("EarthMarker.renderable.enabled", true) - openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) + openspace.setPropertyValue("Constellation Bounds.renderable.Enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) openspace.printInfo("Done setting default values") diff --git a/data/scene/dawn.scene b/data/scene/dawn.scene index 78c03cece5..a18bf0c916 100644 --- a/data/scene/dawn.scene +++ b/data/scene/dawn.scene @@ -20,15 +20,15 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", true) - openspace.setPropertyValue("EarthMarker.renderable.enabled", true) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", true) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", true) --openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) - openspace.setPropertyValue("PlutoTrail.renderable.enabled", false) - openspace.setPropertyValue("PlutoTexture.renderable.enabled", false) + openspace.setPropertyValue("PlutoTrail.renderable.Enabled", false) + openspace.setPropertyValue("PlutoTexture.renderable.Enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) openspace.printInfo("Done setting default values") end diff --git a/data/scene/default.scene b/data/scene/default.scene index 981cbf87ab..b887f7de54 100644 --- a/data/scene/default.scene +++ b/data/scene/default.scene @@ -20,14 +20,22 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("SunMarker.renderable.enabled", false) - openspace.setPropertyValue("EarthMarker.renderable.enabled", false) - openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", false) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", false) + openspace.setPropertyValue("Constellation Bounds.renderable.Enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) - openspace.addVirtualProperty("BoolProperty", "Show Trails", "*Trail.renderable.enabled", true, nil, nil) + openspace.addVirtualProperty( + "BoolProperty", + "Show Trails", + "*Trail.renderable.enabled", + "Disable or enable all trails of the scene at the same time", + true, + nil, + nil + ) openspace.navigation.resetCameraDirection() diff --git a/data/scene/fieldlines.scene b/data/scene/fieldlines.scene index cf494fe43c..b4936dc5d4 100644 --- a/data/scene/fieldlines.scene +++ b/data/scene/fieldlines.scene @@ -20,13 +20,13 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", false) - openspace.setPropertyValue("EarthMarker.renderable.enabled", false) - openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", false) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", false) + openspace.setPropertyValue("Constellation Bounds.renderable.Enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) openspace.printInfo("Done setting default values") end diff --git a/data/scene/globebrowsing.scene b/data/scene/globebrowsing.scene index 0c2b8d23c3..96ff9c3df9 100644 --- a/data/scene/globebrowsing.scene +++ b/data/scene/globebrowsing.scene @@ -19,64 +19,53 @@ function preInitialization() -- Toggle night texture, shading, atmosphere and water openspace.bindKey("s", - helper.property.invert('Earth.RenderableGlobe.Layers.NightLayers.Earth at Night 2012.enabled') .. - helper.property.invert('Earth.RenderableGlobe.performShading') .. - helper.property.invert('Earth.RenderableGlobe.atmosphere') .. - helper.property.invert('Earth.RenderableGlobe.Layers.WaterMasks.MODIS_Water_Mask.enabled'), + helper.property.invert('Earth.RenderableGlobe.Layers.NightLayers.Earth at Night 2012.Enabled') .. + helper.property.invert('Earth.RenderableGlobe.PerformShading') .. + helper.property.invert('Earth.RenderableGlobe.Atmosphere') .. + helper.property.invert('Earth.RenderableGlobe.Layers.WaterMasks.MODIS_Water_Mask.Enabled'), "Toggle night texture, shading, atmosphere, and water for Earth." ) -- Toggle background openspace.bindKey("b", - helper.property.invert('MilkyWay.renderable.enabled') .. - helper.property.invert('Stars.renderable.enabled'), + helper.property.invert('MilkyWay.renderable.Enabled') .. + helper.property.invert('Stars.renderable.Enabled'), "Toggle background (Stars and Milkyway)." ) openspace.bindKey("g", "openspace.setInteractionMode('GlobeBrowsing')" .. - helper.property.invert('MilkyWay.renderable.enabled') .. - helper.property.invert('Stars.renderable.enabled') .. - helper.property.invert('Earth.RenderableGlobe.Layers.NightLayers.Earth at Night 2012.enabled') .. - helper.property.invert('Earth.RenderableGlobe.performShading') .. - helper.property.invert('Mars.RenderableGlobe.performShading') .. - helper.property.invert('Earth.RenderableGlobe.atmosphere') .. - helper.property.invert('Earth.RenderableGlobe.Layers.WaterMasks.MODIS_Water_Mask.enabled') .. - helper.property.invert('Moon.RenderableGlobe.enabled') .. - helper.property.invert('Sun.renderable.enabled'), + helper.property.invert('MilkyWay.renderable.Enabled') .. + helper.property.invert('Stars.renderable.Enabled') .. + helper.property.invert('Earth.RenderableGlobe.Layers.NightLayers.Earth at Night 2012.Enabled') .. + helper.property.invert('Earth.RenderableGlobe.PerformShading') .. + helper.property.invert('Mars.RenderableGlobe.PerformShading') .. + helper.property.invert('Earth.RenderableGlobe.Atmosphere') .. + helper.property.invert('Earth.RenderableGlobe.Layers.WaterMasks.MODIS_Water_Mask.Enabled') .. + helper.property.invert('Moon.RenderableGlobe.Enabled') .. + helper.property.invert('Sun.renderable.Enabled'), "Toogles background and shading mode on the Earth and Mars alongside visibility of the Moon and the Sun" ) openspace.bindKey("h", - "openspace.setPropertyValue('*Trail.renderable.enabled', false)", + "openspace.setPropertyValue('*Trail.renderable.Enabled', false)", "Disables visibility of the trails" ) - - --[[ - -- Toggle trails - openspace.bindKey("o", - 'openspace.setPropertyValue("*Trail.renderable.enabled", false)' - ) - openspace.bindKey("p", - 'openspace.setPropertyValue("*Trail.renderable.enabled", true)' - ) - -]] end function postInitialization() openspace.printInfo("Setting default values") - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) - openspace.setPropertyValue("Sun.renderable.enabled", true) - openspace.setPropertyValue("SunGlare.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", false) + openspace.setPropertyValue("Sun.renderable.Enabled", true) + openspace.setPropertyValue("SunGlare.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", false) - openspace.setPropertyValue("Earth.RenderableGlobe.atmosphere", true) - openspace.setPropertyValue("Earth.RenderableGlobe.Debug.levelByProjectedAreaElseDistance", false) - openspace.setPropertyValue("Earth.RenderableGlobe.Layers.ColorLayers.blendTileLevels", true) + openspace.setPropertyValue("Earth.RenderableGlobe.Atmosphere", true) + openspace.setPropertyValue("Earth.RenderableGlobe.Debug.LevelByProjectedAreaElseDistance", false) + openspace.setPropertyValue("Earth.RenderableGlobe.Layers.ColorLayers.BlendTileLevels", true) openspace.globebrowsing.goToGeo(0, 0, 20000000) diff --git a/data/scene/juno.scene b/data/scene/juno.scene index eee0999a82..f3fb214f73 100755 --- a/data/scene/juno.scene +++ b/data/scene/juno.scene @@ -26,14 +26,14 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", true) - openspace.setPropertyValue("EarthMarker.renderable.enabled", true) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", true) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", true) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) - openspace.setPropertyValue('Jupiter.renderable.performShading', false); + openspace.setPropertyValue('Jupiter.renderable.PerformShading', false); openspace.printInfo("Done setting default values") end diff --git a/data/scene/newhorizons.scene b/data/scene/newhorizons.scene index 30f86d1b94..7dc39df870 100644 --- a/data/scene/newhorizons.scene +++ b/data/scene/newhorizons.scene @@ -26,15 +26,15 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", true) - openspace.setPropertyValue("EarthMarker.renderable.enabled", true) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", true) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", true) --openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) - openspace.setPropertyValue("PlutoTrail.renderable.enabled", false) - openspace.setPropertyValue("PlutoTexture.renderable.enabled", false) + openspace.setPropertyValue("PlutoTrail.renderable.Enabled", false) + openspace.setPropertyValue("PlutoTexture.renderable.Enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) openspace.printInfo("Done setting default values") end diff --git a/data/scene/osirisrex.scene b/data/scene/osirisrex.scene index 79c1e58e67..b869051f7b 100644 --- a/data/scene/osirisrex.scene +++ b/data/scene/osirisrex.scene @@ -28,15 +28,15 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", false) - openspace.setPropertyValue("EarthMarker.renderable.enabled", false) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", false) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", false) --openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) - openspace.setPropertyValue("PlutoTrail.renderable.enabled", true) - openspace.setPropertyValue("PlutoTexture.renderable.enabled", false) + openspace.setPropertyValue("PlutoTrail.renderable.Enabled", true) + openspace.setPropertyValue("PlutoTexture.renderable.Enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) -- Activate night textures and water masks openspace.setPropertyValue("Earth.RenderableGlobe.WaterMasks", {0, 1}); diff --git a/data/scene/rosetta.scene b/data/scene/rosetta.scene index 3ba32966e7..ce4c0213da 100644 --- a/data/scene/rosetta.scene +++ b/data/scene/rosetta.scene @@ -28,14 +28,14 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", true) - openspace.setPropertyValue("EarthMarker.renderable.enabled", true) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", true) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", true) - openspace.setPropertyValue("MilkyWay.renderable.transparency", 0.55) - openspace.setPropertyValue("MilkyWay.renderable.segments", 50) + openspace.setPropertyValue("MilkyWay.renderable.Transparency", 0.55) + openspace.setPropertyValue("MilkyWay.renderable.Segments", 50) - openspace.setPropertyValue('67P.renderable.performShading', false); + openspace.setPropertyValue('67P.renderable.PerformShading', false); openspace.printInfo("Done setting default values") end diff --git a/data/scene/satellites.scene b/data/scene/satellites.scene index 5e09f29196..46cf989799 100644 --- a/data/scene/satellites.scene +++ b/data/scene/satellites.scene @@ -25,12 +25,12 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("SunMarker.renderable.enabled", false) - openspace.setPropertyValue("SunGlare.renderable.enabled", false) - openspace.setPropertyValue("MilkyWay.renderable.enabled", false) - openspace.setPropertyValue("EarthMarker.renderable.enabled", false) - openspace.setPropertyValue("EarthTrail.renderable.enabled", false) - openspace.setPropertyValue("Earth.renderable.performShading", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", false) + openspace.setPropertyValue("SunGlare.renderable.Enabled", false) + openspace.setPropertyValue("MilkyWay.renderable.Enabled", false) + openspace.setPropertyValue("EarthMarker.renderable.Enabled", false) + openspace.setPropertyValue("EarthTrail.renderable.Enabled", false) + openspace.setPropertyValue("Earth.renderable.PerformShading", false) openspace.navigation.resetCameraDirection() diff --git a/data/scene/volumetricmilkyway.scene b/data/scene/volumetricmilkyway.scene index 3a4f4d71c2..7a0708ea32 100644 --- a/data/scene/volumetricmilkyway.scene +++ b/data/scene/volumetricmilkyway.scene @@ -20,8 +20,8 @@ function postInitialization() graphical settings for the renderables. ]]-- openspace.printInfo("Setting default values") - openspace.setPropertyValue("Sun.renderable.enabled", false) - openspace.setPropertyValue("SunMarker.renderable.enabled", true) + openspace.setPropertyValue("Sun.renderable.Enabled", false) + openspace.setPropertyValue("SunMarker.renderable.Enabled", true) -- openspace.setPropertyValue("EarthMarker.renderable.enabled", true) -- openspace.setPropertyValue("Constellation Bounds.renderable.enabled", false) diff --git a/modules/base/rendering/renderablemodel.cpp b/modules/base/rendering/renderablemodel.cpp index 78525ba9e0..5c6596c93e 100644 --- a/modules/base/rendering/renderablemodel.cpp +++ b/modules/base/rendering/renderablemodel.cpp @@ -95,10 +95,10 @@ documentation::Documentation RenderableModel::Documentation() { RenderableModel::RenderableModel(const ghoul::Dictionary& dictionary) : Renderable(dictionary) , _geometry(nullptr) - , _colorTexturePath({ "colorTexture", "Color Texture", "" }) // @TODO Missing documentation - , _performFade({ "performFading", "Perform Fading", "" }, false) // @TODO Missing documentation - , _performShading({ "performShading", "Perform Shading", "" }, true) // @TODO Missing documentation - , _fading({ "fading", "Fade", "" }, 0) // @TODO Missing documentation + , _colorTexturePath({ "ColorTexture", "Color Texture", "" }) // @TODO Missing documentation + , _performFade({ "PerformFading", "Perform Fading", "" }, false) // @TODO Missing documentation + , _performShading({ "PerformShading", "Perform Shading", "" }, true) // @TODO Missing documentation + , _fading({ "Fading", "Fade", "" }, 0) // @TODO Missing documentation , _programObject(nullptr) , _texture(nullptr) , _modelTransform(1.0) diff --git a/modules/base/rendering/renderableplane.cpp b/modules/base/rendering/renderableplane.cpp index dddf149ec3..75fb5cc5af 100644 --- a/modules/base/rendering/renderableplane.cpp +++ b/modules/base/rendering/renderableplane.cpp @@ -87,9 +87,9 @@ documentation::Documentation RenderablePlane::Documentation() { RenderablePlane::RenderablePlane(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _texturePath({ "texture", "Texture", "" }) // @TODO Missing documentation - , _billboard({ "billboard", "Billboard", "" }, false) // @TODO Missing documentation - , _size({ "size", "Size", "" }, 10, 0, std::pow(10, 25)) // @TODO Missing documentation + , _texturePath({ "Texture", "Texture", "" }) // @TODO Missing documentation + , _billboard({ "Billboard", "Billboard", "" }, false) // @TODO Missing documentation + , _size({ "Size", "Size", "" }, 10, 0, std::pow(10, 25)) // @TODO Missing documentation , _shader(nullptr) , _texture(nullptr) , _blendMode(BlendMode::Normal) diff --git a/modules/base/rendering/renderablesphere.cpp b/modules/base/rendering/renderablesphere.cpp index 5120bc4715..03e8715aec 100644 --- a/modules/base/rendering/renderablesphere.cpp +++ b/modules/base/rendering/renderablesphere.cpp @@ -92,11 +92,11 @@ documentation::Documentation RenderableSphere::Documentation() { RenderableSphere::RenderableSphere(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _texturePath({ "texture", "Texture", "" }) // @TODO Missing documentation - , _orientation({ "orientation", "Orientation", "" }) // @TODO Missing documentation - , _size({ "size", "Size", "" }, 1.f, 0.f, std::pow(10.f, 45)) // @TODO Missing documentation - , _segments({ "segments", "Segments", "" }, 8, 4, 100) // @TODO Missing documentation - , _transparency({ "transparency", "Transparency", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation + , _texturePath({ "Texture", "Texture", "" }) // @TODO Missing documentation + , _orientation({ "Orientation", "Orientation", "" }) // @TODO Missing documentation + , _size({ "Size", "Size", "" }, 1.f, 0.f, std::pow(10.f, 45)) // @TODO Missing documentation + , _segments({ "Segments", "Segments", "" }, 8, 4, 100) // @TODO Missing documentation + , _transparency({ "Transparency", "Transparency", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation , _shader(nullptr) , _texture(nullptr) , _sphere(nullptr) diff --git a/modules/base/rendering/renderabletrail.cpp b/modules/base/rendering/renderabletrail.cpp index c7a61525c3..e92b515d5a 100644 --- a/modules/base/rendering/renderabletrail.cpp +++ b/modules/base/rendering/renderabletrail.cpp @@ -133,13 +133,13 @@ documentation::Documentation RenderableTrail::Documentation() { RenderableTrail::RenderableTrail(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _lineColor({ "lineColor", "Color", "" }, glm::vec3(1.f), glm::vec3(0.f), glm::vec3(1.f)) // @TODO Missing documentation - , _useLineFade({ "useLineFade", "Use Line Fade", "" }, true) // @TODO Missing documentation - , _lineFade({ "lineFade", "Line Fade", "" }, 1.f, 0.f, 20.f) // @TODO Missing documentation - , _lineWidth({ "lineWidth", "Line Width", "" }, 2.f, 1.f, 20.f) // @TODO Missing documentation - , _pointSize({ "pointSize", "Point Size", "" }, 1, 1, 64) // @TODO Missing documentation + , _lineColor({ "LineColor", "Color", "" }, glm::vec3(1.f), glm::vec3(0.f), glm::vec3(1.f)) // @TODO Missing documentation + , _useLineFade({ "UseLineFade", "Use Line Fade", "" }, true) // @TODO Missing documentation + , _lineFade({ "LineFade", "Line Fade", "" }, 1.f, 0.f, 20.f) // @TODO Missing documentation + , _lineWidth({ "LineWidth", "Line Width", "" }, 2.f, 1.f, 20.f) // @TODO Missing documentation + , _pointSize({ "PointSize", "Point Size", "" }, 1, 1, 64) // @TODO Missing documentation , _renderingModes( - { "renderingMode", "Rendering Mode", "" }, // @TODO Missing documentation + { "RenderingMode", "Rendering Mode", "" }, // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) { diff --git a/modules/base/rendering/renderabletrailorbit.cpp b/modules/base/rendering/renderabletrailorbit.cpp index 45574e82b4..35ee4bdb32 100644 --- a/modules/base/rendering/renderabletrailorbit.cpp +++ b/modules/base/rendering/renderabletrailorbit.cpp @@ -134,8 +134,8 @@ documentation::Documentation RenderableTrailOrbit::Documentation() { RenderableTrailOrbit::RenderableTrailOrbit(const ghoul::Dictionary& dictionary) : RenderableTrail(dictionary) - , _period({ "period", "Period in days", "" }, 0.0, 0.0, 1e9) // @TODO Missing documentation - , _resolution({ "resolution", "Number of Samples along Orbit", "" }, 10000, 1, 1000000) // @TODO Missing documentation + , _period({ "Period", "Period in days", "" }, 0.0, 0.0, 1e9) // @TODO Missing documentation + , _resolution({ "Resolution", "Number of Samples along Orbit", "" }, 10000, 1, 1000000) // @TODO Missing documentation , _needsFullSweep(true) , _indexBufferDirty(true) , _previousTime(0) diff --git a/modules/base/rendering/renderabletrailtrajectory.cpp b/modules/base/rendering/renderabletrailtrajectory.cpp index e60c562640..5c18e1ed01 100644 --- a/modules/base/rendering/renderabletrailtrajectory.cpp +++ b/modules/base/rendering/renderabletrailtrajectory.cpp @@ -125,14 +125,14 @@ documentation::Documentation RenderableTrailTrajectory::Documentation() { RenderableTrailTrajectory::RenderableTrailTrajectory(const ghoul::Dictionary& dictionary) : RenderableTrail(dictionary) - , _startTime({ "startTime", "Start Time", "" }) // @TODO Missing documentation - , _endTime({ "endTime", "End Time", "" }) // @TODO Missing documentation - , _sampleInterval({ "sampleInterval", "Sample Interval", "" }, 2.0, 2.0, 1e6) // @TODO Missing documentation + , _startTime({ "StartTime", "Start Time", "" }) // @TODO Missing documentation + , _endTime({ "EndTime", "End Time", "" }) // @TODO Missing documentation + , _sampleInterval({ "SampleInterval", "Sample Interval", "" }, 2.0, 2.0, 1e6) // @TODO Missing documentation , _timeStampSubsamplingFactor( - { "subSample", "Time Stamp Subsampling Factor", "" }, // @TODO Missing documentation + { "SubSample", "Time Stamp Subsampling Factor", "" }, // @TODO Missing documentation 1, 1, 1000000000 ) - , _renderFullTrail({ "renderFullTrail", "Render Full Trail", "" }, false) // @TODO Missing documentation + , _renderFullTrail({ "RenderFullTrail", "Render Full Trail", "" }, false) // @TODO Missing documentation , _needsFullSweep(true) , _subsamplingIsDirty(true) { diff --git a/modules/base/rendering/screenspaceframebuffer.cpp b/modules/base/rendering/screenspaceframebuffer.cpp index 7c3ec87af5..87417acba9 100644 --- a/modules/base/rendering/screenspaceframebuffer.cpp +++ b/modules/base/rendering/screenspaceframebuffer.cpp @@ -48,7 +48,7 @@ documentation::Documentation ScreenSpaceFramebuffer::Documentation() { ScreenSpaceFramebuffer::ScreenSpaceFramebuffer(const ghoul::Dictionary& dictionary) : ScreenSpaceRenderable(dictionary) - , _size({ "size", "Size", "" }, glm::vec4(0), glm::vec4(0), glm::vec4(2000)) // @TODO Missing documentation + , _size({ "Size", "Size", "" }, glm::vec4(0), glm::vec4(0), glm::vec4(2000)) // @TODO Missing documentation , _framebuffer(nullptr) { documentation::testSpecificationAndThrow( diff --git a/modules/base/rendering/screenspaceimage.cpp b/modules/base/rendering/screenspaceimage.cpp index f2222559c6..72d7545f34 100644 --- a/modules/base/rendering/screenspaceimage.cpp +++ b/modules/base/rendering/screenspaceimage.cpp @@ -70,7 +70,7 @@ ScreenSpaceImage::ScreenSpaceImage(const ghoul::Dictionary& dictionary) : ScreenSpaceRenderable(dictionary) , _downloadImage(false) , _textureIsDirty(false) - , _texturePath({ "texturePath", "Texture path", "" }) // @TODO Missing documentation + , _texturePath({ "TexturePath", "Texture path", "" }) // @TODO Missing documentation { documentation::testSpecificationAndThrow( Documentation(), diff --git a/modules/base/rotation/staticrotation.cpp b/modules/base/rotation/staticrotation.cpp index ce78292788..340a29087f 100644 --- a/modules/base/rotation/staticrotation.cpp +++ b/modules/base/rotation/staticrotation.cpp @@ -61,7 +61,7 @@ documentation::Documentation StaticRotation::Documentation() { } StaticRotation::StaticRotation() - : _rotationMatrix({ "rotation", "Rotation", "" }, glm::dmat3(1.0)) // @TODO Missing documentation + : _rotationMatrix({ "Rotation", "Rotation", "" }, glm::dmat3(1.0)) // @TODO Missing documentation {} StaticRotation::StaticRotation(const ghoul::Dictionary& dictionary) diff --git a/modules/base/scale/staticscale.cpp b/modules/base/scale/staticscale.cpp index dd4807a23f..75366fa88d 100644 --- a/modules/base/scale/staticscale.cpp +++ b/modules/base/scale/staticscale.cpp @@ -49,7 +49,7 @@ documentation::Documentation StaticScale::Documentation() { } StaticScale::StaticScale() - : _scaleValue({ "scale", "Scale", "" }, 1.0, 1.0, 1000.0) // @TODO Missing documentation + : _scaleValue({ "Scale", "Scale", "" }, 1.0, 1.0, 1000.0) // @TODO Missing documentation { addProperty(_scaleValue); } diff --git a/modules/base/translation/statictranslation.cpp b/modules/base/translation/statictranslation.cpp index ec126458bf..22c0f366d0 100644 --- a/modules/base/translation/statictranslation.cpp +++ b/modules/base/translation/statictranslation.cpp @@ -60,7 +60,7 @@ documentation::Documentation StaticTranslation::Documentation() { StaticTranslation::StaticTranslation() : _position( - { "position", "Position", "" }, // @TODO Missing documentation + { "Position", "Position", "" }, // @TODO Missing documentation glm::dvec3(0.0), glm::dvec3(-std::numeric_limits::max()), glm::dvec3(std::numeric_limits::max()) diff --git a/modules/debugging/rendering/renderabledebugplane.cpp b/modules/debugging/rendering/renderabledebugplane.cpp index 2d900914e5..161fd2675c 100644 --- a/modules/debugging/rendering/renderabledebugplane.cpp +++ b/modules/debugging/rendering/renderabledebugplane.cpp @@ -47,9 +47,9 @@ namespace openspace { RenderableDebugPlane::RenderableDebugPlane(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _texture({ "texture", "Texture", "" }, -1, -1, 255) // @TODO Missing documentation - , _billboard({ "billboard", "Billboard", "" }, false) // @TODO Missing documentation - , _size({ "size", "Size", "" }, 10.f, 0.f, std::pow(10.f, 25.f)) // @TODO Missing documentation + , _texture({ "Texture", "Texture", "" }, -1, -1, 255) // @TODO Missing documentation + , _billboard({ "Billboard", "Billboard", "" }, false) // @TODO Missing documentation + , _size({ "Size", "Size", "" }, 10.f, 0.f, std::pow(10.f, 25.f)) // @TODO Missing documentation , _origin(Origin::Center) , _shader(nullptr) , _quad(0) diff --git a/modules/fieldlines/rendering/renderablefieldlines.cpp b/modules/fieldlines/rendering/renderablefieldlines.cpp index 79aaec4c14..e6fb08f376 100644 --- a/modules/fieldlines/rendering/renderablefieldlines.cpp +++ b/modules/fieldlines/rendering/renderablefieldlines.cpp @@ -76,16 +76,16 @@ namespace openspace { RenderableFieldlines::RenderableFieldlines(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _stepSize({ "stepSize", "Fieldline Step Size", "" }, defaultFieldlineStepSize, 0.f, 10.f) // @TODO Missing documentation - , _classification({ "classification", "Fieldline Classification", "" }, true) // @TODO Missing documentation + , _stepSize({ "StepSize", "Fieldline Step Size", "" }, defaultFieldlineStepSize, 0.f, 10.f) // @TODO Missing documentation + , _classification({ "Classification", "Fieldline Classification", "" }, true) // @TODO Missing documentation , _fieldlineColor( - { "fieldlineColor", "Fieldline Color", "" }, // @TODO Missing documentation + { "FieldlineColor", "Fieldline Color", "" }, // @TODO Missing documentation defaultFieldlineColor, glm::vec4(0.f), glm::vec4(1.f) ) - , _seedPointSource({ "source", "SeedPoint Source", "" }) // @TODO Missing documentation - , _seedPointSourceFile({ "sourceFile", "SeedPoint File", "" }) // @TODO Missing documentation + , _seedPointSource({ "Source", "SeedPoint Source", "" }) // @TODO Missing documentation + , _seedPointSourceFile({ "SourceFile", "SeedPoint File", "" }) // @TODO Missing documentation , _program(nullptr) , _seedPointsAreDirty(true) , _fieldLinesAreDirty(true) diff --git a/modules/galaxy/rendering/renderablegalaxy.cpp b/modules/galaxy/rendering/renderablegalaxy.cpp index 8e8db6b69c..f98c73b749 100644 --- a/modules/galaxy/rendering/renderablegalaxy.cpp +++ b/modules/galaxy/rendering/renderablegalaxy.cpp @@ -57,11 +57,11 @@ namespace openspace { RenderableGalaxy::RenderableGalaxy(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _stepSize({ "stepSize", "Step Size", "" }, 0.012, 0.0005, 0.05) // @TODO Missing documentation - , _pointStepSize({ "pointStepSize", "Point Step Size", "" }, 0.01, 0.01, 0.1) // @TODO Missing documentation - , _translation({ "translation", "Translation", "" }, glm::vec3(0.0, 0.0, 0.0), glm::vec3(0.0), glm::vec3(10.0)) // @TODO Missing documentation - , _rotation({ "rotation", "Euler rotation", "" }, glm::vec3(0.0, 0.0, 0.0), glm::vec3(0), glm::vec3(6.28)) // @TODO Missing documentation - , _enabledPointsRatio({ "nEnabledPointsRatio", "Enabled points", "" }, 0.2, 0, 1) // @TODO Missing documentation + , _stepSize({ "StepSize", "Step Size", "" }, 0.012, 0.0005, 0.05) // @TODO Missing documentation + , _pointStepSize({ "PointStepSize", "Point Step Size", "" }, 0.01, 0.01, 0.1) // @TODO Missing documentation + , _translation({ "Translation", "Translation", "" }, glm::vec3(0.0, 0.0, 0.0), glm::vec3(0.0), glm::vec3(10.0)) // @TODO Missing documentation + , _rotation({ "Rotation", "Euler rotation", "" }, glm::vec3(0.0, 0.0, 0.0), glm::vec3(0), glm::vec3(6.28)) // @TODO Missing documentation + , _enabledPointsRatio({ "NEnabledPointsRatio", "Enabled points", "" }, 0.2, 0, 1) // @TODO Missing documentation { float stepSize; glm::vec3 scaling, translation, rotation; diff --git a/modules/globebrowsing/cache/memoryawaretilecache.cpp b/modules/globebrowsing/cache/memoryawaretilecache.cpp index 30d232b58d..704fdaf705 100644 --- a/modules/globebrowsing/cache/memoryawaretilecache.cpp +++ b/modules/globebrowsing/cache/memoryawaretilecache.cpp @@ -45,26 +45,26 @@ MemoryAwareTileCache::MemoryAwareTileCache() : PropertyOwner("TileCache") , _numTextureBytesAllocatedOnCPU(0) , _cpuAllocatedTileData( - { "cpuAllocatedTileData", "CPU allocated tile data (MB)", "" }, // @TODO Missing documentation + { "CpuAllocatedTileData", "CPU allocated tile data (MB)", "" }, // @TODO Missing documentation 1024, // Default 128, // Minimum 2048, // Maximum 1) // Step: One MB , _gpuAllocatedTileData( - { "gpuAllocatedTileData", "GPU allocated tile data (MB)", ""}, // @TODO Missing documentation + { "GpuAllocatedTileData", "GPU allocated tile data (MB)", ""}, // @TODO Missing documentation 1024, // Default 128, // Minimum 2048, // Maximum 1) // Step: One MB , _tileCacheSize( - { "tileCacheSize", "Tile cache size", ""}, // @TODO Missing documentation + { "TileCacheSize", "Tile cache size", ""}, // @TODO Missing documentation 1024, // Default 128, // Minimum 2048, // Maximum 1) // Step: One MB - , _applyTileCacheSize({ "applyTileCacheSize", "Apply tile cache size", "" }) // @TODO Missing documentation - , _clearTileCache({ "clearTileCache", "Clear tile cache", "" }) // @TODO Missing documentation - , _usePbo({ "usePbo", "Use PBO", "" }, false) // @TODO Missing documentation + , _applyTileCacheSize({ "ApplyTileCacheSize", "Apply tile cache size", "" }) // @TODO Missing documentation + , _clearTileCache({ "ClearTileCache", "Clear tile cache", "" }) // @TODO Missing documentation + , _usePbo({ "UsePbo", "Use PBO", "" }, false) // @TODO Missing documentation { createDefaultTextureContainers(); diff --git a/modules/globebrowsing/globes/pointglobe.cpp b/modules/globebrowsing/globes/pointglobe.cpp index 55381f1506..1539bc27bb 100644 --- a/modules/globebrowsing/globes/pointglobe.cpp +++ b/modules/globebrowsing/globes/pointglobe.cpp @@ -38,11 +38,11 @@ namespace openspace::globebrowsing { PointGlobe::PointGlobe(const RenderableGlobe& owner) : _owner(owner) , _intensityClamp( - { "intensityClamp", "Intensity clamp", ""}, // @TODO Missing documentation + { "IntensityClamp", "Intensity clamp", ""}, // @TODO Missing documentation 1, 0, 1 ) , _lightIntensity( - { "lightIntensity", "Light intensity", ""}, // @TODO Missing documentation + { "LightIntensity", "Light intensity", ""}, // @TODO Missing documentation 1, 0, 50 ) { diff --git a/modules/globebrowsing/globes/renderableglobe.cpp b/modules/globebrowsing/globes/renderableglobe.cpp index cae5f33f7a..c5eb3b9f12 100644 --- a/modules/globebrowsing/globes/renderableglobe.cpp +++ b/modules/globebrowsing/globes/renderableglobe.cpp @@ -42,29 +42,29 @@ namespace openspace::globebrowsing { RenderableGlobe::RenderableGlobe(const ghoul::Dictionary& dictionary) : _debugProperties({ - BoolProperty({ "saveOrThrowCamera", "save or throw camera", "" }, false), // @TODO Missing documentation - BoolProperty({ "showChunkEdges", "show chunk edges", "" }, false), // @TODO Missing documentation - BoolProperty({ "showChunkBounds", "show chunk bounds", "" }, false), // @TODO Missing documentation - BoolProperty({ "showChunkAABB", "show chunk AABB", "" }, false), // @TODO Missing documentation - BoolProperty({ "showHeightResolution", "show height resolution", "" }, false), // @TODO Missing documentation - BoolProperty({ "showHeightIntensities", "show height intensities", "" }, false), // @TODO Missing documentation - BoolProperty({ "performFrustumCulling", "perform frustum culling", "" }, true), // @TODO Missing documentation - BoolProperty({ "performHorizonCulling", "perform horizon culling", "" }, true), // @TODO Missing documentation - BoolProperty({ "levelByProjectedAreaElseDistance", "level by projected area (else distance)", "" }, true), // @TODO Missing documentation - BoolProperty({ "resetTileProviders", "reset tile providers", "" }, false), // @TODO Missing documentation - BoolProperty({ "toggleEnabledEveryFrame", "toggle enabled every frame", "" }, false), // @TODO Missing documentation - BoolProperty({ "collectStats", "collect stats", "" }, false), // @TODO Missing documentation - BoolProperty({ "limitLevelByAvailableData", "Limit level by available data", "" }, true), // @TODO Missing documentation - IntProperty({ "modelSpaceRenderingCutoffLevel", "Model Space Rendering Cutoff Level", "" }, 10, 1, 22) // @TODO Missing documentation + BoolProperty({ "SaveOrThrowCamera", "save or throw camera", "" }, false), // @TODO Missing documentation + BoolProperty({ "ShowChunkEdges", "show chunk edges", "" }, false), // @TODO Missing documentation + BoolProperty({ "ShowChunkBounds", "show chunk bounds", "" }, false), // @TODO Missing documentation + BoolProperty({ "ShowChunkAABB", "show chunk AABB", "" }, false), // @TODO Missing documentation + BoolProperty({ "ShowHeightResolution", "show height resolution", "" }, false), // @TODO Missing documentation + BoolProperty({ "ShowHeightIntensities", "show height intensities", "" }, false), // @TODO Missing documentation + BoolProperty({ "PerformFrustumCulling", "perform frustum culling", "" }, true), // @TODO Missing documentation + BoolProperty({ "PerformHorizonCulling", "perform horizon culling", "" }, true), // @TODO Missing documentation + BoolProperty({ "LevelByProjectedAreaElseDistance", "level by projected area (else distance)", "" }, true), // @TODO Missing documentation + BoolProperty({ "ResetTileProviders", "reset tile providers", "" }, false), // @TODO Missing documentation + BoolProperty({ "ToggleEnabledEveryFrame", "toggle enabled every frame", "" }, false), // @TODO Missing documentation + BoolProperty({ "CollectStats", "collect stats", "" }, false), // @TODO Missing documentation + BoolProperty({ "LimitLevelByAvailableData", "Limit level by available data", "" }, true), // @TODO Missing documentation + IntProperty({ "ModelSpaceRenderingCutoffLevel", "Model Space Rendering Cutoff Level", "" }, 10, 1, 22) // @TODO Missing documentation }) , _generalProperties({ - BoolProperty({ "enabled", "Enabled", "" }, true), // @TODO Missing documentation - BoolProperty({ "performShading", "perform shading", "" }, true), // @TODO Missing documentation - BoolProperty({ "atmosphere", "atmosphere", "" }, false), // @TODO Missing documentation - BoolProperty({ "useAccurateNormals", "useAccurateNormals", "" }, false), // @TODO Missing documentation - FloatProperty({ "lodScaleFactor", "lodScaleFactor", "" }, 10.0f, 1.0f, 50.0f), // @TODO Missing documentation - FloatProperty({ "cameraMinHeight", "cameraMinHeight", "" }, 100.0f, 0.0f, 1000.0f), // @TODO Missing documentation - FloatProperty({ "orenNayarRoughness", "orenNayarRoughness", "" }, 0.0f, 0.0f, 1.0f) // @TODO Missing documentation + BoolProperty({ "Enabled", "Enabled", "" }, true), // @TODO Missing documentation + BoolProperty({ "PerformShading", "perform shading", "" }, true), // @TODO Missing documentation + BoolProperty({ "Atmosphere", "atmosphere", "" }, false), // @TODO Missing documentation + BoolProperty({ "UseAccurateNormals", "useAccurateNormals", "" }, false), // @TODO Missing documentation + FloatProperty({ "LodScaleFactor", "lodScaleFactor", "" }, 10.0f, 1.0f, 50.0f), // @TODO Missing documentation + FloatProperty({ "CameraMinHeight", "cameraMinHeight", "" }, 100.0f, 0.0f, 1000.0f), // @TODO Missing documentation + FloatProperty({ "OrenNayarRoughness", "orenNayarRoughness", "" }, 0.0f, 0.0f, 1.0f) // @TODO Missing documentation }) , _debugPropertyOwner("Debug") { diff --git a/modules/globebrowsing/rendering/layer/layer.cpp b/modules/globebrowsing/rendering/layer/layer.cpp index b3ead7fcaa..985e4605c2 100644 --- a/modules/globebrowsing/rendering/layer/layer.cpp +++ b/modules/globebrowsing/rendering/layer/layer.cpp @@ -42,19 +42,19 @@ namespace { Layer::Layer(layergroupid::GroupID id, const ghoul::Dictionary& layerDict) : properties::PropertyOwner(layerDict.value(keyName)) , _typeOption( - { "type", "Type", "" }, // @TODO Missing documentation + { "Type", "Type", "" }, // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) , _blendModeOption( - { "blendMode", "Blend Mode", "" }, // @TODO Missing documentation + { "BlendMode", "Blend Mode", "" }, // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) - , _enabled({ "enabled", "Enabled", "" }, false) // @TODO Missing documentation - , _reset({ "reset", "Reset", "" }) // @TODO Missing documentation + , _enabled({ "Enabled", "Enabled", "" }, false) // @TODO Missing documentation + , _reset({ "Reset", "Reset", "" }) // @TODO Missing documentation , _tileProvider(nullptr) , _otherTypesProperties{ properties::Vec3Property ( - { "color", "Color", "" }, // @TODO Missing documentation + { "Color", "Color", "" }, // @TODO Missing documentation glm::vec4(1.f, 1.f, 1.f, 1.f), glm::vec4(0.f), glm::vec4(1.f) diff --git a/modules/globebrowsing/rendering/layer/layeradjustment.cpp b/modules/globebrowsing/rendering/layer/layeradjustment.cpp index 6711f4bb51..83238368b6 100644 --- a/modules/globebrowsing/rendering/layer/layeradjustment.cpp +++ b/modules/globebrowsing/rendering/layer/layeradjustment.cpp @@ -35,19 +35,19 @@ namespace openspace::globebrowsing { LayerAdjustment::LayerAdjustment() : properties::PropertyOwner("adjustment") , chromaKeyColor( - { "chromaKeyColor", "Chroma key color", "" }, // @TODO Missing documentation + { "ChromaKeyColor", "Chroma key color", "" }, // @TODO Missing documentation glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(1.f) ) , chromaKeyTolerance( - { "chromaKeyTolerance", "Chroma key tolerance", "" }, // @TODO Missing documentation + { "ChromaKeyTolerance", "Chroma key tolerance", "" }, // @TODO Missing documentation 0, 0, 1 ) , _typeOption( - { "type", "Type", "" }, // @TODO Missing documentation + { "Type", "Type", "" }, // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) , _onChangeCallback([](){}) diff --git a/modules/globebrowsing/rendering/layer/layergroup.cpp b/modules/globebrowsing/rendering/layer/layergroup.cpp index 4b915ed6da..d19a08d222 100644 --- a/modules/globebrowsing/rendering/layer/layergroup.cpp +++ b/modules/globebrowsing/rendering/layer/layergroup.cpp @@ -35,7 +35,7 @@ namespace openspace::globebrowsing { LayerGroup::LayerGroup(layergroupid::GroupID id) : properties::PropertyOwner(std::move(layergroupid::LAYER_GROUP_NAMES[id])) , _groupId(id) - , _levelBlendingEnabled({ "blendTileLevels", "blend tile levels", "" }, false) // @TODO Missing documentation + , _levelBlendingEnabled({ "BlendTileLevels", "blend tile levels", "" }, false) // @TODO Missing documentation { addProperty(_levelBlendingEnabled); } diff --git a/modules/globebrowsing/rendering/layer/layerrendersettings.cpp b/modules/globebrowsing/rendering/layer/layerrendersettings.cpp index 12736a7806..65ee2c015d 100644 --- a/modules/globebrowsing/rendering/layer/layerrendersettings.cpp +++ b/modules/globebrowsing/rendering/layer/layerrendersettings.cpp @@ -36,12 +36,12 @@ namespace openspace::globebrowsing { LayerRenderSettings::LayerRenderSettings() : properties::PropertyOwner("Settings") - , setDefault({ "setDefault", "Set Default", "" }) // @TODO Missing documentation - , opacity(properties::FloatProperty({ "opacity", "Opacity", "" }, 1.f, 0.f, 1.f)) // @TODO Missing documentation - , gamma(properties::FloatProperty({ "gamma", "Gamma", "" }, 1, 0, 5))// @TODO Missing documentation - , multiplier(properties::FloatProperty({ "multiplier", "Multiplier", "" }, 1.f, 0.f, 20.f))// @TODO Missing documentation - , offset(properties::FloatProperty({ "offset", "Offset", "" }, 0.f, -10000.f, 10000.f))// @TODO Missing documentation - , valueBlending(properties::FloatProperty({ "valueBlending", "Value Blending", "" }, // @TODO Missing documentation + , setDefault({ "SetDefault", "Set Default", "" }) // @TODO Missing documentation + , opacity(properties::FloatProperty({ "Opacity", "Opacity", "" }, 1.f, 0.f, 1.f)) // @TODO Missing documentation + , gamma(properties::FloatProperty({ "Gamma", "Gamma", "" }, 1, 0, 5))// @TODO Missing documentation + , multiplier(properties::FloatProperty({ "Multiplier", "Multiplier", "" }, 1.f, 0.f, 20.f))// @TODO Missing documentation + , offset(properties::FloatProperty({ "Offset", "Offset", "" }, 0.f, -10000.f, 10000.f))// @TODO Missing documentation + , valueBlending(properties::FloatProperty({ "ValueBlending", "Value Blending", "" }, // @TODO Missing documentation 1.f, 0.f, 1.f)) , useValueBlending(false) { diff --git a/modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp b/modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp index 4d45166380..83dd2a118c 100644 --- a/modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp +++ b/modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp @@ -88,9 +88,9 @@ bool GdalWrapper::logGdalErrors() const { GdalWrapper::GdalWrapper(size_t maximumCacheSize, size_t maximumMaximumCacheSize) : PropertyOwner("GdalWrapper") - , _logGdalErrors({ "logGdalErrors", "Log GDAL errors", "" }, true) // @TODO Missing documentation + , _logGdalErrors({ "LogGdalErrors", "Log GDAL errors", "" }, true) // @TODO Missing documentation , _gdalMaximumCacheSize ( - { "gdalMaximumCacheSize", "GDAL maximum cache size", "" }, // @TODO Missing documentation + { "GdalMaximumCacheSize", "GDAL maximum cache size", "" }, // @TODO Missing documentation maximumCacheSize / (1024 * 1024), // Default 0, // Minimum: No caching maximumMaximumCacheSize / (1024 * 1024), // Maximum diff --git a/modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp b/modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp index db888fd9e7..e9ddab72d0 100644 --- a/modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp +++ b/modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp @@ -55,8 +55,8 @@ namespace openspace::globebrowsing::tileprovider { DefaultTileProvider::DefaultTileProvider(const ghoul::Dictionary& dictionary) : TileProvider(dictionary) - , _filePath({ "filePath", "File Path", "" }, "") // @TODO Missing documentation - , _tilePixelSize({ "tilePixelSize", "Tile Pixel Size", "" }, 32, 32, 1024) // @TODO Missing documentation + , _filePath({ "FilePath", "File Path", "" }, "") // @TODO Missing documentation + , _tilePixelSize({ "TilePixelSize", "Tile Pixel Size", "" }, 32, 32, 1024) // @TODO Missing documentation , _preCacheLevel(0) { _tileCache = OsEng.moduleEngine().module()->tileCache(); diff --git a/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp b/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp index 10d52fb0ab..60bb55434c 100644 --- a/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp +++ b/modules/globebrowsing/tile/tileprovider/singleimageprovider.cpp @@ -36,7 +36,7 @@ namespace openspace::globebrowsing::tileprovider { SingleImageProvider::SingleImageProvider(const ghoul::Dictionary& dictionary) : _tile(nullptr, nullptr, Tile::Status::Unavailable) - , _filePath({ "filePath", "File Path", "" }) // @TODO Missing documentation + , _filePath({ "FilePath", "File Path", "" }) // @TODO Missing documentation { // Required input std::string filePath; @@ -50,7 +50,7 @@ SingleImageProvider::SingleImageProvider(const ghoul::Dictionary& dictionary) SingleImageProvider::SingleImageProvider(const std::string& imagePath) : _tile(nullptr, nullptr, Tile::Status::Unavailable) - , _filePath({ "filePath", "File Path", "" }, imagePath) // @TODO Missing documentation + , _filePath({ "FilePath", "File Path", "" }, imagePath) // @TODO Missing documentation { reset(); } diff --git a/modules/globebrowsing/tile/tileprovider/temporaltileprovider.cpp b/modules/globebrowsing/tile/tileprovider/temporaltileprovider.cpp index eeeea69dc3..5867c00cf5 100644 --- a/modules/globebrowsing/tile/tileprovider/temporaltileprovider.cpp +++ b/modules/globebrowsing/tile/tileprovider/temporaltileprovider.cpp @@ -56,7 +56,7 @@ const char* TemporalTileProvider::TemporalXMLTags::TIME_FORMAT = "OpenSpaceTimeI TemporalTileProvider::TemporalTileProvider(const ghoul::Dictionary& dictionary) : _initDict(dictionary) - , _filePath({ "filePath", "File Path", "" }, "") // @TODO Missing documentation + , _filePath({ "FilePath", "File Path", "" }, "") // @TODO Missing documentation , _successfulInitialization(false) { std::string filePath; diff --git a/modules/iswa/rendering/datacygnet.cpp b/modules/iswa/rendering/datacygnet.cpp index 8c3945e7e8..f6ec1c6a6d 100644 --- a/modules/iswa/rendering/datacygnet.cpp +++ b/modules/iswa/rendering/datacygnet.cpp @@ -41,13 +41,13 @@ namespace openspace { DataCygnet::DataCygnet(const ghoul::Dictionary& dictionary) : IswaCygnet(dictionary) , _dataProcessor(nullptr) - , _dataOptions({ "dataOptions", "Data Options", "" }) // @TODO Missing documentation - , _useLog({ "useLog","Use Logarithm", "" }, false) // @TODO Missing documentation - , _useHistogram({ "useHistogram", "Auto Contrast", "" }, false) // @TODO Missing documentation - , _autoFilter({ "autoFilter", "Auto Filter", "" }, true) // @TODO Missing documentation - , _normValues({ "normValues", "Normalize Values", "" }, glm::vec2(1.0, 1.0), glm::vec2(0), glm::vec2(5.0)) // @TODO Missing documentation - , _backgroundValues({ "backgroundValues", "Background Values", "" }, glm::vec2(0.0), glm::vec2(0), glm::vec2(1.0)) // @TODO Missing documentation - , _transferFunctionsFile({ "transferfunctions", "Transfer Functions", "" }, "${SCENE}/iswa/tfs/default.tf") // @TODO Missing documentation + , _dataOptions({ "DataOptions", "Data Options", "" }) // @TODO Missing documentation + , _useLog({ "UseLog","Use Logarithm", "" }, false) // @TODO Missing documentation + , _useHistogram({ "UseHistogram", "Auto Contrast", "" }, false) // @TODO Missing documentation + , _autoFilter({ "AutoFilter", "Auto Filter", "" }, true) // @TODO Missing documentation + , _normValues({ "NormValues", "Normalize Values", "" }, glm::vec2(1.0, 1.0), glm::vec2(0), glm::vec2(5.0)) // @TODO Missing documentation + , _backgroundValues({ "BackgroundValues", "Background Values", "" }, glm::vec2(0.0), glm::vec2(0), glm::vec2(1.0)) // @TODO Missing documentation + , _transferFunctionsFile({ "Transferfunctions", "Transfer Functions", "" }, "${SCENE}/iswa/tfs/default.tf") // @TODO Missing documentation //FOR TESTING , _numOfBenchmarks(0) , _avgBenchmarkTime(0.0f) diff --git a/modules/iswa/rendering/iswabasegroup.cpp b/modules/iswa/rendering/iswabasegroup.cpp index 52c02a29a5..b92cca6db1 100644 --- a/modules/iswa/rendering/iswabasegroup.cpp +++ b/modules/iswa/rendering/iswabasegroup.cpp @@ -44,9 +44,9 @@ namespace openspace { IswaBaseGroup::IswaBaseGroup(std::string name, std::string type) : properties::PropertyOwner(std::move(name)) - , _enabled({ "enabled", "Enabled", "" }, true) // @TODO Missing documentation - , _alpha({ "alpha", "Alpha", "" }, 0.9f, 0.0f, 1.0f) // @TODO Missing documentation - , _delete({ "delete", "Delete", "" }) // @TODO Missing documentation + , _enabled({ "Enabled", "Enabled", "" }, true) // @TODO Missing documentation + , _alpha({ "Alpha", "Alpha", "" }, 0.9f, 0.0f, 1.0f) // @TODO Missing documentation + , _delete({ "Delete", "Delete", "" }) // @TODO Missing documentation , _registered(false) , _type(type) , _dataProcessor(nullptr) diff --git a/modules/iswa/rendering/iswacygnet.cpp b/modules/iswa/rendering/iswacygnet.cpp index 7004ac220b..09ec2bd9a1 100644 --- a/modules/iswa/rendering/iswacygnet.cpp +++ b/modules/iswa/rendering/iswacygnet.cpp @@ -41,8 +41,8 @@ namespace openspace { IswaCygnet::IswaCygnet(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _delete({ "delete", "Delete", "" }) // @TODO Missing documentation - , _alpha({ "alpha", "Alpha", "" }, 0.9f, 0.0f, 1.0f) // @TODO Missing documentation + , _delete({ "Delete", "Delete", "" }) // @TODO Missing documentation + , _alpha({ "Alpha", "Alpha", "" }, 0.9f, 0.0f, 1.0f) // @TODO Missing documentation , _shader(nullptr) , _group(nullptr) , _textureDirty(false) diff --git a/modules/iswa/rendering/iswadatagroup.cpp b/modules/iswa/rendering/iswadatagroup.cpp index 3ce6401508..62578eabcb 100644 --- a/modules/iswa/rendering/iswadatagroup.cpp +++ b/modules/iswa/rendering/iswadatagroup.cpp @@ -43,13 +43,13 @@ namespace { namespace openspace{ IswaDataGroup::IswaDataGroup(std::string name, std::string type) : IswaBaseGroup(name, type) - , _useLog({ "useLog","Use Logarithm", "" }, false) // @TODO Missing documentation - , _useHistogram({ "useHistogram", "Auto Contrast", "" }, false) // @TODO Missing documentation - , _autoFilter({ "autoFilter", "Auto Filter", "" }, true) // @TODO Missing documentation - , _normValues({ "normValues", "Normalize Values", "" }, glm::vec2(1.0, 1.0), glm::vec2(0), glm::vec2(5.0)) // @TODO Missing documentation - , _backgroundValues({ "backgroundValues", "Background Values", "" }, glm::vec2(0.0), glm::vec2(0), glm::vec2(1.0)) // @TODO Missing documentation - , _transferFunctionsFile({ "transferfunctions", "Transfer Functions", "" }, "${SCENE}/iswa/tfs/default.tf") // @TODO Missing documentation - , _dataOptions({ "dataOptions", "Data Options", "" }) // @TODO Missing documentation + , _useLog({ "UseLog","Use Logarithm", "" }, false) // @TODO Missing documentation + , _useHistogram({ "UseHistogram", "Auto Contrast", "" }, false) // @TODO Missing documentation + , _autoFilter({ "AutoFilter", "Auto Filter", "" }, true) // @TODO Missing documentation + , _normValues({ "NormValues", "Normalize Values", "" }, glm::vec2(1.0, 1.0), glm::vec2(0), glm::vec2(5.0)) // @TODO Missing documentation + , _backgroundValues({ "BackgroundValues", "Background Values", "" }, glm::vec2(0.0), glm::vec2(0), glm::vec2(1.0)) // @TODO Missing documentation + , _transferFunctionsFile({ "Transferfunctions", "Transfer Functions", "" }, "${SCENE}/iswa/tfs/default.tf") // @TODO Missing documentation + , _dataOptions({ "DataOptions", "Data Options", "" }) // @TODO Missing documentation { addProperty(_useLog); addProperty(_useHistogram); diff --git a/modules/iswa/rendering/iswakameleongroup.cpp b/modules/iswa/rendering/iswakameleongroup.cpp index a29a76bb9a..201a2a537f 100644 --- a/modules/iswa/rendering/iswakameleongroup.cpp +++ b/modules/iswa/rendering/iswakameleongroup.cpp @@ -43,8 +43,8 @@ namespace { namespace openspace{ IswaKameleonGroup::IswaKameleonGroup(std::string name, std::string type) : IswaDataGroup(name, type) - , _resolution({ "resolution", "Resolution%", "" }, 100.0f, 10.0f, 200.0f) // @TODO Missing documentation - , _fieldlines({ "fieldlineSeedsIndexFile", "Fieldline Seedpoints", "" }) // @TODO Missing documentation + , _resolution({ "Resolution", "Resolution%", "" }, 100.0f, 10.0f, 200.0f) // @TODO Missing documentation + , _fieldlines({ "FieldlineSeedsIndexFile", "Fieldline Seedpoints", "" }) // @TODO Missing documentation , _fieldlineIndexFile("") , _kameleonPath("") { diff --git a/modules/iswa/rendering/kameleonplane.cpp b/modules/iswa/rendering/kameleonplane.cpp index 3008e61619..98a875716e 100644 --- a/modules/iswa/rendering/kameleonplane.cpp +++ b/modules/iswa/rendering/kameleonplane.cpp @@ -39,9 +39,9 @@ namespace openspace { KameleonPlane::KameleonPlane(const ghoul::Dictionary& dictionary) : DataCygnet(dictionary) - , _fieldlines({ "fieldlineSeedsIndexFile", "Fieldline Seedpoints", "" }) // @TODO Missing documentation - , _resolution({ "resolution", "Resolution%", "" }, 100.0f, 10.0f, 200.0f) // @TODO Missing documentation - , _slice({ "slice", "Slice", "" }, 0.0, 0.0, 1.0) // @TODO Missing documentation + , _fieldlines({ "FieldlineSeedsIndexFile", "Fieldline Seedpoints", "" }) // @TODO Missing documentation + , _resolution({ "Resolution", "Resolution%", "" }, 100.0f, 10.0f, 200.0f) // @TODO Missing documentation + , _slice({ "Slice", "Slice", "" }, 0.0, 0.0, 1.0) // @TODO Missing documentation { addProperty(_resolution); addProperty(_slice); diff --git a/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp b/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp index c8735878c9..ec0780afbb 100644 --- a/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp +++ b/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp @@ -64,24 +64,24 @@ namespace openspace { RenderableKameleonVolume::RenderableKameleonVolume(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _dimensions({ "dimensions", "Dimensions", "" }) // @TODO Missing documentation - , _variable({ "variable", "Variable", "" }) // @TODO Missing documentation - , _lowerDomainBound({ "lowerDomainBound", "Lower Domain Bound", "" }) // @TODO Missing documentation - , _upperDomainBound({ "upperDomainBound", "Upper Domain Bound", "" }) // @TODO Missing documentation - , _domainScale({ "domainScale", "Domain scale", "" }) // @TODO Missing documentation + , _dimensions({ "Dimensions", "Dimensions", "" }) // @TODO Missing documentation + , _variable({ "Variable", "Variable", "" }) // @TODO Missing documentation + , _lowerDomainBound({ "LowerDomainBound", "Lower Domain Bound", "" }) // @TODO Missing documentation + , _upperDomainBound({ "UpperDomainBound", "Upper Domain Bound", "" }) // @TODO Missing documentation + , _domainScale({ "DomainScale", "Domain scale", "" }) // @TODO Missing documentation , _autoDomainBounds(false) - , _lowerValueBound({ "lowerValueBound", "Lower Value Bound", "" }, 0.f, 0.f, 1.f) // @TODO Missing documentation - , _upperValueBound({ "upperValueBound", "Upper Value Bound", "" }, 1.f, 0.01f, 1.f) // @TODO Missing documentation + , _lowerValueBound({ "LowerValueBound", "Lower Value Bound", "" }, 0.f, 0.f, 1.f) // @TODO Missing documentation + , _upperValueBound({ "UpperValueBound", "Upper Value Bound", "" }, 1.f, 0.01f, 1.f) // @TODO Missing documentation , _autoValueBounds(false) - , _gridType({ "gridType", "Grid Type", "" }, properties::OptionProperty::DisplayType::Dropdown) // @TODO Missing documentation + , _gridType({ "GridType", "Grid Type", "" }, properties::OptionProperty::DisplayType::Dropdown) // @TODO Missing documentation , _autoGridType(false) , _clipPlanes(nullptr) - , _stepSize({ "stepSize", "Step Size", "" }, 0.02f, 0.01f, 1.f) // @TODO Missing documentation - , _sourcePath({ "sourcePath", "Source Path", "" }) // @TODO Missing documentation - , _transferFunctionPath({ "transferFunctionPath", "Transfer Function Path", "" }) // @TODO Missing documentation + , _stepSize({ "StepSize", "Step Size", "" }, 0.02f, 0.01f, 1.f) // @TODO Missing documentation + , _sourcePath({ "SourcePath", "Source Path", "" }) // @TODO Missing documentation + , _transferFunctionPath({ "TransferFunctionPath", "Transfer Function Path", "" }) // @TODO Missing documentation , _raycaster(nullptr) , _transferFunction(nullptr) - , _cache({ "cache", "Cache", "" }) // @TODO Missing documentation + , _cache({ "Cache", "Cache", "" }) // @TODO Missing documentation { glm::vec3 dimensions; diff --git a/modules/multiresvolume/rendering/renderablemultiresvolume.cpp b/modules/multiresvolume/rendering/renderablemultiresvolume.cpp index 7f3910268d..a2e48b63ab 100644 --- a/modules/multiresvolume/rendering/renderablemultiresvolume.cpp +++ b/modules/multiresvolume/rendering/renderablemultiresvolume.cpp @@ -95,20 +95,20 @@ RenderableMultiresVolume::RenderableMultiresVolume (const ghoul::Dictionary& dic , _errorHistogramManager(nullptr) , _histogramManager(nullptr) , _localErrorHistogramManager(nullptr) - , _stepSizeCoefficient({ "stepSizeCoefficient", "Stepsize Coefficient", "" }, 1.f, 0.01f, 10.f) // @TODO Missing documentation - , _currentTime({ "currentTime", "Current Time", "" }, 0, 0, 0) // @TODO Missing documentation - , _memoryBudget({ "memoryBudget", "Memory Budget", "" }, 0, 0, 0) // @TODO Missing documentation - , _streamingBudget({ "streamingBudget", "Streaming Budget", "" }, 0, 0, 0) // @TODO Missing documentation - , _useGlobalTime({ "useGlobalTime", "Global Time", "" }, false) // @TODO Missing documentation - , _loop({ "loop", "Loop", "" }, false) // @TODO Missing documentation - , _selectorName({ "selector", "Brick Selector", "" }) // @TODO Missing documentation + , _stepSizeCoefficient({ "StepSizeCoefficient", "Stepsize Coefficient", "" }, 1.f, 0.01f, 10.f) // @TODO Missing documentation + , _currentTime({ "CurrentTime", "Current Time", "" }, 0, 0, 0) // @TODO Missing documentation + , _memoryBudget({ "MemoryBudget", "Memory Budget", "" }, 0, 0, 0) // @TODO Missing documentation + , _streamingBudget({ "StreamingBudget", "Streaming Budget", "" }, 0, 0, 0) // @TODO Missing documentation + , _useGlobalTime({ "UseGlobalTime", "Global Time", "" }, false) // @TODO Missing documentation + , _loop({ "Loop", "Loop", "" }, false) // @TODO Missing documentation + , _selectorName({ "Selector", "Brick Selector", "" }) // @TODO Missing documentation , _gatheringStats(false) - , _statsToFile({ "printStats", "Print Stats", "" }, false) // @TODO Missing documentation - , _statsToFileName({ "printStatsFileName", "Stats Filename", "" }) // @TODO Missing documentation - , _scalingExponent({ "scalingExponent", "Scaling Exponent", "" }, 1, -10, 20) // @TODO Missing documentation - , _scaling({ "scaling", "Scaling", "" }, glm::vec3(1.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation - , _translation({ "translation", "Translation", "" }, glm::vec3(0.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation - , _rotation({ "rotation", "Euler rotation", "" }, glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(6.28f)) // @TODO Missing documentation + , _statsToFile({ "PrintStats", "Print Stats", "" }, false) // @TODO Missing documentation + , _statsToFileName({ "PrintStatsFileName", "Stats Filename", "" }) // @TODO Missing documentation + , _scalingExponent({ "ScalingExponent", "Scaling Exponent", "" }, 1, -10, 20) // @TODO Missing documentation + , _scaling({ "Scaling", "Scaling", "" }, glm::vec3(1.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation + , _translation({ "Translation", "Translation", "" }, glm::vec3(0.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation + , _rotation({ "Rotation", "Euler rotation", "" }, glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(6.28f)) // @TODO Missing documentation { std::string name; //bool success = dictionary.getValue(constants::scenegraphnode::keyName, name); diff --git a/modules/newhorizons/rendering/renderablefov.cpp b/modules/newhorizons/rendering/renderablefov.cpp index 9d1b569fa3..bb5c09aa64 100644 --- a/modules/newhorizons/rendering/renderablefov.cpp +++ b/modules/newhorizons/rendering/renderablefov.cpp @@ -129,38 +129,38 @@ documentation::Documentation RenderableFov::Documentation() { RenderableFov::RenderableFov(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _lineWidth({ "lineWidth", "Line Width", "" }, 1.f, 1.f, 20.f) // @TODO Missing documentation - , _drawSolid({ "solidDraw", "Draw as Quads", "" }, false) // @TODO Missing documentation - , _standOffDistance({ "standOffDistance", "Standoff Distance", "" }, 0.9999, 0.99, 1.0, 0.000001) // @TODO Missing documentation + , _lineWidth({ "LineWidth", "Line Width", "" }, 1.f, 1.f, 20.f) // @TODO Missing documentation + , _drawSolid({ "SolidDraw", "Draw as Quads", "" }, false) // @TODO Missing documentation + , _standOffDistance({ "StandOffDistance", "Standoff Distance", "" }, 0.9999, 0.99, 1.0, 0.000001) // @TODO Missing documentation , _programObject(nullptr) , _drawFOV(false) , _colors({ { - { "colors.defaultStart", "Start of default color", "" }, // @TODO Missing documentation + { "Colors.DefaultStart", "Start of default color", "" }, // @TODO Missing documentation glm::vec4(0.4f) }, { - { "colors.defaultEnd", "End of default color", "" }, // @TODO Missing documentation + { "Colors.DefaultEnd", "End of default color", "" }, // @TODO Missing documentation glm::vec4(0.85f, 0.85f, 0.85f, 1.f) }, { - { "colors.active", "Active Color", "" }, // @TODO Missing documentation + { "Colors.Active", "Active Color", "" }, // @TODO Missing documentation glm::vec4(0.f, 1.f, 0.f, 1.f) }, { - { "colors.targetInFieldOfView", "Target-in-field-of-view Color", "" }, // @TODO Missing documentation + { "Colors.TargetInFieldOfView", "Target-in-field-of-view Color", "" }, // @TODO Missing documentation glm::vec4(0.f, 0.5f, 0.7f, 1.f) }, { - { "colors.intersectionStart", "Start of the intersection", "" }, // @TODO Missing documentation + { "Colors.IntersectionStart", "Start of the intersection", "" }, // @TODO Missing documentation glm::vec4(1.f, 0.89f, 0.f, 1.f) }, { - { "colors.intersectionEnd", "End of the intersection", "" }, // @TODO Missing documentation + { "Colors.IntersectionEnd", "End of the intersection", "" }, // @TODO Missing documentation glm::vec4(1.f, 0.29f, 0.f, 1.f) }, { - { "colors.square", "Orthogonal Square", "" }, // @TODO Missing documentation + { "Colors.Square", "Orthogonal Square", "" }, // @TODO Missing documentation glm::vec4(0.85f, 0.85f, 0.85f, 1.f) } }) diff --git a/modules/newhorizons/rendering/renderablemodelprojection.cpp b/modules/newhorizons/rendering/renderablemodelprojection.cpp index 73953bd118..127042eb0a 100644 --- a/modules/newhorizons/rendering/renderablemodelprojection.cpp +++ b/modules/newhorizons/rendering/renderablemodelprojection.cpp @@ -104,13 +104,13 @@ documentation::Documentation RenderableModelProjection::Documentation() { RenderableModelProjection::RenderableModelProjection(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _colorTexturePath({ "colorTexture", "Color Texture", "" }) // @TODO Missing documentation - , _rotation({ "rotation", "Rotation", "" }, glm::vec3(0.f), glm::vec3(0.f), glm::vec3(360.f)) // @TODO Missing documentation + , _colorTexturePath({ "ColorTexture", "Color Texture", "" }) // @TODO Missing documentation + , _rotation({ "Rotation", "Rotation", "" }, glm::vec3(0.f), glm::vec3(0.f), glm::vec3(360.f)) // @TODO Missing documentation , _programObject(nullptr) , _fboProgramObject(nullptr) , _baseTexture(nullptr) , _geometry(nullptr) - , _performShading({ "performShading", "Perform Shading", "" }, true) // @TODO Missing documentation + , _performShading({ "PerformShading", "Perform Shading", "" }, true) // @TODO Missing documentation { documentation::testSpecificationAndThrow( Documentation(), diff --git a/modules/newhorizons/rendering/renderableplanetprojection.cpp b/modules/newhorizons/rendering/renderableplanetprojection.cpp index 67922bcde2..6726b36e28 100644 --- a/modules/newhorizons/rendering/renderableplanetprojection.cpp +++ b/modules/newhorizons/rendering/renderableplanetprojection.cpp @@ -121,16 +121,16 @@ documentation::Documentation RenderablePlanetProjection::Documentation() { RenderablePlanetProjection::RenderablePlanetProjection(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _colorTexturePath({ "planetTexture", "RGB Texture", "" }) // @TODO Missing documentation - , _heightMapTexturePath({ "heightMap", "Heightmap Texture", "" }) // @TODO Missing documentation - , _rotation({ "rotation", "Rotation", "" }, 0, 0, 360) // @TODO Missing documentation + , _colorTexturePath({ "PlanetTexture", "RGB Texture", "" }) // @TODO Missing documentation + , _heightMapTexturePath({ "HeightMap", "Heightmap Texture", "" }) // @TODO Missing documentation + , _rotation({ "Rotation", "Rotation", "" }, 0, 0, 360) // @TODO Missing documentation , _programObject(nullptr) , _fboProgramObject(nullptr) , _baseTexture(nullptr) , _heightMapTexture(nullptr) - , _shiftMeridianBy180({ "shiftMeiridian", "Shift Meridian by 180 deg", "" }, false) // @TODO Missing documentation - , _heightExaggeration({ "heightExaggeration", "Height Exaggeration", "" }, 1.f, 0.f, 100.f) // @TODO Missing documentation - , _debugProjectionTextureRotation({ "debug.projectionTextureRotation", "Projection Texture Rotation", "" }, 0.f, 0.f, 360.f) // @TODO Missing documentation + , _shiftMeridianBy180({ "ShiftMeiridian", "Shift Meridian by 180 deg", "" }, false) // @TODO Missing documentation + , _heightExaggeration({ "HeightExaggeration", "Height Exaggeration", "" }, 1.f, 0.f, 100.f) // @TODO Missing documentation + , _debugProjectionTextureRotation({ "Debug.ProjectionTextureRotation", "Projection Texture Rotation", "" }, 0.f, 0.f, 360.f) // @TODO Missing documentation , _capture(false) { documentation::testSpecificationAndThrow( diff --git a/modules/newhorizons/rendering/renderableshadowcylinder.cpp b/modules/newhorizons/rendering/renderableshadowcylinder.cpp index c4555346fb..b49e14619d 100644 --- a/modules/newhorizons/rendering/renderableshadowcylinder.cpp +++ b/modules/newhorizons/rendering/renderableshadowcylinder.cpp @@ -46,9 +46,9 @@ namespace openspace { RenderableShadowCylinder::RenderableShadowCylinder(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _numberOfPoints({ "amountOfPoints", "Points", "" }, 190, 1, 300) // @TODO Missing documentation - , _shadowLength({ "shadowLength", "Shadow Length", "" }, 0.1f, 0.0f, 0.5f) // @TODO Missing documentation - , _shadowColor({ "shadowColor", "Shadow Color", "" }, // @TODO Missing documentation + , _numberOfPoints({ "AmountOfPoints", "Points", "" }, 190, 1, 300) // @TODO Missing documentation + , _shadowLength({ "ShadowLength", "Shadow Length", "" }, 0.1f, 0.0f, 0.5f) // @TODO Missing documentation + , _shadowColor({ "ShadowColor", "Shadow Color", "" }, // @TODO Missing documentation glm::vec4(1.f, 1.f, 1.f, 0.25f), glm::vec4(0.f), glm::vec4(1.f)) , _shader(nullptr) , _vao(0) diff --git a/modules/newhorizons/util/projectioncomponent.cpp b/modules/newhorizons/util/projectioncomponent.cpp index d58ba518a0..11c9797a9d 100644 --- a/modules/newhorizons/util/projectioncomponent.cpp +++ b/modules/newhorizons/util/projectioncomponent.cpp @@ -168,11 +168,11 @@ documentation::Documentation ProjectionComponent::Documentation() { ProjectionComponent::ProjectionComponent() : properties::PropertyOwner("ProjectionComponent") - , _performProjection({ "performProjection", "Perform Projections", "" }, true) // @TODO Missing documentation - , _clearAllProjections({ "clearAllProjections", "Clear Projections", "" }, false) // @TODO Missing documentation - , _projectionFading({ "projectionFading", "Projection Fading", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation - , _textureSize({ "textureSize", "Texture Size", "" }, ivec2(16), ivec2(16), ivec2(32768)) // @TODO Missing documentation - , _applyTextureSize({ "applyTextureSize", "Apply Texture Size", "" }) // @TODO Missing documentation + , _performProjection({ "PerformProjection", "Perform Projections", "" }, true) // @TODO Missing documentation + , _clearAllProjections({ "ClearAllProjections", "Clear Projections", "" }, false) // @TODO Missing documentation + , _projectionFading({ "ProjectionFading", "Projection Fading", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation + , _textureSize({ "TextureSize", "Texture Size", "" }, ivec2(16), ivec2(16), ivec2(32768)) // @TODO Missing documentation + , _applyTextureSize({ "ApplyTextureSize", "Apply Texture Size", "" }) // @TODO Missing documentation , _textureSizeDirty(false) , _projectionTexture(nullptr) { diff --git a/modules/onscreengui/src/guicomponent.cpp b/modules/onscreengui/src/guicomponent.cpp index e2bcbd2afb..21a8f8d741 100644 --- a/modules/onscreengui/src/guicomponent.cpp +++ b/modules/onscreengui/src/guicomponent.cpp @@ -28,7 +28,7 @@ namespace openspace::gui { GuiComponent::GuiComponent(std::string name) : properties::PropertyOwner(std::move(name)) - , _isEnabled({ "enabled", "Is Enabled", "" }, false) // @TODO Missing documentation + , _isEnabled({ "Enabled", "Is Enabled", "" }, false) // @TODO Missing documentation { addProperty(_isEnabled); } diff --git a/modules/onscreengui/src/guiperformancecomponent.cpp b/modules/onscreengui/src/guiperformancecomponent.cpp index 19d4d357b0..40bbab94cd 100644 --- a/modules/onscreengui/src/guiperformancecomponent.cpp +++ b/modules/onscreengui/src/guiperformancecomponent.cpp @@ -55,10 +55,10 @@ namespace openspace::gui { GuiPerformanceComponent::GuiPerformanceComponent() : GuiComponent("PerformanceComponent") - , _sortingSelection({ "sortingSelection", "Sorting", "" }, -1, -1, 6) // @TODO Missing documentation - , _sceneGraphIsEnabled({ "showSceneGraph", "Show Scene Graph Measurements", "" }, false) // @TODO Missing documentation - , _functionsIsEnabled({ "showFunctions", "Show Function Measurements", "" }, false) // @TODO Missing documentation - , _outputLogs({ "outputLogs", "Output Logs", "" }, false) // @TODO Missing documentation + , _sortingSelection({ "SortingSelection", "Sorting", "" }, -1, -1, 6) // @TODO Missing documentation + , _sceneGraphIsEnabled({ "ShowSceneGraph", "Show Scene Graph Measurements", "" }, false) // @TODO Missing documentation + , _functionsIsEnabled({ "ShowFunctions", "Show Function Measurements", "" }, false) // @TODO Missing documentation + , _outputLogs({ "OutputLogs", "Output Logs", "" }, false) // @TODO Missing documentation { addProperty(_sortingSelection); diff --git a/modules/space/rendering/renderableconstellationbounds.cpp b/modules/space/rendering/renderableconstellationbounds.cpp index 75f01a9827..79f9ff1aa8 100644 --- a/modules/space/rendering/renderableconstellationbounds.cpp +++ b/modules/space/rendering/renderableconstellationbounds.cpp @@ -90,8 +90,8 @@ RenderableConstellationBounds::RenderableConstellationBounds( : Renderable(dictionary) , _vertexFilename("") , _constellationFilename("") - , _distance({ "distance", "Distance to the celestial Sphere", "" }, 15.f, 0.f, 30.f) // @TODO Missing documentation - , _constellationSelection({ "constellationSelection", "Constellation Selection", "" }) // @TODO Missing documentation + , _distance({ "Distance", "Distance to the celestial Sphere", "" }, 15.f, 0.f, 30.f) // @TODO Missing documentation + , _constellationSelection({ "ConstellationSelection", "Constellation Selection", "" }) // @TODO Missing documentation , _vao(0) , _vbo(0) { diff --git a/modules/space/rendering/renderableplanet.cpp b/modules/space/rendering/renderableplanet.cpp index 11eb07bc2c..c4bf732375 100644 --- a/modules/space/rendering/renderableplanet.cpp +++ b/modules/space/rendering/renderableplanet.cpp @@ -121,15 +121,15 @@ documentation::Documentation RenderablePlanet::Documentation() { RenderablePlanet::RenderablePlanet(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _colorTexturePath({ "colorTexture", "Color Texture", "" }) // @TODO Missing documentation - , _nightTexturePath({ "nightTexture", "Night Texture", "" }) // @TODO Missing documentation - , _heightMapTexturePath({ "heightMap", "Heightmap Texture", "" }) // @TODO Missing documentation + , _colorTexturePath({ "ColorTexture", "Color Texture", "" }) // @TODO Missing documentation + , _nightTexturePath({ "NightTexture", "Night Texture", "" }) // @TODO Missing documentation + , _heightMapTexturePath({ "HeightMap", "Heightmap Texture", "" }) // @TODO Missing documentation , _programObject(nullptr) , _texture(nullptr) , _nightTexture(nullptr) - , _heightExaggeration({ "heightExaggeration", "Height Exaggeration", "" }, 1.f, 0.f, 10.f) // @TODO Missing documentation + , _heightExaggeration({ "HeightExaggeration", "Height Exaggeration", "" }, 1.f, 0.f, 10.f) // @TODO Missing documentation , _geometry(nullptr) - , _performShading({ "performShading", "Perform Shading", "" }, true) // @TODO Missing documentation + , _performShading({ "PerformShading", "Perform Shading", "" }, true) // @TODO Missing documentation , _alpha(1.f) , _planetRadius(0.f) , _hasNightTexture(false) diff --git a/modules/space/rendering/renderablerings.cpp b/modules/space/rendering/renderablerings.cpp index 1e9bc0b33c..7598a1d4ba 100644 --- a/modules/space/rendering/renderablerings.cpp +++ b/modules/space/rendering/renderablerings.cpp @@ -85,11 +85,11 @@ documentation::Documentation RenderableRings::Documentation() { RenderableRings::RenderableRings(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _texturePath({ "texture", "Texture", "" }) // @TODO Missing documentation - , _size({ "size", "Size", "" }, 1.f, 0.f, std::pow(1.f, 25.f)) // @TODO Missing documentation - , _offset({ "offset", "Offset", "" }, glm::vec2(0, 1.f), glm::vec2(0.f), glm::vec2(1.f)) // @TODO Missing documentation - , _nightFactor({ "nightFactor", "Night Factor", "" }, 0.33f, 0.f, 1.f) // @TODO Missing documentation - , _transparency({ "transparency", "Transparency", "" }, 0.15f, 0.f, 1.f) // @TODO Missing documentation + , _texturePath({ "Texture", "Texture", "" }) // @TODO Missing documentation + , _size({ "Size", "Size", "" }, 1.f, 0.f, std::pow(1.f, 25.f)) // @TODO Missing documentation + , _offset({ "Offset", "Offset", "" }, glm::vec2(0, 1.f), glm::vec2(0.f), glm::vec2(1.f)) // @TODO Missing documentation + , _nightFactor({ "NightFactor", "Night Factor", "" }, 0.33f, 0.f, 1.f) // @TODO Missing documentation + , _transparency({ "Transparency", "Transparency", "" }, 0.15f, 0.f, 1.f) // @TODO Missing documentation , _shader(nullptr) , _texture(nullptr) , _textureFile(nullptr) diff --git a/modules/space/rendering/renderablestars.cpp b/modules/space/rendering/renderablestars.cpp index ebdd77e719..0e16a93cdd 100644 --- a/modules/space/rendering/renderablestars.cpp +++ b/modules/space/rendering/renderablestars.cpp @@ -125,20 +125,20 @@ documentation::Documentation RenderableStars::Documentation() { RenderableStars::RenderableStars(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _pointSpreadFunctionTexturePath({ "psfTexture", "Point Spread Function Texture", "" }) // @TODO Missing documentation + , _pointSpreadFunctionTexturePath({ "PsfTexture", "Point Spread Function Texture", "" }) // @TODO Missing documentation , _pointSpreadFunctionTexture(nullptr) , _pointSpreadFunctionTextureIsDirty(true) - , _colorTexturePath({ "colorTexture", "ColorBV Texture", "" }) // @TODO Missing documentation + , _colorTexturePath({ "ColorTexture", "ColorBV Texture", "" }) // @TODO Missing documentation , _colorTexture(nullptr) , _colorTextureIsDirty(true) , _colorOption( - { "colorOption", "Color Option", "" }, // @TODO Missing documentation + { "ColorOption", "Color Option", "" }, // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) , _dataIsDirty(true) - , _alphaValue({ "alphaValue", "Transparency", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation - , _scaleFactor({ "scaleFactor", "Scale Factor", "" }, 1.f, 0.f, 10.f) // @TODO Missing documentation - , _minBillboardSize({ "minBillboardSize", "Min Billboard Size", "" }, 1.f, 1.f, 100.f) // @TODO Missing documentation + , _alphaValue({ "AlphaValue", "Transparency", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation + , _scaleFactor({ "ScaleFactor", "Scale Factor", "" }, 1.f, 0.f, 10.f) // @TODO Missing documentation + , _minBillboardSize({ "MinBillboardSize", "Min Billboard Size", "" }, 1.f, 1.f, 100.f) // @TODO Missing documentation , _program(nullptr) , _speckFile("") , _nValuesPerStar(0) diff --git a/modules/space/rendering/simplespheregeometry.cpp b/modules/space/rendering/simplespheregeometry.cpp index f090b76b7f..7d97071129 100644 --- a/modules/space/rendering/simplespheregeometry.cpp +++ b/modules/space/rendering/simplespheregeometry.cpp @@ -39,11 +39,11 @@ namespace openspace::planetgeometry { SimpleSphereGeometry::SimpleSphereGeometry(const ghoul::Dictionary& dictionary) : PlanetGeometry() , _radius( - { "radius", "Radius", "" }, // @TODO Missing documentation + { "Radius", "Radius", "" }, // @TODO Missing documentation glm::vec3(1.f, 1.f, 1.f), glm::vec3(0.f, 0.f, 0.f), glm::vec3(std::pow(10.f, 20.f), std::pow(10.f, 20.f), std::pow(10.f, 20.f))) - , _segments({ "segments", "Segments", "" }, 20, 1, 5000) // @TODO Missing documentation + , _segments({ "Segments", "Segments", "" }, 20, 1, 5000) // @TODO Missing documentation , _sphere(nullptr) { float sphereRadius = 0.f; diff --git a/modules/space/rotation/spicerotation.cpp b/modules/space/rotation/spicerotation.cpp index ed7cf6826b..d778a2039e 100644 --- a/modules/space/rotation/spicerotation.cpp +++ b/modules/space/rotation/spicerotation.cpp @@ -83,8 +83,8 @@ documentation::Documentation SpiceRotation::Documentation() { } SpiceRotation::SpiceRotation(const ghoul::Dictionary& dictionary) - : _sourceFrame({ "source", "Source", "" }) // @TODO Missing documentation - , _destinationFrame({ "destination", "Destination", "" }) // @TODO Missing documentation + : _sourceFrame({ "Source", "Source", "" }) // @TODO Missing documentation + , _destinationFrame({ "Destination", "Destination", "" }) // @TODO Missing documentation { documentation::testSpecificationAndThrow( Documentation(), diff --git a/modules/space/translation/keplertranslation.cpp b/modules/space/translation/keplertranslation.cpp index 60fb8432bc..3ad84c468b 100644 --- a/modules/space/translation/keplertranslation.cpp +++ b/modules/space/translation/keplertranslation.cpp @@ -142,24 +142,24 @@ documentation::Documentation KeplerTranslation::Documentation() { KeplerTranslation::KeplerTranslation() : Translation() - , _eccentricity({ "eccentricity", "Eccentricity", "" }, 0.0, 0.0, 1.0) // @TODO Missing documentation - , _semiMajorAxis({ "semimajorAxis", "Semi-major axis", "" }, 0.0, 0.0, 1e6) // @TODO Missing documentation - , _inclination({ "inclination", "Inclination", "" }, 0.0, 0.0, 360.0) // @TODO Missing documentation + , _eccentricity({ "Eccentricity", "Eccentricity", "" }, 0.0, 0.0, 1.0) // @TODO Missing documentation + , _semiMajorAxis({ "SemimajorAxis", "Semi-major axis", "" }, 0.0, 0.0, 1e6) // @TODO Missing documentation + , _inclination({ "Inclination", "Inclination", "" }, 0.0, 0.0, 360.0) // @TODO Missing documentation , _ascendingNode( - { "ascendingNode", "Right ascension of ascending Node", "" }, // @TODO Missing documentation + { "AscendingNode", "Right ascension of ascending Node", "" }, // @TODO Missing documentation 0.0, 0.0, 360.0 ) , _argumentOfPeriapsis( - { "argumentOfPeriapsis", "Argument of Periapsis", "" }, // @TODO Missing documentation + { "ArgumentOfPeriapsis", "Argument of Periapsis", "" }, // @TODO Missing documentation 0.0, 0.0, 360.0 ) - , _meanAnomalyAtEpoch({ "meanAnomalyAtEpoch", "Mean anomaly at epoch", "" }, 0.0, 0.0, 360.0) // @TODO Missing documentation - , _epoch({ "epoch", "Epoch", "" }, 0.0, 0.0, 1e9) // @TODO Missing documentation - , _period({ "period", "Orbit period", "" }, 0.0, 0.0, 1e6) // @TODO Missing documentation + , _meanAnomalyAtEpoch({ "MeanAnomalyAtEpoch", "Mean anomaly at epoch", "" }, 0.0, 0.0, 360.0) // @TODO Missing documentation + , _epoch({ "Epoch", "Epoch", "" }, 0.0, 0.0, 1e9) // @TODO Missing documentation + , _period({ "Period", "Orbit period", "" }, 0.0, 0.0, 1e6) // @TODO Missing documentation , _orbitPlaneDirty(true) { auto update = [this]() { diff --git a/modules/space/translation/spicetranslation.cpp b/modules/space/translation/spicetranslation.cpp index 54e928b484..4f3411f868 100644 --- a/modules/space/translation/spicetranslation.cpp +++ b/modules/space/translation/spicetranslation.cpp @@ -99,9 +99,9 @@ documentation::Documentation SpiceTranslation::Documentation() { } SpiceTranslation::SpiceTranslation(const ghoul::Dictionary& dictionary) - : _target({ "target", "Target", "" }) // @TODO Missing documentation - , _origin({ "origin", "Origin", "" }) // @TODO Missing documentation - , _frame({ "frame", "Reference Frame", "" }, DefaultReferenceFrame) // @TODO Missing documentation + : _target({ "Target", "Target", "" }) // @TODO Missing documentation + , _origin({ "Origin", "Origin", "" }) // @TODO Missing documentation + , _frame({ "Frame", "Reference Frame", "" }, DefaultReferenceFrame) // @TODO Missing documentation { documentation::testSpecificationAndThrow( Documentation(), diff --git a/modules/touch/src/touchinteraction.cpp b/modules/touch/src/touchinteraction.cpp index 72c6617d80..55ec5a0146 100644 --- a/modules/touch/src/touchinteraction.cpp +++ b/modules/touch/src/touchinteraction.cpp @@ -74,7 +74,7 @@ namespace openspace { TouchInteraction::TouchInteraction() : properties::PropertyOwner("TouchInteraction") - , _origin({ "origin", "Origin", "" }) // @TODO Missing documentation + , _origin({ "Origin", "Origin", "" }) // @TODO Missing documentation , _unitTest( { "Click to take a unit test", "Take a unit test saving the LM data into file", "" }, // @TODO Missing documentation false diff --git a/modules/toyvolume/rendering/renderabletoyvolume.cpp b/modules/toyvolume/rendering/renderabletoyvolume.cpp index 103b243293..cf862861a7 100644 --- a/modules/toyvolume/rendering/renderabletoyvolume.cpp +++ b/modules/toyvolume/rendering/renderabletoyvolume.cpp @@ -37,12 +37,12 @@ namespace openspace { RenderableToyVolume::RenderableToyVolume(const ghoul::Dictionary& dictionary) : Renderable(dictionary) - , _scalingExponent({ "scalingExponent", "Scaling Exponent", "" }, 1, -10, 20) - , _stepSize({ "stepSize", "Step Size", "" }, 0.02f, 0.01f, 1.f) // @TODO Missing documentation - , _scaling({ "scaling", "Scaling", "" }, glm::vec3(1.f, 1.f, 1.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation - , _translation({ "translation", "Translation", "" }, glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation - , _rotation({ "rotation", "Euler rotation", "" }, glm::vec3(0.f, 0.f, 0.f), glm::vec3(0), glm::vec3(6.28f)) // @TODO Missing documentation - , _color({ "color", "Color", "" }, glm::vec4(1.f, 0.f, 0.f, 0.1f), glm::vec4(0.f), glm::vec4(1.f)) // @TODO Missing documentation + , _scalingExponent({ "ScalingExponent", "Scaling Exponent", "" }, 1, -10, 20) + , _stepSize({ "StepSize", "Step Size", "" }, 0.02f, 0.01f, 1.f) // @TODO Missing documentation + , _scaling({ "Scaling", "Scaling", "" }, glm::vec3(1.f, 1.f, 1.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation + , _translation({ "Translation", "Translation", "" }, glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(10.f)) // @TODO Missing documentation + , _rotation({ "Rotation", "Euler rotation", "" }, glm::vec3(0.f, 0.f, 0.f), glm::vec3(0), glm::vec3(6.28f)) // @TODO Missing documentation + , _color({ "Color", "Color", "" }, glm::vec4(1.f, 0.f, 0.f, 0.1f), glm::vec4(0.f), glm::vec4(1.f)) // @TODO Missing documentation { float stepSize; int scalingExponent; diff --git a/modules/volume/rendering/volumeclipplane.cpp b/modules/volume/rendering/volumeclipplane.cpp index 0ae65b6c21..f160e74999 100644 --- a/modules/volume/rendering/volumeclipplane.cpp +++ b/modules/volume/rendering/volumeclipplane.cpp @@ -31,13 +31,13 @@ namespace openspace { VolumeClipPlane::VolumeClipPlane(const ghoul::Dictionary& dictionary) : _normal( - { "normal", "Normal", "" }, // @TODO Missing documentation + { "Normal", "Normal", "" }, // @TODO Missing documentation glm::vec3(1.f, 0.f, 0.f), glm::vec3(-1.f), glm::vec3(1.f) ) , _offsets( - { "offsets", "Offsets", "" }, // @TODO Missing documentation + { "Offsets", "Offsets", "" }, // @TODO Missing documentation glm::vec2(-2.f, 0.f), glm::vec2(-2.f, 0.f), glm::vec2(2.f, 1.f) diff --git a/src/engine/openspaceengine.cpp b/src/engine/openspaceengine.cpp index 8708f2b613..082452fe34 100644 --- a/src/engine/openspaceengine.cpp +++ b/src/engine/openspaceengine.cpp @@ -1354,7 +1354,8 @@ scripting::LuaLibrary OpenSpaceEngine::luaLibrary() { { "addVirtualProperty", &luascriptfunctions::addVirtualProperty, - "type, name, identifier, [value, minimumValue, maximumValue]", + "type, name, identifier, description," + "[value, minimumValue, maximumValue]", "Adds a virtual property that will set a group of properties" }, { diff --git a/src/engine/settingsengine.cpp b/src/engine/settingsengine.cpp index b058fcba0d..f2be574d63 100644 --- a/src/engine/settingsengine.cpp +++ b/src/engine/settingsengine.cpp @@ -42,11 +42,11 @@ namespace openspace { SettingsEngine::SettingsEngine() : properties::PropertyOwner("Global Properties") - , _scenes({ "scenes", "Scene", "" }, properties::OptionProperty::DisplayType::Dropdown) // @TODO Missing documentation - , _busyWaitForDecode({ "busyWaitForDecode", "Busy Wait for decode", "" }, false) // @TODO Missing documentation - , _logSGCTOutOfOrderErrors({ "logSGCTOutOfOrderErrors", "Log SGCT out-of-order", "" }, false) // @TODO Missing documentation - , _useDoubleBuffering({ "useDoubleBuffering", "Use double buffering", "" }, false) // @TODO Missing documentation - , _spiceUseExceptions({ "enableSpiceExceptions", "Enable Spice Exceptions", "" }, false) // @TODO Missing documentation + , _scenes({ "Scenes", "Scene", "" }, properties::OptionProperty::DisplayType::Dropdown) // @TODO Missing documentation + , _busyWaitForDecode({ "BusyWaitForDecode", "Busy Wait for decode", "" }, false) // @TODO Missing documentation + , _logSGCTOutOfOrderErrors({ "LogSGCTOutOfOrderErrors", "Log SGCT out-of-order", "" }, false) // @TODO Missing documentation + , _useDoubleBuffering({ "UseDoubleBuffering", "Use double buffering", "" }, false) // @TODO Missing documentation + , _spiceUseExceptions({ "EnableSpiceExceptions", "Enable Spice Exceptions", "" }, false) // @TODO Missing documentation { _spiceUseExceptions.onChange([this] { SpiceManager::ref().setExceptionHandling( diff --git a/src/engine/wrapper/sgctwindowwrapper.cpp b/src/engine/wrapper/sgctwindowwrapper.cpp index 36ecd58d84..416937a8db 100644 --- a/src/engine/wrapper/sgctwindowwrapper.cpp +++ b/src/engine/wrapper/sgctwindowwrapper.cpp @@ -36,8 +36,8 @@ namespace { namespace openspace { SGCTWindowWrapper::SGCTWindowWrapper() - : _eyeSeparation({ "eyeSeparation", "Eye Separation", "" }, 0.f, 0.f, 10.f) // @TODO Missing documentation - , _showStatsGraph({ "showStatsGraph", "Show Stats Graph", "" }, false) // @TODO Missing documentation + : _eyeSeparation({ "EyeSeparation", "Eye Separation", "" }, 0.f, 0.f, 10.f) // @TODO Missing documentation + , _showStatsGraph({ "ShowStatsGraph", "Show Stats Graph", "" }, false) // @TODO Missing documentation { _showStatsGraph.onChange([this](){ sgct::Engine::instance()->setStatsGraphVisibility(_showStatsGraph); diff --git a/src/interaction/luaconsole.cpp b/src/interaction/luaconsole.cpp index ccf87326b6..d2b0e3a028 100644 --- a/src/interaction/luaconsole.cpp +++ b/src/interaction/luaconsole.cpp @@ -75,39 +75,39 @@ namespace openspace { LuaConsole::LuaConsole() : properties::PropertyOwner("LuaConsole") - , _isVisible({ "isVisible", "Is Visible", "" }, false) // @TODO Missing documentation - , _remoteScripting({ "remoteScripting", "Remote scripting", "" }, false) // @TODO Missing documentation + , _isVisible({ "IsVisible", "Is Visible", "" }, false) // @TODO Missing documentation + , _remoteScripting({ "RemoteScripting", "Remote scripting", "" }, false) // @TODO Missing documentation , _backgroundColor( - { "backgroundColor", "Background Color", "" }, // @TODO Missing documentation + { "BackgroundColor", "Background Color", "" }, // @TODO Missing documentation glm::vec4(21.f / 255.f, 23.f / 255.f, 28.f / 255.f, 0.8f), glm::vec4(0.f), glm::vec4(1.f) ) , _highlightColor( - { "highlightColor", "Highlight Color", "" }, // @TODO Missing documentation + { "HighlightColor", "Highlight Color", "" }, // @TODO Missing documentation glm::vec4(1.f, 1.f, 1.f, 0.f), glm::vec4(0.f), glm::vec4(1.f) ) , _separatorColor( - { "separatorColor", "Separator Color", "" }, // @TODO Missing documentation + { "SeparatorColor", "Separator Color", "" }, // @TODO Missing documentation glm::vec4(0.4f, 0.4f, 0.4f, 0.f), glm::vec4(0.f), glm::vec4(1.f) ) , _entryTextColor( - { "entryTextColor", "Entry Text Color", "" }, // @TODO Missing documentation + { "EntryTextColor", "Entry Text Color", "" }, // @TODO Missing documentation glm::vec4(1.f, 1.f, 1.f, 1.f), glm::vec4(0.f), glm::vec4(1.f) ) , _historyTextColor( - { "historyTextColor", "History Text Color", "" }, // @TODO Missing documentation + { "HistoryTextColor", "History Text Color", "" }, // @TODO Missing documentation glm::vec4(1.0f, 1.0f, 1.0f, 0.65f), glm::vec4(0.f), glm::vec4(1.f) ) - , _historyLength({ "historyLength", "History Length", "" }, 13, 0, 100) // @TODO Missing documentation + , _historyLength({ "HistoryLength", "History Length", "" }, 13, 0, 100) // @TODO Missing documentation , _inputPosition(0) , _activeCommand(0) , _autoCompleteInfo({NoAutoComplete, false, ""}) diff --git a/src/interaction/navigationhandler.cpp b/src/interaction/navigationhandler.cpp index 5fec81b06e..835d19f1f7 100644 --- a/src/interaction/navigationhandler.cpp +++ b/src/interaction/navigationhandler.cpp @@ -54,8 +54,8 @@ namespace openspace::interaction { NavigationHandler::NavigationHandler() : properties::PropertyOwner("NavigationHandler") - , _origin({ "origin", "Origin", "" }) // @TODO Missing documentation - , _useKeyFrameInteraction({ "useKeyFrameInteraction", "Use keyframe interaction", "" }, false) // @TODO Missing documentation + , _origin({ "Origin", "Origin", "" }) // @TODO Missing documentation + , _useKeyFrameInteraction({ "UseKeyFrameInteraction", "Use keyframe interaction", "" }, false) // @TODO Missing documentation { _origin.onChange([this]() { SceneGraphNode* node = sceneGraphNode(_origin.value()); diff --git a/src/interaction/orbitalnavigator.cpp b/src/interaction/orbitalnavigator.cpp index 693750ff1c..ca9ccb32d0 100644 --- a/src/interaction/orbitalnavigator.cpp +++ b/src/interaction/orbitalnavigator.cpp @@ -41,18 +41,18 @@ namespace openspace::interaction { OrbitalNavigator::OrbitalNavigator() : properties::PropertyOwner("OrbitalNavigator") - , _rotationalFriction({ "rotationalFriction", "Rotational friction", "" }, true) // @TODO Missing documentation - , _horizontalFriction({ "horizontalFriction", "Horizontal friction", "" }, true) // @TODO Missing documentation - , _verticalFriction({ "verticalFriction", "Vertical friction", "" }, true) // @TODO Missing documentation + , _rotationalFriction({ "RotationalFriction", "Rotational friction", "" }, true) // @TODO Missing documentation + , _horizontalFriction({ "HorizontalFriction", "Horizontal friction", "" }, true) // @TODO Missing documentation + , _verticalFriction({ "VerticalFriction", "Vertical friction", "" }, true) // @TODO Missing documentation , _followFocusNodeRotationDistance( - { "followFocusNodeRotationDistance", "Follow focus node rotation distance", "" }, // @TODO Missing documentation + { "FollowFocusNodeRotationDistance", "Follow focus node rotation distance", "" }, // @TODO Missing documentation 2.0f, 0.0f, 10.f ) , _minimumAllowedDistance( - {"minimumAllowedDistance", "Minimum allowed distance", "" }, // @TODO Missing documentation + {"MinimumAllowedDistance", "Minimum allowed distance", "" }, // @TODO Missing documentation 10.0f, 0.0f, 10000.f) - , _sensitivity({ "sensitivity", "Sensitivity", "" }, 20.0f, 1.0f, 50.f) // @TODO Missing documentation - , _motionLag({ "motionLag", "Motion lag", "" }, 0.5f, 0.f, 1.f) // @TODO Missing documentation + , _sensitivity({ "Sensitivity", "Sensitivity", "" }, 20.0f, 1.0f, 50.f) // @TODO Missing documentation + , _motionLag({ "MotionLag", "Motion lag", "" }, 0.5f, 0.f, 1.f) // @TODO Missing documentation , _mouseStates(_sensitivity * pow(10.0,-4), 1 / (_motionLag + 0.0000001)) { auto smoothStep = diff --git a/src/network/parallelconnection.cpp b/src/network/parallelconnection.cpp index c080cfb44c..45ac3c0f9c 100644 --- a/src/network/parallelconnection.cpp +++ b/src/network/parallelconnection.cpp @@ -87,25 +87,25 @@ namespace openspace { ParallelConnection::ParallelConnection() : properties::PropertyOwner("ParallelConnection") - , _password({ "password", "Password", "" }) // @TODO Missing documentation - , _hostPassword({ "hostPassword", "Host Password", "" }) // @TODO Missing documentation - , _port({ "port", "Port", "" }, "20501") // @TODO Missing documentation - , _address({ "address", "Address", "" }, "localhost") // @TODO Missing documentation - , _name({ "name", "Connection name", "" }, "Anonymous") // @TODO Missing documentation - , _bufferTime({ "bufferTime", "Buffer Time", "" }, 1, 0.5, 10) // @TODO Missing documentation + , _password({ "Password", "Password", "" }) // @TODO Missing documentation + , _hostPassword({ "HostPassword", "Host Password", "" }) // @TODO Missing documentation + , _port({ "Port", "Port", "" }, "20501") // @TODO Missing documentation + , _address({ "Address", "Address", "" }, "localhost") // @TODO Missing documentation + , _name({ "Name", "Connection name", "" }, "Anonymous") // @TODO Missing documentation + , _bufferTime({ "BufferTime", "Buffer Time", "" }, 1, 0.5, 10) // @TODO Missing documentation , _timeKeyframeInterval( - { "timeKeyframeInterval", "Time keyframe interval", ""}, // @TODO Missing documentation + { "TimeKeyframeInterval", "Time keyframe interval", ""}, // @TODO Missing documentation 0.1f, 0.f, 1.f ) , _cameraKeyframeInterval( - { "cameraKeyframeInterval", "Camera Keyframe interval", "" }, // @TODO Missing documentation + { "CameraKeyframeInterval", "Camera Keyframe interval", "" }, // @TODO Missing documentation 0.1f, 0.f, 1.f ) - , _timeTolerance({ "timeTolerance", "Time tolerance", "" }, 1.f, 0.5f, 5.f) // @TODO Missing documentation + , _timeTolerance({ "TimeTolerance", "Time tolerance", "" }, 1.f, 0.5f, 5.f) // @TODO Missing documentation , _lastTimeKeyframeTimestamp(0) , _lastCameraKeyframeTimestamp(0) , _clientSocket(INVALID_SOCKET) diff --git a/src/rendering/renderable.cpp b/src/rendering/renderable.cpp index e0a9410daf..dd2c012c99 100644 --- a/src/rendering/renderable.cpp +++ b/src/rendering/renderable.cpp @@ -93,7 +93,7 @@ std::unique_ptr Renderable::createFromDictionary( Renderable::Renderable() : properties::PropertyOwner("renderable") - , _enabled({ "enabled", "Is Enabled", "" }, true) // @TODO Missing documentation + , _enabled({ "Enabled", "Is Enabled", "" }, true) // @TODO Missing documentation , _renderBin(RenderBin::Opaque) , _startTime("") , _endTime("") @@ -102,7 +102,7 @@ Renderable::Renderable() Renderable::Renderable(const ghoul::Dictionary& dictionary) : properties::PropertyOwner("renderable") - , _enabled({ "enabled", "Is Enabled", "" }, true) // @TODO Missing documentation + , _enabled({ "Enabled", "Is Enabled", "" }, true) // @TODO Missing documentation , _renderBin(RenderBin::Opaque) , _startTime("") , _endTime("") diff --git a/src/rendering/renderengine.cpp b/src/rendering/renderengine.cpp index 94ddb55505..12643c9281 100644 --- a/src/rendering/renderengine.cpp +++ b/src/rendering/renderengine.cpp @@ -100,32 +100,32 @@ RenderEngine::RenderEngine() , _camera(nullptr) , _scene(nullptr) , _raycasterManager(nullptr) - , _performanceMeasurements({ "performanceMeasurements", "Performance Measurements", "" }) // @TODO Missing documentation + , _performanceMeasurements({ "PerformanceMeasurements", "Performance Measurements", "" }) // @TODO Missing documentation , _performanceManager(nullptr) , _renderer(nullptr) , _rendererImplementation(RendererImplementation::Invalid) , _log(nullptr) , _frametimeType( - { "frametimeType", "Type of the frametime display", "" }, // @TODO Missing documentation + { "FrametimeType", "Type of the frametime display", "" }, // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) - , _showDate({ "showDate", "Show Date Information", "" }, true) // @TODO Missing documentation - , _showInfo({ "showInfo", "Show Render Information", "" }, true) // @TODO Missing documentation - , _showLog({ "showLog", "Show the OnScreen log", "" }, true) // @TODO Missing documentation - , _takeScreenshot({ "takeScreenshot", "Take Screenshot", "" }) // @TODO Missing documentation + , _showDate({ "ShowDate", "Show Date Information", "" }, true) // @TODO Missing documentation + , _showInfo({ "ShowInfo", "Show Render Information", "" }, true) // @TODO Missing documentation + , _showLog({ "ShowLog", "Show the OnScreen log", "" }, true) // @TODO Missing documentation + , _takeScreenshot({ "TakeScreenshot", "Take Screenshot", "" }) // @TODO Missing documentation , _shouldTakeScreenshot(false) - , _applyWarping({ "applyWarpingScreenshot", "Apply Warping to Screenshots", "" }, false) // @TODO Missing documentation - , _showFrameNumber({ "showFrameNumber", "Show Frame Number", "" }, false) // @TODO Missing documentation - , _disableMasterRendering({ "disableMasterRendering", "Disable Master Rendering", "" }, false) // @TODO Missing documentation + , _applyWarping({ "ApplyWarpingScreenshot", "Apply Warping to Screenshots", "" }, false) // @TODO Missing documentation + , _showFrameNumber({ "ShowFrameNumber", "Show Frame Number", "" }, false) // @TODO Missing documentation + , _disableMasterRendering({ "DisableMasterRendering", "Disable Master Rendering", "" }, false) // @TODO Missing documentation , _disableSceneTranslationOnMaster( - { "disableSceneTranslationOnMaster", "Disable Scene Translation on Master", "" }, // @TODO Missing documentation + { "DisableSceneTranslationOnMaster", "Disable Scene Translation on Master", "" }, // @TODO Missing documentation false ) , _globalBlackOutFactor(1.f) , _fadeDuration(2.f) , _currentFadeTime(0.f) , _fadeDirection(0) - , _nAaSamples({ "nAaSamples", "Number of Antialiasing samples", "" }, 8, 1, 16) // @TODO Missing documentation + , _nAaSamples({ "NAaSamples", "Number of Antialiasing samples", "" }, 8, 1, 16) // @TODO Missing documentation , _frameNumber(0) { _performanceMeasurements.onChange([this](){ diff --git a/src/rendering/screenspacerenderable.cpp b/src/rendering/screenspacerenderable.cpp index 41334a9020..fccf1bae30 100644 --- a/src/rendering/screenspacerenderable.cpp +++ b/src/rendering/screenspacerenderable.cpp @@ -98,24 +98,24 @@ std::unique_ptr ScreenSpaceRenderable::createFromDictiona ScreenSpaceRenderable::ScreenSpaceRenderable(const ghoul::Dictionary& dictionary) : properties::PropertyOwner("") - , _enabled({ "enabled", "Is Enabled", "" }, true) // @TODO Missing documentation - , _useFlatScreen({ "flatScreen", "Flat Screen", "" }, true) // @TODO Missing documentation + , _enabled({ "Enabled", "Is Enabled", "" }, true) // @TODO Missing documentation + , _useFlatScreen({ "FlatScreen", "Flat Screen", "" }, true) // @TODO Missing documentation , _euclideanPosition( - { "euclideanPosition", "Euclidean coordinates", "" }, // @TODO Missing documentation + { "EuclideanPosition", "Euclidean coordinates", "" }, // @TODO Missing documentation glm::vec2(0.f), glm::vec2(-4.f), glm::vec2(4.f) ) , _sphericalPosition( - { "sphericalPosition", "Spherical coordinates", "" }, // @TODO Missing documentation + { "SphericalPosition", "Spherical coordinates", "" }, // @TODO Missing documentation glm::vec2(0.f, static_cast(M_PI_2)), glm::vec2(-static_cast(M_PI)), glm::vec2(static_cast(M_PI)) ) - , _depth({ "depth", "Depth", "" }, 0.f, 0.f, 1.f) // @TODO Missing documentation - , _scale({ "scale", "Scale", "" }, 0.25f, 0.f, 2.f) // @TODO Missing documentation - , _alpha({ "alpha", "Alpha", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation - , _delete({ "delete", "Delete", "" }) // @TODO Missing documentation + , _depth({ "Depth", "Depth", "" }, 0.f, 0.f, 1.f) // @TODO Missing documentation + , _scale({ "Scale", "Scale", "" }, 0.25f, 0.f, 2.f) // @TODO Missing documentation + , _alpha({ "Alpha", "Alpha", "" }, 1.f, 0.f, 1.f) // @TODO Missing documentation + , _delete({ "Delete", "Delete", "" }) // @TODO Missing documentation , _quad(0) , _vertexPositionBuffer(0) , _texture(nullptr)