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

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

18
modules/exoplanets/rendering/renderableorbitdisc.cpp
View File

@@ -43,33 +43,33 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo TextureInfo = {
"Texture",
"Texture",
"This value is the path to a texture on disk that contains a one-dimensional "
"texture which is used for the color.",
"The path to a file with a one-dimensional texture to be used for the disc "
"color. The leftmost color will be innermost color when rendering the disc, "
"and the rightmost color will be the outermost color.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
"Size",
"Size",
"This value specifies the semi-major axis of the orbit, in meters.",
"The size of the semi-major axis of the orbit in meters.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo EccentricityInfo = {
"Eccentricity",
"Eccentricity",
"This value determines the eccentricity, that is the deviation from a perfect "
"sphere, for this orbit.",
"The eccentricity of the orbit, which is the deviation from a perfect circle.",
openspace::properties::Property::Visibility::AdvancedUser
};
constexpr openspace::properties::Property::PropertyInfo OffsetInfo = {
"Offset",
"Offset",
"This property determines the width of the disc. The values specify the lower "
"and upper deviation from the semi major axis, respectively. The values are "
"relative to the size of the semi-major axis. That is, 0 means no deviation "
"from the semi-major axis and 1 is a whole semi-major axis's worth of deviation.",
"The width of the disc, given as two values that specify the lower and upper "
"deviation from the semi major axis, respectively. The values are relative "
"to the size of the semi-major axis. That is, 0 means no deviation from the "
"semi-major axis and 1 is a whole semi-major axis's worth of deviation.",
openspace::properties::Property::Visibility::AdvancedUser
};