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

Add description to Propertys

Browse Source
This commit is contained in:
Alexander Bock
2017-07-21 16:31:58 -04:00
parent 3c213fae1e
commit b584f0197e
73 changed files with 409 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -95,10 +95,10 @@ documentation::Documentation RenderableModel::Documentation() {
RenderableModel::RenderableModel(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _geometry(nullptr)
, _colorTexturePath("colorTexture", "Color Texture")
, _performFade("performFading", "Perform Fading", false)
, _performShading("performShading", "Perform Shading", true)
, _fading("fading", "Fade", 0)
, _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)

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

@@ -87,9 +87,9 @@ documentation::Documentation RenderablePlane::Documentation() {
RenderablePlane::RenderablePlane(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _texturePath("texture", "Texture")
, _billboard("billboard", "Billboard", false)
, _size("size", "Size", 10, 0, std::pow(10, 25))
, _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)

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

@@ -92,11 +92,11 @@ documentation::Documentation RenderableSphere::Documentation() {
RenderableSphere::RenderableSphere(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _texturePath("texture", "Texture")
, _orientation("orientation", "Orientation")
, _size("size", "Size", 1.f, 0.f, std::pow(10.f, 45))
, _segments("segments", "Segments", 8, 4, 100)
, _transparency("transparency", "Transparency", 1.f, 0.f, 1.f)
, _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)

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

@@ -133,14 +133,15 @@ 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))
, _useLineFade("useLineFade", "Use Line Fade", true)
, _lineFade("lineFade", "Line Fade", 1.f, 0.f, 20.f)
, _lineWidth("lineWidth", "Line Width", 2.f, 1.f, 20.f)
, _pointSize("pointSize", "Point Size", 1, 1, 64)
, _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
properties::OptionProperty::DisplayType::Dropdown
)
{

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

@@ -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)
, _resolution("resolution", "Number of Samples along Orbit", 10000, 1, 1000000)
, _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)

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

@@ -125,15 +125,16 @@ documentation::Documentation RenderableTrailTrajectory::Documentation() {
RenderableTrailTrajectory::RenderableTrailTrajectory(const ghoul::Dictionary& dictionary)
: RenderableTrail(dictionary)
, _startTime("startTime", "Start Time")
, _endTime("endTime", "End Time")
, _sampleInterval("sampleInterval", "Sample Interval", 2.0, 2.0, 1e6)
, _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
1, 1, 1000000000
)
, _renderFullTrail("renderFullTrail", "Render Full Trail", false)
, _renderFullTrail("renderFullTrail", "Render Full Trail", "", false) // @TODO Missing documentation
, _needsFullSweep(true)
, _subsamplingIsDirty(true)
{

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

@@ -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))
, _size("size", "Size", "", glm::vec4(0), glm::vec4(0), glm::vec4(2000)) // @TODO Missing documentation
, _framebuffer(nullptr)
{
documentation::testSpecificationAndThrow(

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

@@ -61,7 +61,7 @@ documentation::Documentation StaticRotation::Documentation() {
}
StaticRotation::StaticRotation()
: _rotationMatrix("rotation", "Rotation", glm::dmat3(1.0))
: _rotationMatrix("rotation", "Rotation", "", glm::dmat3(1.0)) // @TODO Missing documentation
{}
StaticRotation::StaticRotation(const ghoul::Dictionary& dictionary)

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

@@ -49,7 +49,7 @@ documentation::Documentation StaticScale::Documentation() {
}
StaticScale::StaticScale()
: _scaleValue("scale", "Scale", 1.0, 1.0, 1000.0)
: _scaleValue("scale", "Scale", "", 1.0, 1.0, 1000.0) // @TODO Missing documentation
{
addProperty(_scaleValue);
}

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

@@ -62,6 +62,7 @@ StaticTranslation::StaticTranslation()
: _position(
"position",
"Position",
"", // @TODO Missing documentation
glm::dvec3(0.0),
glm::dvec3(-std::numeric_limits<double>::max()),
glm::dvec3(std::numeric_limits<double>::max())

6
modules/debugging/rendering/renderabledebugplane.cpp
View File

@@ -47,9 +47,9 @@ namespace openspace {
RenderableDebugPlane::RenderableDebugPlane(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _texture("texture", "Texture", -1, -1, 255)
, _billboard("billboard", "Billboard", false)
, _size("size", "Size", 10.f, 0.f, std::pow(10.f, 25.f))
, _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)

9
modules/fieldlines/rendering/renderablefieldlines.cpp
View File

@@ -76,17 +76,18 @@ namespace openspace {
RenderableFieldlines::RenderableFieldlines(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _stepSize("stepSize", "Fieldline Step Size", defaultFieldlineStepSize, 0.f, 10.f)
, _classification("classification", "Fieldline Classification", true)
, _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
defaultFieldlineColor,
glm::vec4(0.f),
glm::vec4(1.f)
)
, _seedPointSource("source", "SeedPoint Source")
, _seedPointSourceFile("sourceFile", "SeedPoint File")
, _seedPointSource("source", "SeedPoint Source", "") // @TODO Missing documentation
, _seedPointSourceFile("sourceFile", "SeedPoint File", "") // @TODO Missing documentation
, _program(nullptr)
, _seedPointsAreDirty(true)
, _fieldLinesAreDirty(true)

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

@@ -57,12 +57,12 @@ namespace openspace {
RenderableGalaxy::RenderableGalaxy(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _stepSize("stepSize", "Step Size", 0.012, 0.0005, 0.05)
, _pointStepSize("pointStepSize", "Point Step Size", 0.01, 0.01, 0.1)
, _translation("translation", "Translation", glm::vec3(0.0, 0.0, 0.0), glm::vec3(0.0), glm::vec3(10.0))
, _rotation("rotation", "Euler rotation", glm::vec3(0.0, 0.0, 0.0), glm::vec3(0), glm::vec3(6.28))
, _enabledPointsRatio("nEnabledPointsRatio", "Enabled points", 0.2, 0, 1) {
, _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;
glm::vec4 color;

12
modules/globebrowsing/cache/memoryawaretilecache.cpp vendored
View File

@@ -45,26 +45,26 @@ MemoryAwareTileCache::MemoryAwareTileCache()
: PropertyOwner("TileCache")
, _numTextureBytesAllocatedOnCPU(0)
, _cpuAllocatedTileData(
"cpuAllocatedTileData", "CPU allocated tile data (MB)",
"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)",
"gpuAllocatedTileData", "GPU allocated tile data (MB)", "", // @TODO Missing documentation
1024, // Default
128, // Minimum
2048, // Maximum
1) // Step: One MB
, _tileCacheSize(
"tileCacheSize", "Tile cache size",
"tileCacheSize", "Tile cache size", "", // @TODO Missing documentation
1024, // Default
128, // Minimum
2048, // Maximum
1) // Step: One MB
, _applyTileCacheSize("applyTileCacheSize", "Apply tile cache size")
, _clearTileCache("clearTileCache", "Clear tile cache")
, _usePbo("usePbo", "Use PBO", false)
, _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();

2
modules/globebrowsing/globes/pointglobe.cpp
View File

@@ -40,11 +40,13 @@ PointGlobe::PointGlobe(const RenderableGlobe& owner)
, _intensityClamp(
"intensityClamp",
"Intensity clamp",
"", // @TODO Missing documentation
1, 0, 1
)
, _lightIntensity(
"lightIntensity",
"Light intensity",
"", // @TODO Missing documentation
1, 0, 50
)
{

42
modules/globebrowsing/globes/renderableglobe.cpp
View File

@@ -42,29 +42,29 @@ namespace openspace::globebrowsing {
RenderableGlobe::RenderableGlobe(const ghoul::Dictionary& dictionary)
: _debugProperties({
BoolProperty("saveOrThrowCamera", "save or throw camera", false),
BoolProperty("showChunkEdges", "show chunk edges", false),
BoolProperty("showChunkBounds", "show chunk bounds", false),
BoolProperty("showChunkAABB", "show chunk AABB", false),
BoolProperty("showHeightResolution", "show height resolution", false),
BoolProperty("showHeightIntensities", "show height intensities", false),
BoolProperty("performFrustumCulling", "perform frustum culling", true),
BoolProperty("performHorizonCulling", "perform horizon culling", true),
BoolProperty("levelByProjectedAreaElseDistance", "level by projected area (else distance)", true),
BoolProperty("resetTileProviders", "reset tile providers", false),
BoolProperty("toggleEnabledEveryFrame", "toggle enabled every frame", false),
BoolProperty("collectStats", "collect stats", false),
BoolProperty("limitLevelByAvailableData", "Limit level by available data", true),
IntProperty("modelSpaceRenderingCutoffLevel", "Model Space Rendering Cutoff Level", 10, 1, 22)
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),
BoolProperty("performShading", "perform shading", true),
BoolProperty("atmosphere", "atmosphere", false),
BoolProperty("useAccurateNormals", "useAccurateNormals", false),
FloatProperty("lodScaleFactor", "lodScaleFactor",10.0f, 1.0f, 50.0f),
FloatProperty("cameraMinHeight", "cameraMinHeight", 100.0f, 0.0f, 1000.0f),
FloatProperty("orenNayarRoughness", "orenNayarRoughness", 0.0f, 0.0f, 1.0f)
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")
{

7
modules/globebrowsing/rendering/layer/layer.cpp
View File

@@ -44,20 +44,23 @@ Layer::Layer(layergroupid::GroupID id, const ghoul::Dictionary& layerDict)
, _typeOption(
"type",
"Type",
"", // @TODO Missing documentation
properties::OptionProperty::DisplayType::Dropdown
)
, _blendModeOption(
"blendMode",
"Blend Mode",
"", // @TODO Missing documentation
properties::OptionProperty::DisplayType::Dropdown
)
, _enabled(properties::BoolProperty("enabled", "Enabled", false))
, _reset("reset", "Reset")
, _enabled(properties::BoolProperty("enabled", "Enabled", "", false)) // @TODO Missing documentation
, _reset("reset", "Reset", "") // @TODO Missing documentation
, _tileProvider(nullptr)
, _otherTypesProperties{
properties::Vec3Property (
"color",
"Color",
"", // @TODO Missing documentation
glm::vec4(1.f, 1.f, 1.f, 1.f),
glm::vec4(0.f),
glm::vec4(1.f))

3
modules/globebrowsing/rendering/layer/layeradjustment.cpp
View File

@@ -37,6 +37,7 @@ LayerAdjustment::LayerAdjustment()
, chromaKeyColor(
"chromaKeyColor",
"Chroma key color",
"", // @TODO Missing documentation
glm::vec3(0.f, 0.f, 0.f),
glm::vec3(0.f),
glm::vec3(1.f)
@@ -44,6 +45,7 @@ LayerAdjustment::LayerAdjustment()
, chromaKeyTolerance(
"chromaKeyTolerance",
"Chroma key tolerance",
"", // @TODO Missing documentation
0,
0,
1
@@ -51,6 +53,7 @@ LayerAdjustment::LayerAdjustment()
, _typeOption(
"type",
"Type",
"", // @TODO Missing documentation
properties::OptionProperty::DisplayType::Dropdown
)
, _onChangeCallback([](){})

12
modules/globebrowsing/rendering/layer/layerrendersettings.cpp
View File

@@ -36,12 +36,12 @@ namespace openspace::globebrowsing {
LayerRenderSettings::LayerRenderSettings()
: properties::PropertyOwner("Settings")
, setDefault("setDefault", "Set Default")
, opacity(properties::FloatProperty("opacity", "Opacity", 1.f, 0.f, 1.f))
, gamma(properties::FloatProperty("gamma", "Gamma", 1, 0, 5))
, multiplier(properties::FloatProperty("multiplier", "Multiplier", 1.f, 0.f, 20.f))
, offset(properties::FloatProperty("offset", "Offset", 0.f, -10000.f, 10000.f))
, valueBlending(properties::FloatProperty("valueBlending", "Value Blending",
, 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)
{

4
modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp
View File

@@ -88,9 +88,9 @@ bool GdalWrapper::logGdalErrors() const {
GdalWrapper::GdalWrapper(size_t maximumCacheSize,
size_t maximumMaximumCacheSize)
: PropertyOwner("GdalWrapper")
, _logGdalErrors("logGdalErrors", "Log GDAL errors", true)
, _logGdalErrors("logGdalErrors", "Log GDAL errors", "", true) // @TODO Missing documentation
, _gdalMaximumCacheSize (
"gdalMaximumCacheSize", "GDAL maximum cache size",
"gdalMaximumCacheSize", "GDAL maximum cache size", "", // @TODO Missing documentation
maximumCacheSize / (1024 * 1024), // Default
0, // Minimum: No caching
maximumMaximumCacheSize / (1024 * 1024), // Maximum

8
modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp
View File

@@ -55,8 +55,8 @@ namespace openspace::globebrowsing::tileprovider {
DefaultTileProvider::DefaultTileProvider(const ghoul::Dictionary& dictionary)
: TileProvider(dictionary)
, _filePath("filePath", "File Path", "")
, _tilePixelSize("tilePixelSize", "Tile Pixel Size", 32, 32, 1024)
, _filePath("filePath", "File Path", "", "") // @TODO Missing documentation
, _tilePixelSize("tilePixelSize", "Tile Pixel Size", "", 32, 32, 1024) // @TODO Missing documentation
, _preCacheLevel(0)
{
_tileCache = OsEng.moduleEngine().module<GlobeBrowsingModule>()->tileCache();
@@ -108,8 +108,8 @@ DefaultTileProvider::DefaultTileProvider(const ghoul::Dictionary& dictionary)
DefaultTileProvider::DefaultTileProvider(
std::shared_ptr<AsyncTileDataProvider> tileReader)
: _asyncTextureDataProvider(tileReader)
, _filePath("filePath", "File Path", "")
, _tilePixelSize("tilePixelSize", "Tile Pixel Size", 32, 32, 1024)
, _filePath("filePath", "File Path", "", "") // @TODO Missing documentation
, _tilePixelSize("tilePixelSize", "Tile Pixel Size", "", 32, 32, 1024) // @TODO Missing documentation
{ }
DefaultTileProvider::~DefaultTileProvider()

14
modules/iswa/rendering/datacygnet.cpp
View File

@@ -41,13 +41,13 @@ namespace openspace {
DataCygnet::DataCygnet(const ghoul::Dictionary& dictionary)
: IswaCygnet(dictionary)
, _dataProcessor(nullptr)
, _dataOptions("dataOptions", "Data Options")
, _useLog("useLog","Use Logarithm", false)
, _useHistogram("useHistogram", "Auto Contrast", false)
, _autoFilter("autoFilter", "Auto Filter", true)
, _normValues("normValues", "Normalize Values", glm::vec2(1.0,1.0), glm::vec2(0), glm::vec2(5.0))
, _backgroundValues("backgroundValues", "Background Values", glm::vec2(0.0), glm::vec2(0), glm::vec2(1.0))
, _transferFunctionsFile("transferfunctions", "Transfer Functions", "${SCENE}/iswa/tfs/default.tf")
, _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)

6
modules/iswa/rendering/iswabasegroup.cpp
View File

@@ -44,9 +44,9 @@ namespace openspace {
IswaBaseGroup::IswaBaseGroup(std::string name, std::string type)
: properties::PropertyOwner(std::move(name))
, _enabled("enabled", "Enabled", true)
, _alpha("alpha", "Alpha", 0.9f, 0.0f, 1.0f)
, _delete("delete", "Delete")
, _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)

4
modules/iswa/rendering/iswacygnet.cpp
View File

@@ -41,8 +41,8 @@ namespace openspace {
IswaCygnet::IswaCygnet(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _delete("delete", "Delete")
, _alpha("alpha", "Alpha", 0.9f, 0.0f, 1.0f)
, _delete("delete", "Delete", "") // @TODO Missing documentation
, _alpha("alpha", "Alpha", "", 0.9f, 0.0f, 1.0f) // @TODO Missing documentation
, _shader(nullptr)
, _group(nullptr)
, _textureDirty(false)

14
modules/iswa/rendering/iswadatagroup.cpp
View File

@@ -43,13 +43,13 @@ namespace {
namespace openspace{
IswaDataGroup::IswaDataGroup(std::string name, std::string type)
: IswaBaseGroup(name, type)
, _useLog("useLog","Use Logarithm", false)
, _useHistogram("useHistogram", "Auto Contrast", false)
, _autoFilter("autoFilter", "Auto Filter", true)
, _normValues("normValues", "Normalize Values", glm::vec2(1.0,1.0), glm::vec2(0), glm::vec2(5.0))
, _backgroundValues("backgroundValues", "Background Values", glm::vec2(0.0), glm::vec2(0), glm::vec2(1.0))
, _transferFunctionsFile("transferfunctions", "Transfer Functions", "${SCENE}/iswa/tfs/default.tf")
, _dataOptions("dataOptions", "Data Options")
, _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);

10
modules/iswa/rendering/iswakameleongroup.cpp
View File

@@ -42,11 +42,11 @@ namespace {
namespace openspace{
IswaKameleonGroup::IswaKameleonGroup(std::string name, std::string type)
:IswaDataGroup(name, type)
,_resolution("resolution", "Resolution%", 100.0f, 10.0f, 200.0f)
,_fieldlines("fieldlineSeedsIndexFile", "Fieldline Seedpoints")
,_fieldlineIndexFile("")
,_kameleonPath("")
: IswaDataGroup(name, type)
, _resolution("resolution", "Resolution%", "", 100.0f, 10.0f, 200.0f) // @TODO Missing documentation
, _fieldlines("fieldlineSeedsIndexFile", "Fieldline Seedpoints", "") // @TODO Missing documentation
, _fieldlineIndexFile("")
, _kameleonPath("")
{
addProperty(_resolution);
addProperty(_fieldlines);

6
modules/iswa/rendering/kameleonplane.cpp
View File

@@ -39,9 +39,9 @@ namespace openspace {
KameleonPlane::KameleonPlane(const ghoul::Dictionary& dictionary)
: DataCygnet(dictionary)
, _fieldlines("fieldlineSeedsIndexFile", "Fieldline Seedpoints")
, _resolution("resolution", "Resolution%", 100.0f, 10.0f, 200.0f)
, _slice("slice", "Slice", 0.0, 0.0, 1.0)
, _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);

24
modules/kameleonvolume/rendering/renderablekameleonvolume.cpp
View File

@@ -64,24 +64,24 @@ namespace openspace {
RenderableKameleonVolume::RenderableKameleonVolume(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _dimensions("dimensions", "Dimensions")
, _variable("variable", "Variable")
, _lowerDomainBound("lowerDomainBound", "Lower Domain Bound")
, _upperDomainBound("upperDomainBound", "Upper Domain Bound")
, _domainScale("domainScale", "Domain scale")
, _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)
, _upperValueBound("upperValueBound", "Upper Value Bound", 1.f, 0.01f, 1.f)
, _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)
, _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)
, _sourcePath("sourcePath", "Source Path")
, _transferFunctionPath("transferFunctionPath", "Transfer Function Path")
, _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")
, _cache("cache", "Cache", "") // @TODO Missing documentation
{
glm::vec3 dimensions;

32
modules/multiresvolume/rendering/renderablemultiresvolume.cpp
View File

@@ -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)
, _currentTime("currentTime", "Current Time", 0, 0, 0)
, _memoryBudget("memoryBudget", "Memory Budget", 0, 0, 0)
, _streamingBudget("streamingBudget", "Streaming Budget", 0, 0, 0)
, _useGlobalTime("useGlobalTime", "Global Time", false)
, _loop("loop", "Loop", false)
, _selectorName("selector", "Brick Selector")
, _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)
, _statsToFileName("printStatsFileName", "Stats Filename")
, _scalingExponent("scalingExponent", "Scaling Exponent", 1, -10, 20)
, _scaling("scaling", "Scaling", glm::vec3(1.f), glm::vec3(0.f), glm::vec3(10.f))
, _translation("translation", "Translation", glm::vec3(0.f), glm::vec3(0.f), glm::vec3(10.f))
, _rotation("rotation", "Euler rotation", glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(6.28f))
, _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);
@@ -349,9 +349,9 @@ bool RenderableMultiresVolume::initialize() {
unsigned int maxInitialBudget = 2048;
int initialBudget = std::min(maxInitialBudget, maxNumBricks);
_currentTime = properties::IntProperty("currentTime", "Current Time", 0, 0, _tsp->header().numTimesteps_ - 1);
_memoryBudget = properties::IntProperty("memoryBudget", "Memory Budget", initialBudget, 0, maxNumBricks);
_streamingBudget = properties::IntProperty("streamingBudget", "Streaming Budget", initialBudget, 0, maxNumBricks);
_currentTime = properties::IntProperty("currentTime", "Current Time", "", 0, 0, _tsp->header().numTimesteps_ - 1); // @TODO Missing documentation
_memoryBudget = properties::IntProperty("memoryBudget", "Memory Budget", "", initialBudget, 0, maxNumBricks); // @TODO Missing documentation
_streamingBudget = properties::IntProperty("streamingBudget", "Streaming Budget", "", initialBudget, 0, maxNumBricks); // @TODO Missing documentation
addProperty(_currentTime);
addProperty(_memoryBudget);
addProperty(_streamingBudget);

13
modules/newhorizons/rendering/renderablefov.cpp
View File

@@ -129,45 +129,52 @@ documentation::Documentation RenderableFov::Documentation() {
RenderableFov::RenderableFov(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _lineWidth("lineWidth", "Line Width", 1.f, 1.f, 20.f)
, _drawSolid("solidDraw", "Draw as Quads", false)
, _standOffDistance("standOffDistance", "Standoff Distance", 0.9999, 0.99, 1.0, 0.000001)
, _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
glm::vec4(0.4f)
},
{
"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
glm::vec4(0.f, 1.f, 0.f, 1.f)
},
{
"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
glm::vec4(1.f, 0.89f, 0.f, 1.f)
},
{
"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
glm::vec4(0.85f, 0.85f, 0.85f, 1.f)
}
})

6
modules/newhorizons/rendering/renderablemodelprojection.cpp
View File

@@ -104,13 +104,13 @@ documentation::Documentation RenderableModelProjection::Documentation() {
RenderableModelProjection::RenderableModelProjection(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _colorTexturePath("colorTexture", "Color Texture")
, _rotation("rotation", "Rotation", glm::vec3(0.f), glm::vec3(0.f), glm::vec3(360.f))
, _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)
, _performShading("performShading", "Perform Shading", "", true) // @TODO Missing documentation
{
documentation::testSpecificationAndThrow(
Documentation(),

12
modules/newhorizons/rendering/renderableplanetprojection.cpp
View File

@@ -121,16 +121,16 @@ documentation::Documentation RenderablePlanetProjection::Documentation() {
RenderablePlanetProjection::RenderablePlanetProjection(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _colorTexturePath("planetTexture", "RGB Texture")
, _heightMapTexturePath("heightMap", "Heightmap Texture")
, _rotation("rotation", "Rotation", 0, 0, 360)
, _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)
, _heightExaggeration("heightExaggeration", "Height Exaggeration", 1.f, 0.f, 100.f)
, _debugProjectionTextureRotation("debug.projectionTextureRotation", "Projection Texture Rotation", 0.f, 0.f, 360.f)
, _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(

6
modules/newhorizons/rendering/renderableshadowcylinder.cpp
View File

@@ -46,9 +46,9 @@ namespace openspace {
RenderableShadowCylinder::RenderableShadowCylinder(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _numberOfPoints("amountOfPoints", "Points", 190, 1, 300)
, _shadowLength("shadowLength", "Shadow Length", 0.1f, 0.0f, 0.5f)
, _shadowColor("shadowColor", "Shadow Color",
, _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)

10
modules/newhorizons/util/projectioncomponent.cpp
View File

@@ -168,11 +168,11 @@ documentation::Documentation ProjectionComponent::Documentation() {
ProjectionComponent::ProjectionComponent()
: properties::PropertyOwner("ProjectionComponent")
, _performProjection("performProjection", "Perform Projections", true)
, _clearAllProjections("clearAllProjections", "Clear Projections", false)
, _projectionFading("projectionFading", "Projection Fading", 1.f, 0.f, 1.f)
, _textureSize("textureSize", "Texture Size", ivec2(16), ivec2(16), ivec2(32768))
, _applyTextureSize("applyTextureSize", "Apply Texture Size")
, _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)
{

2
modules/onscreengui/src/gui.cpp
View File

@@ -41,7 +41,7 @@
#include "gui_lua.inl"
//#define SHOW_IMGUI_HELPERS
#define SHOW_IMGUI_HELPERS
namespace {

2
modules/onscreengui/src/guicomponent.cpp
View File

@@ -28,7 +28,7 @@ namespace openspace::gui {
GuiComponent::GuiComponent(std::string name)
: properties::PropertyOwner(std::move(name))
, _isEnabled("enabled", "Is Enabled", false)
, _isEnabled("enabled", "Is Enabled", "", false) // @TODO Missing documentation
{
addProperty(_isEnabled);
}

8
modules/onscreengui/src/guiperformancecomponent.cpp
View File

@@ -55,10 +55,10 @@ namespace openspace::gui {
GuiPerformanceComponent::GuiPerformanceComponent()
: GuiComponent("PerformanceComponent")
, _sortingSelection("sortingSelection", "Sorting", -1, -1, 6)
, _sceneGraphIsEnabled("showSceneGraph", "Show Scene Graph Measurements", false)
, _functionsIsEnabled("showFunctions", "Show Function Measurements", false)
, _outputLogs("outputLogs", "Output Logs", false)
, _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);

10
modules/onscreengui/src/renderproperties.cpp
View File

@@ -42,7 +42,15 @@ using namespace properties;
void renderTooltip(Property* prop) {
if (ImGui::IsItemHovered()) {
ImGui::SetTooltip(prop->fullyQualifiedIdentifier().c_str());
ImGui::BeginTooltip();
if (!prop->description().empty()) {
ImGui::TextWrapped(prop->description().c_str());
ImGui::Spacing();
}
ImGui::Text(
(std::string("Identifier: ") + prop->fullyQualifiedIdentifier()).c_str()
);
ImGui::EndTooltip();
}
}

4
modules/space/rendering/renderableconstellationbounds.cpp
View File

@@ -90,8 +90,8 @@ RenderableConstellationBounds::RenderableConstellationBounds(
: Renderable(dictionary)
, _vertexFilename("")
, _constellationFilename("")
, _distance("distance", "Distance to the celestial Sphere", 15.f, 0.f, 30.f)
, _constellationSelection("constellationSelection", "Constellation Selection")
, _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)
{

10
modules/space/rendering/renderableplanet.cpp
View File

@@ -121,15 +121,15 @@ documentation::Documentation RenderablePlanet::Documentation() {
RenderablePlanet::RenderablePlanet(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _colorTexturePath("colorTexture", "Color Texture")
, _nightTexturePath("nightTexture", "Night Texture")
, _heightMapTexturePath("heightMap", "Heightmap Texture")
, _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)
, _heightExaggeration("heightExaggeration", "Height Exaggeration", "", 1.f, 0.f, 10.f) // @TODO Missing documentation
, _geometry(nullptr)
, _performShading("performShading", "Perform Shading", true)
, _performShading("performShading", "Perform Shading", "", true) // @TODO Missing documentation
, _alpha(1.f)
, _planetRadius(0.f)
, _hasNightTexture(false)

10
modules/space/rendering/renderablerings.cpp
View File

@@ -85,11 +85,11 @@ documentation::Documentation RenderableRings::Documentation() {
RenderableRings::RenderableRings(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _texturePath("texture", "Texture")
, _size("size", "Size", 1.f, 0.f, std::pow(1.f, 25.f))
, _offset("offset", "Offset", glm::vec2(0, 1.f), glm::vec2(0.f), glm::vec2(1.f))
, _nightFactor("nightFactor", "Night Factor", 0.33f, 0.f, 1.f)
, _transparency("transparency", "Transparency", 0.15f, 0.f, 1.f)
, _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)

11
modules/space/rendering/renderablestars.cpp
View File

@@ -125,21 +125,22 @@ documentation::Documentation RenderableStars::Documentation() {
RenderableStars::RenderableStars(const ghoul::Dictionary& dictionary)
: Renderable(dictionary)
, _pointSpreadFunctionTexturePath("psfTexture", "Point Spread Function Texture")
, _pointSpreadFunctionTexturePath("psfTexture", "Point Spread Function Texture", "") // @TODO Missing documentation
, _pointSpreadFunctionTexture(nullptr)
, _pointSpreadFunctionTextureIsDirty(true)
, _colorTexturePath("colorTexture", "ColorBV Texture")
, _colorTexturePath("colorTexture", "ColorBV Texture", "") // @TODO Missing documentation
, _colorTexture(nullptr)
, _colorTextureIsDirty(true)
, _colorOption(
"colorOption",
"Color Option",
"", // @TODO Missing documentation
properties::OptionProperty::DisplayType::Dropdown
)
, _dataIsDirty(true)
, _alphaValue("alphaValue", "Transparency", 1.f, 0.f, 1.f)
, _scaleFactor("scaleFactor", "Scale Factor", 1.f, 0.f, 10.f)
, _minBillboardSize("minBillboardSize", "Min Billboard Size", 1.f, 1.f, 100.f)
, _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)

3
modules/space/rendering/simplespheregeometry.cpp
View File

@@ -41,10 +41,11 @@ SimpleSphereGeometry::SimpleSphereGeometry(const ghoul::Dictionary& dictionary)
, _radius(
"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)
, _segments("segments", "Segments", "", 20, 1, 5000) // @TODO Missing documentation
, _sphere(nullptr)
{
float sphereRadius = 0.f;

14
modules/space/translation/keplertranslation.cpp
View File

@@ -142,12 +142,13 @@ documentation::Documentation KeplerTranslation::Documentation() {
KeplerTranslation::KeplerTranslation()
: Translation()
, _eccentricity("eccentricity", "Eccentricity", 0.0, 0.0, 1.0)
, _semiMajorAxis("semimajorAxis", "Semi-major axis", 0.0, 0.0, 1e6)
, _inclination("inclination", "Inclination", 0.0, 0.0, 360.0)
, _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
0.0,
0.0,
360.0
@@ -155,13 +156,14 @@ KeplerTranslation::KeplerTranslation()
, _argumentOfPeriapsis(
"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)
, _epoch("epoch", "Epoch", 0.0, 0.0, 1e9)
, _period("period", "Orbit period", 0.0, 0.0, 1e6)
, _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]() {

7
modules/space/translation/spicetranslation.cpp
View File

@@ -99,10 +99,9 @@ documentation::Documentation SpiceTranslation::Documentation() {
}
SpiceTranslation::SpiceTranslation(const ghoul::Dictionary& dictionary)
: _target("target", "Target", "")
, _origin("origin", "Origin", "")
, _frame("frame", "Reference Frame", DefaultReferenceFrame)
, _kernelsLoadedSuccessfully(true)
: _target("target", "Target", "longlong test asdkl;asd;klas\nasdklasdkl;asl;d") // @TODO Missing documentation
, _origin("origin", "Origin", "") // @TODO Missing documentation
, _frame("frame", "Reference Frame", "", DefaultReferenceFrame) // @TODO Missing documentation
{
documentation::testSpecificationAndThrow(
Documentation(),

1
modules/space/translation/spicetranslation.h
View File

@@ -45,7 +45,6 @@ private:
properties::StringProperty _frame;
glm::dvec3 _position;
bool _kernelsLoadedSuccessfully;
};
} // namespace openspace

19
modules/touch/src/touchinteraction.cpp
View File

@@ -74,26 +74,30 @@ namespace openspace {
TouchInteraction::TouchInteraction()
: properties::PropertyOwner("TouchInteraction")
, _origin("origin", "Origin", "")
, _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
)
, _touchActive(
"TouchEvents",
"True if we have a touch event",
"", // @TODO Missing documentation
false,
properties::Property::Visibility::Hidden
)
, _reset(
"Default Values",
"Reset all properties to default",
"", // @TODO Missing documentation
false
)
, _maxTapTime(
"Max Tap Time",
"Max tap delay (in ms) for double tap",
"", // @TODO Missing documentation
300,
10,
1000
@@ -101,6 +105,7 @@ TouchInteraction::TouchInteraction()
, _deceleratesPerSecond(
"Decelerates per second",
"Number of times velocity is decelerated per second",
"", // @TODO Missing documentation
240,
60,
300
@@ -108,6 +113,7 @@ TouchInteraction::TouchInteraction()
, _touchScreenSize(
"TouchScreenSize",
"Touch Screen size in inches",
"", // @TODO Missing documentation
55.0f,
5.5f,
150.0f
@@ -115,6 +121,7 @@ TouchInteraction::TouchInteraction()
, _tapZoomFactor(
"Tap zoom factor",
"Scaling distance travelled on tap",
"", // @TODO Missing documentation
0.2f,
0.f,
0.5f
@@ -122,6 +129,7 @@ TouchInteraction::TouchInteraction()
, _nodeRadiusThreshold(
"Activate direct-manipulation",
"Radius a planet has to have to activate direct-manipulation",
"", // @TODO Missing documentation
0.2f,
0.0f,
1.0f
@@ -129,6 +137,7 @@ TouchInteraction::TouchInteraction()
, _rollAngleThreshold(
"Interpret roll",
"Threshold for min angle for roll interpret",
"", // @TODO Missing documentation
0.025f,
0.f,
0.05f
@@ -136,6 +145,7 @@ TouchInteraction::TouchInteraction()
, _orbitSpeedThreshold(
"Activate orbit spinning",
"Threshold to activate orbit spinning in direct-manipulation",
"", // @TODO Missing documentation
0.005f,
0.f,
0.01f
@@ -143,6 +153,7 @@ TouchInteraction::TouchInteraction()
, _spinSensitivity(
"Sensitivity of spinning",
"Sensitivity of spinning in direct-manipulation",
"", // @TODO Missing documentation
1.f,
0.f,
2.f
@@ -150,6 +161,7 @@ TouchInteraction::TouchInteraction()
, _inputStillThreshold(
"Input still",
"Threshold for interpreting input as still",
"", // @TODO Missing documentation
0.0005f,
0.f,
0.001f
@@ -157,6 +169,7 @@ TouchInteraction::TouchInteraction()
, _centroidStillThreshold(
"Centroid stationary",
"Threshold for stationary centroid",
"", // @TODO Missing documentation
0.0018f,
0.f,
0.01f
@@ -164,6 +177,7 @@ TouchInteraction::TouchInteraction()
, _interpretPan(
"Pan delta distance",
"Delta distance between fingers allowed for interpreting pan interaction",
"", // @TODO Missing documentation
0.015f,
0.f,
0.1f
@@ -171,6 +185,7 @@ TouchInteraction::TouchInteraction()
, _slerpTime(
"Time to slerp",
"Time to slerp in seconds to new orientation with new node picking",
"", // @TODO Missing documentation
3.f,
0.f,
5.f
@@ -178,6 +193,7 @@ TouchInteraction::TouchInteraction()
, _guiButton(
"GUI Button",
"GUI button size in pixels",
"", // @TODO Missing documentation
glm::ivec2(32, 64),
glm::ivec2(8, 16),
glm::ivec2(128, 256)
@@ -185,6 +201,7 @@ TouchInteraction::TouchInteraction()
, _friction(
"Friction",
"Friction for different interactions (orbit, zoom, roll, pan)",
"", // @TODO Missing documentation
glm::vec4(0.01f, 0.025f, 0.02f, 0.02f),
glm::vec4(0.f),
glm::vec4(0.2f)

9
modules/touch/src/touchmarker.cpp
View File

@@ -39,13 +39,14 @@ namespace openspace {
TouchMarker::TouchMarker()
: properties::PropertyOwner("TouchMarker")
, _visible("TouchMarkers visible", "Toggle visibility of markers", true)
, _radiusSize("Marker size", "Marker radius", 30.f, 0.f, 100.f)
, _transparency("Transparency of marker", "Marker transparency", 0.8f, 0.f, 1.f)
, _thickness("Thickness of marker", "Marker thickness", 2.f, 0.f, 4.f)
, _visible("TouchMarkers visible", "Toggle visibility of markers", "", true) // @TODO Missing documentation
, _radiusSize("Marker size", "Marker radius", "", 30.f, 0.f, 100.f) // @TODO Missing documentation
, _transparency("Transparency of marker", "Marker transparency", "", 0.8f, 0.f, 1.f) // @TODO Missing documentation
, _thickness("Thickness of marker", "Marker thickness", "", 2.f, 0.f, 4.f) // @TODO Missing documentation
, _color(
"MarkerColor",
"Marker color",
"", // @TODO Missing documentation
glm::vec3(204.f / 255.f, 51.f / 255.f, 51.f / 255.f),
glm::vec3(0.f),
glm::vec3(1.f)

12
modules/toyvolume/rendering/renderabletoyvolume.cpp
View File

@@ -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)
, _scaling("scaling", "Scaling", glm::vec3(1.f, 1.f, 1.f), glm::vec3(0.f), glm::vec3(10.f))
, _translation("translation", "Translation", glm::vec3(0.f, 0.f, 0.f), glm::vec3(0.f), glm::vec3(10.f))
, _rotation("rotation", "Euler rotation", glm::vec3(0.f, 0.f, 0.f), glm::vec3(0), glm::vec3(6.28f))
, _color("color", "Color", glm::vec4(1.f, 0.f, 0.f, 0.1f), glm::vec4(0.f), glm::vec4(1.f))
, _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;

2
modules/volume/rendering/volumeclipplane.cpp
View File

@@ -33,6 +33,7 @@ VolumeClipPlane::VolumeClipPlane(const ghoul::Dictionary& dictionary)
: _normal(
"normal",
"Normal",
"", // @TODO Missing documentation
glm::vec3(1.f, 0.f, 0.f),
glm::vec3(-1.f),
glm::vec3(1.f)
@@ -40,6 +41,7 @@ VolumeClipPlane::VolumeClipPlane(const ghoul::Dictionary& dictionary)
, _offsets(
"offsets",
"Offsets",
"", // @TODO Missing documentation
glm::vec2(-2.f, 0.f),
glm::vec2(-2.f, 0.f),
glm::vec2(2.f, 1.f)

2
modules/volume/rendering/volumeclipplanes.cpp
View File

@@ -30,7 +30,7 @@
namespace openspace {
VolumeClipPlanes::VolumeClipPlanes(const ghoul::Dictionary& dictionary)
: _nClipPlanes("nClipPlanes", "Number of clip planes", 0, 0, 10)
: _nClipPlanes("nClipPlanes", "Number of clip planes", "", 0, 0, 10) // @TODO Missing documentation
{
std::vector<std::string> keys = dictionary.keys();
for (const std::string& key : keys) {