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

9
modules/spacecraftinstruments/rendering/renderableplaneprojection.cpp
View File

@@ -45,18 +45,19 @@ namespace {
constexpr std::string_view _loggerCat = "RenderablePlaneProjection";
struct [[codegen::Dictionary(RenderablePlaneProjection)]] Parameters {
// The SPICE name of the spacecraft from which the projection is performed
// The SPICE name of the spacecraft from which the projection is performed.
std::string spacecraft;
// The SPICE name of the instrument that is used to project the image onto this
// RenderablePlaneProjection
// `RenderablePlaneProjection`.
std::string instrument;
// The SPICE name of the default target that is imaged by this planet
// The SPICE name of the default target that is imaged by this instrument (used
// when no target is identified by the `ImageSequencer`).
std::optional<std::string> defaultTarget;
// The image that is used on this plane before any image is loaded from the
// ImageSequencerr
// `ImageSequencer`.
std::optional<std::string> texture;
};
#include "renderableplaneprojection_codegen.cpp"