mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-05 19:19:39 -06:00
Renderable property info walkthrough/cleanup (#3226)
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:
@@ -43,7 +43,7 @@ namespace {
|
||||
constexpr openspace::properties::Property::PropertyInfo InterpolationValueInfo = {
|
||||
"Value",
|
||||
"Value",
|
||||
"The value to use for interpolation. The max value is set from the number of "
|
||||
"The value used for interpolation. The max value is set from the number of "
|
||||
"steps in the dataset, so a step of one corresponds to one step in the dataset "
|
||||
"and values in-between will be determined using interpolation.",
|
||||
openspace::properties::Property::Visibility::NoviceUser
|
||||
@@ -136,7 +136,7 @@ namespace {
|
||||
// the used texture will be decided based on the first N set of points.
|
||||
struct [[codegen::Dictionary(RenderableInterpolatedPoints)]] Parameters {
|
||||
// The number of objects to read from the dataset. Every N:th datapoint will
|
||||
// be interpreted as the same point, but at a different step in the interpolation
|
||||
// be interpreted as the same point, but at a different step in the interpolation.
|
||||
int numberOfObjects [[codegen::greaterequal(1)]];
|
||||
|
||||
struct Interpolation {
|
||||
@@ -149,7 +149,7 @@ namespace {
|
||||
// [[codegen::verbatim(UseSplineInfo.description)]]
|
||||
std::optional<bool> useSplineInterpolation;
|
||||
};
|
||||
// Initial settings for the interpolation
|
||||
// Initial settings for the interpolation.
|
||||
std::optional<Interpolation> interpolation;
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user