mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-04-21 01:59:15 -05:00
Fix references in documentation
This commit is contained in:
+1
-1
@@ -1,6 +1,6 @@
|
||||
-- Basic
|
||||
-- Creates a screenspace image that shows a spherical grid as an example for any
|
||||
-- [Renderable](#renderable) that can be displayed.
|
||||
-- [Renderable](#core_renderable) that can be displayed.
|
||||
|
||||
local Item = {
|
||||
Type = "ScreenSpaceRenderableRenderable",
|
||||
|
||||
@@ -58,7 +58,7 @@ namespace {
|
||||
// ScreenSpaceDashboard. This value must not be specified if `UseMainDashboard` is
|
||||
// specified.
|
||||
std::optional<std::vector<ghoul::Dictionary>>
|
||||
items [[codegen::reference("dashboarditem")]];
|
||||
items [[codegen::reference("core_dashboarditem")]];
|
||||
};
|
||||
} // namespace
|
||||
#include "screenspacedashboard_codegen.cpp"
|
||||
|
||||
@@ -83,9 +83,9 @@ namespace {
|
||||
};
|
||||
|
||||
// This [ScreenSpaceRenderable](#core_screenspacerenderable) object can render any
|
||||
// [Renderable](#renderable) type into an image that is shown in screen space. This
|
||||
// can be used to display a rendered object as an overlay in front of the regular 3D
|
||||
// rendering of the scene.
|
||||
// [Renderable](#core_renderable) type into an image that is shown in screen space.
|
||||
// This can be used to display a rendered object as an overlay in front of the regular
|
||||
// 3D rendering of the scene.
|
||||
//
|
||||
// Note that to use this `ScreenSpaceRenderable`, it might be necessary to specify the
|
||||
// `size` parameter, which determines the resolution of the inset window into which
|
||||
@@ -98,31 +98,31 @@ namespace {
|
||||
struct [[codegen::Dictionary(ScreenSpaceRenderableRenderable)]] Parameters {
|
||||
std::optional<std::string> identifier [[codegen::private()]];
|
||||
|
||||
// The [Renderable](#renderable) object that is shown in this ScreenSpace object.
|
||||
// See the list of creatable renderable objects for options that can be used for
|
||||
// this type.
|
||||
// The [Renderable](#core_renderable) object that is shown in this ScreenSpace
|
||||
// object. See the list of creatable renderable objects for options that can be
|
||||
// used for this type.
|
||||
ghoul::Dictionary renderable [[codegen::reference("core_renderable")]];
|
||||
|
||||
struct Transform {
|
||||
// The [Translation](#core_transform_translation) object that is used for the
|
||||
// provided [Renderable](#renderable). If no value is specified, a
|
||||
// The [Translation](#core_translation) object that is used for the provided
|
||||
// [Renderable](#core_renderable). If no value is specified, a
|
||||
// [StaticTranslation](#base_translation_static) is created instead.
|
||||
std::optional<ghoul::Dictionary> translation
|
||||
[[codegen::reference("core_translation")]];
|
||||
|
||||
// The [Rotation](#core_transform_rotation) object that is used for the
|
||||
// provided [Renderable](#renderable). If no value is specified, a
|
||||
// The [Rotation](#core_rotation) object that is used for the provided
|
||||
// [Renderable](#core_renderable). If no value is specified, a
|
||||
// [StaticRotation](#base_rotation_static) is created instead.
|
||||
std::optional<ghoul::Dictionary> rotation
|
||||
[[codegen::reference("core_rotation")]];
|
||||
|
||||
// The [Scale](#core_transform_scale) object that is used for the provided
|
||||
// [Renderable](#renderable). If no value is specified, a
|
||||
// The [Scale](#core_scale) object that is used for the provided
|
||||
// [Renderable](#core_renderable). If no value is specified, a
|
||||
// [StaticScale](#base_scale_static) is created instead.
|
||||
std::optional<ghoul::Dictionary> scale [[codegen::reference("core_scale")]];
|
||||
};
|
||||
// The collection of transformations that are applied to the
|
||||
// [Renderable](#renderable) before it is shown on screen.
|
||||
// [Renderable](#core_renderable) before it is shown on screen.
|
||||
std::optional<Transform> transform;
|
||||
|
||||
// Specifies the start date that is used to control the renderable and the
|
||||
|
||||
@@ -14,11 +14,10 @@ openspace.gaia.documentation = {
|
||||
old one will be removed.
|
||||
|
||||
\\param identifier The identifier of the scene graph node with a
|
||||
[RenderableGaiaStars](#gaiamission_renderablegaiastars) to be
|
||||
filtered
|
||||
[RenderableGaiaStars](#gaia_renderable_gaiastars) to be filtered
|
||||
\\param size The size of each dimension of the box, in Kiloparsec
|
||||
\\param position The position of the center of the box, specified in galactic
|
||||
coordinates in Kiloparsec
|
||||
coordinates in Kiloparsec
|
||||
]]
|
||||
},
|
||||
{
|
||||
@@ -41,8 +40,7 @@ openspace.gaia.documentation = {
|
||||
the old one will be removed.
|
||||
|
||||
\\param identifier The identifier of the scene graph node with a
|
||||
[RenderableGaiaStars](#gaiamission_renderablegaiastars) to be
|
||||
filtered
|
||||
[RenderableGaiaStars](#gaia_renderable_gaiastars) to be filtered
|
||||
\\param radius The desired radius outside of the clipping sphere, in Kiloparsec
|
||||
]]
|
||||
},
|
||||
|
||||
@@ -571,7 +571,6 @@ nlohmann::json DocumentationEngine::generateFactoryManagerJson() const {
|
||||
|
||||
for (const Documentation& doc : docs) {
|
||||
if (doc.id.empty()) {
|
||||
LERROR("Documentation without identifier");
|
||||
continue;
|
||||
}
|
||||
leftovers[ClassesKey].push_back(documentationToJson(doc));
|
||||
@@ -673,21 +672,19 @@ void DocumentationEngine::writeJavascriptDocumentation() const {
|
||||
}
|
||||
|
||||
void DocumentationEngine::writeJsonDocumentation() const {
|
||||
nlohmann::json factory = generateFactoryManagerJson();
|
||||
nlohmann::json scripting = generateScriptEngineJson();
|
||||
|
||||
// Write two json files for the static docs page - asset components and scripting API
|
||||
std::ofstream out = std::ofstream(absPath("${DOCUMENTATION}/assetComponents.json"));
|
||||
if (out) {
|
||||
out << factory.dump();
|
||||
}
|
||||
out.close();
|
||||
|
||||
out.open(absPath("${DOCUMENTATION}/scriptingApi.json"));
|
||||
if (out) {
|
||||
out << scripting.dump();
|
||||
std::ofstream outFactory(absPath("${DOCUMENTATION}/assetComponents.json"));
|
||||
if (outFactory.good()) {
|
||||
nlohmann::json factory = generateFactoryManagerJson();
|
||||
outFactory << factory.dump();
|
||||
}
|
||||
|
||||
std::ofstream outScription(absPath("${DOCUMENTATION}/scriptingApi.json"));
|
||||
if (outScription.good()) {
|
||||
nlohmann::json scripting = generateScriptEngineJson();
|
||||
outScription << scripting.dump();
|
||||
}
|
||||
out.close();
|
||||
}
|
||||
|
||||
nlohmann::json DocumentationEngine::generateActionJson() const {
|
||||
|
||||
@@ -47,9 +47,9 @@ namespace {
|
||||
// A `TimeFrame` object determines the time frame during which a scene graph node is
|
||||
// valid. If the simulation time is outside the time frame range, the scene graph node
|
||||
// and all of its children are automatically disabled and any attached
|
||||
// [Renderable](#renderable) will not be displayed either. Usually, the time frame
|
||||
// corresponds to the time during which datasets are available or to disable a scene
|
||||
// graph node during uninteresting periods of time.
|
||||
// [Renderable](#core_renderable) will not be displayed either. Usually, the time
|
||||
// frame corresponds to the time during which datasets are available or to disable a
|
||||
// scene graph node during uninteresting periods of time.
|
||||
struct [[codegen::Dictionary(TimeFrame)]] Parameters {
|
||||
// The type of the time frame that is described in this element. The available
|
||||
// types of scaling depend on the configuration of the application and can be
|
||||
|
||||
Reference in New Issue
Block a user