diff --git a/include/openspace/properties/numericalproperty.h b/include/openspace/properties/numericalproperty.h index 45633abb89..601d70c94d 100644 --- a/include/openspace/properties/numericalproperty.h +++ b/include/openspace/properties/numericalproperty.h @@ -33,14 +33,16 @@ template class NumericalProperty : public TemplateProperty { public: NumericalProperty(std::string identifier, std::string guiName, + std::string description, Property::Visibility visibility = Property::Visibility::User); - NumericalProperty(std::string identifier, std::string guiName, T value, + NumericalProperty(std::string identifier, std::string guiName, + std::string description, T value, Property::Visibility visibility = Property::Visibility::User); - NumericalProperty(std::string identifier, std::string guiName, T value, - T minimumValue, T maximumValue, + NumericalProperty(std::string identifier, std::string guiName, + std::string description, T value, T minimumValue, T maximumValue, Property::Visibility visibility = Property::Visibility::User); - NumericalProperty(std::string identifier, std::string guiName, T value, - T minimumValue, T maximumValue, T steppingValue, + NumericalProperty(std::string identifier, std::string guiName, + std::string description, T value, T minimumValue, T maximumValue, T steppingValue, Property::Visibility visibility = Property::Visibility::User); bool getLuaValue(lua_State* state) const override; diff --git a/include/openspace/properties/numericalproperty.inl b/include/openspace/properties/numericalproperty.inl index 0263286b8c..9d1a7a4573 100644 --- a/include/openspace/properties/numericalproperty.inl +++ b/include/openspace/properties/numericalproperty.inl @@ -233,9 +233,10 @@ const std::string NumericalProperty::SteppingValueKey = "SteppingValue"; template NumericalProperty::NumericalProperty(std::string identifier, std::string guiName, + std::string description, Property::Visibility visibility) : NumericalProperty( - std::move(identifier), std::move(guiName), + std::move(identifier), std::move(guiName), std::move(description), PropertyDelegate>::template defaultValue(), PropertyDelegate>::template defaultMinimumValue(), PropertyDelegate>::template defaultMaximumValue(), @@ -246,10 +247,10 @@ NumericalProperty::NumericalProperty(std::string identifier, std::string guiN template NumericalProperty::NumericalProperty(std::string identifier, - std::string guiName, T value, + std::string guiName, std::string desc, T value, Property::Visibility visibility) : NumericalProperty( - std::move(identifier), std::move(guiName), std::move(value), + std::move(identifier), std::move(guiName), std::move(desc), std::move(value), PropertyDelegate>::template defaultMinimumValue(), PropertyDelegate>::template defaultMaximumValue(), PropertyDelegate>::template defaultSteppingValue(), @@ -259,23 +260,24 @@ NumericalProperty::NumericalProperty(std::string identifier, template NumericalProperty::NumericalProperty(std::string identifier, std::string guiName, - T value, T minimumValue, T maximumValue, - Property::Visibility visibility) + std::string description, T value, T minimumValue, + T maximumValue, Property::Visibility visibility) : NumericalProperty( - std::move(identifier) , std::move(guiName), std::move(value), - std::move(minimumValue), std::move(maximumValue), + std::move(identifier), std::move(guiName), std::move(description), + std::move(value), std::move(minimumValue), std::move(maximumValue), PropertyDelegate>::template defaultSteppingValue(), visibility ) {} template -NumericalProperty::NumericalProperty(std::string identifier, - std::string guiName, T value, +NumericalProperty::NumericalProperty(std::string identifier, std::string guiName, + std::string description, T value, T minimumValue, T maximumValue, T steppingValue, Property::Visibility visibility) - : TemplateProperty(std::move(identifier), std::move(guiName), std::move(value), - visibility) + : TemplateProperty( + std::move(identifier), std::move(guiName), std::move(description), + std::move(value), visibility) , _minimumValue(std::move(minimumValue)) , _maximumValue(std::move(maximumValue)) , _stepping(std::move(steppingValue)) diff --git a/include/openspace/properties/optionproperty.h b/include/openspace/properties/optionproperty.h index c5a292f665..444819ae0a 100644 --- a/include/openspace/properties/optionproperty.h +++ b/include/openspace/properties/optionproperty.h @@ -60,7 +60,7 @@ public: * \param identifier A unique identifier for this property * \param guiName The GUI name that should be used to represent this property */ - OptionProperty(std::string identifier, std::string guiName, + OptionProperty(std::string identifier, std::string guiName, std::string description, Property::Visibility visibility = Property::Visibility::User); /** @@ -70,7 +70,8 @@ public: * \param guiName The GUI name that should be used to represent this property * \param displayType Optional DisplayType for GUI (default RADIO) */ - OptionProperty(std::string identifier, std::string guiName, DisplayType displayType, + OptionProperty(std::string identifier, std::string guiName, std::string description, + DisplayType displayType, Property::Visibility visibility = Property::Visibility::User); /** diff --git a/include/openspace/properties/property.h b/include/openspace/properties/property.h index eb5ecc3b52..d58a9fbf94 100644 --- a/include/openspace/properties/property.h +++ b/include/openspace/properties/property.h @@ -85,15 +85,17 @@ public: * The constructor for the property. The identifier needs to be unique * for each PropertyOwner. The guiName will be stored in the metaData * to be accessed by the GUI elements using the guiName key. The default - * visibility settings is true, whereas the default read-only state is + * visibility settings is Visibility::All, whereas the default read-only state is * false. * \param identifier A unique identifier for this property. It has to be unique to the * PropertyOwner and cannot contain any .s * \param guiName The human-readable GUI name for this Property + * \param description The human-readable description for this Property + * \param visibility The visibility of the Property for user interfaces * \pre \p identifier must not be empty * \pre \p guiName must not be empty */ - Property(std::string identifier, std::string guiName, + Property(std::string identifier, std::string guiName, std::string description, Visibility visibility = Visibility::All); /** @@ -258,18 +260,12 @@ public: std::string guiName() const; /** - * Returns the description for this Property that contains all necessary information - * required for creating a GUI representation. The format of the description is a - * valid Lua table, i.e., it is surrounded by a pair of { and - * } with key,value pairs between. Each value can either be a number, a - * string, a bool, or another table. The general values set by this base function - * are: Identifier, Name, Type. All other - * values are specific to the type and are added in a specific subclass, which require - * the subclass to call this method first. - * \return The descriptive text for the Property that can be used for constructing a - * GUI representation + * This function returns a user-facing description of the Property which can be + * displayed in the user interface to inform the user what this Property does and how + * it affects the rendering. + * \return The description of this Property */ - virtual std::string description() const; + std::string description() const; /** * Sets the identifier of the group that this Property belongs to. Property groups can @@ -407,6 +403,9 @@ protected: /// The identifier for this Property std::string _identifier; + /// The user-facing description of this Property + std::string _description; + /// The Dictionary containing all meta data necessary for external applications ghoul::Dictionary _metaData; diff --git a/include/openspace/properties/selectionproperty.h b/include/openspace/properties/selectionproperty.h index 1a7d58ed73..d14414fdc5 100644 --- a/include/openspace/properties/selectionproperty.h +++ b/include/openspace/properties/selectionproperty.h @@ -39,6 +39,7 @@ public: }; SelectionProperty(std::string identifier, std::string guiName, + std::string description, Property::Visibility visibility = Property::Visibility::User); void addOption(Option option); diff --git a/include/openspace/properties/templateproperty.h b/include/openspace/properties/templateproperty.h index 4eea529a0d..6f99a57353 100644 --- a/include/openspace/properties/templateproperty.h +++ b/include/openspace/properties/templateproperty.h @@ -51,7 +51,7 @@ namespace openspace::properties { template class TemplateProperty : public Property { public: - typedef T ValueType; + using ValueType = T; /** * The constructor initializing the TemplateProperty with the provided @@ -62,15 +62,17 @@ public: * \param identifier The identifier that is used for this TemplateProperty * \param guiName The human-readable GUI name for this TemplateProperty */ - TemplateProperty(std::string identifier, std::string guiName, - Property::Visibility visibility = Visibility::User); + //TemplateProperty(std::string identifier, std::string guiName, + // Property::Visibility visibility = Visibility::User); /** * The constructor initializing the TemplateProperty with the provided * identifier, human-readable guiName and provided * value. */ - TemplateProperty(std::string identifier, std::string guiName, T value, + TemplateProperty(std::string identifier, std::string guiName, + std::string description, + T value = PropertyDelegate>::template defaultValue(), Property::Visibility visibility = Visibility::User); /** @@ -159,7 +161,7 @@ public: /** * The assignment operator allows the TemplateProperty's value to be set without using - * the TemplateProperty::set method. It will be done internally by thos method and it + * the TemplateProperty::set method. It will be done internally by this method and it * allows assignments such as prop = T(1). * \param val The value that should be set. */ diff --git a/include/openspace/properties/templateproperty.inl b/include/openspace/properties/templateproperty.inl index 3f6201736d..bc927ab974 100644 --- a/include/openspace/properties/templateproperty.inl +++ b/include/openspace/properties/templateproperty.inl @@ -147,20 +147,21 @@ namespace openspace::properties { // deduce template argument for 'U' if 'default' methods are used as default values in // a single constructor -template -TemplateProperty::TemplateProperty(std::string identifier, std::string guiName, - Property::Visibility visibility) - : TemplateProperty( - std::move(identifier), std::move(guiName), - PropertyDelegate>::template defaultValue(), - visibility) -{ -} +//template +//TemplateProperty::TemplateProperty(std::string identifier, std::string guiName, +// Property::Visibility visibility) +// : TemplateProperty( +// std::move(identifier), std::move(guiName), +// PropertyDelegate>::template defaultValue(), +// visibility) +//{ +//} template TemplateProperty::TemplateProperty(std::string identifier, std::string guiName, + std::string desc, T value, Property::Visibility visibility) - : Property(std::move(identifier), std::move(guiName), visibility) + : Property(std::move(identifier), std::move(guiName), std::move(desc), visibility) , _value(std::move(value)) {} diff --git a/include/openspace/properties/triggerproperty.h b/include/openspace/properties/triggerproperty.h index 0040949cad..5bc707f667 100644 --- a/include/openspace/properties/triggerproperty.h +++ b/include/openspace/properties/triggerproperty.h @@ -41,7 +41,7 @@ public: * \param identifier The unique identifier used for this Property * \param guiName The human-readable name of this Property */ - TriggerProperty(std::string identifier, std::string guiName, + TriggerProperty(std::string identifier, std::string guiName, std::string description, Property::Visibility visibility = Property::Visibility::User); /** diff --git a/modules/base/rendering/renderablemodel.cpp b/modules/base/rendering/renderablemodel.cpp index 306fbfa497..b0b84493cf 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") - , _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) diff --git a/modules/base/rendering/renderableplane.cpp b/modules/base/rendering/renderableplane.cpp index 75aef3b932..0156a679e2 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") - , _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) diff --git a/modules/base/rendering/renderablesphere.cpp b/modules/base/rendering/renderablesphere.cpp index 79959887bf..2b2cfb38b1 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") - , _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) diff --git a/modules/base/rendering/renderabletrail.cpp b/modules/base/rendering/renderabletrail.cpp index 1825e32376..68686c0bed 100644 --- a/modules/base/rendering/renderabletrail.cpp +++ b/modules/base/rendering/renderabletrail.cpp @@ -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 ) { diff --git a/modules/base/rendering/renderabletrailorbit.cpp b/modules/base/rendering/renderabletrailorbit.cpp index c8ebaa048d..450e6243f3 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) - , _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) diff --git a/modules/base/rendering/renderabletrailtrajectory.cpp b/modules/base/rendering/renderabletrailtrajectory.cpp index 1969e9a58c..28fa60e344 100644 --- a/modules/base/rendering/renderabletrailtrajectory.cpp +++ b/modules/base/rendering/renderabletrailtrajectory.cpp @@ -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) { diff --git a/modules/base/rendering/screenspaceframebuffer.cpp b/modules/base/rendering/screenspaceframebuffer.cpp index 26f1118543..0fe8ad1f6d 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)) + , _size("size", "Size", "", glm::vec4(0), glm::vec4(0), glm::vec4(2000)) // @TODO Missing documentation , _framebuffer(nullptr) { documentation::testSpecificationAndThrow( diff --git a/modules/base/rotation/staticrotation.cpp b/modules/base/rotation/staticrotation.cpp index eb7c5815c8..7b852c3f8d 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)) + : _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 16de25b4a9..97f13ad5f8 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) + : _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 3af71ff175..e21b57954c 100644 --- a/modules/base/translation/statictranslation.cpp +++ b/modules/base/translation/statictranslation.cpp @@ -62,6 +62,7 @@ StaticTranslation::StaticTranslation() : _position( "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 1cc77421d2..c64bff0c02 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) - , _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) diff --git a/modules/fieldlines/rendering/renderablefieldlines.cpp b/modules/fieldlines/rendering/renderablefieldlines.cpp index 0240dc897e..d4087966dd 100644 --- a/modules/fieldlines/rendering/renderablefieldlines.cpp +++ b/modules/fieldlines/rendering/renderablefieldlines.cpp @@ -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) diff --git a/modules/galaxy/rendering/renderablegalaxy.cpp b/modules/galaxy/rendering/renderablegalaxy.cpp index 9146885392..9859630ce2 100644 --- a/modules/galaxy/rendering/renderablegalaxy.cpp +++ b/modules/galaxy/rendering/renderablegalaxy.cpp @@ -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; diff --git a/modules/globebrowsing/cache/memoryawaretilecache.cpp b/modules/globebrowsing/cache/memoryawaretilecache.cpp index b507e4f35f..ffb57ec918 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)", + "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(); diff --git a/modules/globebrowsing/globes/pointglobe.cpp b/modules/globebrowsing/globes/pointglobe.cpp index c81f4ec215..65a3037269 100644 --- a/modules/globebrowsing/globes/pointglobe.cpp +++ b/modules/globebrowsing/globes/pointglobe.cpp @@ -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 ) { diff --git a/modules/globebrowsing/globes/renderableglobe.cpp b/modules/globebrowsing/globes/renderableglobe.cpp index 281d5b253a..4ee80cfa88 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), - 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") { diff --git a/modules/globebrowsing/rendering/layer/layer.cpp b/modules/globebrowsing/rendering/layer/layer.cpp index 2cc362463d..dbf4239580 100644 --- a/modules/globebrowsing/rendering/layer/layer.cpp +++ b/modules/globebrowsing/rendering/layer/layer.cpp @@ -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)) diff --git a/modules/globebrowsing/rendering/layer/layeradjustment.cpp b/modules/globebrowsing/rendering/layer/layeradjustment.cpp index bae061c736..b763c21a4b 100644 --- a/modules/globebrowsing/rendering/layer/layeradjustment.cpp +++ b/modules/globebrowsing/rendering/layer/layeradjustment.cpp @@ -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([](){}) diff --git a/modules/globebrowsing/rendering/layer/layerrendersettings.cpp b/modules/globebrowsing/rendering/layer/layerrendersettings.cpp index 15e11c7615..a3e2e9fd3a 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") - , 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) { diff --git a/modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp b/modules/globebrowsing/tile/rawtiledatareader/gdalwrapper.cpp index 0e09f07d9d..c19215f1db 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) + , _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 diff --git a/modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp b/modules/globebrowsing/tile/tileprovider/defaulttileprovider.cpp index f41906c331..2386deef2f 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", "") - , _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()->tileCache(); @@ -108,8 +108,8 @@ DefaultTileProvider::DefaultTileProvider(const ghoul::Dictionary& dictionary) DefaultTileProvider::DefaultTileProvider( std::shared_ptr 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() diff --git a/modules/iswa/rendering/datacygnet.cpp b/modules/iswa/rendering/datacygnet.cpp index 9fe3a51652..65fc8f928f 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") - , _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) diff --git a/modules/iswa/rendering/iswabasegroup.cpp b/modules/iswa/rendering/iswabasegroup.cpp index 7053a39e1c..84b4dbf0d1 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) - , _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) diff --git a/modules/iswa/rendering/iswacygnet.cpp b/modules/iswa/rendering/iswacygnet.cpp index 0b3985b3ac..2e39253013 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") - , _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) diff --git a/modules/iswa/rendering/iswadatagroup.cpp b/modules/iswa/rendering/iswadatagroup.cpp index b6e1113d3b..8546e0221c 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) - , _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); diff --git a/modules/iswa/rendering/iswakameleongroup.cpp b/modules/iswa/rendering/iswakameleongroup.cpp index f51fb2135a..3030cb1e90 100644 --- a/modules/iswa/rendering/iswakameleongroup.cpp +++ b/modules/iswa/rendering/iswakameleongroup.cpp @@ -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); diff --git a/modules/iswa/rendering/kameleonplane.cpp b/modules/iswa/rendering/kameleonplane.cpp index 97c361cb01..db7ce81888 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") - , _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); diff --git a/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp b/modules/kameleonvolume/rendering/renderablekameleonvolume.cpp index d47fb495e1..cce9d4a2c6 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") - , _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; diff --git a/modules/multiresvolume/rendering/renderablemultiresvolume.cpp b/modules/multiresvolume/rendering/renderablemultiresvolume.cpp index 6d1cceca5b..be9514e5db 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) - , _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); diff --git a/modules/newhorizons/rendering/renderablefov.cpp b/modules/newhorizons/rendering/renderablefov.cpp index a56b153f38..325f4c0569 100644 --- a/modules/newhorizons/rendering/renderablefov.cpp +++ b/modules/newhorizons/rendering/renderablefov.cpp @@ -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) } }) diff --git a/modules/newhorizons/rendering/renderablemodelprojection.cpp b/modules/newhorizons/rendering/renderablemodelprojection.cpp index bf85249810..34440944a3 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") - , _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(), diff --git a/modules/newhorizons/rendering/renderableplanetprojection.cpp b/modules/newhorizons/rendering/renderableplanetprojection.cpp index f2b649d472..1caed1166a 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") - , _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( diff --git a/modules/newhorizons/rendering/renderableshadowcylinder.cpp b/modules/newhorizons/rendering/renderableshadowcylinder.cpp index 9ab8c44c52..39c641a258 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) - , _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) diff --git a/modules/newhorizons/util/projectioncomponent.cpp b/modules/newhorizons/util/projectioncomponent.cpp index 5e00eb3052..d67c2307df 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) - , _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) { diff --git a/modules/onscreengui/src/gui.cpp b/modules/onscreengui/src/gui.cpp index ba1d041e94..30c6dc5804 100644 --- a/modules/onscreengui/src/gui.cpp +++ b/modules/onscreengui/src/gui.cpp @@ -41,7 +41,7 @@ #include "gui_lua.inl" -//#define SHOW_IMGUI_HELPERS +#define SHOW_IMGUI_HELPERS namespace { diff --git a/modules/onscreengui/src/guicomponent.cpp b/modules/onscreengui/src/guicomponent.cpp index d4bdb0c14a..3a3e845015 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) + , _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 3eaccb9877..dfe7ce7986 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) - , _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); diff --git a/modules/onscreengui/src/renderproperties.cpp b/modules/onscreengui/src/renderproperties.cpp index 221e92b3f2..c676e1f922 100644 --- a/modules/onscreengui/src/renderproperties.cpp +++ b/modules/onscreengui/src/renderproperties.cpp @@ -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(); } } diff --git a/modules/space/rendering/renderableconstellationbounds.cpp b/modules/space/rendering/renderableconstellationbounds.cpp index 0566ded92d..1ce2c7d462 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) - , _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) { diff --git a/modules/space/rendering/renderableplanet.cpp b/modules/space/rendering/renderableplanet.cpp index 9a82bf2881..2239026e3d 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") - , _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) diff --git a/modules/space/rendering/renderablerings.cpp b/modules/space/rendering/renderablerings.cpp index b6074a622f..7a5ab1f73e 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") - , _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) diff --git a/modules/space/rendering/renderablestars.cpp b/modules/space/rendering/renderablestars.cpp index dc09f38c6a..ecfcf0bb09 100644 --- a/modules/space/rendering/renderablestars.cpp +++ b/modules/space/rendering/renderablestars.cpp @@ -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) diff --git a/modules/space/rendering/simplespheregeometry.cpp b/modules/space/rendering/simplespheregeometry.cpp index 5335c544e9..0ff0e03a12 100644 --- a/modules/space/rendering/simplespheregeometry.cpp +++ b/modules/space/rendering/simplespheregeometry.cpp @@ -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; diff --git a/modules/space/translation/keplertranslation.cpp b/modules/space/translation/keplertranslation.cpp index 5c845c62a3..340352f193 100644 --- a/modules/space/translation/keplertranslation.cpp +++ b/modules/space/translation/keplertranslation.cpp @@ -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]() { diff --git a/modules/space/translation/spicetranslation.cpp b/modules/space/translation/spicetranslation.cpp index f4924f4341..3171c2c6c3 100644 --- a/modules/space/translation/spicetranslation.cpp +++ b/modules/space/translation/spicetranslation.cpp @@ -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(), diff --git a/modules/space/translation/spicetranslation.h b/modules/space/translation/spicetranslation.h index 539cabe0d4..9be65fc52d 100644 --- a/modules/space/translation/spicetranslation.h +++ b/modules/space/translation/spicetranslation.h @@ -45,7 +45,6 @@ private: properties::StringProperty _frame; glm::dvec3 _position; - bool _kernelsLoadedSuccessfully; }; } // namespace openspace diff --git a/modules/touch/src/touchinteraction.cpp b/modules/touch/src/touchinteraction.cpp index d604dbb122..6b3a5ece08 100644 --- a/modules/touch/src/touchinteraction.cpp +++ b/modules/touch/src/touchinteraction.cpp @@ -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) diff --git a/modules/touch/src/touchmarker.cpp b/modules/touch/src/touchmarker.cpp index a16c4da2fc..f94018117e 100644 --- a/modules/touch/src/touchmarker.cpp +++ b/modules/touch/src/touchmarker.cpp @@ -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) diff --git a/modules/toyvolume/rendering/renderabletoyvolume.cpp b/modules/toyvolume/rendering/renderabletoyvolume.cpp index 774acea8aa..1a8f223f6d 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) - , _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; diff --git a/modules/volume/rendering/volumeclipplane.cpp b/modules/volume/rendering/volumeclipplane.cpp index 7209551e08..6498eb0dbe 100644 --- a/modules/volume/rendering/volumeclipplane.cpp +++ b/modules/volume/rendering/volumeclipplane.cpp @@ -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) diff --git a/modules/volume/rendering/volumeclipplanes.cpp b/modules/volume/rendering/volumeclipplanes.cpp index f08f983cf9..5d1a9e8d74 100644 --- a/modules/volume/rendering/volumeclipplanes.cpp +++ b/modules/volume/rendering/volumeclipplanes.cpp @@ -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 keys = dictionary.keys(); for (const std::string& key : keys) { diff --git a/src/engine/openspaceengine_lua.inl b/src/engine/openspaceengine_lua.inl index cd2695a65b..a5dda2323c 100644 --- a/src/engine/openspaceengine_lua.inl +++ b/src/engine/openspaceengine_lua.inl @@ -65,35 +65,59 @@ int writeDocumentation(lua_State* L) { */ int addVirtualProperty(lua_State* L) { const int nArguments = lua_gettop(L); - if (nArguments != 6) { - return luaL_error(L, "Expected %i arguments, got %i", 6, nArguments); + if (nArguments != 7) { + return luaL_error(L, "Expected %i arguments, got %i", 7, nArguments); } - const std::string type = lua_tostring(L, -6); - const std::string name = lua_tostring(L, -5); - const std::string identifier = lua_tostring(L, -4); + const std::string type = lua_tostring(L, -7); + const std::string name = lua_tostring(L, -6); + const std::string identifier = lua_tostring(L, -5); + const std::string description = lua_tostring(L, -4); std::unique_ptr prop; if (type == "BoolProperty") { bool v = lua_toboolean(L, -3); - prop = std::make_unique(identifier, name, v); + prop = std::make_unique( + identifier, + name, + description, + v + ); } else if (type == "IntProperty") { int v = static_cast(lua_tonumber(L, -3)); int min = static_cast(lua_tonumber(L, -2)); int max = static_cast(lua_tonumber(L, -1)); - prop = std::make_unique(identifier, name, v, min, max); + prop = std::make_unique( + identifier, + name, + description, + v, + min, + max + ); } else if (type == "FloatProperty") { float v = static_cast(lua_tonumber(L, -3)); float min = static_cast(lua_tonumber(L, -2)); float max = static_cast(lua_tonumber(L, -1)); - prop = std::make_unique(identifier, name, v, min, max); + prop = std::make_unique( + identifier, + name, + description, + v, + min, + max + ); } else if (type == "TriggerProperty") { - prop = std::make_unique(identifier, name); + prop = std::make_unique( + identifier, + name, + description + ); } else { return luaL_error(L, "Unknown property type '%s'", type.c_str()); diff --git a/src/engine/settingsengine.cpp b/src/engine/settingsengine.cpp index 999ac1d61e..a4da6d755d 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) - , _busyWaitForDecode("busyWaitForDecode", "Busy Wait for decode", false) - , _logSGCTOutOfOrderErrors("logSGCTOutOfOrderErrors", "Log SGCT out-of-order", false) - , _useDoubleBuffering("useDoubleBuffering", "Use double buffering", false) - , _spiceUseExceptions("enableSpiceExceptions", "Enable Spice Exceptions", false) + , _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 c772b7863f..758e7bbf9f 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) - , _showStatsGraph("showStatsGraph", "Show Stats Graph", false) + : _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 b0b7401f9e..57c5ff7030 100644 --- a/src/interaction/luaconsole.cpp +++ b/src/interaction/luaconsole.cpp @@ -75,11 +75,12 @@ namespace openspace { LuaConsole::LuaConsole() : properties::PropertyOwner("LuaConsole") - , _isVisible("isVisible", "Is Visible", false) - , _remoteScripting("remoteScripting", "Remote scripting", false) + , _isVisible("isVisible", "Is Visible", "", false) // @TODO Missing documentation + , _remoteScripting("remoteScripting", "Remote scripting", "", false) // @TODO Missing documentation , _backgroundColor( "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) @@ -87,6 +88,7 @@ LuaConsole::LuaConsole() , _highlightColor( "highlightColor", "Highlight Color", + "", // @TODO Missing documentation glm::vec4(1.f, 1.f, 1.f, 0.f), glm::vec4(0.f), glm::vec4(1.f) @@ -94,6 +96,7 @@ LuaConsole::LuaConsole() , _separatorColor( "separatorColor", "Separator Color", + "", // @TODO Missing documentation glm::vec4(0.4f, 0.4f, 0.4f, 0.f), glm::vec4(0.f), glm::vec4(1.f) @@ -101,6 +104,7 @@ LuaConsole::LuaConsole() , _entryTextColor( "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) @@ -108,11 +112,12 @@ LuaConsole::LuaConsole() , _historyTextColor( "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) + , _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 61bd162335..b7fc5bdcde 100644 --- a/src/interaction/navigationhandler.cpp +++ b/src/interaction/navigationhandler.cpp @@ -55,7 +55,7 @@ namespace openspace::interaction { NavigationHandler::NavigationHandler() : properties::PropertyOwner("NavigationHandler") , _origin("origin", "Origin", "") - , _useKeyFrameInteraction("useKeyFrameInteraction", "Use keyframe interaction", false) + , _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 cd9683da69..e1c5fc45c2 100644 --- a/src/interaction/orbitalnavigator.cpp +++ b/src/interaction/orbitalnavigator.cpp @@ -41,15 +41,15 @@ namespace openspace::interaction { OrbitalNavigator::OrbitalNavigator() : properties::PropertyOwner("OrbitalNavigator") - , _rotationalFriction("rotationalFriction", "Rotational friction", true) - , _horizontalFriction("horizontalFriction", "Horizontal friction", true) - , _verticalFriction("verticalFriction", "Vertical friction", true) + , _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", 2.0f, 0.0f, 10.f) + "Follow focus node rotation distance", "", 2.0f, 0.0f, 10.f) // @TODO Missing documentation , _minimumAllowedDistance("minimumAllowedDistance", - "Minimum allowed distance", 10.0f, 0.0f, 10000.f) - , _sensitivity("sensitivity", "Sensitivity", 20.0f, 1.0f, 50.f) - , _motionLag("motionLag", "Motion lag", 0.5f, 0.f, 1.f) + "Minimum allowed distance", "", 10.0f, 0.0f, 10000.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 71c8f603ad..99f3c7b05c 100644 --- a/src/network/parallelconnection.cpp +++ b/src/network/parallelconnection.cpp @@ -87,15 +87,16 @@ namespace openspace { ParallelConnection::ParallelConnection() : properties::PropertyOwner("ParallelConnection") - , _password("password", "Password") - , _hostPassword("hostPassword", "Host Password") - , _port("port", "Port", "20501") - , _address("address", "Address", "localhost") - , _name("name", "Connection name", "Anonymous") - , _bufferTime("bufferTime", "Buffer Time", 1, 0.5, 10) + , _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 0.1f, 0.f, 1.f @@ -103,11 +104,12 @@ ParallelConnection::ParallelConnection() , _cameraKeyframeInterval( "cameraKeyframeInterval", "Camera Keyframe interval", + "", // @TODO Missing documentation 0.1f, 0.f, 1.f ) - , _timeTolerance("timeTolerance", "Time tolerance", 1.f, 0.5f, 5.f) + , _timeTolerance("timeTolerance", "Time tolerance", "", 1.f, 0.5f, 5.f) // @TODO Missing documentation , _lastTimeKeyframeTimestamp(0) , _lastCameraKeyframeTimestamp(0) , _clientSocket(INVALID_SOCKET) diff --git a/src/properties/optionproperty.cpp b/src/properties/optionproperty.cpp index 70b3e37434..a28aad52c6 100644 --- a/src/properties/optionproperty.cpp +++ b/src/properties/optionproperty.cpp @@ -33,14 +33,15 @@ namespace openspace::properties { const std::string OptionProperty::OptionsKey = "Options"; OptionProperty::OptionProperty(std::string identifier, std::string guiName, - Property::Visibility visibility) - : IntProperty(std::move(identifier), std::move(guiName), visibility) + std::string desc, Property::Visibility visibility) + : IntProperty(std::move(identifier), std::move(guiName), std::move(desc), visibility) , _displayType(DisplayType::Radio) {} OptionProperty::OptionProperty(std::string identifier, std::string guiName, - DisplayType displayType, Property::Visibility visibility) - : IntProperty(std::move(identifier), std::move(guiName), visibility) + std::string desc, DisplayType displayType, + Property::Visibility visibility) + : IntProperty(std::move(identifier), std::move(guiName), std::move(desc), visibility) , _displayType(displayType) {} diff --git a/src/properties/property.cpp b/src/properties/property.cpp index e071ee503b..218387611f 100644 --- a/src/properties/property.cpp +++ b/src/properties/property.cpp @@ -52,9 +52,11 @@ const char* Property::NameKey = "Name"; const char* Property::TypeKey = "Type"; const char* Property::MetaDataKey = "MetaData"; -Property::Property(std::string identifier, std::string guiName, Visibility visibility) +Property::Property(std::string identifier, std::string guiName, std::string description, + Visibility visibility) : _owner(nullptr) , _identifier(std::move(identifier)) + , _description(std::move(description)) , _currentHandleValue(0) { ghoul_assert(!_identifier.empty(), "Identifier must not be empty"); @@ -118,7 +120,7 @@ std::string Property::guiName() const { } std::string Property::description() const { - return "return {" + generateBaseDescription() + "}"; + return _description; } void Property::setGroupIdentifier(std::string groupId) { @@ -209,6 +211,8 @@ void Property::notifyListener() { } } +// This was used in the old version of Property::Description but was never used. Is this +// still useful? ---abock std::string Property::generateBaseDescription() const { return std::string(TypeKey) + " = \"" + className() + "\", " + diff --git a/src/properties/selectionproperty.cpp b/src/properties/selectionproperty.cpp index 88452dcd16..d2ddf9de79 100644 --- a/src/properties/selectionproperty.cpp +++ b/src/properties/selectionproperty.cpp @@ -37,9 +37,10 @@ namespace openspace::properties { const std::string SelectionProperty::OptionsKey = "Options"; SelectionProperty::SelectionProperty(std::string identifier, std::string guiName, + std::string desc, Property::Visibility visibility) - : TemplateProperty(std::move(identifier), std::move(guiName), std::vector(), - visibility) + : TemplateProperty(std::move(identifier), std::move(guiName), std::move(desc), + std::vector(), visibility) {} void SelectionProperty::addOption(Option option) { diff --git a/src/properties/triggerproperty.cpp b/src/properties/triggerproperty.cpp index 5e543e8f29..5a1c0f1396 100644 --- a/src/properties/triggerproperty.cpp +++ b/src/properties/triggerproperty.cpp @@ -27,8 +27,8 @@ namespace openspace::properties { TriggerProperty::TriggerProperty(std::string identifier, std::string guiName, - Property::Visibility visibility) - : Property(std::move(identifier), std::move(guiName), visibility) + std::string desc, Property::Visibility visibility) + : Property(std::move(identifier), std::move(guiName), std::move(desc), visibility) {} std::string TriggerProperty::className() const { diff --git a/src/rendering/renderable.cpp b/src/rendering/renderable.cpp index 548ffc7e23..b1e67d53db 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) + , _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) + , _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 902dec515b..9c1f7da5f8 100644 --- a/src/rendering/renderengine.cpp +++ b/src/rendering/renderengine.cpp @@ -100,7 +100,7 @@ RenderEngine::RenderEngine() , _camera(nullptr) , _scene(nullptr) , _raycasterManager(nullptr) - , _performanceMeasurements("performanceMeasurements", "Performance Measurements") + , _performanceMeasurements("performanceMeasurements", "Performance Measurements", "") // @TODO Missing documentation , _performanceManager(nullptr) , _renderer(nullptr) , _rendererImplementation(RendererImplementation::Invalid) @@ -108,26 +108,28 @@ RenderEngine::RenderEngine() , _frametimeType( "frametimeType", "Type of the frametime display", + "", // @TODO Missing documentation properties::OptionProperty::DisplayType::Dropdown ) - , _showDate("showDate", "Show Date Information", true) - , _showInfo("showInfo", "Show Render Information", true) - , _showLog("showLog", "Show the OnScreen log", true) - , _takeScreenshot("takeScreenshot", "Take Screenshot") + , _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) - , _showFrameNumber("showFrameNumber", "Show Frame Number", false) - , _disableMasterRendering("disableMasterRendering", "Disable Master Rendering", 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 , _disableSceneTranslationOnMaster( "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) + , _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 860c066325..98cac7b3a6 100644 --- a/src/rendering/screenspacerenderable.cpp +++ b/src/rendering/screenspacerenderable.cpp @@ -98,11 +98,12 @@ std::unique_ptr ScreenSpaceRenderable::createFromDictiona ScreenSpaceRenderable::ScreenSpaceRenderable(const ghoul::Dictionary& dictionary) : properties::PropertyOwner("") - , _enabled("enabled", "Is Enabled", true) - , _useFlatScreen("flatScreen", "Flat Screen", true) + , _enabled("enabled", "Is Enabled", "", true) // @TODO Missing documentation + , _useFlatScreen("flatScreen", "Flat Screen", "", true) // @TODO Missing documentation , _euclideanPosition( "euclideanPosition", "Euclidean coordinates", + "", // @TODO Missing documentation glm::vec2(0.f), glm::vec2(-4.f), glm::vec2(4.f) @@ -110,14 +111,15 @@ ScreenSpaceRenderable::ScreenSpaceRenderable(const ghoul::Dictionary& dictionary , _sphericalPosition( "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) - , _scale("scale", "Scale", 0.25f, 0.f, 2.f) - , _alpha("alpha", "Alpha", 1.f, 0.f, 1.f) - , _delete("delete", "Delete") + , _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)