ScreenSpaceDashboard

Inherits ScreenSpaceRenderable

Displays dashboard content as a 2D overlay on top of the scene. Unlike world-space objects, it is anchored to the screen rather than to any location in the 3D environment, which makes it suitable for HUD-style information displays.

The class acts as a container and renderer for DashboardItem instances. These items can present textual or status-oriented information such as time, camera state, mission data, frame rate, or other runtime values. The dashboard is rendered into a framebuffer-backed screen-space surface and then composited into the final view.

ScreenSpaceDashboard supports two usage patterns. It can either render the application’s shared main dashboard, or it can host its own independent dashboard instance. This makes it useful both for reusing a global information overlay and for creating dedicated screen-space panels with their own item composition.

Members

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
BorderFeather	If this value is enabled and a border width is set, the border will be rendered as a feathered border rather than a hard corner.	Boolean	Value of type ‘Boolean’	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
Identifier		Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	Yes
Items	A list of DashboardItems that are added automatically upon construction of the ScreenSpaceDashboard. This value must not be specified if UseMainDashboard is specified.	Table	Table parameters	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
Rotation	An Euler rotation (x, y, z) to apply to the screen space object.	Vector3<double>	Value of type ‘Vector3’	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
UseMainDashboard	If true, this ScreenSpaceDashboard will use the main dashboard instead of creating an independent one.	Boolean	Value of type ‘Boolean’	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

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
BorderFeather	If this value is enabled and a border width is set, the border will be rendered as a feathered border rather than a hard corner.	Boolean	Value of type ‘Boolean’	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
Rotation	An Euler rotation (x, y, z) to apply to the screen space object.	Vector3<double>	Value of type ‘Vector3’	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

Table parameters for Items

A list of DashboardItems that are added automatically upon construction of the ScreenSpaceDashboard. This value must not be specified if UseMainDashboard is specified.

• Optional: Yes

Name	Documentation	Type	Description	Optional
*		Table	DashboardItem	Yes

Asset Examples

Basic

This example shows how to display dashboard items in a screen space. In this specific example it is show the date in the simulation, but any #DashboardItem is supported.

local Item = {
  Type = "ScreenSpaceDashboard",
  Identifier = "ScreenSpaceDashboard_Example",
  Name = "ScreenSpaceDashboard Example - Basic",
  Items = {
    {
      Identifier = "ScreenSpaceDashboard_Example_Date",
      Type = "DashboardItemDate"
    }
  }
}


asset.onInitialize(function()
  openspace.addScreenSpaceRenderable(Item)
end)

asset.onDeinitialize(function()
  openspace.removeScreenSpaceRenderable(Item)
end)