mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-05 19:19:39 -06:00
Utilize new docs functionality in API scripts that are defined in Lua files (#3505)
* Fix a reference to a deprecated and renamed function in navigationstate docs * Review documentation for scripts defined in .lua files And utilize new markdown functionality * Update renderable box grid size specs So that it can have a size less than 1, and throws a specification error when the size is given as negative * Fix some issues with the gaia filtering scripts * Try adding param documentation to the lua script documentation It works! * Utiliize mroe markdown features in the updated documentations * Add function parameter info and make small updated to gaia filtering functions * Replace a long parameter info in description with `param` description * Update usage examples * Add example of how to create debug axes for the current SGN
This commit is contained in:
@@ -7,12 +7,21 @@ openspace.debugging.documentation = {
|
||||
},
|
||||
Documentation = [[
|
||||
Creates a new scene graph node that show the coordinate system used for the
|
||||
currently selected focus node. The first argument specifies the name of the
|
||||
scene graph node for which the axes should be added. If this parameter is
|
||||
not specified, the current focus node is used instead. The second argument
|
||||
provides the length of the coordinate axis in meters. If this value is not
|
||||
specified 2.5 times the interaction sphere of the selected node is used
|
||||
instead.
|
||||
currently selected focus node, or a specified scene graph node.
|
||||
|
||||
Usage:
|
||||
```lua
|
||||
-- To add coordinate axes for the currently selected focus node, do not specify any
|
||||
-- parameters
|
||||
openspace.debugging.createCoordinateAxes()
|
||||
```
|
||||
|
||||
\\param nodeIdentifier The identifier of the scene graph node for which the axes
|
||||
should be added. If this parameter is not specified, the
|
||||
current focus node is used instead.
|
||||
\\param scale An optional parameter that specifies the size of the coordinate axes,
|
||||
in meters. If not specified, the size is set to 2.5 times the
|
||||
interaction sphere of the selected node.
|
||||
]]
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user