RenderableSphereImageOnline

Inherits Renderable

A RenderableSphereImageOnline can be used to show an image from an online source (as a URL) on a sphere in the OpenSpace scene. The image should be provided in an equirectangular projection, if it is a map that is draped over the sphere.

Members

Name

Documentation

Type

Description

Optional

URL

A URL to an image to use as a texture for this sphere. The image is expected to be an equirectangular projection.

String

Value of type ‘String’

No

DisableFadeInOut

Enables/Disables the fade in and out effects.

Boolean

Value of type ‘Boolean’

Yes

FadeInThreshold

The distance from the center of the Milky Way at which the sphere should start to fade in, given as a percentage of the size of the object. A value of zero means that no fading in will happen.

Double

Value of type ‘Double’

Yes

FadeOutThreshold

A threshold for when the sphere should start fading out, given as a percentage of how much of the sphere that is visible before the fading should start. A value of zero means that no fading out will happen.

Double

In range: ( 0,1 )

Yes

MirrorTexture

If true, mirror the texture along the x-axis.

Boolean

Value of type ‘Boolean’

Yes

Orientation

Specifies whether the texture is applied to the inside of the sphere, the outside of the sphere, or both.

String

In list { Outside, Inside, Both }

Yes

Segments

The number of segments that the sphere is split into.

Integer

Greater or equal to: 4

Yes

Size

The radius of the sphere in meters.

Double

Greater than: 0

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, 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

The type of the renderable.

String

Value of type ‘String’

Yes

Asset Examples

Basic

This example shows a sphere that is covered with an image which is retrieved from an online URL. The image will be stretched over the entire sphere as an equirectangular projection.

 1local Node = {
 2  Identifier = "RenderableSphereImageOnline_Example",
 3  Renderable = {
 4    Type = "RenderableSphereImageOnline",
 5    URL = "http://data.openspaceproject.com/examples/renderableplaneimageonline.jpg"
 6  },
 7  GUI = {
 8    Name = "RenderableSphereImageOnline - Basic",
 9    Path = "/Examples"
10  }
11}
12
13asset.onInitialize(function()
14  openspace.addSceneGraphNode(Node)
15end)
16
17asset.onDeinitialize(function()
18  openspace.removeSceneGraphNode(Node)
19end)