RenderableEclipseCone

Inherits Renderable

Members

Name

Documentation

Type

Description

Optional

LightSource

This value determines the SPICE name of the object that is used as the illuminator for computing the shadow cylinder

String

Value of type ‘String’

No

LightSourceFrame

This value is the SPICE name of the body-fixed reference frame for the light source

String

Value of type ‘String’

No

Shadowee

This value is the SPICE name of object that is receiving the shadow from the shadower

String

Value of type ‘String’

No

Shadower

This value specifies the SPICE name of the object that is casting the shadow on the shadowee

String

Value of type ‘String’

No

ShadowerFrame

This value is the SPICE name of the body-fixed reference frame for the shadower

String

Value of type ‘String’

No

NumberOfPoints

This value determines the number of control points that is used to construct the shadow geometry. The higher this number, the more detailed the shadow is, but it will have a negative impact on the performance. Also note that rendering errors will occur if this value is even

Integer

Value of type ‘Integer’

Yes

PenumbralShadowColor

This value determines the color that is used for the shadow cylinder of the penumbral shadow

Color4

Value of type ‘Color4’

Yes

ShadowLength

This value determines the length of the shadow that is cast by the target object. The total distance of the shadow is equal to the distance from the target to the Sun multiplied with this value

Double

Value of type ‘Double’

Yes

ShowPenumbralShadow

If this is enabled, the penumbral portioon of the shadow is shown

Boolean

Value of type ‘Boolean’

Yes

ShowUmbralShadow

If this is enabled, the umbral portioon of the shadow is shown

Boolean

Value of type ‘Boolean’

Yes

UmbralShadowColor

This value determines the color that is used for the shadow cylinder of the umbral shadow

Color4

Value of type ‘Color4’

Yes

Inherited members from Renderable

Name

Documentation

Type

Description

Optional

DimInAtmosphere

Enables/Disables if the object should be dimmed when the camera is in the sunny part of an atmosphere

Boolean

Value of type ‘Boolean’

Yes

Enabled

This setting 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

This value specifies if the renderable should be rendered in the Background,Opaque, Pre/PostDeferredTransparency, or Overlay rendering step

String

In list { Background, Opaque, PreDeferredTransparent, PostDeferredTransparent, Overlay }

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

This tells the type of the renderable

String

Value of type ‘String’

Yes

Asset Examples

 1local transforms = asset.require("scene/solarsystem/planets/earth/moon/moon")
 2local coreKernels = asset.require("spice/core")
 3
 4local EarthMoonShadow = {
 5  Identifier = "EarthMoonShadow",
 6  Parent = transforms.Moon.Identifier,
 7  Renderable = {
 8    Type = "RenderableEclipseCone",
 9    Opacity = 1.0,
10    ShadowLength = 1.0,
11    UmbralShadowColor = { 0.85, 1.0, 1.0, 0.20 },
12    PenumbralShadowColor = { 0.35, 0.35, 0.35, 0.29 },
13    LightSource = coreKernels.ID.Sun,
14    LightSourceFrame = coreKernels.Frame.Sun,
15    Shadower = coreKernels.ID.Moon,
16    ShadowerFrame = coreKernels.Frame.Moon,
17    Shadowee = coreKernels.ID.Earth
18  },
19  GUI = {
20    Name = "Earth/Moon Shadow",
21    Path = "/Solar System/Planets/Earth"
22  }
23}
24
25asset.onInitialize(function()
26  openspace.addSceneGraphNode(EarthMoonShadow)
27end)
28
29asset.onDeinitialize(function()
30  openspace.removeSceneGraphNode(EarthMoonShadow)
31end)
32
33asset.export(EarthMoonShadow)
34
35
36
37asset.meta = {
38  Name = "Eclipse Shadow",
39  Version = "1.0",
40  Description = "The penumbral and umbral shadow eclipses for the Earth-Moon system",
41  Author = "OpenSpace Team",
42  URL = "http://openspaceproject.com",
43  License = "MIT license"
44}