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

20
modules/spacecraftinstruments/rendering/renderablemodelprojection.cpp
View File

@@ -42,17 +42,15 @@ namespace {
constexpr openspace::properties::Property::PropertyInfo PerformShadingInfo = {
"PerformShading",
"Perform Shading",
"If this value is enabled, the model will be shaded based on the relative "
"location to the Sun. If this value is disabled, shading is disabled and the "
"entire model is rendered brightly.",
"If true, the model will be shaded based on the location of the Sun. If false, "
"shading is disabled and the model is fully illuminated.",
openspace::properties::Property::Visibility::NoviceUser
};
struct [[codegen::Dictionary(RenderableModelProjection)]] Parameters {
// The file or files that should be loaded in this RenderableModel. The file can
// contain filesystem tokens or can be specified relatively to the
// location of the .asset file.
// This specifies the model that is rendered by the Renderable.
// The file or files that should be loaded, that specifies the model to load. The
// file can contain filesystem tokens or can be specified relative to the
// location of the asset file.
std::filesystem::path geometryFile;
enum class [[codegen::map(openspace::DistanceUnit)]] ScaleUnit {
@@ -73,12 +71,12 @@ namespace {
};
// The scale of the model. For example if the model is in centimeters
// then ModelScale = Centimeter or ModelScale = 0.01
// then `ModelScale = \"Centimeter\"` or `ModelScale = 0.01`.
std::optional<std::variant<ScaleUnit, double>> modelScale;
// By default the given ModelScale is used to scale the model down,
// by setting this setting to true the model is instead scaled up with the
// given ModelScale
// By default the given `ModelScale` is used to scale down the model. By setting
// this setting to true the scaling is inverted to that the model is instead
// scaled up with the given `ModelScale`.
std::optional<bool> invertModelScale;
// Contains information about projecting onto this planet.