Interface vrui

vr ui

Type vrui

vrui.overrideLayerConfig(layer, override)

Override configs for a given layer.

vrui.setLayerConfig(config)

Set Config for the given layer

vrui.setLayerPose(pose)

Set pose for the given layer

vrui.version

Interface version

Type GuiConfig

GuiConfig.autosize

Defines whether this layer should be auto-sized or not

GuiConfig.backgroundOpacity

Default: 0

GuiConfig.center

Defines where within a layer is considered the center. x and y values range from -0.5 to 0.5. The geometry will be positioned with its center at the assigned coordinate. This most importantly affects the direction auto-sized layers will grow. For example, the HUD has a default center of util.vector2(0, 0.5), causing it to grow left as new magic effects are added, keeping all elements in place.

GuiConfig.extent

Defines the spatial size of a layer in meters. Is ignored for auto-sized layers.

GuiConfig.pixelsPerMeter

Defines the spatial size of auto-sized layers. Is ignored for non-auto-sized layers.

GuiConfig.space

(Optional) name of a space to actively track. If set, the UI element will actively track this space, updating its pose every frame.

Type Pose

Type vrui

Field(s)

vrui.overrideLayerConfig(layer, override)

Override configs for a given layer.

Stops this script from processing that layer, allowing you to change it however you wish without this script interfering.

Parameters

  • #string layer :

  • #boolean override : Set to true to override config. Set to false to stop overriding.

vrui.setLayerConfig(config)

Set Config for the given layer

Parameter

vrui.setLayerPose(pose)

Set pose for the given layer

Parameter

#number vrui.version

Interface version

Type GuiConfig

Configuration of a VR 3D GUI quad.

Informs the engine where to place a layer of the GUI within the game world, and at what size.

Field(s)

#boolean GuiConfig.autosize

Defines whether this layer should be auto-sized or not

#number GuiConfig.backgroundOpacity

Default: 0

openmw.util#Vector2 GuiConfig.center

Defines where within a layer is considered the center. x and y values range from -0.5 to 0.5. The geometry will be positioned with its center at the assigned coordinate. This most importantly affects the direction auto-sized layers will grow. For example, the HUD has a default center of util.vector2(0, 0.5), causing it to grow left as new magic effects are added, keeping all elements in place.

openmw.util#Vector2 GuiConfig.extent

Defines the spatial size of a layer in meters. Is ignored for auto-sized layers.

#number GuiConfig.pixelsPerMeter

Defines the spatial size of auto-sized layers. Is ignored for non-auto-sized layers.

#string GuiConfig.space

(Optional) name of a space to actively track. If set, the UI element will actively track this space, updating its pose every frame.

Type Pose

A spatial pose, consisting of a position and an orientation

Field(s)

openmw.util#Transform Pose.orientation

openmw.util#Transform

openmw.util#Vector3 Pose.position

openmw.util#Vector3