ScreenSpaceDashboard

Inherits ScreenSpaceRenderable

Members

Name

Documentation

Type

Description

Optional

UseMainDashboard

If true, this ScreenSpaceDashboard will use the main dashboard instead of creating an independent one.

Boolean

Value of type ‘Boolean’

Yes

Inherited members from ScreenSpaceRenderable

Name

Documentation

Type

Description

Optional

Type

The type of the ScreenSpaceRenderable that is to be created.

String

Must name a valid ScreenSpaceRenderable

No

BackgroundColor

A fixed color that is combined with the screen space renderable to create the final color. The actual color of the screen space renderable is alpha-blended with the background color to produce the final result.

Color4

Value of type ‘Color4’

Yes

BorderColor

The color of the border.

Color3

Value of type ‘Color3’

Yes

BorderWidth

The width of the border.

Double

Greater than: 0

Yes

CartesianPosition

Determines the position of this screen space plane in Cartesian three-dimensional coordinates (meters).

Vector3<double>

Value of type ‘Vector3

Yes

Enabled

Determines whether this sceen space object will be rendered or not.

Boolean

Value of type ‘Boolean’

Yes

FaceCamera

If enabled, the object will be rotated to face the camera position. Any local rotation is then applied after this rotation.

Boolean

Value of type ‘Boolean’

Yes

GammaOffset

Sets the gamma correction of the texture that is applied in addition to the global gamma value.

Double

Value of type ‘Double’

Yes

Identifier

The unique identifier for this screen space renderable. It has to be unique amongst all existing screen space nodes that have been added to the scene.

Identifier

An identifier string. May not contain ‘.’, spaces, newlines, or tabs

Yes

MultiplyColor

If set, the plane’s texture is multiplied with this color. Useful for applying a color grayscale images.

Color3

Value of type ‘Color3’

Yes

Name

The name of the ScreenSpaceRenderable, which will be shown in the GUI. This does not have to be unique to the scene, but it is recommended to be.

String

Value of type ‘String’

Yes

Opacity

The opacity of the screen space object. If 1, the object is completely opaque. If 0, the object is completely transparent.

Double

In range: ( 0,1 )

Yes

RadiusAzimuthElevation

Determines the position of this screen space plane in a coordinate system based on radius (meters), azimuth (radians), and elevation (radians).

Vector3<double>

Value of type ‘Vector3

Yes

RenderDuringBlackout

If true, this screen space renderable is going to ignore the global blackout factor from the Render Engine and will always render at full opacity. If false, it will adhere to the factor and fade out like the rest of the 3D rendering.

Boolean

Value of type ‘Boolean’

Yes

Scale

A scale factor for the plane that can be used to increase or decrease the visual size. The default size is determined separately for each screen space renderable type and may for example be affected by the size of an image being displayed.

Double

Value of type ‘Double’

Yes

Tag

Defines either a single or multiple tags that apply to this ScreenSpaceRenderable, thus making it possible to address multiple, separate Renderables with a single property change.

String, or Table

Value of type ‘String’, or Value of type ‘Table’

Yes

UsePerspectiveProjection

Determines whetether the z/radius values affects the size of the plane or not.

Boolean

Value of type ‘Boolean’

Yes

UseRadiusAzimuthElevation

Determines whether the location of this screen space plane will be specified using radius, azimuth and elevation (if ‘true’) or using Cartesian coordinates. The Cartesian coordinate system is useful if a regular rendering is applied, whereas the radius azimuth elevation are most useful in a planetarium environment.

Boolean

Value of type ‘Boolean’

Yes

Asset Examples

 1local Dashboard = {
 2  Identifier = "ScreenSpaceTime",
 3  Name = "Time",
 4  Type = "ScreenSpaceDashboard",
 5  FaceCamera = false,
 6  Scale = 3.0,
 7  Items = {
 8    {
 9      Type = "DashboardItemDate",
10      Identifier = "Date",
11      GuiName = "Date",
12      FontSize = 72,
13      FormatString = "{}",
14      TimeFormat = "YYYY MON DD HR:MN:SC.### ::RND"
15    }
16  }
17}
18
19
20asset.onInitialize(function()
21  openspace.addScreenSpaceRenderable(Dashboard)
22
23  openspace.setPropertyValueSingle("ScreenSpace.ScreenSpaceTime.Size", {0.000000,0.000000,640.000000,320.000000})
24end)
25
26asset.onDeinitialize(function()
27  openspace.removeScreenSpaceRenderable(Dashboard)
28end)
29
30asset.export(Dashboard)
31
32
33
34asset.meta = {
35  Name = "ScreenSpace - Date",
36  Description = [[
37    This asset provides a Date dashboard item that is shown on a screen space object.
38    This can be place on a dome surface to show the current time to the audience.
39  ]],
40  Author = "OpenSpace Team",
41  URL = "http://openspaceproject.com",
42  License = "MIT license"
43}