mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-04-30 07:49:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Renderable property info walkthrough/cleanup (#3226)

Browse Source 
A passover of all the Parameters descriptions and PropertyInfo descriptions of the renderables in the code base to make then more consistently and concisely formatted. Also fixed some small issues and added or updated descriptions.

* Start rephrasing propertyinfos for more consistency

* Update eclipse cone propertyinfos

* Update `RenderableFov` property infos and group colors in UI

* `RenderableGalaxy` and `RenderableGlobe`

* Update more descriptions

* Moore descriptions

* Update docs for `RenderableShadowCylinder` and add properties

* `RenderableSkyTarget`, and spheres (`ImageOnline` and `ImageLocal`)

* `RnederableSphericalGrid`, and update line width info of other types, for consistency

* `RenderableStars` and `RenderableTimeVaryingSphere`

* Update more propertyinfos

* Fix inconsistent mentioning of true/false

* change some phrasings for increased consistency

* Update Renderbin description to include Sticker bin and remove extra property

* Rename `OutlineWeight` -> `OutlineWidth`

* Extend description about enable depth test for models

* Clarify what relative values mean for `RenderableNodeArrow`

* Elaborate on `RenderableLabel` size property

---------

Co-authored-by: Alexander Bock <alexander.bock@liu.se>
Co-authored-by: Ylva Selling <ylva.selling@gmail.com>
Co-authored-by: Malin E <malin.ejdbo@gmail.com>
This commit is contained in:
Emma Broman
2024-05-20 09:24:40 +02:00
committed by GitHub
parent 542f35e4de
commit eb1cfec7bd
57 changed files with 636 additions and 671 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/rendering/renderable.cpp
+6 -6
View File
@@ -45,14 +45,14 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
"Enabled",
"Enabled",
"This setting determines whether this object will be visible or not.",
"Determines whether this object will be visible or not.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo RenderableTypeInfo = {
"Type",
"Renderable Type",
"This tells the type of the renderable.",
"The type of the renderable.",
openspace::properties::Property::Visibility::AdvancedUser
};
@@ -60,16 +60,16 @@ namespace {
{
"RenderBinMode",
"Render Bin Mode",
"This value specifies if the renderable should be rendered in the Background,"
"Opaque, Pre/PostDeferredTransparency, or Overlay rendering step.",
"A value that specifies if the renderable should be rendered in the Background, "
"Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo DimInAtmosphereInfo = {
"DimInAtmosphere",
"Dim In Atmosphere",
"Enables/Disables if the object should be dimmed when the camera is in the "
"sunny part of an atmosphere.",
"Decides if the object should be dimmed (i.e. faded out) when the camera is in "
"the sunny part of an atmosphere.",
openspace::properties::Property::Visibility::AdvancedUser
};