RenderableTrailOrbit

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
Color	This value determines the RGB main color for the lines and points of the trail.	Color3	Value of type ‘Color3’	No
Period	The objects period, i.e. the length of its orbit around the parent object given in (Earth) days. In the case of Earth, this would be a sidereal year (=365.242 days). If this values is specified as multiples of the period, it is possible to show the effects of precession.	Double	Greater than: 0	No
Resolution	The number of samples along the orbit. This determines the resolution of the trail; the tradeoff being that a higher resolution is able to resolve more detail, but will take more resources while rendering, too. The higher, the smoother the trail, but also more memory will be used.	Integer	Greater than: 1	No
Translation	A translation used to compute locations along the path.	Table	Translation	No
DimInAtmosphere	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Enabled	Determines whether this object will be visible or not.	Boolean	Value of type ‘Boolean’	Yes
EnableFade	Toggles whether the trail should fade older points out. If this value is true, the ‘Fade’ parameter determines the speed of fading. If this value is false, the entire trail is rendered at full opacity and color.	Boolean	Value of type ‘Boolean’	Yes
EndTime	The end time for the range of this orbit. The date must be in ISO 8601.	String	A valid date in ISO 8601 format	Yes
ForceFullOrbitTrail	Forces the trail to always have a visible length of one orbit. If the time from the start date of the trail and the current time in OpenSpace is less than one period (full rotation), then the trail will extends into the future compared to the current OpenSpace time. If the current time in OpenSpace has passed the end date, the last full period of the trail will be shown. Only works if there exist a Start Time and End Time for the orbit data.	Boolean	Value of type ‘Boolean’	Yes
LimitToTimeRange	Only forces full trail orbit trail between start time and one orbital period after the end time.	Boolean	Value of type ‘Boolean’	Yes
LineFadeAmount	The amount of the trail that should be faded. If the value is 0 then the trail will have no fading applied. A value of 0.6 will result in a trail where 60% of the extent of the trail will have fading applied to it. In other words, the 40% closest to the head of the trail will be solid and the rest will fade until completely transparent at the end of the trail. A value of 1 will result in a trail that starts fading immediately, becoming fully transparent by the end of the trail.This setting only applies if the ‘EnableFade’ value is true. If it is false, this setting has no effect.	Double	In range: ( 0, 1)	Yes
LineLength	The extent of the rendered trail. A value of 0 will result in no trail and a value of 1 will result in a trail that covers the entire extent. The setting only applies if ‘EnableFade’ is true. If it is false, this setting has no effect.	Double	In range: ( 0, 1)	Yes
LineWidth	Specifies the line width of the trail lines, if the selected rendering method includes lines. If the rendering mode is Points, this value is ignored.	Double	Greater or equal to: 0	Yes
Opacity	This value determines the opacity of this renderable. A value of 0 means completely transparent.	Double	In range: ( 0, 1)	Yes
PointSize	Specifies the base size of the points along the line, if the selected rendering method includes points. If the rendering mode is Lines, this value is ignored. If a subsampling of the values is performed, the subsampled values are half this size.	Integer	Greater or equal to: 0	Yes
RenderBinMode	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	String	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	Yes
Rendering	Determines how the trail should be rendered. If ‘Lines’ is selected, only the line part is visible, if ‘Points’ is selected, only the corresponding points (and subpoints) are shown. ‘Lines+Points’ shows both parts.	String	In list { Lines, Points, Lines+Points, Lines+Points }	Yes
StartTime	The start time for the range of this orbit. The date must be in ISO 8601.	String	A valid date in ISO 8601 format	Yes
Tag	A single tag or a list of tags that this renderable will respond to when setting properties.	Table, or String	Value of type ‘Table’, or Value of type ‘String’	Yes
Type	The type of the renderable.	String	Value of type ‘String’	Yes

Inherited members from Renderable

Name	Documentation	Type	Description	Optional
DimInAtmosphere	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	Boolean	Value of type ‘Boolean’	Yes
Enabled	Determines whether this object will be visible or not.	Boolean	Value of type ‘Boolean’	Yes
Opacity	This value determines the opacity of this renderable. A value of 0 means completely transparent.	Double	In range: ( 0, 1)	Yes
RenderBinMode	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	String	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	Yes
Tag	A single tag or a list of tags that this renderable will respond to when setting properties.	Table, or String	Value of type ‘Table’, or Value of type ‘String’	Yes
Type	The type of the renderable.	String	Value of type ‘String’	Yes

Asset Examples

local sunAsset = asset.require("scene/solarsystem/sun/transforms")
local transforms = asset.require("./transforms")



local OrcusTrail = {
  Identifier = "OrcusTrail",
  Parent = sunAsset.SunEclipJ2000.Identifier,
  Renderable = {
    Type = "RenderableTrailOrbit",
    Enabled = asset.enabled,
    Translation = transforms.Translation,
    Color = { 0.2, 0.8, 0.3 },
    Period = 89359.12208173508,
    Resolution = 10000,
    Fade = 1.24
  },
  Tag = { "planetTrail_dwarf" },
  GUI = {
    Name = "Orcus Trail",
    Focusable = false,
    Path = "/Solar System/Dwarf Planets/Orcus"
  }
}


asset.onInitialize(function()
  openspace.addSceneGraphNode(OrcusTrail)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(OrcusTrail)
end)

asset.export(OrcusTrail)



asset.meta = {
  Name = "Orcus Trail",
  Description = [[Trail of Orcus]],
  Author = "OpenSpace Team",
  URL = "https://www.openspaceproject.com",
  License = "MIT"
}